Versions Compared

Old Version 1

changes.mady.by.user esnata (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user UCom4B Doc Writer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAdd tasks of the queue task_scheduler

POST /client/{client_id}/task_scheduler/

Create the queue tasks

URL Parameters

Name

Type

Description

client_id

string

mandatory

Request Parameters (JSON)

Name

Type

Description

comment

string

Update the comment

status

string

Can change to 'on' (switch on) or change to 'off' (switch off)

name

string

A task name

concurrent_task_limit

integer

Change the limit on the number of simultaneous callback

Response field

Name

Type

Description

comment

string

The specified comment

status

string

Either it is switched off 'off' or is switched on 'on'. By default is off

name

string

The specified queue name when creating a task

concurrent_task_limit

integer

The limit on the number of simultaneous callback

create_date_utc

string

The date of queue creation (post) in utc in the format YYYY-MM-DD HH:MM:SS

id

integer

Resource ID

The queue parameters can be updated:

Описание
Expand
titleUpdate the task_scheduler

PUT /client/{client_id}/task_scheduler/{scheduler_id}

Update the task

URL Parameters

Название

Name

Тип

Type

Описание

Description

scheduler_id

string

Обязательный

Mandatory

client_id

string

Обязательный

Mandatory

Параметры запроса Request Parameters (JSON)

Название

Name

Тип

Type

Описание

Description

comment

string

Обновить комментарий

Update the comment

status

string

Можно сделать

Can change to 'on' (

включить) , а может сделать

switch on) or change to 'off' (

выключить

switch off)

.

Название

Тип

concurrent_task_limit

integer

Изменить ограничение на количество одновременных callback

Поля ответа

Change the limit on the number of simultaneous callback

Request field

Name

Type

Description

comment

string

Заданный комментарий

The specified comment

status

string

Либо выключен

Either it is switched off 'off'

, либо включен

or is switched on 'on'.

По умолчанию:

By default is off

name

string

Заданное имя очереди при создании задачи

The specified queue name when creating a task

concurrent_task_limit

integer

Ограничение на количество одновременных

The limit on the number of simultaneous callback

create_date_utc

string

Дата создания очереди

The date of queue creation (post)

в utc в формате

in utc in the format YYYY-MM-DD HH:MM:SS

id

integer

Resource

id.

...

ID

Clarify the information on the queue:

Описание

Get the information regarding the queue

URL Parameters

Expand
titleПолучить информацию о Get the information of task_scheduler

GET /client/{client_id}/task_scheduler/{scheduler_id}

Получить информацию о очереди

Параметры URL

Название

Тип

Name

Type

Description

scheduler_id

string

Обязательный

Mandatory

client_id

string

Обязательный

Mandatory

Поля ответа

Request field

Название

Name

Тип

Type

Описание

Description

comment

string

Заданный комментарий

The specified comment

status

string

Либо выключен

Either it is switched off 'off'

, либо включен

or is switched on 'on'.

По умолчанию:

By default is off

name

string

Заданное имя очереди при создании задачи

The specified queue name when creating a task

concurrent_task_limit

integer

Ограничение на количество одновременных

The limit on the number of simultaneous callback

create_date_utc

string

Дата создания

The date of queue creation (post)

очереди в utc в формате

in utc in the format YYYY-MM-DD HH:MM:SS

id

integer

Resource

id.

...

ID

sched_task_count

integer

Count of sheduled tasks

task_count

integer

Count of all tasks

last_call_date

string

The date of last call in the queue in utc in the format YYYY-MM-DD HH:MM:SS

Add a task (or several tasks at once) to the queue:

Массив задач
Expand
titleДобавить задачу или несколько задач в Add a task or multiple tasks to task_scheduler

