连接器事件发送 - 钉钉开放平台

连接器事件发送

连接器事件发送

更新时间:2021-03-24
调用本接口将本地业务系统产生的事件发送到钉钉连接器服务中,钉钉会将这些事件再广播转发给订阅了此事件的其它业务系统。

权限

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

无需申请

调试

第三方企业应用

无需申请

调试

第三方个人应用

基本信息

请求方式:POST

请求地址:https://oapi.dingtalk.com/topapi/connector/trigger/send_v2

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

bE3xxxx

调用服务端接口的授权凭证。

Body参数

名称

类型

是否必填

示例值

描述

trigger_msg_request

TriggerMsgRequest

触发消息请求结构体。

└ test

Boolean

false

是否为测试属性。

└ trigger_msg_data_list

TriggerMsgData[]

触发动作数据。

└ trigger_id

String

TRIGGER-123SD

事件ID。在开发者后台创建应用连接器后,可以在连接器页面查看。详情请参考创建应用连接器

└ dd_event_time

Date

2018-07-11 12:12:12

事件真实触发的时间。

└ json_data

String

{}

这里的JSON数据对应的是单次事件,数据结构要与触发事件使用的数据模型相匹配。

返回参数

名称

类型

示例值

描述

request_id

String

slv9pxu72v6t

请求ID。

errmsg

String

ok

返回码描述。

errcode

Number

0

返回码。

result

TriggerMsgResponse

调用结果。

└ request_id

String

request-283sjs

业务ID。

示例

请求示例:

Java

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/connector/trigger/send_v2");
OapiConnectorTriggerSendV2Request req = new OapiConnectorTriggerSendV2Request();
TriggerMsgData msgData = new TriggerMsgData();
msgData.setTriggerId("替换为事件ID");
msgData.setDdEventTime(new Date());
JSONObject jsonObject = new JSONObject();
jsonObject.put("AAA","AAA");
jsonObject.put("BBB","BBB");
msgData.setJsonData(jsonObject.toJSONString());
TriggerMsgRequest msgRequest = new TriggerMsgRequest();
msgRequest.setTest(false);
msgRequest.setTriggerMsgDataList(Arrays.asList(msgData));
//这里可以一次传入多个事件批量发送
req.setTriggerMsgRequest(msgRequest);
OapiConnectorTriggerSendV2Response rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

HTTP

POST https://oapi.dingtalk.com/topapi/connector/trigger/send_v2?access_token=ACCESS_TOKEN

{
    "trigger_msg_request": {
        "test": false, 
        "trigger_msg_data_list": [
            {
                "trigger_id": "TRIGGERID-xxxx", 
                "dd_event_time": "2018-07-11 12:12:12", 
                "json_data": "{\"AAA\":\"AAA\",\"BBB\":\"BBB\"}"
            }
        ]
    }
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok",
    "result": {
        "request_id": "605AA1493831323A006A83C9"
    },
    "request_id": "slv9pxu72v6t"
}

权限

基本信息

Query参数

Body参数

返回参数

示例


原网址: 访问
创建于: 2021-07-10 17:11:17
目录: default
标签: 无

请先后发表评论
  • 最新评论
  • 总共0条评论