获取工作通知消息的发送结果

POST

/topapi/message/corpconversation/getsendresult

企业内部应用第三方企业应用oapi

说明

调用本接口查询工作通知消息的发送结果。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在创建应用时，系统已默认添加了消息通知权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	无需申请	调试
第三方企业应用	是	无需申请	调试
第三方个人应用	否	—	—

错误码

错误码	描述	解决方案
143103	企业单应用消息发送人次QPM超限	接口调用太快，稍后重试。
143104	企业每分钟发送人次QPM超限	接口调用太快，稍后重试。
143105	单应用给单人每日推送量超限	企业每天给每个员工最多可发送500条消息通知，ISV最多可发送50条。
143106	单应用给单人推送重复消息超限	给同一员工一天只能发送一条内容相同的消息通知。
143203	ISV单应用发送给单企业人次QPM超限	接口调用太快，稍后重试。
143204	ISV单应用发送给所有企业人次QPM超限	接口调用太快，稍后重试。
143205	单应用给单人每日推送量超限	企业每天给每个员工最多可发送500条消息通知，ISV最多可发送50条。
143206	单应用给单人推送重复消息超限	给同一员工一天只能发送一条内容相同的消息通知。
1430000	接受者为空	接受者不能为空。
1430001	未识别的grantType	无。
1430002	包含违禁内容	检查消息文本中是否有黄色、反动等词语。
1430003	触发OAPI系统保护	无。
1430004	超级高管保护	关闭高管保护。

请求参数

Query 参数

access_token

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

agent_id

number

必需

发送消息时使用的微应用的ID。企业内部应用可在开发者后台的应用详情页面查看。第三方企业应用可调用获取企业授权信息接口获取。

task_id

number

必需

发送消息时钉钉返回的任务ID。仅支持查询24小时内的任务。

示例

{
        "agent_id":123,
        "task_id":456
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/topapi/message/corpconversation/getsendresult?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
        "agent_id":123,
        "task_id":456
}'

返回响应

🟢200成功

application/json

Body

send_result

object

返回结果。

可选

invalid_user_id_list

array[string]

可选

无效的userid。

forbidden_user_id_list

array[string]

可选

因发送消息过于频繁或超量而被流控过滤后实际未发送的userid。未被限流的接收者仍会被成功发送。限流规则包括：给同一用户发相同内容消息一天仅允许一次同一个应用给同一个用户发送消息：如果是ISV接入方式，给同一用户发消息一天不得超过100次如果是企业接入方式，此上限为500

failed_user_id_list

array[string]

可选

发送失败的userid。

read_user_id_list

array[string]

可选

已读消息的userid。

unread_user_id_list

array[string]

可选

未读消息的userid。

invalid_dept_id_list

array[number]

无效的部门ID。

可选

forbidden_list

array [object {3}]

可选

推送被禁止的具体原因。

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
    "send_result": {
        "invalid_user_id_list": [
            "string"
        ],
        "forbidden_user_id_list": [
            "string"
        ],
        "failed_user_id_list": [
            "string"
        ],
        "read_user_id_list": [
            "string"
        ],
        "unread_user_id_list": [
            "string"
        ],
        "invalid_dept_id_list": [
            0
        ],
        "forbidden_list": [
            {
                "code": "string",
                "count": 0,
                "userid": "string"
            }
        ]
    },
    "errcode": 0,
    "errmsg": "string",
    "request_id": "string"
}

修改于 2023-12-26 06:53:24

获取工作通知消息的发送进度

撤回工作通知消息

获取工作通知消息的发送结果

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码