- 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 Template消息状态变更通知
- Workflow内Chatbot会话结束通知
- 获取Workflow内SMS message记录
- Workflow内SMS message状态变更通知
- 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
- Obtain SMS message records within the workflow
- Notification of SMS message status change within the workflow.
- 传输过程中加解密
- Encryption and decryption during the transmission process
- Chatbot
- Chatbot English
- Quick Start
- Error Code
- bot
- Query available WABA accountsPOST
- Query the template listPOST
- Template detailsPOST
- Send template messagePOST
- Query the template message sending resultPOST
- Callback template message sending resultPOST
- Send single template messagePOST
- Callback single template message user responsePOST
- Callback agent transfer requestPOST
- Callback status change after the message is sentPOST
- Callback message sent by userPOST
- *Callback agent transfer requestPOST
- *Callback for status change after the agent message is sentPOST
- *Callback for messages sent by the user after transferring to agentPOST
- Callback for session end eventPOST
- Agent transfer resultPOST
- Query conversation listPOST
- *Query message listPOST
- Mark user message as readPOST
- Send regular messagePOST
- End sessionPOST
- Upload filePOST
- Upload file (Google maps thumbnail)POST
- Report after session endsPOST
- 呼入机器人业务
- Inbound
- 数据模型
Error Code
| Error code | Error message | Explanation |
|---|---|---|
| 0 | success | The request was successful |
| 100001 | Record not found | The record does not exist |
| 100101 | Unknown error | An unknown error occurred, please contact us |
| 100102 | Server error | A server error occurred, please contact us |
| 100105 | Parameter error | The parameter is invalid or missing |
| 100201 | Invalid signature | The signature is incorrect or expired |
修改于 2024-01-26 07:23:12