dingtalk.oapi.impaas.message.asyncsend (impaas消息异步发送)

消息异步发送,返回taskid,根据taskid获取消息是否成功

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request AsyncSendMessageRequest 必须 发送消息的结构
  • └ group_id
  • String
  • 可选
  • "232334"
  • 群ID
  • └ msg_content
  • 必须
  • { "content":"文本消息内容" }
  • 消息内容,根据msgtype不同,解析方式不同
  • └ msg_extension
  • 可选
  • {"key":"value"}
  • 消息的可扩展字段,透传
  • └ receiverid_list
  • []
  • 可选
  • 接受者,暂不支持,可不填
  • senderid
  • AccountInfo
  • 可选
  • 发送者,暂不支持,可不填
  • └ id
  • String
  • 可选
  • "eleme账号"
  • 账号ID
  • └ type
  • String
  • 可选
  • "channelUser"
  • 账号类型:channelUser/staff。当类型为channelUser时,填写app自己的账号,当类型为staff时,填写钉钉的staffid
  • └ channel
  • String
  • 可选
  • "eleme"
  • 账号通道:eleme,hema等
  • └ msg_feature
  • 可选
  • {"silent": "1"}
  • 消息的特性:静默消息,系统消息
  • └ msg_type
  • String
  • 必须
  • "text"
  • 消息类型:text,image,user-defined
  • xpn_model
  • XpnContentModel
  • 可选
  • 推送信息
  • └ alert_content
  • String
  • 可选
  • "xpn提醒文案"
  • 推送文案
  • └ params
  • 可选
  • {"key":"value"}
  • 推送参数,透传

响应参数

名称 类型 示例值 描述
taskid Number 123456 异步任务返回的ID
errmsg String "ok" 返回描述信息
errcode Number 0 返回码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/impaas/message/asyncsend");
OapiImpaasMessageAsyncsendRequest req = new OapiImpaasMessageAsyncsendRequest();
AsyncSendMessageRequest obj1 = new AsyncSendMessageRequest();
obj1.setGroupId("\"232334\"");
AccountInfo obj2 = new AccountInfo();
obj2.setId("\"eleme账号\"");
obj2.setType("\"channelUser\"");
obj2.setChannel("\"eleme\"");
obj1.setSenderid(obj2);
obj1.setMsgType("\"text\"");
XpnContentModel obj3 = new XpnContentModel();
obj3.setAlertContent("\"xpn提醒文案\"");
obj1.setXpnModel(obj3);
req.setRequest(obj1);
OapiImpaasMessageAsyncsendResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "taskid":123456,
    "errmsg":"\"ok\"",
    "errcode":0
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部