- 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任务POST
- 获取workflow模板列表GET
- 为workflow任务新增名单POST
- 更新workflow任务内的名单信息POST
- 取消workflow任务内某个电话的后续流程POST
- Workflow外呼电话拨打结束通知 (催收/营销/电商示例)POST
- Workflow外呼电话拨打结束通知 (信审示例)POST
- 自定义API 节点数据推送POST
- 验证 自定义API 节点数据推送POST
- 停止workflow任务POST
- 获取workflow任务列表GET
- 获取workflow实例的子任务列表信息GET
- 获取workflow节点运行的外呼任务POST
- 获取workflow外呼任务明细 (催收/营销/电商示例)POST
- 获取workflow外呼任务明细(信审示例)POST
- 根据callee/caseid和taskid/workflow_id获取电话信息和录音链接GET
- 根据callid获取电话信息和录音链接GET
- 获取workflow里单个电话的所有录音GET
- 通过 case_id/callee 查询 workflow_idPOST
- workflow 名单结束通知POST
- workflow 状态变更通知POST
- 获取workflow节点运行的WABA任务GET
- 获取workflow内WABA任务明细GET
- Workflow内WABA消息状态变更通知POST
- Workflow内Chatbot会话结束通知POST
- 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
自定义API 节点数据推送
POST
对接方提供此url在workflow模板内配置
请求参数
Header 参数
Content-Type
string
必需
默认值:
application/json
User-Agent
string
可选
默认值:
Airudder
Body 参数application/json
workflow_id
string
必需
workflow_name
string
必需
node_id
string
必需
node_name
string
必需
callee
object
该电话的名单信息
case_id
string
必需
callee_name
string
必需
callee_gender
string
必需
callee_number
string
必需
platform_name
string
必需
extra_a
string
必需
extra_b
string
必需
extra_c
string
必需
extra
array [object {2}]
必需
extend
object
必需
comments
string
必需
borrowed_date
string
可选
due_date
string
可选
borrowed_amount
string
可选
total_owing_amount
string
可选
currency_unit
string
可选
custom_attribute
object
必需
var1
string
可选
var2
string
可选
call
object
必需
task_id
string
必需
call_id
string
必需
robot_id
string
必需
callee_number
string
必需
call_start_time
string
必需
call_end_time
string
必需
call_times
integer
必需
ring_type
enum<string>
必需
枚举值:
busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull
hangup_type
enum<string>
必需
枚举值:
ByCalleeByRobotCanceled
intention
string
必需
multi_label
object
必需
asr_ptp
string
必需
asr_result
array [object {3}]
必需
ner_slots
object
该通电话的槽值信息
slots
string
请忽略此字段
talk_round
integer
通话回合。
ring_time
integer
响铃时长。
intention_description
string
通话结果标签含义。
redial_call
array [object {8}]
可选
caller_number
string
可选
question_answer
array [object {10}]
信审问题和答案明细
示例
{
"workflow_id": "079918b288xxxxxxxx3815e2a8030eb",
"workflow_name": "test_api_action6",
"node_id": "f878645926xxxxxxxxb0b779ba254",
"node_name": "API2",
"callee": {
"case_id": "12345.0",
"callee_name": "WILL SMITH",
"callee_gender": "MALE",
"callee_number": "+861xxxxxxxx5721",
"platform_name": "AIZCC",
"extra_a": "a",
"extra_b": "b",
"extra_c": "c",
"extra": [
{
"Content": "d",
"Question": "extra_d"
}
],
"extend": {
"variables": {
"extra_d": "d"
},
"detail_source": "web",
"pds_variables": {}
},
"comments": "12345.0",
"borrowed_date": "2024-02-01",
"due_date": "2024-03-07",
"borrowed_amount": "20000.00",
"total_owing_amount": "20310.00",
"currency_unit": "USD"
},
"custom_attribute": {
"a": "1",
"b": "2"
},
"call": {
"task_id": "b1a9e2ea8xxxxxxxx1551b6454b414b",
"call_id": "817377d194xxxxxxxxc8ad463bc81d996a",
"robot_id": "4496",
"callee_number": "+8618717905721",
"call_start_time": "2024-03-11 15:58:26",
"call_end_time": "2024-03-11 15:59:12",
"call_times": 2,
"ring_type": "normal",
"hangup_type": "ByCallee",
"intention": "E",
"ner_slots": {
"item_name": "da",
"receivetime": "2"
},
"slots": "",
"talk_round": 1,
"ring_time": 2,
"question_answer": [
{
"question_name": "Q1",
"answer": "ss02",
"answer_text": "s s cero dos",
"status": "Completed",
"answer_text_slot": "s02;02",
"var": "S02",
"verification_results": "Match",
"question_content": "CURP Verification",
"question_type": "open",
"whether_answer": "Answered"
}
],
"multi_label": {
"A0": "A0",
"Correct_Person": "identity_correct_person",
"Request_Installment": "action_item_request_installment"
},
"intention_description": "No Voice",
"asr_ptp": "",
"asr_result": [
{
"time": "00:00:00",
"robottext": "This is Hannah, I'm a customer service agent. We called you today to confirm your order with us so we could deliver it to you. Can I take a moment of your time here?",
"text": "no no no no no"
},
{
"time": "00:00:14",
"robottext": "",
"text": ""
},
{
"time": "00:00:14",
"robottext": "You have placed an order via our website. Are the above-mentioned information correct?",
"text": ""
},
{
"time": "00:00:25",
"robottext": "Hello?",
"text": ""
},
{
"time": "00:00:25",
"robottext": "You have placed an order via our website. Can you confirm the information ?",
"text": ""
},
{
"time": "00:00:35",
"robottext": "Are you there?",
"text": ""
},
{
"time": "00:00:35",
"robottext": "You have placed an order via our website. Can you confirm the information ?",
"text": ""
},
{
"time": "00:00:45",
"robottext": "Sorry,we cannot hear your clearly. we will try to contact you later.Thank you for your time. Goodbye!",
"text": ""
}
],
"redial_call": [
{
"call_id": "4edf1697f7bxxxxxxxx65bca97f996bb",
"call_start_time": "2024-03-05 16:15:53",
"ring_type": "normal",
"ring_time": 0,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+822xxxxxxxx2795",
"caller_number": "+950xxxxxxxx088"
},
{
"call_id": "001453803xxxxxxxxcc53b4a3b9db",
"call_start_time": "2024-03-05 16:15:56",
"ring_type": "normal",
"ring_time": 15,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+83xxxxxxxx795",
"caller_number": "+95xxxxxxxx0088"
},
{
"call_id": "04b6d8d97xxxxxxxx6b16db252a1dad8",
"call_start_time": "2024-03-05 16:16:59",
"ring_type": "normal",
"ring_time": 0,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+822xxxxxxxx795",
"caller_number": "+95xxxxxxxx0088"
}
],
"caller_number": "+95xxxxxxxx0088"
}
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '对接方提供此url在workflow模板内配置' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
"workflow_id": "079918b288xxxxxxxx3815e2a8030eb",
"workflow_name": "test_api_action6",
"node_id": "f878645926xxxxxxxxb0b779ba254",
"node_name": "API2",
"callee": {
"case_id": "12345.0",
"callee_name": "WILL SMITH",
"callee_gender": "MALE",
"callee_number": "+861xxxxxxxx5721",
"platform_name": "AIZCC",
"extra_a": "a",
"extra_b": "b",
"extra_c": "c",
"extra": [
{
"Content": "d",
"Question": "extra_d"
}
],
"extend": {
"variables": {
"extra_d": "d"
},
"detail_source": "web",
"pds_variables": {}
},
"comments": "12345.0",
"borrowed_date": "2024-02-01",
"due_date": "2024-03-07",
"borrowed_amount": "20000.00",
"total_owing_amount": "20310.00",
"currency_unit": "USD"
},
"custom_attribute": {
"a": "1",
"b": "2"
},
"call": {
"task_id": "b1a9e2ea8xxxxxxxx1551b6454b414b",
"call_id": "817377d194xxxxxxxxc8ad463bc81d996a",
"robot_id": "4496",
"callee_number": "+8618717905721",
"call_start_time": "2024-03-11 15:58:26",
"call_end_time": "2024-03-11 15:59:12",
"call_times": 2,
"ring_type": "normal",
"hangup_type": "ByCallee",
"intention": "E",
"ner_slots": {
"item_name": "da",
"receivetime": "2"
},
"slots": "",
"talk_round": 1,
"ring_time": 2,
"question_answer": [
{
"question_name": "Q1",
"answer": "ss02",
"answer_text": "s s cero dos",
"status": "Completed",
"answer_text_slot": "s02;02",
"var": "S02",
"verification_results": "Match",
"question_content": "CURP Verification",
"question_type": "open",
"whether_answer": "Answered"
}
],
"multi_label": {
"A0": "A0",
"Correct_Person": "identity_correct_person",
"Request_Installment": "action_item_request_installment"
},
"intention_description": "No Voice",
"asr_ptp": "",
"asr_result": [
{
"time": "00:00:00",
"robottext": "This is Hannah, I'\''m a customer service agent. We called you today to confirm your order with us so we could deliver it to you. Can I take a moment of your time here?",
"text": "no no no no no"
},
{
"time": "00:00:14",
"robottext": "",
"text": ""
},
{
"time": "00:00:14",
"robottext": "You have placed an order via our website. Are the above-mentioned information correct?",
"text": ""
},
{
"time": "00:00:25",
"robottext": "Hello?",
"text": ""
},
{
"time": "00:00:25",
"robottext": "You have placed an order via our website. Can you confirm the information ?",
"text": ""
},
{
"time": "00:00:35",
"robottext": "Are you there?",
"text": ""
},
{
"time": "00:00:35",
"robottext": "You have placed an order via our website. Can you confirm the information ?",
"text": ""
},
{
"time": "00:00:45",
"robottext": "Sorry,we cannot hear your clearly. we will try to contact you later.Thank you for your time. Goodbye!",
"text": ""
}
],
"redial_call": [
{
"call_id": "4edf1697f7bxxxxxxxx65bca97f996bb",
"call_start_time": "2024-03-05 16:15:53",
"ring_type": "normal",
"ring_time": 0,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+822xxxxxxxx2795",
"caller_number": "+950xxxxxxxx088"
},
{
"call_id": "001453803xxxxxxxxcc53b4a3b9db",
"call_start_time": "2024-03-05 16:15:56",
"ring_type": "normal",
"ring_time": 15,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+83xxxxxxxx795",
"caller_number": "+95xxxxxxxx0088"
},
{
"call_id": "04b6d8d97xxxxxxxx6b16db252a1dad8",
"call_start_time": "2024-03-05 16:16:59",
"ring_type": "normal",
"ring_time": 0,
"hangup_type": "ByCallee",
"result_label": "F",
"callee_number": "+822xxxxxxxx795",
"caller_number": "+95xxxxxxxx0088"
}
],
"caller_number": "+95xxxxxxxx0088"
}
}'
返回响应
🟢200成功
application/json
Body
object {0}
示例
{}
修改于 2025-04-17 11:35:03