批量发送服务窗消息

说明

调用本接口向服务窗的一批粉丝用户发送消息。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	服务窗发送消息权限,获取CRM主数据的接口访问权限	API Explorer
第三方企业应用	支持	服务窗发送消息权限,获取CRM主数据的接口访问权限	API Explorer
第三方个人应用	暂不支持	服务窗发送消息权限,获取CRM主数据的接口访问权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	idempotentParameterMismatch.uuid	illegal parameter %s	UUID 不存在
400	illegalParameter.uuid	illegal uuid	UUID 不合法
400	illegalParameter.messageContent	illegal message content	消息内容不正确
400	illegalParameter.messageBody	illegal message body	消息体不正确
400	illegalParameter.messageType	illegal message type	消息类型不正确
400	illegalParameter.messageReceiver	illegal message receiver	消息接收人不正确
400	illegalParameter.accountOrg	illegal account org	服务窗帐号不存在
400	illegalParameter.account	illegal account	服务窗帐号不存在
400	illegalRequest.overQuota	request over quota.	请求超过配额。
500	systemError	System error.	系统异常
500	systemError.messageStatus	illegal message status	消息状态异常

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

detail

object

消息详情。

必需

msgType

string

消息类型。

必需

uuid

string

必需

消息请求唯一ID。长度不超过128位字符。

bizRequestId

string

可选

业务请求标识。
当一次业务请求需要多次调用发送API时可以设置此参数，方便后续跟踪处理。

userIdList

array[string]

可选

消息接收人列表，最多支持1000人。
值为服务窗粉丝userid，可以通过粉丝关注事件获取对应的userid。

messageBody

object

消息体。

必需

sendToAll

boolean

全员群发。

可选

bizId

string

可选

服务窗授权的调用方标识，可以为空。

accountId

string

账单id。

可选

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

object

返回结果。

可选

openPushId

string

可选

消息推送ID，长度不超过128位，可用于消息发送进度排查。

requestId

string

请求ID。

可选

示例

{
  "result": {
    "openPushId": "string"
  },
  "requestId": "string"
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码