- 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 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
快速上手
| APIs | 说明 |
|---|---|
| 创建拨打任务 | 创建调用任务 |
| 列出已创建 的任务 | 按分页列出您的任务, 任务按任务创建时间的降序排列。 |
| 停止一个呼叫任务 | 取消创建的任务 |
| 取消某个任务电话拨打 | 取消特定任务中的某个呼叫。 |
| 任务结束状态通知 | 任务结束回调-当任务结束时，主动通知对方任务已经结束。 |
| 任务电话维度拨打结束状态通知 | 电话结束回调-当通话结束（连接或完成）时，无论是否连接，都会通知对方该任务的通话数据。 |
| 获取任务详细信息 | 根据TaskID获取Task的详细信息。 |
| 获取单个案件通话录音 | 使用 TaskID 和 Callee Number 获取通话录音。 |
| 获取任务录音文件 | 获取任务中的 .mp3 录音。 |
iCall 网站创建。| APIs | 说明 |
|---|---|
| 获取策略列表 | 获取网站中创建的策略列表。 |
| 创建策略计划拨打任务 | 使用策略创建拨打计划。 |
| 获取计划状态信息 | 获取计划的当前状态 |
| 获取计划内任务轮次信息 | 获取计划中的轮数、任务名称、任务ID、任务状态等信息. |
| 列出已创建的任务 | 按分页列出您的任务。 任务按任务创建时间的降序排列。 |
| 取消一个呼叫任务 | 取消创建的调用任务。 |
| 取消计划中的某个电话的拨打 | 取消整个计划中的某个电话 |
| 计划维度拨打结束状态通知 | 计划回调- 当计划的所有任务结束时，我们会主动通知对方计划已经结束。 |
| 任务结束状态通知 | 任务回调-当任务结束时，我们会主动通知对方任务已经结束。 |
| 任务电话维度拨打结束状态通知 | 电话回调-当电话完成（连接或完成）时，无论连接与否，都会通知对方该任务的调用数据。 |
| 获取任务详细信息 | 根据任务ID获取任务的详细信息 |
| 获取单个案件通话录音 | 使用TaskID和Callee Number获取通话录音地址。 仅提供最近一个月的录音。 |
| 获取任务录音文件 | 获取任务的 .mp3 录音。 只提供最近一个月的录音。 |
| 获取计划内某个电话所有的通话录音 | 使用Plan Name和Callee Number获取计划内号码的所有拨号记录 |