Retrieves call queues

GET /call_queues/list
Placeholders

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.

Sample Request

https://example.com/api/call_queues/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • queues

    array

    required

    The array of call queues.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "queues": [
        {
            "name": "queue name",
            "queue_number": 9999,
            "polling_strategy": "RING_SIMULTANEOUSLY",
            "status": "ONLINE"
        }
    ]
}

Retrieve settings of a call queue

GET /call_queues/show
Placeholders

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • queue_number

    string

    required

    Extension number of call queue.

Sample Request

https://example.com/api/call_queues/show?access_token=196ACE20C6F34027895F7F95402BB164&queue_number=123

Response

Placeholders
  • name

    string

    required

    Name of call queue.
  • queue_number

    string

    required

    Extension number of call queue.
  • ring_time

    integer

    required

    Duration that each extension will ring, in seconds.
  • polling_strategy

    string

    required

    Polling strategy:
    RING_SIMULTANEOUSLY - Ring Simultaneously;
    PRIORITIZED_HUNT - Prioritized Hunt;
    CYCLIC_HUNT - Cyclic Hunt;
    LEAST_WORKED_HUNT - Least Worked Hunt;
    PAGING/INTERCOM - Paging/Intercom
    RING_SIMULTANEOUS - to ring all the extensions simultaneously;
    HUNT_MODE - to ring extensions one by one;
  • max_callers

    integer

    required

    The maximum number of callers allowed in queue.
  • music_on_hold

    string

    required

    The prompt file for music on hold.
  • enable_skip_busy_member

    boolean

    required

    Indicates if extension members on call will be skipped.
  • enable_intro_prompt

    boolean

    required

    Indicates if introduction prompt is enabled in queue.
  • intro_prompt_file

    string

    optional

    Introduction prompt files. Precondition: "enable_intro_prompt" MUST be set to "true".
  • enable_play_full_intro

    boolean

    optional

    Indicates if full introduction prompt would be played before calling agents. Precondition: "enable_intro_prompt" MUST be set to "true".
  • max_wait_time

    integer

    required

    The maximum time limit for waiting in the queue, in seconds. After this time interval, the call will be handled as pre-configured.
  • enable_announce_caller_position

    boolean

    required

    Queue will announce the actual position of the caller who's currently waiting in the queue.
  • announce_caller_position_interval

    integer

    optional

    Time interval for repeating announcement of the waiting position, in seconds. This parameter will be available only if it's enabled to announce position to caller.
  • notify_when_slatime_breached

    boolean

    optional

    Notify Queue manager via email when SLA time has been Breached.
  • notify_when_queuecall_islost

    boolean

    optional

    Notify Queue Manager when a Queue call is lost.
  • sla_time

    integer

    optional

  • members

    array

    required

    Extension members in current call queue.
    Show child attributes
  • queue_manager_members

    array

    required

    Queue Manager members in current call queue.
    Show child attributes
  • no_answer_action

    string

    required

    Actions when the call is not answered by any member of the call queue.
    END_CALL - End Call; CONNECT_TO_EXTENSION - Connect to Extension; CONNECT_TO_RING_GROUP - Connect to Ring group; CONNECT_TO_CALL_QUEUE - Connect to Call queue; CONNECT_TO_VIRTUAL_RECEPTIONIST - Connect to Virtual Receptionist; VOICE_MAIL_FOR_EXTENSION – Connect to Voicemail; CONNECT_TO_EXTERNAL_NUMBER - Connect to external number; REPEAT - Repeat
  • no_answer_action_value

    string

    required

    Value of actions for destination if no answer.

Sample Response

{
    "queue_number": "101",
    "name": "cq101",
    "ring_time": 20,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "max_callers": 10,
    "music_on_hold": "test.wav",
    "enable_skip_busy_member": true,
    "enable_intro_prompt": true,
    "enable_play_full_intro": false,
    "intro_prompt_file": "intro.wav",
    "max_wait_time": 1800,
    "enable_announce_caller_position": true,
    "announce_caller_position_interval": 60,
    "notify_when_slatime_breached": false,
    "notify_when_queuecall_islost": false,
    "sla_time": 5,
    "members": [
        "105",
        "106",
        "107"
    ],
    "queue_manager_members": [
        "108"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Add a new call queue

POST /call_queues/create
Placeholders

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    Name of call queue.
  • queue_number

    string

    required

    Extension number of call queue.
  • ring_time

    integer

    required

    Duration that each extension will ring, in seconds.
  • polling_strategy

    string

    required

    Polling strategy:
    RING_SIMULTANEOUSLY - Ring Simultaneously;
    PRIORITIZED_HUNT - Prioritized Hunt;
    CYCLIC_HUNT - Cyclic Hunt;
    LEAST_WORKED_HUNT - Least Worked Hunt;
    PAGING/INTERCOM - Paging/Intercom
    RING_SIMULTANEOUS - to ring all the extensions simultaneously;
    HUNT_MODE - to ring extensions one by one;
  • max_callers

    integer

    required

    The maximum number of callers allowed in queue.
  • music_on_hold

    string

    required

    The prompt file for music on hold.
  • enable_skip_busy_member

    boolean

    required

    Indicates if extension members on call will be skipped.
  • enable_intro_prompt

    boolean

    required

    Indicates if introduction prompt is enabled in queue.
  • intro_prompt_file

    string

    optional

    Introduction prompt files. Precondition: "enable_intro_prompt" MUST be set to "true".
  • enable_play_full_intro

    boolean

    optional

    Indicates if full introduction prompt would be played before calling agents. Precondition: "enable_intro_prompt" MUST be set to "true".
  • max_wait_time

    integer

    required

    The maximum time limit for waiting in the queue, in seconds. After this time interval, the call will be handled as pre-configured.
  • enable_announce_caller_position

    boolean

    required

    Queue will announce the actual position of the caller who's currently waiting in the queue.
  • announce_caller_position_interval

    integer

    optional

    Time interval for repeating announcement of the waiting position, in seconds. This parameter will be available only if it's enabled to announce position to caller.
  • notify_when_slatime_breached

    boolean

    optional

    Notify Queue manager via email when SLA time has been Breached.
  • notify_when_queuecall_islost

    boolean

    optional

    Notify Queue Manager when a Queue call is lost.
  • sla_time

    integer

    optional

  • members

    array

    required

    Extension members in current call queue.
    Show child attributes
  • queue_manager_members

    array

    required

    Queue Manager members in current call queue.
    Show child attributes
  • no_answer_action

    string

    required

    Actions when the call is not answered by any member of the call queue.
    END_CALL - End Call; CONNECT_TO_EXTENSION - Connect to Extension; CONNECT_TO_RING_GROUP - Connect to Ring group; CONNECT_TO_CALL_QUEUE - Connect to Call queue; CONNECT_TO_VIRTUAL_RECEPTIONIST - Connect to Virtual Receptionist; VOICE_MAIL_FOR_EXTENSION – Connect to Voicemail; CONNECT_TO_EXTERNAL_NUMBER - Connect to external number; REPEAT - Repeat
  • no_answer_action_value

    string

    required

    Value of actions for destination if no answer.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "queue_number": "101",
    "name": "cq101",
    "ring_time": 20,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "max_callers": 10,
    "music_on_hold": "test.wav",
    "enable_skip_busy_member": true,
    "enable_intro_prompt": true,
    "enable_play_full_intro": false,
    "intro_prompt_file": "intro.wav",
    "max_wait_time": 1800,
    "enable_announce_caller_position": true,
    "announce_caller_position_interval": 60,
    "notify_when_slatime_breached": false,
    "notify_when_queuecall_islost": false,
    "sla_time": 5,
    "members": [
        "105",
        "106",
        "107"
    ],
    "queue_manager_members": [
        "108"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Response

Placeholders

Sample Response

Update a call queue

POST /call_queues/update
Modify the settings of a call queue.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • name

    string

    required

    Name of call queue.
  • queue_number

    string

    required

    Extension number of call queue.
  • ring_time

    integer

    required

    Duration that each extension will ring, in seconds.
  • polling_strategy

    string

    required

    Polling strategy:
    RING_SIMULTANEOUSLY - Ring Simultaneously;
    PRIORITIZED_HUNT - Prioritized Hunt;
    CYCLIC_HUNT - Cyclic Hunt;
    LEAST_WORKED_HUNT - Least Worked Hunt;
    PAGING/INTERCOM - Paging/Intercom
    RING_SIMULTANEOUS - to ring all the extensions simultaneously;
    HUNT_MODE - to ring extensions one by one;
  • max_callers

    integer

    required

    The maximum number of callers allowed in queue.
  • music_on_hold

    string

    required

    The prompt file for music on hold.
  • enable_skip_busy_member

    boolean

    required

    Indicates if extension members on call will be skipped.
  • enable_intro_prompt

    boolean

    required

    Indicates if introduction prompt is enabled in queue.
  • intro_prompt_file

    string

    optional

    Introduction prompt files. Precondition: "enable_intro_prompt" MUST be set to "true".
  • enable_play_full_intro

    boolean

    optional

    Indicates if full introduction prompt would be played before calling agents. Precondition: "enable_intro_prompt" MUST be set to "true".
  • max_wait_time

    integer

    required

    The maximum time limit for waiting in the queue, in seconds. After this time interval, the call will be handled as pre-configured.
  • enable_announce_caller_position

    boolean

    required

    Queue will announce the actual position of the caller who's currently waiting in the queue.
  • announce_caller_position_interval

    integer

    optional

    Time interval for repeating announcement of the waiting position, in seconds. This parameter will be available only if it's enabled to announce position to caller.
  • notify_when_slatime_breached

    boolean

    optional

    Notify Queue manager via email when SLA time has been Breached.
  • notify_when_queuecall_islost

    boolean

    optional

    Notify Queue Manager when a Queue call is lost.
  • sla_time

    integer

    optional

  • members

    array

    required

    Extension members in current call queue.
    Show child attributes
  • queue_manager_members

    array

    required

    Queue Manager members in current call queue.
    Show child attributes
  • no_answer_action

    string

    required

    Actions when the call is not answered by any member of the call queue.
    END_CALL - End Call; CONNECT_TO_EXTENSION - Connect to Extension; CONNECT_TO_RING_GROUP - Connect to Ring group; CONNECT_TO_CALL_QUEUE - Connect to Call queue; CONNECT_TO_VIRTUAL_RECEPTIONIST - Connect to Virtual Receptionist; VOICE_MAIL_FOR_EXTENSION – Connect to Voicemail; CONNECT_TO_EXTERNAL_NUMBER - Connect to external number; REPEAT - Repeat
  • no_answer_action_value

    string

    required

    Value of actions for destination if no answer.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "queue_number": "101",
    "name": "cq101",
    "ring_time": 20,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "max_callers": 10,
    "music_on_hold": "test.wav",
    "enable_skip_busy_member": true,
    "enable_intro_prompt": true,
    "enable_play_full_intro": false,
    "intro_prompt_file": "intro.wav",
    "max_wait_time": 1800,
    "enable_announce_caller_position": true,
    "announce_caller_position_interval": 60,
    "notify_when_slatime_breached": false,
    "notify_when_queuecall_islost": false,
    "sla_time": 5,
    "members": [
        "105",
        "106",
        "107"
    ],
    "queue_manager_members": [
        "108"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Response

Placeholders

Sample Response

Delete a call queue

POST /call_queues/destroy
Delete a certain call queue.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • queue_number

    string

    required

    Extension number of call queue to be deleted.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "queue_number": "123"
}

Response

Placeholders

Sample Response

Update a call queue audio data

POST /call_queues/audiodata/update
curl -H "username: admin" -H "password: admin" -H "number: 300" -H "type: 1" --form "fileupload=@transfer.wav" http://yourip:8899/api/call_queues/audio_prompt_file/update.

Request

Placeholders

Sample Request

Response

Placeholders

Sample Response