接收消息回调 POST - API接口文档

请求参数

Body 参数application/json

orgId

string

企业id

必需

groupId

string

小组ID

必需

token

string

企业级token

必需

botId

string

bot的账号id

必需

imBotId

string

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

必需

botUserId

string

bot的企业微信userId

必需

chatId

string

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

必需

avatar

string

客户或者群头像

必需

coworker

boolean

是否为内部员工

可选

imContactId

string

发送息人员系统wxid

可选

imRoomId

string

群聊的系统wxid

可选

roomWecomChatId

string

群的企微chatId

可选

roomTopic

string

群名

可选

messageId

string

消息id

可选

isSelf

boolean

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

可选

sendBy

string

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

可选

source

enum<number>

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

可选

枚举值:

0134567

externalUserId

string

客户的企业微信externalUserId

可选

当发送消息对象为外部用户时，该值为externalUserId。当发送消息对象为托管账号时，该值为托管账号user_id

customerExternalUserId

string

对话客户外部联系人id

必需

本字段只是打招呼语消息的回调中没有ExternalUserId和customerExteernalUserId,当时还是非好友关
系,添加好友后续回调中就会正常返回

contactName

string

发送者姓名

必需

contactType

enum<number>

客户的类型

必需

枚举值:

0123

messageType

enum<number>

消息的payload

必需

枚举值:

01234567891011121314151699991000010001

payload

消息内容

可选

示例

{
  "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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '' \
--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"
}