- 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 StrategiesGET
- Create a Dialing Plan with StrategyPOST
- Obtain the Information of Plan StatusGET
- Obtain the Information of Each Round of the PlanGET
- List the Task CreatedGET
- Cancel a Calling TaskPOST
- Cancel a Certain Call in a PlanPOST
- Webhook of PlanPOST
- Webhook of TaskPOST
- Webhook of CallPOST
- Obtain the Detailed Information of TasksGET
- Obtain a Call RecordingGET
- Obtain Call RecordingsGET
- Obtain All Call Records of a Number in the PlanGET
- 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 Template消息状态变更通知
- Workflow内Chatbot会话结束通知
- 【J&T】Workflow内电话拨打完成&WABA状态变更&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 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
Webhook of Plan
POST
Please provide your URL for Webhook to us
There are two parameters need for configuration
URL The URL for Webhook
KEY KEY for parameter sign, or airudder sign by default, see the sign description
请求参数
Header 参数
Content-Type
string
必需
默认值:
application/json
User-Agent
string
可选
默认值:
Airudder
Body 参数application/json
PlanName
string
必需
Timestamp
integer
必需
PlanDetails
array [object {4}]
必需
Rounds
string
必需
TaskName
string
必需
TaskID
string
必需
Status
string
必需
Sign
integer
必需
1.
2.
3.
4.
5.
Timestamp=1667903472 KEY=airudder
Expression = md5(Timestamp+KEY).hexdigest()
md5 value=13f3660caa70fcc4d89c6b77b1131cb2
task_id
string
必需
task_name
string
必需
status
string
必需
created_at
string
必需
repeat_interval
integer
必需
repeat_number
integer
必需
robot_hash
string
必需
robot_method
string
必需
sip_line
string
必需
schedule_start_time
string
必需
schedule_end_time
string
必需
details
array [object {13}]
必需
id
integer
可选
callee
string
可选
result
string
可选
result_label
string
可选
duration
integer
可选
hangup_type
string
可选
ring_type
string
可选
question_answer
array [object {10}]
可选
robot_hash
string
可选
call_id
string
可选
call_times
integer
可选
call_start_time
string
可选
call_end_time
string
可选
示例
{
"task_id": "c55452c57345a3000000000000",
"task_name": "Linetest",
"status": "calling",
"created_at": "2022-11-07 20:50:58",
"repeat_interval": 2,
"repeat_number": 1,
"robot_hash": "40bf5c77bf2ee9a57cc123456",
"robot_method": "single",
"sip_line": "IC_TEST_LINE",
"schedule_start_time": "2022-11-07 21:10:00",
"schedule_end_time": "2022-11-07 21:40:00",
"details": [
{
"id": 845533332,
"callee": "+528110000000",
"result": "finished",
"result_label": "A",
"duration": 258,
"hangup_type": "ByRobot",
"ring_type": "normal",
"question_answer": [
{
"question_name": "Q0",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": "ABCD Check",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q1",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": " NameCheck",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q2",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": "\u8d37\u6b3e\u4eba\u786e\u8ba4 ***Check",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q3",
"answer": "er01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "er01",
"var": "AB01",
"verification_results": "Not Match",
"question_content": "CURP\u6838\u9a8c ABCD Verification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q3N",
"answer": "ok01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "ok01;01",
"var": "AB01",
"verification_results": "Not Match",
"question_content": "ABCD\u518d\u6b21\u6838\u9a8c ABCD Reverification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q4",
"answer": "2022-01-01 21:12",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "2022-01-01 21:12",
"var": "1987-01-01",
"verification_results": "Match",
"question_content": "\u751f\u65e5\u6838\u9a8c ABCD Verification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q4N",
"answer": "/",
"answer_text": "",
"status": "Skip",
"answer_text_slot": "/",
"var": "1987-01-01",
"verification_results": "/",
"question_content": "\u751f\u65e5\u518d\u6b21\u6838\u9a8c ABCD Reverification",
"question_type": "open",
"whether_answer": "Skip"
},
{
"question_name": "Q5",
"answer": "ok01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "ok01",
"var": "AB01",
"verification_results": "Match",
"question_content": "CURP2\u4f4d\u6838\u9a8c ABCD Verification for 2 character",
"question_type": "open",
"whether_answer": "Answered"
}
],
"robot_hash": "40bf5c77bf2ee9a57cc000000000000",
"call_id": "ic87613a176182f2b1df00000000000",
"call_times": 2,
"call_start_time": "2022-11-07 21:12:26",
"call_end_time": "2022-11-07 21:16:44"
}
]
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'Please provide your URL for Webhook to us' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
"task_id": "c55452c57345a3000000000000",
"task_name": "Linetest",
"status": "calling",
"created_at": "2022-11-07 20:50:58",
"repeat_interval": 2,
"repeat_number": 1,
"robot_hash": "40bf5c77bf2ee9a57cc123456",
"robot_method": "single",
"sip_line": "IC_TEST_LINE",
"schedule_start_time": "2022-11-07 21:10:00",
"schedule_end_time": "2022-11-07 21:40:00",
"details": [
{
"id": 845533332,
"callee": "+528110000000",
"result": "finished",
"result_label": "A",
"duration": 258,
"hangup_type": "ByRobot",
"ring_type": "normal",
"question_answer": [
{
"question_name": "Q0",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": "ABCD Check",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q1",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": " NameCheck",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q2",
"answer": "Yes",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "-",
"var": "-",
"verification_results": "-",
"question_content": "\u8d37\u6b3e\u4eba\u786e\u8ba4 ***Check",
"question_type": "whether",
"whether_answer": "Answered"
},
{
"question_name": "Q3",
"answer": "er01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "er01",
"var": "AB01",
"verification_results": "Not Match",
"question_content": "CURP\u6838\u9a8c ABCD Verification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q3N",
"answer": "ok01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "ok01;01",
"var": "AB01",
"verification_results": "Not Match",
"question_content": "ABCD\u518d\u6b21\u6838\u9a8c ABCD Reverification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q4",
"answer": "2022-01-01 21:12",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "2022-01-01 21:12",
"var": "1987-01-01",
"verification_results": "Match",
"question_content": "\u751f\u65e5\u6838\u9a8c ABCD Verification",
"question_type": "open",
"whether_answer": "Answered"
},
{
"question_name": "Q4N",
"answer": "/",
"answer_text": "",
"status": "Skip",
"answer_text_slot": "/",
"var": "1987-01-01",
"verification_results": "/",
"question_content": "\u751f\u65e5\u518d\u6b21\u6838\u9a8c ABCD Reverification",
"question_type": "open",
"whether_answer": "Skip"
},
{
"question_name": "Q5",
"answer": "ok01",
"answer_text": "",
"status": "Completed",
"answer_text_slot": "ok01",
"var": "AB01",
"verification_results": "Match",
"question_content": "CURP2\u4f4d\u6838\u9a8c ABCD Verification for 2 character",
"question_type": "open",
"whether_answer": "Answered"
}
],
"robot_hash": "40bf5c77bf2ee9a57cc000000000000",
"call_id": "ic87613a176182f2b1df00000000000",
"call_times": 2,
"call_start_time": "2022-11-07 21:12:26",
"call_end_time": "2022-11-07 21:16:44"
}
]
}'返回响应
🟢200Success
application/json
Body
object {0}
示例
{}修改于 2024-12-17 10:57:44