Versions Compared

Key

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

...

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

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

Expand
titleДобавить задачу или несколько задач в 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Номер, который будет вызван первым

The number that will be called first

b_number

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

The number that will be called second

extension_id

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

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Пауза

перед следующей попыткой обзвона (в секундахPause before next dialing attempt (in seconds)

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

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

 

Поля ответа

Описание

Название

Тип

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

Respond field

Name

Type

Description

status

string

Одно из One of the 'scheduled', 'executed', 'delayed', 'finished'.

'finished' - выполненная задачаcompleted task

'delayed' - отложена по postponed by try_again_pause

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

By default, not yet executed with the status: 'scheduled'

a_number

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

The number that will be called first

b_number

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

The number that will be called second

extension_id

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

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

scheduler_id

integerid

очереди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Максимальное

количество попыток callbackThe 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

integerid

задачиTask ID

name

stringимя

задачиTask name

finish_comment

string

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

...

Here the reason of the failure can be clarified

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 the 'scheduled', 'executed', 'delayed', 'finished'.

'finished' - выполненная задачаcompleted task

'delayed' - отложена по postponed by try_again_pause

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

By default, not yet executed with the status: 'scheduled'

a_number

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

The number that will be called first

b_number

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

The number that will be called second

extension_id

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

Extension ID, due to which the call will be made

scheduler_id

integerid

очереди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Максимальное

количество попыток callbackThe 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

integerid

задачиTask ID

name

stringимя

задачиTask name

finish_comment

string

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

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

...

Here the reason of the failure can be clarified

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}

...