API接口文档

小组级接收消息回调

POST

https://aa-hub.ddregion.com

💡

回调地址在：小组控制台 -> api接入 -> 回调地址

建议此接口在对接上线之前，参考我们的最佳实践文档来确保最好的稳定性和性能

请求参数

Body 参数application/json

data

object

必需

messageId

string

消息id

可选

chatId

string

对话id（表示一个bot和一个客户）

可选

avatar

string

客户或者群头像

可选

roomTopic

string

群名

可选

roomId

string

群聊的系统wxid

可选

contactName

string

客户姓名

可选

contactId

string

客户的系统wxid

可选

payload

消息内容

可选

type

enum<number>

消息的payload

可选

枚举值:

012345678910111213151699991000010001

timestamp

string

消息时间戳

必需

token

string

小组级token

可选

botId

string

bot的账号id

可选

contactType

enum<number>

客户的类型

可选

枚举值:

0123

coworker

boolean

是否为内部员工

可选

botWxid

string

托管账号对应成员的系统wxid

可选

botWeixin

string

bot的企业微信userId

可选

source

enum<number>

消息来源，具体来源信息参考下面的枚举定义

可选

枚举值:

01234567

sendBy

string

消息发送者的秒回id，仅当消息为消息为托管账号发送的，且消息来源为小组级控制台手动发消息时有效

可选

isSelf

boolean

消息是否是托管账号自己发送的消息

可选

mentionSelf

boolean

当前消息是否@了托管账号

必需

externalUserId

string

客户的企业微信externalUserId

可选

roomWecomChatId

string

群的企微chatId

可选

示例

{
  "orgId": "string",
  "token": "string",
  "botId": "string",
  "imBotId": "string",
  "botUserId": "string",
  "chatId": "string",
  "avatar": "string",
  "coworker": true,
  "imContactId": "string",
  "imRoomId": "string",
  "roomWecomChatId": "string",
  "roomTopic": "string",
  "messageId": "string",
  "isSelf": true,
  "sendBy": "string",
  "source": 0,
  "externalUserId": "string",
  "contactName": "string",
  "contactType": 0,
  "messageType": 0,
  "payload": {
    "content": "string"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orgId": "string",
    "token": "string",
    "botId": "string",
    "imBotId": "string",
    "botUserId": "string",
    "chatId": "string",
    "avatar": "string",
    "coworker": true,
    "imContactId": "string",
    "imRoomId": "string",
    "roomWecomChatId": "string",
    "roomTopic": "string",
    "messageId": "string",
    "isSelf": true,
    "sendBy": "string",
    "source": 0,
    "externalUserId": "string",
    "contactName": "string",
    "contactType": 0,
    "messageType": 0,
    "payload": {
        "content": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

errmsg

string

对返回码的文本描述内容

必需

示例

{
  "errcode": 0,
  "errmsg": "string"
}

修改于 2025-02-06 06:17:42

聊天历史

发送消息