Create a Calling Task - AIRUDDER API

请求参数

Header 参数

Authorization

string

必需

默认值:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

TaskName

string

必需

The unique task name for each task. Length of Task Name must be no longer than 64 characters.

ScheduleStartTime

string

必需

The time should be within following 5 days.
In "YYYY-MM-DD hh:mm:ss"format.
Time Zone is the same as your account's service area.
E.g. Philippines (UTC +08:00) Indonesia (UTC +07:00) India (UTC +05:30) Mexico DST (UTC -05:00) Mexico (UTC -06:00)

ScheduleEndTime

string

必需

The time should be at least 30 minutes later than Scheduled Start Time and within the next 5 days
Format in "YYYY-MM-DD hh:mm:ss".
Time Zone is the same as your account's service area.
E.g. Philippines (UTC +08:00) Indonesia (UTC +07:00) India (UTC +05:30) Mexico DST (UTC -05:00) Mexico (UTC -06:00)

RobotID

string

必需

The unique ID for Robot. Please contact us to get your Robot ID.

SIPLine

string

必需

The SIP Line name assigned for your company. Please contact us to get your SIP Line.The line by default can only be used to dial local numbers.

RepeatInterval

integer

必需

Range from 0 to 30 minutes. Interval for a specific phone number between redials ranging from 0 to 30 minutes (if the previous call in the task is not answered).

>= 0<= 30

RepeatNumber

integer

必需

Repeat frequency if the previous call in the task is not answered. Range from 0 to 15. If 0, Repeat Interval will be ignored.

>= 0<= 15

Type

enum<string>

必需

It is ‘tele-marketing’ by default if using tele-marketing robot. It is ‘cod’ by default if using E-commerce robot.

枚举值:

promotioncod

Perform

integer

必需

Create tasks, different handling methods when errors occur.
1: Create a task and return the wrong roster list information, and the created task does not contain the wrong roster.
2: Do not create a task, only check the roster list, and return wrong roster list information.
3: When all lists are correct, create the task. When the roster contains errors, the task is not created and the error roster list information is returned.

RobotMethod

enum<string>

可选

2 options here, ‘single’ or ‘group’.
‘single’ means calls would be made by a specific robot defined above; ‘group’ means calls would be made by a group of those robots applicable for this client.

枚举值:

singlegroup

默认值:

single

AsyncCreate

boolean

可选

Whether to create tasks asynchronously.
true means to create tasks asynchronously, false means to create tasks synchronously when requested, and if this field is not passed, the default is to create tasks synchronously

DncSwitch

boolean

可选

Whether to apply dnc (Do Not Call) number pool service. true means to use, false means not to use, if this field is not passed, the dnc number pool service is not used by default. Please contact us in advance when using this service.(Applicable to US regional lines only)

Details

array [object {9}]

必需

Detailed information about telemarketing, please refer to the following table.

Customer

string

必需

The customer's name, no longer than 64 letters.

Mobile

string

必需

The customer's mobile number, with prefix '+' and international area code, e.g. '+6212341234'.

Platform

string

必需

The telemarketing platform name, no longer than 20 letters.

Comments

string

可选

Comments, no longer than 64 letters. Returns the same thing as uploaded.

RobotID

string

可选

Same as RobotID above, but only supports robots in single mode. Note: If the Robot ID field is uploaded from both Parameters and Details, the robot specified by Details will be used first.

Gender

enum<string>

可选

The gender of customer, male or female, blank by default.

枚举值:

malefemale

ExtraA

string

可选

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

ExtraB

string

可选

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

ExtraC

string

可选

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

示例

{
  "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",
  "RepeatNumber": 1,
  "RepeatInterval": 10,
  "Type": "promotion",
  "Perform": 1,
  "RobotMethod": "single",
  "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

返回响应

🟢200success

application/json

Body

data

object

必需

TaskID

string

必需

status

enum<string>

必需

枚举值:

默认值:

code

enum<integer>

必需

枚举值:

200403500401

示例

successexample of success

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

🟢200error