接受并处理KooMessage发送的报告消息接口
接口功能
接受并处理KooMessage发送的报告消息。
接口鉴权
通过KooMessage集成商接入WhatsApp使用该鉴权方式。
使用说明:
在AICC测,渠道配置页面,配置webhook密码。
调用whatsappadapter侧接口,请求中添加请求头Authorization,Authorization的值为webhook密码。
Headers请求参数
|
参数名称 |
选取原则 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
|
Content-Type |
必选 |
String |
无 |
固定填 application/json; charset=UTF-8。 |
|
Authorization |
必选 |
String |
无 |
AICC测渠道配置处配置的webhook认证密码 |
接口原型
|
请求方法 |
POST |
|
|---|---|---|
|
请求URL |
https://ip:port/social/on/whatsapp/koomessage/report/{channelId} |
其中,ip:port为对外暴露的nslb的ip和port,channelId为渠道id |
BODY请求参数
|
参数名称 |
选取原则 |
参数类型 |
说明 |
|---|---|---|---|
|
message_id |
必选 |
String |
消息ID(发送消息时返回的ID) |
|
sender |
必选 |
String |
商户电话 |
|
user_number |
必选 |
String |
收件人WhatsApp_id |
|
status |
必选 |
String |
消息的状态 delivered(已送达) read(已读) failed(发送失败) |
响应参数
调用本接口无响应内容。
接口示例
- 请求示例
POST /social/on/whatsapp/koomessage/report/202105102694809992 host: 10.10.10.2:18446 connection: Keep-Alive x-forwarded-for: 10.10.10.3, 10.10.10.4 x-real-ip: 10.10.10.5 content-length: 401 remote-host: 10.10.10.6 user-agent: java/socket Authorization: ************* content-type: application/json; charset=utf-8 accept: */* { "sender": "86173xxxx4526", "user_number": "86187xxxx5632", "message_id": "044852ee407b40ec88ea65adb73ff5c27", "status": "read" }