dingtalk.oapi.message.corpconversation.getsendresult (获取异步向企业会话发送消息的结果)

获取异步向企业会话发送消息的结果

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
agent_id Number 可选 123 微应用的agentid
task_id Number 可选 456 异步任务的id

响应参数

名称 类型 示例值 描述
send_result AsyncSendResult {} result
  • └ invalid_user_id_list
  • String []
  • zhangsan,lisi
  • 无效的用户id
  • └ forbidden_user_id_list
  • String []
  • zhangsan,lisi
  • 因发送消息过于频繁或超量而被流控过滤后实际未发送的userid。未被限流的接收者仍会被成功发送。限流规则包括:1、给同一用户发相同内容消息一天仅允许一次;2、如果是ISV接入方式,给同一用户发消息一天不得超过100次;如果是企业接入方式,此上限为500。
  • └ failed_user_id_list
  • String []
  • zhangsan,lisi
  • 发送失败的用户id
  • └ read_user_id_list
  • String []
  • zhangsan,lisi
  • 已读消息的用户id
  • └ unread_user_id_list
  • String []
  • zhangsan,lisi
  • 未读消息的用户id
  • └ invalid_dept_id_list
  • Number []
  • 1,2,3
  • 无效的部门id
  • forbidden_list
  • SendForbiddenModel []
  • 推送被禁止的具体原因
  • └ code
  • String
  • 流控code
  • └ count
  • Number
  • 流控阀值
  • └ userid
  • String
  • 员工userId
errcode Number 0 errcode
errmsg String ok errmsg

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult");
OapiMessageCorpconversationGetsendresultRequest req = new OapiMessageCorpconversationGetsendresultRequest();
req.setAgentId(123L);
req.setTaskId(456L);
OapiMessageCorpconversationGetsendresultResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "send_result":{
        "invalid_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "forbidden_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "failed_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "read_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "unread_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "invalid_dept_id_list":{
            "number":[
                1,
                2,
                3
            ]
        },
        "forbidden_list":[
            {
                    "code":"",
                    "count":,
                    "userid":""
            }
        ]
    },
    "errcode":0,
    "errmsg":"ok"
}

异常示例

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

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部