创建外呼拨打任务

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

必需

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

StartImmediately

boolean

可选

是否立刻开始，为true时ScheduleStartTime和ScheduleEndTime可不传，系统会自动计算

RobotID

string

必需

每一个机器人对应唯一的ID，请联系我们获得 RobotID

SIPLine

string

必需

为您分配的SIP线路名称。请联系我们获得SIPLine

RepeatInterval

integer

必需

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

>= 0<= 30

RepeatNumber

integer

必需

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

>= 0<= 15

Type

string

必需

任务类型，营销场景请传promotion

Perform

enum<integer>

必需

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

枚举值:

123

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 {9}]

必需

有关名单的详细信息。单个任务建议拨5,000个号码，最大不超过10,000。

Customer

string

可选

客户名称，不超过64个字符。

Mobile

string

必需

客户的手机号码，前缀为“+”和国际区号，例如 '+6212341234'。

Platform

string

必需

电话营销平台名称，不超过20个字母。

Comments

string

可选

注释，不超过 64 个字母

RobotID

string

可选

同上RobotID，但只支持“single”模式的机器人。注意：如果Robot ID字段是Parameters和Details都上传的，Details指定的机器人会优先使用。

Gender

enum<string>

可选

客户性别，男或女，默认为空。

枚举值:

malefemale

ExtraA

string

可选

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

ExtraB

string

可选

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

ExtraC

string

可选

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

示例

{
    "TaskName": "test-apitest-001",
    "RobotID": "e9f60ec4e5f1721c7992dc882767eb19",
    "SIPLine": "ID_PHONE_HK_LINE",
    "ScheduleStartTime": "2023-03-31 20:00:20",
    "ScheduleEndTime": "2023-03-31 23:19:20",
    "StartImmediately": true,
    "RepeatNumber": 1,
    "RepeatInterval": 10,
    "RobotMethod": "single",
    "Type": "promotion",
    "Perform": 1,
    "Details": [
        {
            "Customer": "Customer-user1",
            "Mobile": "+6212345678",
            "Platform": "AIRUDDER",
            "Comments":"Comments",
            "Gender": "male",
            "ExtraA": "ExtraA"
        }
    ]
}

示例代码

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": "test-apitest-001",
    "RobotID": "e9f60ec4e5f1721c7992dc882767eb19",
    "SIPLine": "ID_PHONE_HK_LINE",
    "ScheduleStartTime": "2023-03-31 20:00:20",
    "ScheduleEndTime": "2023-03-31 23:19:20",
    "StartImmediately": true,
    "RepeatNumber": 1,
    "RepeatInterval": 10,
    "RobotMethod": "single",
    "Type": "promotion",
    "Perform": 1,
    "Details": [
        {
            "Customer": "Customer-user1",
            "Mobile": "+6212345678",
            "Platform": "AIRUDDER",
            "Comments":"Comments",
            "Gender": "male",
            "ExtraA": "ExtraA"
        }
    ]
}'

返回响应

🟢200success

application/json

Body

data

object

必需

TaskID

string

必需

detail_error_list

array [object {3}]

可选

task部分成功时才会有detail error list

status

string

必需

code

integer

必需

示例

部分名单失败成功示例

{
    "data": {
        "TaskID": "c3b6b04cd7f8d2b182d3fd20eed3d144",
        "detail_error_list": [
            {
                "field": "Details[1]",
                "msg": "Country Code Error: 13016111",
                "comments": "C12345567 "
            }
        ]
    },
    "status": "OK",
    "code": 200
}

🟢200error

获取机器人详情