- API 文档介绍
- Introductions
- 快速上手
- Quick Start
- 鉴权方法
- Get the Authorization token
- 全局错误代码
- Error Codes
- 催收
- 快速上手
- 调用任务相关 API
- 调用计划相关的API
- 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
创建策略计划拨打任务
POST
https://api.airudder.com/service/cloud/v2/plan
请求参数
Header 参数
Authorization
string
必需
默认值:
Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU
Content-Type
string
必需
默认值:
application/json
User-Agent
string
可选
默认值:
Airudder
Body 参数application/json
PlanName
string
可选
SIPLine
string
必需
Strategy
string
必需
Date
string
可选
Perform
enum<integer>
必需
1：创建任务并返回错误的名单列表信息，其中创建的任务中不包含错误的名单。
2：不创建任务，仅对名单列表进行检测，并返回错误的名单列表信息 。
3：当所有名单中都正确，创建任务。 当名单中含有错误， 不创建任务，并返回错误的名单列表信息。
枚举值:
123
DncSwitch
boolean
可选
true 为使用， false 为不使用，不传该字段时默认为不使用dnc号码池服务 。使用该服务时请提前联系我们。
Details
array [object {13}]
必需
Debtor
string
必需
单个任务建议拨5,000个借款人和号码，最大不超过10,000
Mobile
string
必需
LoanDate
string
必需
DueDate
string
必需
LoanAmount
number
贷款金额
Arrears
number
欠款总额，包括利息
Unit
string
必需
Platform
string
必需
Comments
string
可选
Gender
enum<string>
可选
枚举值:
malefemale
ExtraA
string
可选
ExtraB
string
可选
ExtraC
string
可选
示例
{
"PlanName": "my_plan_3",
"Strategy": "test_test_1",
"Perform": 1,
"SIPLine": "LIVEDEMO_CH_SOFTPHONE_LINE",
"Date": "2022-11-17",
"Details": [
{
"Debtor": "Smith",
"Mobile": "+8610086",
"LoanDate": "2022-05-24",
"DueDate": "2022-06-17",
"LoanAmount": 65,
"Arrears": 84,
"Unit": "occaecat",
"Platform": "AIRUDDER",
"Gender": "female",
"Comments": "cillum laboris quis culpa"
}
]
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.airudder.com/service/cloud/v2/plan' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
"PlanName": "my_plan_3",
"Strategy": "test_test_1",
"Perform": 1,
"SIPLine": "LIVEDEMO_CH_SOFTPHONE_LINE",
"Date": "2022-11-17",
"Details": [
{
"Debtor": "Smith",
"Mobile": "+8610086",
"LoanDate": "2022-05-24",
"DueDate": "2022-06-17",
"LoanAmount": 65,
"Arrears": 84,
"Unit": "occaecat",
"Platform": "AIRUDDER",
"Gender": "female",
"Comments": "cillum laboris quis culpa"
}
]
}'返回响应
🟢200success
application/json
Body
data
object
必需
TaskID
string
必需
detail_error_list
array[string]
必需
PlanName
string
必需
status
string
必需
code
integer
必需
示例
{
"data": {
"TaskID": "ed517116f46bbe1ff93d29056a717522",
"detail_error_list": [],
"PlanName": "test-dnc-prod--true-003-plan "
},
"status": "OK",
"code": 200
}🟢200Error1
🟢200Error2