Добавить задачи (может быть добавлена однаAdd tasks (one can be added)

POST /client/{client_id}/task_scheduler/{scheduler_id}/tasks/

 

Параметры

URL Parameters

Название

Name

Тип

Type

Описание

Description

scheduler_id

string

Обязательный

Mandatory

client_id

string

Обязательный

Mandatory

Параметры запроса Request Parameters (JSON)

Название

Name

Тип

Type

Описание

Description

tasks

array of tasks

Массив задач - обязательный параметр

Должен содержать одну задачу или более

Array of tasks - the required parameter

Must contain one or more tasks

The array of tasks JSON:

Name

Type

Description

name

string

Имя задачи

A task name

a_number

string

Номер, который будет вызван первым

b_number

string

Номер, который будет вызван вторым

The number that will be called first

b_number

string

The number that will be called second

callback_params

object

A set of optional callback parameters + extended_a_numbers.

Except of a_number, b_number, variables

extended_a_numbers list extends a_number
Format:

{“caller_id_name”: "string",
“caller_id_number“: "string",
“extended_a_numbers”: list}

extension_id

integer

Id добавочного, за счет которого будет совершаться вызов

ID of the extension at the expense of which the call will be made

try_count

integer

Максимальное количество попыток callback. По умолчанию: 1 максимум:

The maximum number of callback attempts. By default: 1 maximum 50

try_again_pause

string

Пауза перед следующей попыткой обзвона (в секундах)

integer

Pause before next dialing attempt (in seconds)

try_count_caller

integer

Maximum number of attempts to call the first number (“a_number”, “extended_a_numbers”). If set to 0, then only the “try_count” counter is used. If after establishing a connection with the first number the second call could not be made, then “try_count_caller“ continues to decrease from the value it had after establishing a connection with the first number. Once it reaches 0, the task no longer tries to repeat itself, regardless of the “try_count” value

try_again_pause_caller

integer

Used if “try_count_caller“>0: pause (in seconds) before next attempt to establish connection with “a_number”. Maximum value is 864000

url_before

string

URL

, куда уйдет событие перед началом срабатывания задачи

where the event will go before the task starts

url_before_again

string

URL

, куда уйдет событие перед повторной попыткой обзвона

where the event will go before trying to call again

url_success

string

URL

, куда уйдет событие в случае успеха задачи (успешное соединение А и Б номеров

where the event will go if the task is successful (successful connection of A and B numbers)

url_after

string

URL

, куда уйдет событие по результату задачи

where the event will go by the result of the task

start_time_utc

string

Время начала старта задачи по utc в формате

The time of the start task by utc in the format YYYY-MM-DD HH: MM: SS

(

может быть указано кол-во секунд, через это время будет старт задачи)

 

Поля ответа

Название

Тип

Описание

status

string

Одно из

the number of seconds can be specified, after this time the task will start)

callback_params

object

A set of optional callback parameters + extended_a_numbers, except for a_number, b_number, variables

extended_a_numbers - list of additional a_numbers
Format:

{"caller_id_name": "string",
"caller_id_number": "string",
"extended_a_numbers": list}

variables

object

Variables for callback. Maximum size of each variable's value - 200 characters.

attempts_src_ani_numbers

list

Ordered list of src_ani for callback by task attempts. Taken in the order of attempts.

attempts_dst_ani_numbers

list

Ordered list of dst_ani for callback by task attempts. Taken in the order of attempts.

interval_timezone

string

Time zone for the interval from the scheduler of a specific task.

Respond field

Name

Type

Description

status

string

One of 'scheduled', 'executed', 'delayed', 'finished'.

'finished' -

выполненная задача

completed task

'delayed' -

отложена по

delayed by try_again_pause

'executed' -

задача была запущенаПо умолчанию, еще не выполненные со статусом

he task has been started

Default, not yet completed with status: 'scheduled'

a_number

string

Номер, который будет вызван первым

The number that will be called first

b_number

string

Номер, который будет вызван вторым

The number that will be called second

extension_id

integer

Id добавочного, за счет которого будет совершаться вызов

ID of the extension, due to which the call will be made

scheduler_id

integer

id очереди

Queue ID

finish_result

string

Либо успех

Either it is success: 'success'

, либо неуспех

or is failure: 'failed'

.

cdr

string

uuid

звонка, до обвзона это поле пустое, далее, по результату обзвона

of the call, before the call, this field is empty, then, based on the call result (status = ‘executed’)

uuid можно использовать в ресурсе

, uuid can be used in the resource /client/{client_id}/call_history/{call_uuid}

try_count

integer

Максимальное количество попыток callback

try_again_pause

integer

try_count_caller

integer

try_again_pause_caller

string

Пауза перед следующей попыткой обзвона (в секундах)

integer

start_time_utc

integer

Время начала старта задачи по utc в форматеYYYY-MM-DD HH:MM:SS

url_before

string

URL, куда уйдет событие перед началом срабатывания задачи

url_before_again

string

URL, куда уйдет событие перед повторной попыткой обзвона

url_after

string

URL, куда уйдет событие по результату задачи

url_success

string

URL, куда уйдет событие в случае успеха задачи (успешное соединение А и Б номеров)

create_date_utc

string

Время создания задачи по utc в формате

Time of the task creation by utc in the format YYYY-MM-DD HH: MM: SS

id

integer

id задачи

Task ID

name

string

имя задачи

finish_comment

string

Тут может быть уточнена причина неуспеха

...

Here the reason of the failure can be clarified

callback_params

object

variables

object

attempts_src_ani_numbers

list

attempts_dst_ani_numbers

list

interval_timezone

string

Clarify the task parameters:

Expand
titleУточнить конкретную задачу в Clarify the exact task in task_scheduler

GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id}

 

