INSTAGRAM推送消息接口
场景描述
社交媒体推送消息。
接口方法
POST
接口URI
https://域名/apiaccess/instagram/message/{chanId},例如域名是service.besclouds.com。
其中chanId是指渠道Id,非必选。
请求说明
| 序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | requestBody | object | True | 请求体json |
| 1.1 | object | string | False | 社交媒体的名称,如: instagram、viber |
| 1.2 | entry | array[object] | False | 一个包含事件的数组 |
| 1.2.1 | id | string | False | 账号或page等的ID |
| 1.2.2 | time | number | False | 更新的时间 |
| 1.2.3 | messaging | array[object] | False | 包含的具体消息内容 |
| 1.2.3.1 | sender | object | False | 消息发送者信息 |
| 1.2.3.1.1 | id | string | False | 消息发送者Id |
| 1.2.3.2 | recipient | object | False | 消息接收者信息 |
| 1.2.3.2.1 | id | string | False | 接收者ID |
| 1.2.3.3 | timestamp | number | False | 消息的创建时间 |
| 1.2.3.4 | message | object | False | 消息内容 |
| 1.2.3.4.1 | mid | string | False | 消息Id |
| 1.2.3.4.2 | text | string | False | 消息的文本 |
| 1.2.3.4.3 | attachments | array[object] | False | 附件数组数据 |
| 1.2.3.4.3.1 | type | string | False | 附件的类型audio,image,file,video |
| 1.2.3.4.3.2 | payload | object | False | 附件的负载信息 |
| 1.2.3.4.3.2.1 | url | string | False | 附件的url |
| 1.2.3.4.4 | is_deleted | boolean | False | 该消息是否删除 |
| 1.2.3.4.5 | is_echo | boolean | False | 该消息是否是座席侧发送
|
| 1.2.3.4.6 | is_unsupported | boolean | False | 客户发送的媒体消息类型是否支持 |
| 1.2.3.4.7 | quick_reply | object | False | 快速回复对象 |
| 1.2.3.4.7.1 | payload | string | False | 快速回复的负载 |
| 1.2.3.4.8 | referral | object | False | 客户单击Instagram Shop产品时包含 |
| 1.2.3.4.8.1 | product | object | False | 产品对象 |
| 1.2.3.4.8.1.1 | id | string | False | 产品Id |
| 1.2.3.4.9 | reply_to | object | False | 回复消息负载 |
| 1.2.3.4.9.1 | story | object | False | 回复消息对象 |
| 1.2.3.4.9.1.1 | url | string | False | 媒体地址 |
| 1.2.3.4.9.1.2 | id | string | False | 回复文本消息Id |
| 1.2.3.4.9.2 | mid | string | False | 回复消息对象Id |
响应说明
- 响应状态码: 200
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无
报文样例
请求参数:
{
"object": "instagram",
"entry": [
{
"id": "IGID",
"time": 1569262486134,
"messaging": [
{
"sender": {
"id": "IGSID"
},
"recipient": {
"id": "IGID"
},
"timestamp": 1569262485349,
"message": {
"mid": "MESSAGE-ID",
"text": "MESSAGE-TEXT",
"attachments": [
{
"type": "image",
"payload": {
"url": "LINK"
}
}
],
"is_deleted": true,
"is_echo": true,
"is_unsupported": true,
"quick_reply": {
"payload": "CUSTOMER-RESPONSE-PAYLOAD"
},
"referral": {
"product": {
"id": "PRODUCT-ID"
}
},
"reply_to": {
"mid": "MESSAGE-ID"
},
"reply_to": {
"story": {
"url": "CDN-URL",
"id": "STORY-ID"
}
}
}
}
]
}
]
} {“resultMsg”:“200”}