- 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
全局错误代码
| 错误代码号 | 说明 |
|---|---|
| 401 | 令牌不正确. |
| 10101 | 密码不正确 |
| 10102 | 缺少密码 |
| 10301 | 缺少一个或多个参数 |
| 10302 | 参数错误，具体看错误内容明细 |
| 10401 | TaskName为空 |
| 10402 | TaskName太长，应少于64个字符 |
| 10403 | TaskName 已存在 |
| 10404 | TaskScheduleStartTime 不正确 |
| 10405 | TaskScheduleEndTime 不正确 |
| 10406 | RobotID 不正确，请联系我们以获取正确的信息 |
| 10407 | SIPLine不正确，请联系我们以获取正确的信息 |
| 10408 | RepeatInterval 类型错误，应该为int型 |
| 10409 | RepeatInterval over limits,超出范围，范围应该为0到30 |
| 10410 | RepeatNumber 类型错误，应该为int型 |
| 10411 | RepeatNumber 超出范围，范围应该为0到15. |
| 10412 | Details为空 |
| 10413 | 缺少Details 的一个或多个参数 |
| 10414 | 缺少 Details 的全部参数 |
| 10415 | Debtor太长，应少于64个字符 |
| 10416 | Mobile 不正确 |
| 10417 | LoanDate 不正确 |
| 10418 | 截止日期不正确 |
| 10419 | 贷款数额类型错误，应该为数字 |
| 10420 | 贷款数额为负数，应该是大于零的数字 |
| 10421 | 欠款为错误类型，应该为数字 |
| 10422 | 欠款为负数，应该是大于零的数字 |
| 10423 | Error1：机器人未绑定该平台名称 Error2：平台名称太长，应少于20个字符 |
| 10501 | 操作有误 |
| 10502 | TaskID为空 |
| 10503 | TaskID非法, 请检查它是否存在 |
| 10504 | 停止操作失败 |
| 10601 | 数量不正确 |
| 10602 | 页面不正确 |
| 10701 | TaskID为空 |
| 10702 | TaskID非法, 请检查它是否存在 |
| 10801 | PlanName已存在 |
| 10802 | Error1：计划开始时间为创建当天，但是选择的策略开始时间比当前时间早15分钟以上 Error2：计划开始时间在创建日期的5天后（不含第5天）（均为账号时区） |
| 10803 | Debtor太长，应少于64个字符 |
| 10804 | Type非法，请检查它的类型是否正确 |
| 10805 | RobotMethod非法，请检查的它的方式是否正确 |
| 10806 | Customer太长，应少于64个字符 |
| 10807 | Gender太长，应少于8个字符 |
| 10809 | 太多重复的手机号码, 请联系我们的客服支持 |
| 10901 | 创建任务时由于非名单校验性错误，导致任务无法创建成功. |
| 10902 | 创建任务时没有任何成功的名单 |
| 10903 | 策略名称已存在 |
| 10904 | 不能取消已完成的任务 |
| 10905 | TTS SSML 错误 |
| 10906 | 账户服务与接口类型不匹配 |
| 10907 | 策略时间必须大于重拨间隔*重拨次数 |