- API 文档介绍
- Introductions
- 快速上手
- Quick Start
- 鉴权方法
- Get the Authorization token
- 全局错误代码
- Error Codes
- 催收
- Collection
- Quick Start
- APIs Related to Calling Tasks
- APIs Related to Calling Plans
- Obtain the List of Strategies
- Create a Dialing Plan with Strategy
- Obtain the Information of Plan Status
- Obtain the Information of Each Round of the Plan
- List the Task Created
- Cancel a Calling Task
- Cancel a Certain Call in a Plan
- Webhook of Plan
- Webhook of Task
- Webhook of Call
- Obtain the Detailed Information of Tasks
- Obtain a Call Recording
- Obtain Task Recordings
- Obtain All Call Recordings of a Number in the Plan
- 营销&电商
- Telemarketing & E-commerce
- Quick Start
- APIs Related to Calling Tasks
- APIs Related to Calling Plans
- Obtain the List of Strategies
- Create a Dialing Plan with Strategy
- Obtain the Information of Plan Status
- Obtain the Information of Each Round of the Plan
- List the Task Created
- Cancel a Calling Task
- Cancel a Certain Call in a Plan
- Webhook of Plan
- Webhook of Task
- Webhook of Call
- Obtain the Detailed Information of Tasks
- Obtain a Call Recording
- Obtain Call Recordings
- Obtain All Call Records of a Number in the Plan
- 信审
- Info Check
- Quick Start
- APIs Related to Calling Tasks
- APIs Related to Calling Plans
- Obtain the List of Strategies
- Create a Dialing Plan with Strategy
- Obtain the Information of Plan Status
- Obtain the Information of Each Round of the Plan
- List the Task Created
- Cancel a Calling Task
- Cancel a Certain Call in a Plan
- Webhook of Plan
- Webhook of Task
- Webhook of Call
- Obtain the Detailed Information of Tasks
- Obtain a Call Recording
- Obtain Call Recordings
- Obtain All Call Records of a Number in the Plan
- Workflow 工作流
- 预测式外呼信息回调
- 创建一个新的Workflow任务
- 获取workflow模板列表
- 为workflow任务新增名单
- 更新workflow任务内的名单信息
- 取消workflow任务内某个电话的后续流程
- Workflow外呼电话拨打结束通知 (催收/营销/电商示例)
- Workflow外呼电话拨打结束通知 (信审示例)
- 自定义API 节点数据推送
- 验证 自定义API 节点数据推送
- 停止workflow任务
- 获取workflow任务列表
- 获取workflow实例的子任务列表信息
- 获取workflow节点运行的外呼任务
- 获取workflow外呼任务明细 (催收/营销/电商示例)
- 获取workflow外呼任务明细(信审示例)
- 根据callee/caseid和taskid/workflow_id获取电话信息和录音链接
- 根据callid获取电话信息和录音链接
- 获取workflow里单个电话的所有录音
- 通过 case_id/callee 查询 workflow_id
- workflow 名单结束通知
- workflow 状态变更通知
- 获取workflow节点运行的WABA任务
- 获取workflow内WABA任务明细
- Workflow内WABA消息状态变更通知
- Workflow内Chatbot会话结束通知
- Workflow
- Webhooks of the Info of Predictive Dialer System
- Create a New WorkFlow Task
- Obtain the List of Workflow Templates
- Add lists to an workflow task
- Update the List Info of Workflow Task
- Cancel the processes for a specific list
- Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)
- Notification of Call Completion in Workflow(Info Check)
- Custom API Node Data Push
- Verify the Custom API Node Data Push
- Stop the Workflow Task
- Obtain the Workflow Task List
- Obtain the Subtask List of the Workflow
- Obtain the Outbound Task List of Workflow
- Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)
- Obtain the Outbound Task Details of Workflow(Info Check)
- Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id
- Obtian Call Information and Recording Link by Call ID
- Obtain All the Recordings of a Single Number in the Workflow
- Query workflow_id using case_id/callee
- Notification for Workflow List Completion
- Notification of Workflow Status Change
- Obtain the WABA Tasks List of Workflow
- Obtain the WABA Task Details of Workflow
- Notification of WABA Message Status Alteration in Workflow
- Chatbot Session End Notification in Workflow
- 加解密对接
- WorkFlow_LeadsGeneration
- Webhooks of the Info of Predictive Dialer System
- Create a New WorkFlow Task
- Obtain the List of Workflow Templates
- Add Workflow Contacts
- Update the List Info of Workflow
- Cancel a Call
- End Status Notification from the Dimension of Phone Call
- Stop the Workflow Task
- Custom API Data Push
- Verify the Custom API Data Push
- Obtain the Task List of Workflow
- Obtain the Subtask List of the Workflow
- Obtain All the Recordings of a Single Number in the Workflow
- Flex_Route
- API_Store
- 回调数据加解密对接
- DIDI营销定制
- Chatbot
- Chatbot English
- Quick Start
- Error Code
- bot
- Query available WABA accountsPOST
- Query the template listPOST
- Template detailsPOST
- Send template messagePOST
- Query the template message sending resultPOST
- Callback template message sending resultPOST
- Send single template messagePOST
- Callback single template message user responsePOST
- Callback agent transfer requestPOST
- Callback status change after the message is sentPOST
- Callback message sent by userPOST
- *Callback agent transfer requestPOST
- *Callback for status change after the agent message is sentPOST
- *Callback for messages sent by the user after transferring to agentPOST
- Callback for session end eventPOST
- Agent transfer resultPOST
- Query conversation listPOST
- Query message listPOST
- *Query message listPOST
- Mark user message as readPOST
- Send regular messagePOST
- End sessionPOST
- Upload filePOST
- Upload file (Google maps thumbnail)POST
- Report after session endsPOST
- Inbound Callback
Query message list
POST
https://api.airudder.com/api/v1/session/messages
Chatbot
请求参数
Header 参数
X-AIRudder-Sign
string
必需
X-AIRudder-Sign-Key
string
必需
示例值:
95721c4a78688b356a0a4eed25a76980
Body 参数application/json
call_id
string
必需
last_msg_id
string
可选
size
integer
必需
示例
{
"call_id": "7738ff156ad12075578af25c84908567",
"last_msg_id": "",
"size": 20
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.airudder.com/api/v1/session/messages' \
--header 'X-AIRudder-Sign;' \
--header 'X-AIRudder-Sign-Key: 95721c4a78688b356a0a4eed25a76980' \
--header 'Content-Type: application/json' \
--data-raw '{
"call_id": "7738ff156ad12075578af25c84908567",
"last_msg_id": "",
"size": 20
}'
返回响应
🟢200Success
application/json
Body
request_id
string
必需
code
integer
必需
message
string
必需
data
array [object {7}]
必需
msg_id
string
必需
seat_id
string
Agent ID
timestamp
integer
必需
sender_type
enum<string>
Sender
枚举值:
robotagentusersystem
status
enum<string>
必需
枚举值:
readdeliveryfailedsent
content
object
必需
reply
object
必需
示例
{
"request_id": "d102d2f159d739abe142a17fcb2ea483",
"code": 200,
"message": "Success",
"data": [
{
"msg_id": "b1666ac1514d9e7bbd863319668dc5b9",
"seat_id": "",
"timestamp": 1716969283,
"sender_type": "user",
"status": "delivery",
"content": {
"type": "interactive",
"text": "女"
},
"reply": {
"msg_id": "05edd4a966b14b77803c36fca1044aa7-1",
"type": "interactive",
"interactive": {
"type": "button",
"body": {
"text": "请选择您的性别(button)👉👉👉"
},
"footer": {
"text": ""
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-0-",
"title": "男"
}
},
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-1-",
"title": "女"
}
},
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-2-",
"title": "其他"
}
}
]
}
}
}
},
{
"msg_id": "aab80ee4b49c4d179db2a7202d25b9c2",
"seat_id": "",
"timestamp": 1716965209,
"sender_type": "robot",
"status": "read",
"content": {
"type": "text",
"text": "正在为你转人工,请稍后。。。。。。"
}
},
{
"msg_id": "9fec57b9bd3cbf762a18d0c03afb9394",
"seat_id": "",
"timestamp": 1716965209,
"sender_type": "user",
"status": "delivery",
"content": {
"type": "text",
"text": "转人工"
}
},
{
"msg_id": "05edd4a966b14b77803c36fca1044aa7-1",
"seat_id": "",
"timestamp": 1716965203,
"sender_type": "robot",
"status": "read",
"content": {
"type": "interactive",
"interactive": {
"type": "list",
"body": {
"text": "请选择你要咨询的业务类(本次通过list展示)"
},
"footer": {
"text": ""
},
"action": {
"sections": [
{
"title": "查询类",
"rows": [
{
"id": "0b83f81b7ede2cc620b5a9cabc021855-3-1-list-0-0-",
"title": "物流查询",
"description": ""
},
{
"id": "0b83f81b7ede2cc620b5a9cabc021855-3-1-list-0-1-",
"title": "网点查询",
"description": ""
}
]
},
{
"title": "寄件类",
"rows": [
{
"id": "0b83f81b7ede2cc620b5a9cabc021855-3-1-list-1-0-",
"title": "大件快递",
"description": ""
},
{
"id": "0b83f81b7ede2cc620b5a9cabc021855-3-1-list-1-1-",
"title": "小件快递",
"description": ""
}
]
}
]
}
}
}
},
{
"msg_id": "05edd4a966b14b77803c36fca1044aa7-0",
"seat_id": "",
"timestamp": 1716965203,
"sender_type": "robot",
"status": "read",
"content": {
"type": "text",
"text": "若您需要咨询的业务类型不在以上选项内,请手动输入(也可以说:人工服务/转人工)"
}
},
{
"msg_id": "1b94be3dd2384fdbc2c54ffdd31ac7f9",
"seat_id": "",
"timestamp": 1716965203,
"sender_type": "user",
"status": "delivery",
"content": {
"type": "text",
"text": "ok",
"reply": {
"type": "text",
"text": "一位来自WhatsApp的J&T 朋友 ,欢迎使用 J&T Express 客户服务"
}
}
},
{
"msg_id": "1db1af246d534fb3a4c3cc675d71885a-1",
"seat_id": "",
"timestamp": 1716965186,
"sender_type": "robot",
"status": "read",
"content": {
"type": "interactive",
"interactive": {
"type": "button",
"body": {
"text": "请选择您的性别(button)👉👉👉"
},
"footer": {
"text": ""
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-0-",
"title": "男"
}
},
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-1-",
"title": "女"
}
},
{
"type": "reply",
"reply": {
"id": "0b83f81b7ede2cc620b5a9cabc021855-2-1-button-2-",
"title": "其他"
}
}
]
}
}
}
},
{
"msg_id": "1db1af246d534fb3a4c3cc675d71885a-0",
"seat_id": "",
"timestamp": 1716965186,
"sender_type": "robot",
"status": "read",
"content": {
"type": "text",
"text": "请选择您的性别👉👉👉"
}
},
{
"msg_id": "c38dba25208d40e8a97916dcfc6e2bb1-2",
"seat_id": "",
"timestamp": 1716965185,
"sender_type": "robot",
"status": "read",
"content": {
"type": "file",
"media": {
"origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F0ca8b6c9e76f49f081e709a5b821e87c_welcome_to_Earth.pdf?Expires=1743064081&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=yHRWceK6eJOhwcUKA%2BPuGtYfrAg%3D",
"name": "welcome_to_Earth.pdf"
}
}
},
{
"msg_id": "c38dba25208d40e8a97916dcfc6e2bb1-1",
"seat_id": "",
"timestamp": 1716965185,
"sender_type": "robot",
"status": "read",
"content": {
"type": "image",
"media": {
"origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F79a5ef5ba61b410c9b418d513eb48924_KrKRsV0DWY.jpeg?Expires=1743062224&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=agKUyWeiSkwQd0ussZ5bUJuKmDM%3D"
}
}
},
{
"msg_id": "c38dba25208d40e8a97916dcfc6e2bb1-0",
"seat_id": "",
"timestamp": 1716965185,
"sender_type": "robot",
"status": "read",
"content": {
"type": "text",
"text": "一位来自WhatsApp的J&T 朋友 ,欢迎使用 J&T Express 客户服务"
}
},
{
"msg_id": "7bc58a7794cc51d09f077133736cb314",
"seat_id": "",
"timestamp": 1716965185,
"sender_type": "user",
"status": "delivery",
"content": {
"type": "text",
"text": "hi"
}
}
]
}
修改于 2024-10-31 07:31:29