DING API开放接口V2

接口说明

DING API开放接口V2版本。

接口限制规则：

• 同一个应用相同消息的内容同一个用户一天只能接收一次。
• 同一个应用给同一个用户发送消息，24小时内不得超过100次。

以ISV应用及接收人作为独立的计算时间窗口（24h），在窗口内只能接受100条DING消息：

用户收到应用发送的第一条DING消息后为记录点，此后24小时内，最多只能接收该应用发送的100条DING消息，当超过24小时后重新计算，依次类推。

举例：用户A在今天3点收到应用B的DING消息，此后24小时内（明天3点前），只能收到应用B的100条信息。到明天3点之后，计数重新计算。

通知类型为电话语音钉的限制规则 ：

电话DING使用的阿里云的语音服务，ISV发DING也收到阿里云语音服务的流控管控，阿里云语音服务的流控规则&效果如下：

• 流控规则：针对同一个被叫号码。流控规则：1次/分钟、5次/小时、20次/天（24小时）。
• 流控效果：命中流控规则时，再对该被叫号码发送电话DING（无论通过DING接口还是通过客户端发送），实际不播出电话，只能收到应用内DING。

基本信息

中文名： DING API开放接口V2

接口名： /ding/isv/send.json

所在目录： DING

调用方式： POST（HTTPS）

发布版本： V2.7.0

最低可用版本	V2.7.0

请求参数

名称	子对象	类型	是否必填	示例值	描述
tenantId		String	是	695716	租户ID
creator		Obj	是	“creator”:{<br/>“accountId”:8844491,<br/>dingId<br/>“accountOrgId”:“”, “accountOrgName”:“”<br/>}	发送者
	accountId	Long	是		账号ID
	accountName	String	是		账号名称
	accountOrgId	String	否		组织ID
	accountOrgName	String	否		组织名称
receivers		List	是	[<br/>{ “accountId”:143918250, “accountName”:“冯世明”, “accountOrgId”:“pre.saas.zwdingding”<br/>}<br/>]	接收者集合，最多100个。
	accountId	Long	是		账号ID
	accountName	String	是		账号名称
	accountOrgId	String	否		组织ID
	accountOrgName	String	否		组织名称
source		Obj	是	无需发送到im会话：“source”:{<br/>“extJson”:“{"msgId":""}”, “sourceId”:“143906377”,“sourceName”:“周丽英”<br/>}<br/>需要发送到im会话：<br/>“source”:{<br/>“extJson”:“{"msgId":""}”, “sourceId”:“207693:789507”,“sourceName”:“xxx办公室<br/>”<br/>}	来源信息。<br/>具体见各字段描述。
	sourceId		是	“sourceId”:“143906377”<br/>或者<br/>“sourceId”:“207693:789507”	创建DING的源。<br/>+ sourceId分情况： 无需发送IM会话时：sourceId与creator的accountId保持一致。<br/>+ 需要发送IM会话时：sourceId需要按照发送方接收方两个uid，小:大的顺序填写。 （小uid:大uid，英文冒号拼接，大小由uid数值大小判断，小的在前大的在后）如：“sourceId”:“207693:789507”<br/>注意：发送到IM只支持发送单人，不能群发。
	sourceName		是	xxx办公室	源的名称，如会话名
	extJson		是	“extJson”:“{"msgId":""}”	扩展字段，msgId默认为空，无需填写
body		String	是	“body”:“{"text":"（当前版本过低，升级版本后可查看DING详情）"}”	内容json字符串，必须带text这个key
bodyType		String	是	text	内容类型，目前发钉接口只支持文本类型<br/>text：文本
textType		String	是	plaintext	内容加密类型<br/>plaintext：明文
dingBody		String	是	“dingBody”:“{"text":"测试一下", "attachments":[]}”	消息体json字符串，dingBody格式见示例值，必须包含key：text和attachments。
dingBodyContentType		String	是	attachment	消息体内容类型，文本默认填写：attachment
dingBodyTextType		String	是	plaintext	消息体加密类型<br/>plaintext：明文；<br/>ciphertext：密文（暂不对ISV开放）
notifyType		String	是	app	通知类型 <br/>app：应用内；<br/>sms：短信；<br/>vms：语音（电话语音钉限制规则见接口说明）
sendToIm		Boolean	否	false	是否发送到IM会话，默认false<br/>为true时scene填写固定值：session<br/>注意：发送到IM只支持发送单人，不能群发。
scene		String	否	session	sendToIm为true，scene填写固定值：session

返回参数

名称	类型	描述
success	Boolean	请求是否成功。true：请求成功；false：请求失败
content	Object
└ data	String	发钉ID，可根据此信息，来查询/ding/query/userDetail以获取已未读/发送成功失败的接收者信息
└ success	Boolean	业务处理是否成功