Параметры

URL Parameters

Название

Name

Тип

Type

Описание

Description

scheduler_id

string

Обязательный

Mandatory

client_id

string

Обязательный

Mandatory

task_id

integer

Обязательный

Mandatory

 

Поля ответа

Respond field

Название

Name

Тип

Type

Описание

Description

Название

Name

Тип

Type

Описание

Description

status

string

Одно из

One of 'scheduled', 'executed', 'delayed', 'finished', 'delayed_asr', 'delayed_concurrent_task', 'delayed_interval'.

'finished' -

выполненная задача

completed task

'delayed' -

отложена по

delayed by try_again_pause

'delayed_asr'

executed' - задача была запущенаПо умолчанию, еще не выполненные со статусом

- delayed due to high number of failed calls (ASR)

'delayed_concurrent_task' - delayed due to the set limit on the task_scheduler concurrent_task_limit

'delayed_interval' - delayed due to task_scheduler interval

'executed' - he task has been started

Default, not yet completed with status: 'scheduled'

a_number

string

Номер, который будет вызван первым

The number that will be called first

b_number

string

Номер, который будет вызван вторым

The number that will be called second

extension_id

integer

Id добавочного, за счет которого будет совершаться вызов

Extension ID, due to which the call will be made

scheduler_id

integer

id очереди

Queue ID

finish_result

string

Либо успех

Either it is success: 'success'

, либо неуспех

or is failure: 'failed'

.

cdr

string

uuid

звонка, до обвзона это поле пустое, далее, по результату обзвона

of the call, before the call, this field is empty, then, based on the call result (status = ‘executed’)

uuid можно использовать в ресурсе

, uuid can be used in the resource /client/{client_id}/call_history/{call_uuid}

try_count

integer

Максимальное количество попыток callback

The maximum number of callback attempts

try_again_pause

string

Пауза перед следующей попыткой обзвона (в секундах

Pause before the next call attempt (in seconds)

start_time_utc

integer

Время начала старта задачи по utc в формате

Start time of the start task by utc in the format YYYY-MM-DD HH: MM: SS

url_before

string

URL

, куда уйдет событие перед началом срабатывания задачи

where the event will go before the task starts

url_before_again

string

URL

, куда уйдет событие перед повторной попыткой обзвона

where the event will go before trying to call again

url_after

string

URL

, куда уйдет событие по результату задачи

where the event will go by the result of the task

url_success

string

URL

, куда уйдет событие в случае успеха задачи (успешное соединение А и Б номеров

where the event will go if the task is successful (successful connection of A and B numbers)

create_date_utc

string

Время создания задачи по utc в формате

Time of the task creation by utc in the format YYYY-MM-DD HH: MM: SS

id

integer

id задачи

Task ID

name

string

имя задачи

Task name

finish_comment

string

Тут может быть уточнена причина неуспеха

По аналогии с ресурсами создания\управлениями можно:

...

string

Here the reason of the failure can be clarified

callback_params

object

A set of optional callback parameters. Currently available: extended_a_numbers, caller_id_name and caller_id_number.

extended_a_numbers - list of additional a_number numbers

variables

object

Variables for callback. Maximum size of each variable's value - 200 characters.

attempts_src_ani_numbers

list

Ordered list of src_ani for callback by task attempts. Taken in the order of attempts.

attempts_dst_ani_numbers

list

Ordered list of dst_ani for callback by task attempts. Taken in the order of attempts.

interval_timezone

string

Time zone for the interval from the scheduler of a specific task.

By analogy with the creation of resources\controls, you can:

Clarify the list of all queues:

GET /client/{client_id}/task_scheduler/

Удалить конкретную очередьDelete a specific queue:

DELETE /client/{client_id}/task_scheduler/{scheduler_id}

Уточнить список задач в очередиClarify the list of tasks in the queue:

GET /client/{client_id}/task_scheduler/{scheduler_id}/task/

И удалить конкретную задачу в очередиAnd delete a specific task in the queue:

DELETE /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id}

...