-
Notifications
You must be signed in to change notification settings - Fork 6
WhatsApp API webhook
GiuFLim edited this page Apr 29, 2025
·
50 revisions
对提供的webhook地址，进行WhatsApp业务相关的推送信息（目前webhook支持推送状态回复，消息回复，模板状态更新，WABA账号更新）
- URL：
webhook_url - Method：
POST - Content-Type：
application/json
对调用WhatsApp-API发送消息的场景，提供消息的回执情况
对于客户应用配置了回执加签算法，所有的回执请求服务端都会进行加签处理，客户端可自行对回执请求进行验签处理，验签算法请参照签名算法
body参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| statuses | array[status JsonObject] | 状态对象 |
| business_phone | String | 商户电话 |
| messaging_product | String | 消息类型，固定值”whatsapp“ |
- status object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| conversation | JsonObject | 会话信息 |
| errors | array[error JsonObject] | 错误信息 |
| recipient_id | String | 收件人WhatsApp_id |
| timestamp | String | 回调时间戳 |
| status | String | 消息的状态，sent（已发送），delivered（已送达)，read（已读），failed（发送失败） |
| id | String | 消息ID（发送消息时返回的ID） |
| costs | array[cost object] | 费用信息 |
| meta_message_id | String | meta原始消息ID, 该字段不一定存在； 发送引用消息时可能用到该字段值，id与meta_message_id 并存时使用meta_message_id作为被引用的消息id，否则使用id |
| biz_opaque_callback_data | String | 发送消息时携带的追踪参数 |
- conversation object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 会话ID |
| expiration_timestamp | String | 会话过期时间戳 |
| origin | JsonObject | 会话类型信息 |
- origin object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | 会话类型，marketing（营销会话），utility（通知会话），authentication（验证会话），service（服务会话），referral_conversion（免费会话），marketing_lite（MM Lite API会话) |
- error object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 平台错误码（错误码说明） |
| meta_code | Integer | meta错误码 |
| title | String | 错误信息 |
- cost object参数:
| 参数名 | 类型 | 说明 |
|---|---|---|
| currency | String | 币种 |
| price | number | 客户售价（本币CNY） |
| foreign_price | number | 客户售价（外币） |
| cdr_type | Integer | cdr类型， 1（消息），4（营销会话），5（通知会话），6（验证会话），7（服务会话），8（免费会话） |
| message_id | String | wa消息id |
| direction | Integer | 方向，1（下行），2（上行） |
{
"statuses":[
{
"id":"wamid.HBgNODYxNzYwNjA1MDgxORUCABEYEjI4RTcyNzFGRDVGQTQwQkQ1RAA=",
"meta_message_id": "wamid.HBgNNjI4MTI4MTM3NTYwNBUCABEYEkMzODdBNTEzMTAxNDhFMEI5NQA=",
"status":"sent",
"timestamp":"1660019986",
"recipient_id":"86176xxxx0819",
"conversation":{
"id":"72569257438b471cae074da84bed1b83",
"expiration_timestamp":"1660106400",
"origin":{
"type":"authentication"
}
},
"costs":[
{
"currency":"USD",
"price":0,
"foreign_price":0,
"cdr_type":1,
"message_id":"wamid.HBgNNjI4MTI4MTM3NTYwNBUCABEYEkMzODdBNTEzMTAxNDhFMEI5NQA=",
"direction":1
},
{
"currency":"USD",
"price":0.1381,
"foreign_price":0.02,
"cdr_type":4,
"message_id":"wamid.HBgNNjI4MTI4MTM3NTYwNBUCABEYEkMzODdBNTEzMTAxNDhFMEI5NQA=",
"direction":1
}
]
}
]
}{
"statuses": [
{
"id": "wamid.HBgNODYxNzYwNjA1MDgxORUCABEYEjI4RTcyNzFGRDVGQTQwQkQ1RAA=",
"meta_message_id": "wamid.HBgNNjI4MTI4MTM3NTYwNBUCABEYEkMzODdBNTEzMTAxNDhFMEI5NQA=",
"status": "delivered",
"timestamp": "1660019987",
"recipient_id": "86176xxxx0819",
"conversation": {
"id": "72569257438b471cae074da84bed1b83",
"origin": {
"type": "authentication"
}
}
}
]
}{
"statuses": [
{
"id": "wamid.HBgNODYxNzYwNjA1MDgxORUCABEYEjI4RTcyNzFGRDVGQTQwQkQ1RAA=",
"meta_message_id": "wamid.HBgNNjI4MTI4MTM3NTYwNBUCABEYEkMzODdBNTEzMTAxNDhFMEI5NQA=",
"status": "read",
"timestamp": "1660019990",
"recipient_id": "86176xxxx0819"
}
]
}| code | message | 解决办法 |
|---|---|---|
| 9001 | System business error | 平台错误，请联系相关人员排查 |
| 10000 | Meta Error | WhatsApp官方发送错误，详情参见meta_code、title |
| 10001 | Wa Engine Error | WhatsApp-Engine上游错误，请联系相关人员排查 |
| 10002 | Wa Engine Send Message Timeout | WhatsApp-Engine发送超时，请联系相关人员排查 |
{
"statuses": [
{
"id": "wamid.2e27ab39dbxxxxxxxb124a74b8",
"errors": [
{
"code": 9001,
"title": "System business error()"
}
],
"recipient_id": "3934xxxxx6000",
"status": "failed",
"timestamp": "1723604140"
}
],
"business_phone": "8523xxxxx862",
"messaging_product": "whatsapp"
}{
"statuses": [
{
"errors": [
{
"code": 10000,
"meta_code": 132001,
"title": "Meta Error((#132001) Template name does not exist in the translation)"
}
],
"id": "ID",
"recipient_id": "WHATSAPP_ID",
"status": "failed",
"timestamp": "TIMESTAMP"
}
]
}{
"statuses": [
{
"id": "wamid.302061d8f10d47fea6136ba290a2bda7",
"errors": [
{
"code": 10000,
"meta_code": 132005,
"title": "Meta Error((#132005) Translated text too long)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713504965"
}
]
}{
"statuses": [
{
"id": "wamid.c14d12fc44d1439c92adf69b4e5a2a43",
"errors": [
{
"code": 10000,
"meta_code": 131009,
"title": "Meta Error((#131009) Parameter value is not valid)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713503819"
}
]
}{
"statuses": [
{
"id": "wamid.456b7a1001754b0a8518517868071de8",
"errors": [
{
"code": 10000,
"meta_code": 100,
"title": "Meta Error((#100) Invalid parameter)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713500742"
}
]
}{
"statuses": [
{
"id": "wamid.db8cc8d4a8bb4a969df274e25857cca5",
"errors": [
{
"code": 10000,
"meta_code": 131000,
"title": "Meta Error((#131000) Something went wrong)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713472479"
}
]
}{
"statuses": [
{
"id": "wamid.3a9eefbbc792486da5850822dedcd8de",
"errors": [
{
"code": 10000,
"meta_code": 130429,
"title": "Meta Error((#130429) Rate limit hit)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713367837"
}
]
}{
"statuses": [
{
"id": "wamid.f9f92a5a951749898060a257bd5668bb",
"errors": [
{
"code": 10000,
"meta_code": 132000,
"title": "Meta Error((#132000) Number of parameters does not match the expected number of params)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1713426137"
}
]
}{
"statuses": [
{
"id": "wamid.e8c6b1835fed401a8786ab1547ebf5af",
"errors": [
{
"code": 10000,
"meta_code": 10,
"title": "Meta Error((#10) Application does not have permission for this action)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1712983756"
}
]
}{
"statuses": [
{
"id": "wamid.d7cbc64872dc46ffabf76b8087d39933",
"errors": [
{
"code": 10000,
"meta_code": 131056,
"title": "Meta Error((#131056) (Business Account, Consumer Account) pair rate limit hit)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1712912513"
}
]
}{
"statuses": [
{
"id": "wamid.d7cbc64872dc46ffabf76b8087d39933",
"errors": [
{
"code": 10000,
"meta_code": 131008,
"title": "Meta Error((#131008) Parameter of type text is missing text value)"
}
],
"recipient_id": "96650xxxx431",
"status": "failed",
"timestamp": "1712912513"
}
]
}
{
"statuses": [
{
"id": "wamid.8caca9c7fxxxxxxxx2cd1a9a2111",
"errors": [
{
"code": 10001,
"title": "Wa Engine Error(获取meta message id 失败)"
}
],
"recipient_id": "386xxxx1268",
"status": "failed",
"timestamp": "1723500463"
}
],
"business_phone": "852664xxxx105",
"messaging_product": "whatsapp"
}{
"statuses": [
{
"id": "wamid.807ff7e5026d4a4xxxx532a244232444",
"errors": [
{
"code": 10002,
"title": "Wa Engine Send Message Timeout"
}
],
"recipient_id": "417xxxx9752",
"status": "failed",
"timestamp": "1723337517"
}
],
"business_phone": "852xxxx3862",
"messaging_product": "whatsapp"
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852xxxx3862",
"phone_number_id": "161169xxxx19812"
},
"statuses": [
{
"meta_message_id": "wamid.HBgMMzkzNTA1OTYxxxxxxERgSMTJEQjQzNEYwRUEzNUI3ODY1AA==",
"id": "wamid.4e03bc5bc12d4xxxxa51a9380c4bfb6",
"recipient_id": "3935xxxx2976",
"status": "failed",
"timestamp": "1723337288",
"errors": [
{
"code": 131026,
"title": "Message Undeliverable."
}
]
}
],
"app_id": "xxx",
"business_phone": "852xxxx3862",
"merchant_phone": "852xxxx3862",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852xxxx3862",
"phone_number_id": "161169xxxx19812"
},
"statuses": [
{
"meta_message_id": "wamid.HBgMOTY2NTU3ODk1OTIzxxxxxxxGRjFFNzNFRUE1N0YxRDQyAA==",
"id": "wamid.eb78c85b970f4xxxxfdaba8a0f350128",
"recipient_id": "9665xxxx5923",
"status": "failed",
"timestamp": "1723337111",
"errors": [
{
"code": 131053,
"title": "Unsupported Image mime type image/webp. Please use one of image/png, image/jpeg."
}
]
}
],
"app_id": "xxx",
"business_phone": "852xxxx3862",
"merchant_phone": "852xxxx3862",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852xxxx3313",
"phone_number_id": "24094xxxx439281"
},
"statuses": [
{
"meta_message_id": "wamid.HBgLODUyNTQxxxxxxxxI5MTkwRkIzQTlBMEY3RDQ0NjYA",
"id": "wamid.30bf536d5ad6xxxxxxe144dcf31",
"recipient_id": "852xxxxx409",
"status": "failed",
"timestamp": "1723345890",
"errors": [
{
"code": 130472,
"title": "Failed to send message because this user's phone number is part of an experiment",
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
],
"app_id": "xxx",
"business_phone": "852xxxxx313",
"merchant_phone": "852xxxxx313",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "6221xxxx0365",
"phone_number_id": "10652xxxx19185"
},
"statuses": [
{
"meta_message_id": "wamid.HBgNNjI4NTIzNjg5ODAzNhUCABIYIDxxxxxxxxxxxxxxxxxxxTJFNEVFNDIyNDJCRDE4MzUzAA==",
"id": "wamid.HBgNNjI4NTIzNjg5ODAzNhUCABIYIDxxxxxxxxxxxxxxxxxxxTJFNEVFNDIyNDJCRDE4MzUzAA==",
"recipient_id": "62852xxxx8036",
"status": "failed",
"timestamp": "1723370701",
"errors": [
{
"code": 131052,
"title": "Incoming media file validation failed or the received media is in incorrect format, please ask the sender to resend the media message."
}
]
}
],
"app_id": "xxx",
"business_phone": "62852xxxx8036",
"merchant_phone": "62852xxxx8036",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "62852xxxx8036",
"phone_number_id": "271352389392750"
},
"statuses": [
{
"meta_message_id": "wamid.HBgKNTkyNjIxMzcxMRsxxxxxxxxFNkI5MkVDMDlCMUY5OTE1QgA=",
"id": "wamid.870f44e7a4xxxxxxxx4a7763938e7009",
"recipient_id": "5926213711",
"status": "failed",
"timestamp": "1723441066",
"errors": [
{
"code": 131009,
"title": "Cannot react to a message if it's more than 30 days old or doesn't correspond to any message in the conversation."
}
]
}
],
"app_id": "xxx",
"business_phone": "62852xxxx8036",
"merchant_phone": "62852xxxx8036",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "62852xxxx8036",
"phone_number_id": "10347xxxx349406"
},
"statuses": [
{
"meta_message_id": "wamid.HBgNNDkxNTIwNjYxMDI5MhUCABEYEkFGNzUwMDExNDAyQUQ0OUY4QwA=",
"id": "wamid.db05dcfd6a5347ac9d97c27e5e7ab68d",
"recipient_id": "4915206610292",
"status": "failed",
"timestamp": "1723444780",
"errors": [
{
"code": 131047,
"title": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
],
"app_id": "xxx",
"business_phone": "62852xxxx8036",
"merchant_phone": "62852xxxx8036",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "62852xxxx8036",
"phone_number_id": "268080186388284"
},
"statuses": [
{
"meta_message_id": "wamid.HBgMOTcxNTAzMTEwOxxxxxxxxx0ODJEN0ZFRUU4AA==",
"id": "wamid.e5fee94051bf4929xxxx31beb6821",
"recipient_id": "971503110900",
"status": "failed",
"timestamp": "1723464255",
"errors": [
{
"code": 131000,
"title": "Something went wrong."
}
]
}
],
"app_id": "xxx",
"business_phone": "62852xxxx8036",
"merchant_phone": "62852xxxx8036",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852664xxxx105",
"phone_number_id": "277xxxxxxxxx8733"
},
"statuses": [
{
"meta_message_id": "wamid.HBgNNjI4MjI3Nzg4OTU5ORUCxxxxxxxxxM3QzlERDUxQjNBQQA=",
"id": "wamid.f40485e53bd1xxxxxxxxxc669c3a",
"recipient_id": "6282xxxxxxx9599",
"status": "failed",
"timestamp": "1723616606",
"errors": [
{
"code": 131031,
"title": "Business account has been locked.",
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
],
"app_id": "xxx",
"business_phone": "852664xxxx105",
"merchant_phone": "852664xxxx105",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852664xxxx105",
"phone_number_id": "17205xxxxx1593"
},
"statuses": [
{
"meta_message_id": "wamid.HBgLMzM3NjIxNjxxxxxxxxxxxxxjg4RUQyRUFBNjFFOTUA",
"id": "wamid.61e1f287fxxxxxxx1e37e75adaa6",
"recipient_id": "337xxxxx383",
"status": "failed",
"timestamp": "1723639940",
"errors": [
{
"code": 131048,
"title": "Message failed to send because there are restrictions on how many messages can be sent from this phone number.This may be because too many previous messages were blocked or flagged as spam.",
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
],
"app_id": "xxx",
"business_phone": "852664xxxx105",
"merchant_phone": "852664xxxx105",
"channel": 2
}{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "852664xxxx105",
"phone_number_id": "17205xxxxx1593"
},
"statuses": [
{
"meta_message_id": "wamid.HBgNNTIxODQ0NjEwODU2ORUCABEYExxxxxxFOERBRjlERDg4NkU4QwA=",
"id": "24a44ec9155145b9xxxxxx28b148b11",
"recipient_id": "521xxxxxx8569",
"status": "failed",
"timestamp": "1726630150",
"errors": [
{
"code": 131049,
"title": "In order to maintain a healthy ecosystem engagement, the message failed to be delivered.",
"href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/"
}
]
}
],
"app_id": "749",
"business_phone": "852664xxxx105",
"merchant_phone": "852664xxxx105",
"channel": 2
}对WhatsApp用户发送消息到商户号码的场景，提供入站消息的推送情况
body参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| contacts | array[contact JsonObject] | 提供联系人的信息 |
| messages | array[message JsonObject] | 入站消息 |
| business_phone | String | 商户电话 |
| messaging_product | String | 消息类型，固定值”whatsapp“ |
- contact object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| profile | JsonObject | 配置文件对象 |
| wa_id | String | 联系人的 WhatsApp ID |
- profile object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| name | String | 发件人的配置文件名称 |
- message object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| from | String | 发件人的 WhatsApp ID |
| id | String | 消息标识，此 ID 可用于将消息标记为已读 |
| timestamp | String | 消息接收时间戳 |
| type | String | 支持接收的消息类型 1. text 文本 2. image 图片 3. video 视频 4. voice 语音 5. audio 音频 6. document 文件 7. location 位置 8. sticker 贴图表情 9. interactive 互动消息 10. order 下单消息 11. referral 被广告引流来的客户消息 12. reaction 心情消息 |
| context | JsonObject | 仅在用户回复或与您的消息之一互动时存在 |
| cost | JsonObject | 费用信息 |
- cost object参数:
| 参数名 | 类型 | 说明 |
|---|---|---|
| currency | String | 币种 |
| price | number | 客户售价（本币CNY） |
| foreign_price | number | 客户售价（外币） |
| cdr_type | Integer | cdr类型，4营销 5通知 6验证 7服务 8广告推广这五个类型 |
| message_id | String | wa消息id |
| direction | Integer | 方向，1（下行），2（上行） |
- 消息类型
- 文本消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| text | JsonObject | 参照响应示例 文本消息内容，type=text时有值 |
- text object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| body | String | 消息文本 |
- 图片消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| image | JsonObject | 参照响应示例 图片消息内容，type=image时有值 |
- image object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
| caption | String | 图片的描述 |
| mime_type | String | 媒体文件的MiME类型 |
| sha256 | String | 媒体文件的校验签名 |
- 视频消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| video | JsonObject | 参照响应示例 视频消息内容，type=video时有值 |
- video object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
| caption | String | 视频的描述 |
| mime_type | String | 媒体文件的MiME类型 |
| sha256 | String | 媒体文件的校验签名 |
- 语音消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| voice | JsonObject | 参照响应示例 语音消息内容，type=voice时有值 |
- voice object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
| mime_type | String | 媒体文件的MiME类型 |
| sha256 | String | 媒体文件的校验签名 |
- 音频消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| audio | JsonObject | 参照响应示例 音频消息内容，type=audio时有值 |
- audio object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
| mime_type | String | 媒体文件的MiME类型 |
| sha256 | String | 媒体文件的校验签名 |
- 文档消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| document | JsonObject | 参照响应示例 文档消息内容，type=document时有值 |
- document object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
| mime_type | String | 媒体文件的MiME类型 |
| sha256 | String | 媒体文件的校验签名 |
| filename | String | 文档文件名称 |
- 位置消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| location | JsonObject | 参照响应示例 位置消息内容，type=location时有值 |
- location object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| longitude | String | 位置的经度信息 |
| latitude | String | 位置的维度信息 |
| name | String | 位置的名称 |
| address | String | 位置的详细地址信息 |
- 贴图表情消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| sticker | JsonObject | 参照响应示例 贴图表情消息内容，type=sticker时有值 |
- sticker object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 媒体存储的id，可用于获取媒体链接 |
- 互动消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| interactive | JsonObject |
参照响应示例1 参照响应示例2 type=interactive时有值 |
- interactive object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | button_reply (按钮回复) list_reply（列表回复） nfm_reply（表单提交） |
| button_reply | JsonObject | 当客户点击按钮时发送，具有该属性的对象。 |
| list_reply | JsonObject | 当客户从列表中选择一个项目时发送，具有该属性的对象。 |
| nfm_reply | JsonObject |
- button_reply 或者 list_reply object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | String | 按钮id |
| title | String | 标题 |
| description | String | 选项描述，list_reply才有 |
- nfm_reply object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| name | String | 固定为 flow |
| body | String | 消息提交后的文案 |
| response_json | String | flow的json数据. The structure is either defined in flow JSON (see Complete action) or, if flow is using an endpoint, controlled by endpoint (see Final Response Payload in Data Exchange Request) |
- 下单消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| order | JsonObject |
参照响应示例 type=order时有值 |
- order object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| catalog_id | String | 目录id |
| text | String | 当客户点击按钮时发送，具有该属性的对象。 |
| product_items | Array[JsonObject] | 当客户从列表中选择一个项目时发送，具有该属性的对象。 |
- product_items object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| product_retailer_id | String | 目录中产品的唯一标识符 |
| quantity | Number | 物品数量 |
| item_price | Number | 每个物品的价格 |
| currency | String | 货币类型 |
- 引用消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| context | JsonObject |
商品消息响应示例 引用消息响应示例 仅在用户回复或与您的消息之一互动时存在 |
- context object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| from | String | 被引用消息来源号码 |
| id | String | 消息id |
| meta_message_id | String | meta消息id(不一定存在) |
| forwarded | Boolean | 如果商家收到的该消息已被转发，则设置为true |
| frequently_forwarded | Boolean | 如果商家收到的该消息已被转发超过5次，则设置为true。 |
| referred_product | JsonObject | 引用回复商品消息时含有该对象 |
- referred_product object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| catalog_id | String | 目录id |
| product_retailer_id | String | 目录中产品的唯一标识符 |
- 广告引入客户的消息参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| referral | JsonObject |
消息响应示例 当客户点击一个广告且该广告将他们重定向到WhatsApp时， 此对象会包含在消息对象中 |
- referral object参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| source_url | String | 指向客户点击的广告或帖子的Meta URL。 打开这个URL将会看到客户视角的广告 |
| source_type | String | 广告或帖子的Meta ID |
| headline | String | 广告或帖子中使用的标题 |
| body | String | 广告或帖子的正文 |
| media_type | String | 广告或帖子中存在的媒体类型；图片或视频 |
| image_url | String | 当媒体类型为图片时的图片URL |
| video_url | String | 当媒体类型为视频时的视频URL |
| thumbnail_url | String | 当媒体类型为视频时的缩略图URL |
| ctwa_clid | String | 由Meta为点击至WhatsApp的广告生成的点击ID |
- reaction消息参数：
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| reaction | JsonObject | 否 | 参照请求示例 | 心情消息内容，type=reaction必填 |
- reaction object参数：
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| meta_message_id | String | 是 | - | meta消息id |
| message_id | String | 是 | - | 消息回复id,例如:wamid.HBgNODYxMzE2MzczMTQ2NxUCABIYEkVCQkE4NjdGRUE5RDgyQzg0RAA= |
| emoji | String | 是 | - | 表情 例如:"❤️" |
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQNkLO2ipL1_ZpZ41mwgMHEg",
"text": {
"body": "你好"
},
"timestamp": "1663053831",
"type": "text",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQNkLO2ipL1_ZpZ41mwgMHEg",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQk5kC-xMSoi3XpEwoF2ZkIg",
"image": {
"id": "2bc7102f-5491-40b1-a92f-338303eab9d3",
"mime_type": "image/jpeg",
"sha256": "0ed3d9d4db83ed7751314af5f2e9bf008edc49a101bebb9054a97f824cf2136b"
},
"timestamp": "1663053029",
"type": "image",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQk5kC-xMSoi3XpEwoF2ZkIg",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQysyxXFholwoQ-lCwUTTWfw",
"timestamp": "1663054466",
"type": "video",
"video": {
"id": "bfc0619d-995e-49da-9869-e911a34c43b9",
"mime_type": "video/mp4",
"sha256": "e0ceec95f44fec6282ab02f947ee92dbe481dacf0478618a997580a822acc88b"
},
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQysyxXFholwoQ-lCwUTTWfw",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQyrJn0a5IBKlmHZqf_uAuFw",
"timestamp": "1663055136",
"type": "voice",
"voice": {
"id": "25fdf335-d846-4e6c-9aa8-35f25abc564c",
"mime_type": "audio/ogg; codecs=opus",
"sha256": "f321ac774459c50e376048d6f2c02fc2c14f13be85c5e52a67ec16a358b34de7"
},
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQyrJn0a5IBKlmHZqf_uAuFw",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"audio": {
"id": "aab95384-fc19-4136-a330-97e1f8a4cb02",
"mime_type": "audio/mpeg",
"sha256": "9a73ab6362694fba48a5027c8443ceb34838009601ce480d85f08c600cf520f1"
},
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQdSLi6R7UCDSsCqNkjrtczg",
"timestamp": "1663053098",
"type": "audio",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQdSLi6R7UCDSsCqNkjrtczg",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"document": {
"caption": "null.txt",
"filename": "null.txt",
"id": "806bb2f3-d8cc-4477-8b4d-d89df862f6c0",
"mime_type": "text/plain",
"sha256": "90c7bd7c509aa1d68c09a67b9ba2d17022a6861681fbd75c8845ee48193e8646"
},
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQGvyQjDNptdnjvjN0dkD90Q",
"timestamp": "1663052759",
"type": "document",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQGvyQjDNptdnjvjN0dkD90Q",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQO8HTCPOtJUZLNLRo2dPufw",
"location": {
"address": "深圳市, 广东",
"latitude": 22.550802897696343,
"longitude": 113.93844723701477,
"name": "KFC (肯德基)",
"url": "http://www.kfc.com.cn"
},
"timestamp": "1663053163",
"type": "location",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQO8HTCPOtJUZLNLRo2dPufw",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "ABGHhhdgYFCBnwIQ1kuKFSU5LfuDxSUPOjKIwA",
"sticker": {
"id": "1b0a4c77-c5e7-44fa-b2a3-b69941ed3c64",
"metadata": {
"emojis": [
"☕",
"🙂"
],
"is-first-party-sticker": 1,
"sticker-pack-id": "whatsappcuppy"
},
"mime_type": "image/webp",
"sha256": "98267fedaeac67a4cc6b5e18a2444249fba5b6363a690115139675d53a63b0ff"
},
"timestamp": "1663054803",
"type": "sticker",
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 4,
"message_id": "ABGHhhdgYFCBnwIQ1kuKFSU5LfuDxSUPOjKIwA",
"direction": 1
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"context": {
"from": "86176xxxx0819",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgARGBJDNDI1ODA3QzE0NkEwMUY1NjQA"
},
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTc1OEVGOEFBQ0U4QkIwNzFCOQA=",
"timestamp": "1701849537",
"type": "interactive",
"interactive": {
"type": "button_reply",
"button_reply": {
"id": "2",
"title": "不愿意"
}
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTc1OEVGOEFBQ0U4QkIwNzFCOQA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"context": {
"from": "86176xxxx0819",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgARGBI2NDFBRDA4NzcyOUU3NUJDODIA"
},
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQUVGMzA0MDM0QUZGRUJGOTRCMgA=",
"timestamp": "1701850329",
"type": "interactive",
"interactive": {
"type": "list_reply",
"list_reply": {
"id": "2",
"title": "牛肉面",
"description": "红烧牛肉面"
}
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQUVGMzA0MDM0QUZGRUJGOTRCMgA=",
"direction": 2
}
}
]
,
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"context": {
"from": "86176xxxx0819",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgARGA9wcm9kdWN0X2lucXVpcnkA",
"referred_product": {
"catalog_id": "310639698193384",
"product_retailer_id": "qnp7xflxk9"
}
},
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTQ0MEI2Rjc4MURCM0VFOTQwMwA=",
"timestamp": "1701846846",
"type": "text",
"text": {
"body": "我想要"
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTQ0MEI2Rjc4MURCM0VFOTQwMwA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTJEQ0M5MEM0OURFNjZDQjY0MQA=",
"timestamp": "1701847162",
"type": "order",
"order": {
"catalog_id": "310639698193384",
"text": "",
"product_items": [
{
"product_retailer_id": "h0v6snwgg6",
"quantity": 1.0,
"item_price": 124.0,
"currency": "CNY"
},
{
"product_retailer_id": "qnp7xflxk9",
"quantity": 1.0,
"item_price": 1000.0,
"currency": "CNY"
}
]
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTJEQ0M5MEM0OURFNjZDQjY0MQA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"context": {
"from": "86176xxxx0819",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgARGBJFRjIzOTZGNDhBOTRCQTIzNjcA"
},
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTkxRUFCRTc2QjJBRTZBQ0ZEMwA=",
"timestamp": "1701847428",
"type": "interactive",
"interactive": {
"type": "nfm_reply",
"nfm_reply": {
"response_json": "{\"screen_0_RadioButtonsGroup_0\":\"0_10分\",\"flow_token\":\"AQAAAAACS5FpgQ_cAAAAAD0QI3s\",\"screen_0_TextInput_1\":\"好评，满意\"}",
"body": "已发送",
"name": "flow"
}
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTkxRUFCRTc2QjJBRTZBQ0ZEMwA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "wamid.HBgNODYxMzE2MzczMTQ2NxUCABIYIDM3REYzQUZEMzQ5MDY1RkYxQjg4NEY0NURBMjg3QUIxAA==",
"timestamp": "1700222189",
"type": "text",
"text": {
"body": "您好，我想多了解一些信息。"
},
"referral": {
"headline": "与我们聊天",
"source_type": "ad",
"source_id": "120200744305620497",
"source_url": "https://fb.me/6cf1tN8rT"
},
"cost": {
"currency": "USD",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgNODYxMzE2MzczMTQ2NxUCABIYIDM3REYzQUZEMzQ5MDY1RkYxQjg4NEY0NURBMjg3QUIxAA==",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"context": {
"from": "86176xxxx0819",
"id": "wamid.d148508dce0149c9aca912ea6fb6035d",
"meta_message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgARGBI3NEZGOTg5NDc5RkExRjg2RjUA"
},
"from": "85255311705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTkwNDhEMDQ0MEY2QzA1NDE4OAA=",
"timestamp": "1701856516",
"type": "text",
"text": {
"body": "OK you"
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQTkwNDhEMDQ0MEY2QzA1NDE4OAA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}
{
"contacts": [
{
"profile": {
"name": "Jay"
},
"wa_id": "852xxxx705"
}
],
"messages": [
{
"from": "852xxxx705",
"id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQUY3OTA5Mzg5MDU2NDU5RDg4NgA=",
"timestamp": "1701861490",
"type": "unsupported",
"errors": [
{
"code": 131051,
"title": "Message type is currently not supported."
}
],
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgLODUyNTUzMTE3MDUVAgASGBQzQUY3OTA5Mzg5MDU2NDU5RDg4NgA=",
"direction": 2
}
}
],
"merchant_phone": "86176xxxx0819",
"messaging_product": "whatsapp"
}{
"messaging_product": "whatsapp",
"contacts": [
{
"wa_id": "8617xxxx50819",
"profile": {
"name": "Jay"
}
}
],
"messages": [
{
"from": "8617xxxx50819",
"id": "wamid.HBgNODYxNzYwNjA1MDgxORUCABISVASBMzBDMjVFNkIxRUFGMzAzNTREAA==",
"timestamp": "1724118060",
"type": "reaction",
"reaction": {
"message_id": "wamid.4092fc1a7877448f8ec8c8d2216dfdd4",
"meta_message_id": "wamid.HBgNODYxNzYwNjA1MDgxORUCABISVASBMzBDMjVFNkIxRUFGMzAzNTREAA=",
"emoji": "👍"
},
"cost": {
"currency": "CNY",
"price": 0,
"foreign_price": 0,
"cdr_type": 1,
"message_id": "wamid.HBgNODYxNzYwNjA1MDgxORUCABISVASBMzBDMjVFNkIxRUFGMzAzNTREAA==",
"direction": 2
}
}
],
"metadata": {
"display_phone_number": "8523xxxx859",
"phone_number_id": "12487xxxxx14609"
},
"app_id": "48",
"business_phone": "8523xxxx859",
"merchant_phone": "8523xxxx859",
"channel": 2
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "APPROVED",
"time": 1713313467,
"message_template_id": "1370101990353470",
"message_template_name": "lostgreethungarian20",
"message_template_language": "hu",
"reason": "NONE"
},
"field": "message_template_status_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "REJECTED",
"time": 1713165587,
"message_template_id": "1084366229523542",
"message_template_name": "mulanfreeen",
"message_template_language": "en",
"reason": "INCORRECT_CATEGORY"
},
"field": "message_template_status_update"
}{
"field": "message_template_status_update",
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "FLAGGED",
"message_template_id": "TEMPLATE-ID",
"message_template_name": "My message template",
"message_template_language": "en-US",
"reason": null,
"disable_info": {
"disable_date": "DATE",
}
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "PAUSED",
"message_template_id": 6048,
"message_template_name": "welcome",
"message_template_language": "en_US",
"reason": "NONE",
"other_info": {
"title": "SECOND_PAUSE",
"description": "Your WhatsApp message template has been paused for 6 hours until Aug 31 at 12:47 AM UTC because it continued to have issues."
}
},
"field": "message_template_status_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "PENDING_DELETION",
"message_template_id": 1137,
"message_template_name": "<MY_TEMPLATE_NAME>",
"message_template_language": "en_US",
"reason": "NONE"
},
"field": "message_template_status_update"
}{
"value": {
"business_phone": "852xxxx3867",
"time": 1730390145,
"message_template_id": "301336xxxx511624",
"message_template_name": "simon_def2",
"message_template_language": "en_US",
"previous_quality_score": "UNKNOWN",
"new_quality_score": "YELLOW",
"wabaId": "10903xxxxxx0925"
},
"field": "message_template_quality_update"
}{
"field": "template_category_update",
"value": {
"business_phone": "8523***859",
"message_template_id": "138641***878",
"message_template_language": "zh_CN",
"message_template_name": "test_service_1",
"new_category": "MARKETING",
"time": 1745385279,
"wabaId": "1386417***78"
}
}{
"field": "template_category_update",
"value": {
"business_phone": "8523****59",
"message_template_id": "13864****7878",
"message_template_language": "zh_CN",
"message_template_name": "test_service_1",
"new_category": "MARKETING",
"previous_category": "UTILITY",
"time": 1745385279,
"wabaId": "13864****878"
}
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"phone_number": "PHONE_NUMBER",
"event": "VERIFIED_ACCOUNT"
},
"field": "account_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "DISABLED_UPDATE",
"ban_info": {
"waba_ban_state": [
"SCHEDULE_FOR_DISABLE",
"DISABLE",
"REINSTATE"
],
"waba_ban_date": "DATE"
}
},
"field": "account_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "ACCOUNT_VIOLATION",
"violation_info": {
"violation_type": "VIOLATION_TYPE"
}
},
"field": "account_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"event": "ACCOUNT_RESTRICTION",
"restriction_info": [
{
"restriction_type": "RESTRICTED_BIZ_INITIATED_MESSAGING" | "RESTRICTION_ON_ADD_PHONE_NUMBER_ACTION"| "RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
"expiration": "TIMESTAMP"
}
]
},
"field": "account_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"decision": "APPROVED"
},
"field": "account_review_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"phone_number": "1669xxxx193",
"event": "ACCOUNT_DELETED"
},
"field": "account_update"
}{
"value": {
"business_phone": "1669xxxx193",
"wabaId": "1049513xxxx7327",
"phone_number": "1669xxxx193",
"event": "PARTNER_REMOVED"
},
"field": "account_update"
}简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心（NXLink）
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席状态信息查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心（AI自动外呼）
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口，未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 异步创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席（旧版）
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent