The scheduler allows to set the callback task at a specific time in the future. The system allows to create several schedulers which can be called as a "task queue".
In each task queue is possible to enable or disable the task execution.
The scheduler queue is created by the following resource:
Add 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:
Update 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 | 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) in utc in the format YYYY-MM-DD HH:MM:SS |
id | integer | Resource ID |
Clarify the information on the queue:
Get the information of task_scheduler
GET /client/{client_id}/task_scheduler/{scheduler_id}
Get the information regarding the queue
URL Parameters
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) in utc in the format YYYY-MM-DD HH:MM:SS |
id | integer | Resource 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:
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 | The number that will be called first |
b_number | string | The number that will be called second |
extension_id | integer | ID of the extension at the expense of which the call will be made |
try_count | integer | 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 | 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) |
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} |
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 | integer | ID of the extension, due to which the call will be made |
scheduler_id | integer | 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 can be used in the resource /client/{client_id}/call_history/{call_uuid} |
try_count | integer | The maximum number of callback attempts |
try_again_pause | string | Pause before the next call attempt (in seconds) |
start_time_utc | integer | 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 | Time of the task creation by utc in the format YYYY-MM-DD HH: MM: SS |
id | integer | Task ID |
name | string | Task name |
finish_comment | 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 |
Clarify the task parameters:
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 |
|---|
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 | integer | Extension ID, due to which the call will be made |
scheduler_id | integer | 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 can be used in the resource /client/{client_id}/call_history/{call_uuid} |
try_count | integer | The maximum number of callback attempts |
try_again_pause | string | Pause before the next call attempt (in seconds) |
start_time_utc | integer | 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 | Time of the task creation by utc in the format YYYY-MM-DD HH: MM: SS |
id | integer | Task ID |
name | string | Task name |
finish_comment | 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 |
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}