- 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
- 接入准备
- 错误码
- HSB关于custom字段使用说明
- 华为
- bot
- 查询可用WABA账号POST
- 查询模版列表POST
- 查询模版详情POST
- 发送模版消息POST
- 查询模版消息发送结果POST
- 回调模版消息发送结果POST
- 发送单个模版消息接口POST
- 回调单个模版消息用户响应POST
- 回调转人工申请POST
- 回调坐席消息发送之后的状态变更POST
- 回调转人工后用户发送的消息POST
- 回调会话结束事件POST
- 转人工结果POST
- 查询会话列表POST
- 查询消息列表POST
- 将用户消息标记为已读POST
- 发送普通消息POST
- 结束会话POST
- 上传文件POST
- 上传文件(谷歌地图缩略图)POST
- 会话结束后上报POST
- 查询公司所有渠道信息POST
- 用户发送的消息事件上报POST
- 渠道发送的消息事件上报POST
- 渠道发送的消息状态变更事件上报POST
- 获取公司信息POST
- 查询运单号物流轨迹POST
- Chatbot English
- Quick Start
- Error Code
- bot
- Query available WABA accounts
- Query the template list
- Template details
- Send template message
- Query the template message sending result
- Callback template message sending result
- Send single template message
- Callback single template message user response
- Callback agent transfer request
- Callback status change after the message is sent
- Callback message sent by user
- *Callback agent transfer request
- *Callback for status change after the agent message is sent
- *Callback for messages sent by the user after transferring to agent
- Callback for session end event
- Agent transfer result
- Query conversation list
- Query message list
- *Query message list
- Mark user message as read
- Send regular message
- End session
- Upload file
- Upload file (Google maps thumbnail)
- Report after session ends
- Inbound Callback
发送普通消息
POST
https://api.airudder.com/api/v1/session/message/send
Chatbot
请求参数
Header 参数
X-AIRudder-Sign-Key
string
必需
示例值:
95721c4a78688b356a0a4eed25a76980
X-AIRudder-Sign
string
必需
Body 参数application/json
channel
enum<string>
可选
枚举值:
WhatsApp
channel_id
string
所用的WABA账号
user
object
用户信息
id
string
用户渠道id
call_id
string
会话id
sender_type
enum<string>
必需
枚举值:
agentagent_system
messages
array [object {5}]
必需
>= 1 items<= 1 items
type
enum<string>
发送的消息类别
枚举值:
textimagevideoaudiofilelocationinteractive
text
string
可选
>= 1 字符<= 2096 字符
media
object | null
可选
location
object | null
可选
interactive
object | null
可选
示例
{
"channel": "WhatsApp",
"channel_id": "6583753709",
"user": {
"id": "62895402190807"
},
"call_id": "aa2870b1e9da2fe808d690c42feca78e",
"sender_type": "agent",
"messages": [
{
"type": "text",
"text": "this's agent"
}
]
}示例代码
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/message/send' \
--header 'X-AIRudder-Sign-Key: 95721c4a78688b356a0a4eed25a76980' \
--header 'X-AIRudder-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
"channel": "WhatsApp",
"channel_id": "6583753709",
"user": {
"id": "62895402190807"
},
"call_id": "aa2870b1e9da2fe808d690c42feca78e",
"sender_type": "agent",
"messages": [
{
"type": "text",
"text": "this'\''s agent"
}
]
}'返回响应
🟢200成功
application/json
Body
request_id
string
请求唯一标识
code
integer
必需
message
string
错误信息
data
object
响应信息
msg_id
string
消息id
示例
{
"request_id": "7b50b74e5ec2910fe9b250c9fda7085e",
"code": 200,
"message": "Success",
"data": {
"msg_id": "3b36592db276377cf65fe22337cc2bff"
}
}修改于 2024-12-03 06:26:51