创建外呼拨打任务

POST

https://api.airudder.com/service/cloud/v2/task

创建外呼拨打任务

请求参数

Header 参数

Authorization

string

必需

默认值:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

TaskName

string

必需

每个任务对应唯一的任务名称
任务名称需要小于等于64个英文字符

ScheduleStartTime

string

必需

ScheduleStartTime的范围为接下来五天内的某时刻（格式为："YYYY-MM-DD hh:mm:ss" ）
此时间为账号对应时区
例如
菲律宾时区为（UTC +08:00）
印尼时区为（UTC +07:00）
印度时区为（UTC +05:30）
墨西哥时区冬令时为（UTC -06:00）
墨西哥时区夏令时为（UTC -05:00）

ScheduleEndTime

string

必需

ScheduleEndTime的范围为迟于ScheduleStartTime至少半个小时并且满足属于接下来五天内的某时刻。（格式为："YYYY-MM-DD hh:mm:ss" ）
此时间为账号对应时区
例如
菲律宾时区为（UTC +08:00）
印尼时区为（UTC +07:00）
印度时区为（UTC +05:30）
墨西哥时区冬令时为（UTC -06:00）
墨西哥时区夏令时为（UTC -05:00

RobotID

string

必需

每一个机器人（或机器人组）对应唯一的ID，请联系我们获得 RobotID
注意：若Parameters和Details同时上传RobotID字段时，则优先使用Detail指定的机器人。
RobotMethod选择single时，使用对应机器人的ID
RobotMethod选择group时，使用对应机器人组的ID

SIPLine

string

必需

为您分配的SIP线路名称。请联系我们获得SIPLine，默认线路只支持拨打业务所在地号码。

RepeatInterval

integer

必需

重复呼叫时间间隔(之前的呼叫未接听) ，范围为0到30分钟。

>= 0<= 30

RepeatNumber

integer

必需

重复呼叫频率(之前的呼叫未接听)，范围从0到15，如果为0，将忽略RepeatInterval。

>= 0<= 15

示例值:

Perform

enum<integer>

必需

创建任务，发生错误时不同的处理方法。
1：创建任务并返回错误的名单列表信息，其中创建的任务中不包含错误的名单。
2：不创建任务，仅对名单列表进行检测，并返回错误的名单列表信息。
3：当所有名单中都正确，创建任务。当名单中含有错误，不创建任务，并返回错误的名单列表信息。

枚举值:

123

Type

string

可选

任务类型不传则默认normal

默认值:

normal

RobotMethod

enum<string>

可选

机器人方式分为single和 group，默认single。
‘single’指的是用上述定义的机器人进行电话拨打。
‘group’指的是用一组机器人进行电话拨打，机器人组由用户适用的机器人组成

枚举值:

singlegroup

默认值:

single

AsyncCreate

boolean

可选

创建任务是否异步进行。 true 即异步创建任务， false 为请求时同步创建任务，不传该字段时默认为同步创建任务

DncSwitch

boolean

可选

是否应用dnc（Do Not Call ）号码池服务，仅适用于美国地区线路。
true 为使用， false 为不使用，不传该字段时默认为不使用dnc号码池服务。使用该服务时请提前联系我们。

Details

array [object {14}]

必需

有关接款方的详细信息。单个任务建议拨5,000个借款人和号码，最大不超过10,000。

Debtor

string

必需

借款人姓名，应不超过64个字符

Mobile

string

必需

借款人电话，带有前缀‘+’和国际区号，例如“+6212341234”“+6312341234”“+9112341234”

LoanDate

string

必需

贷款日期 (格式为: "YYYY-MM-DD") 不允许包含具体的时间信息，不能晚于当前日期，必须早于DueDate。

DueDate

string

必需

贷款到期日期 (格式为: "YYYY-MM-DD") 不允许包含具体的时间信息，必须晚于LoanDate。

LoanAmount

number

贷款金额

必需

Arrears

number

欠款总额，包括利息

必需

Unit

string

必需

货币单位，包括但不限于INR(印度)，IDR（印尼），MXN(墨西哥），PHP（菲律宾）

Platform

string

必需

贷款平台名称，应不超过20个字符，请联系商务，获得可用平台名称列表。

Comments

string

可选

备注，不超过64个字符，返回传入的信息

Gender

enum<string>

可选

借款人性别， male 或者 female，不填默认为空

枚举值:

malefemale

ExtraA

string

可选

自定义变量。详细名称和内容因机器人而异。请提前联系我们确认。

ExtraB

string

可选

自定义变量。详细名称和内容因机器人而异。请提前联系我们确认。

ExtraC

string

可选

自定义变量。详细名称和内容因机器人而异。请提前联系我们确认。

RobotID

string

可选

同上面的RobotID, 但只支持方式为single的机器人。
注意：若Parameters和Details同时上传RobotID字段时，则优先使用Detail指定的机器人。

示例

{
    "TaskName": "task-b-7",
    "ScheduleEndTime": "2022-10-25 16:35:28",
    "ScheduleStartTime": "2022-10-25 16:06:16",
    "RobotID": "8ab9004c349ebb3d645fb1990ad46adb",
    "SIPLine": "CH_SOFTPHONE_TESTBJ_LINE",
    "RepeatInterval": 1,
    "RepeatNumber": 1,
    "Perform": 1,
    "Type": "normal",
    "RobotMethod": "single",
    "Details": [
        {
            "Debtor": "dolore",
            "Mobile": "+6212345678",
            "Arrears": 29,
            "LoanAmount": 82,
            "DueDate": "2022-05-02",
            "LoanDate": "2004-05-19",
            "Platform": "TEMP1",
            "Unit": "INR",
            "Comments": "in enim deserunt irure minim",
            "Gender": "male"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/service/cloud/v2/task' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TaskName": "task-b-7",
    "ScheduleEndTime": "2022-10-25 16:35:28",
    "ScheduleStartTime": "2022-10-25 16:06:16",
    "RobotID": "8ab9004c349ebb3d645fb1990ad46adb",
    "SIPLine": "CH_SOFTPHONE_TESTBJ_LINE",
    "RepeatInterval": 1,
    "RepeatNumber": 1,
    "Perform": 1,
    "Type": "normal",
    "RobotMethod": "single",
    "Details": [
        {
            "Debtor": "dolore",
            "Mobile": "+6212345678",
            "Arrears": 29,
            "LoanAmount": 82,
            "DueDate": "2022-05-02",
            "LoanDate": "2004-05-19",
            "Platform": "TEMP1",
            "Unit": "INR",
            "Comments": "in enim deserunt irure minim",
            "Gender": "male"
        }
    ]
}'

返回响应

🟢200success

application/json

Body

data

object

必需

TaskID

string

必需

Task ID generated when task is created.

detail_error_list

array [object {3}]

必需

任务有部分名单失败时才会出现

status

string

必需

code

integer

必需

示例

成功示例部分名单失败

{
    "data": {
        "TaskID": "c3b6b04cd7f8d2b182d3fd20eed3d144"
    },
    "status": "OK",
    "code": 200
}

🟢200error

修改于 2023-12-27 09:54:18

快速上手

列出已创建的任务