API接口文档

API发送消息结果回调

POST

https://aa-hub.ddregion.com

功能说明：

本接口为发送消息回调接口，本接口将使用API发送消息的详情数据回调给指定的路径。

💡

回调地址在企业级 api接入配置发消息结果回调地址
注：此接口仅是【发送消息】接口的情况回执，仅对该接口生效

请求参数

Query 参数

token

string

可选

示例值:

***

Body 参数application/json

示例

{
  "orgId": "string",
  "token": "string",
  "requestId": "string",
  "externalRequestId": "string",
  "timestamp": 0,
  "botId": "string",
  "imBotId": "string",
  "imContactId": "string",
  "imRoomId": "string",
  "messageType": 1,
  "payload": {
    "name": "string",
    "url": "string",
    "size": 0
  },
  "sendCode": 0,
  "errorCode": "string",
  "messageId": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com?token=***' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orgId": "string",
    "token": "string",
    "requestId": "string",
    "externalRequestId": "string",
    "timestamp": 0,
    "botId": "string",
    "imBotId": "string",
    "imContactId": "string",
    "imRoomId": "string",
    "messageType": 1,
    "payload": {
        "name": "string",
        "url": "string",
        "size": 0
    },
    "sendCode": 0,
    "errorCode": "string",
    "messageId": "string"
}'

返回响应

🟢200成功

application/json

Body

errcode

enum<number>

返回码

必需

枚举值:

101102103104105106107108109150151152153154155156157158159160161162163164165166167168169170201202204206250100110021003110020001

errmsg

string

对返回码的文本描述内容

必需

示例

{
  "orgId": "646d818baf71f175124fabde",
  "token": "66fe7b0b027b4277bdadfb3236c230e5",
  "requestId": "65a772cd0b1f68bb1b4a85b6",
  "externalRequestId": "",
  "botId": "657fb386adadbcecdf5a5567",
  "imBotId": "1688854807513525",
  "imContactId": "7881301204958266",
  "messageType": 7,
  "payload": {
    "text": "Hello World"
  },
  "errorCode": 0,
  "sendCode": 0,
  "timestamp": 1705472718082
}

修改于 2024-11-21 08:48:51

发送消息

接收消息回调 POST