- 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
Callback bot reply message
开发中
POST
https://api.airudder.com
请求参数
Header 参数
X-AIRudder-Sign
string
必需
Body 参数application/json
event
enum<string>
必需
枚举值:
message.send
call_id
string
必需
company
string
必需
channel
string
Channel
channel_id
string
必需
user
object
User info
id
string
User id
name
string
User name
messages
array [object {4}]
必需
>= 1 items<= 1 items
msg_id
string
必需
sender_type
enum<string>
Sender
枚举值:
robot
timestamp
integer
必需
content
object
必需
示例
{
"event": "message.send",
"call_id": "6cf8c876eeefdca168ae7a08cb93fe20",
"company": "test",
"channel": "chatbot",
"channel_id": "sicepat_whatsapp",
"user": {
"id": "123",
"name": "nick"
},
"messages": [
{
// text 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "text",
"text": "hi"
}
},
{
// image 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "image",
"media": {
"origin_url": "https://www.airudder.com/xxxx.jpg"
}
}
},
{
// video 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "video",
"media": {
"origin_url": "https://www.airudder.com/xxxx.mp4"
}
}
},
{
// audio 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "audio",
"media": {
"origin_url": "https://www.airudder.com/xxx.wav"
}
}
},
{
// file 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "file",
"media": {
"origin_url": "https://www.airudder.com/xxxx.pdf",
"name": "filename"
}
}
},
{
// interactive list 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "interactive",
"interactive": {
"type": "list",
"body": {
"text": "请选择你要咨询的业务类(本次通过list展示)"
},
"action": {
"button": "请选择", // 若list做成弹出式,则字段为按钮文案,否则可不用
"sections": [
{
"title": "查询类", // list 选项一级选项
// list 选项二级选项
"rows": [
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-0-0-", // 选项的唯一标识
"title": "物流查询" // 选项文案
},
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-0-1-",
"title": "网点查询"
}
]
},
{
"title": "寄件类",
"rows": [
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-1-0-",
"title": "大件快递"
},
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-1-1-",
"title": "小件快递"
}
]
}
]
}
}
}
},
{
// interactive button 消息示例
"msg_id": "9f856b06d44a48e39723ee9c4403cd5a",
"sender_type": "robot",
"timestamp": 1722223026,
"content": {
"type": "interactive",
"interactive": {
"type": "button",
"body": {
"text": "请选择您的性别(button)👉👉👉"
},
"action": {
// 按钮集合
"buttons": [
{
"type": "reply", // 每个按钮固定为 reply 类型
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-0-", // 按钮的唯一标识
"title": "男" // 按钮文案
}
},
{
"type": "reply",
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-1-",
"title": "女"
}
},
{
"type": "reply",
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-2-",
"title": "其他"
}
}
]
}
}
}
}
]
}
示例代码
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' \
--header 'X-AIRudder-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
"event": "message.send",
"call_id": "6cf8c876eeefdca168ae7a08cb93fe20",
"company": "test",
"channel": "chatbot",
"channel_id": "sicepat_whatsapp",
"user": {
"id": "123",
"name": "nick"
},
"messages": [
{
// text 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "text",
"text": "hi"
}
},
{
// image 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "image",
"media": {
"origin_url": "https://www.airudder.com/xxxx.jpg"
}
}
},
{
// video 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "video",
"media": {
"origin_url": "https://www.airudder.com/xxxx.mp4"
}
}
},
{
// audio 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "audio",
"media": {
"origin_url": "https://www.airudder.com/xxx.wav"
}
}
},
{
// file 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "file",
"media": {
"origin_url": "https://www.airudder.com/xxxx.pdf",
"name": "filename"
}
}
},
{
// interactive list 消息示例
"msg_id": "c98a99f32afab85d709ba23820fccccb",
"sender_type": "robot",
"timestamp": 1722223064,
"content": {
"type": "interactive",
"interactive": {
"type": "list",
"body": {
"text": "请选择你要咨询的业务类(本次通过list展示)"
},
"action": {
"button": "请选择", // 若list做成弹出式,则字段为按钮文案,否则可不用
"sections": [
{
"title": "查询类", // list 选项一级选项
// list 选项二级选项
"rows": [
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-0-0-", // 选项的唯一标识
"title": "物流查询" // 选项文案
},
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-0-1-",
"title": "网点查询"
}
]
},
{
"title": "寄件类",
"rows": [
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-1-0-",
"title": "大件快递"
},
{
"id": "59a3d8ba24ec0d29334775623182facf-3-1-list-1-1-",
"title": "小件快递"
}
]
}
]
}
}
}
},
{
// interactive button 消息示例
"msg_id": "9f856b06d44a48e39723ee9c4403cd5a",
"sender_type": "robot",
"timestamp": 1722223026,
"content": {
"type": "interactive",
"interactive": {
"type": "button",
"body": {
"text": "请选择您的性别(button)👉👉👉"
},
"action": {
// 按钮集合
"buttons": [
{
"type": "reply", // 每个按钮固定为 reply 类型
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-0-", // 按钮的唯一标识
"title": "男" // 按钮文案
}
},
{
"type": "reply",
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-1-",
"title": "女"
}
},
{
"type": "reply",
"reply": {
"id": "59a3d8ba24ec0d29334775623182facf-2-1-button-2-",
"title": "其他"
}
}
]
}
}
}
}
]
}'
返回响应
🟢200Success
application/json
Body
object {0}
示例
{}
修改于 2025-02-14 10:26:31