- 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
PDS 任务状态更改回调
POST
对接方提供此url在workflow里配置
当任务的电话拨打结束时(接通或者完成拨打次数)，不管接通还是未接通，主动通知对接方该任务的此电话拨打数据。
如果此url响应异常，我方会间隔1分钟进行重试，最多5次重试失败后不再进行通知。
在任务执行过程中，预测式外呼api会通过创建任务请求时的url进行如下回调，且每有状态（任务、联系人、坐席）发生变化就会发起回调，由于存在三种类型（任务、联系人、坐席）的状态变更，回调的消息体也存在三种格式
请求参数
Header 参数
Content-Type
string
必需
默认值:
application/json
User-Agent
string
可选
默认值:
Airudder
Body 参数application/json
workflow_id
string
必需
workflow_name
string
必需
nodetask_id
string
必需
nodetask_name
string
必需
pds
object
必需
type
string
必需
默认值:
TaskStatus
body
object
必需
示例
{
"workflow_id": "2b6951a25b434657b94d4d60d96fcf18",
"workflow_name": "pds-test20",
"nodetask_id": "5abeb76b414c4b8da455a253dac7bd86",
"nodetask_name": "PDS1_cc18c2",
"pds": {
"type": "TaskStatus",
"body": {
"taskId": "9751a67700274a24b650334587653de6",
"taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
"groupName": "group1",
"startTime": "2022-11-21T02:37:50Z",
"actualStartTime": "2022-11-21T02:38:02Z",
"endTime": "",
"totalNumber": 3,
"dialedNumber": 0,
"answeredNumber": 0,
"talkedNumber": 0,
"registeredCount": 1,
"state": "Running",
"displayTalkResult": "Agree",
"talkResultCount": 0
}
}
}示例代码
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": "2b6951a25b434657b94d4d60d96fcf18",
"workflow_name": "pds-test20",
"nodetask_id": "5abeb76b414c4b8da455a253dac7bd86",
"nodetask_name": "PDS1_cc18c2",
"pds": {
"type": "TaskStatus",
"body": {
"taskId": "9751a67700274a24b650334587653de6",
"taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
"groupName": "group1",
"startTime": "2022-11-21T02:37:50Z",
"actualStartTime": "2022-11-21T02:38:02Z",
"endTime": "",
"totalNumber": 3,
"dialedNumber": 0,
"answeredNumber": 0,
"talkedNumber": 0,
"registeredCount": 1,
"state": "Running",
"displayTalkResult": "Agree",
"talkResultCount": 0
}
}
}'返回响应
🟢200Success
application/json
Body
object {0}
示例
{}修改于 2023-07-05 01:41:48