Retrieve a collection of call queues member state

GET /member_state/list
Retrieve a collection of call queues member state
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The call queue's ID.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_queues/member_state/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • wait_members

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "count": 100
}

Update call queue

POST /update
Update call queue
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • language

    string

    required

    language.
  • notify_when_callback_ismade

    boolean

    required

    notify_when_callback_ismade.
  • max_callers

    integer

    required

    The maximum number of callers allowed in queue.
  • notify_when_callback_fails

    boolean

    required

    notify_when_callback_fails.
  • notify_when_slatime_breached

    boolean

    required

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

    integer

    required

    The ID of the call queue.

    format : int64

  • intro_prompt_metadata_id

    integer

    required

    intro_prompt_metadata_id.

    format : int64

  • 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.
  • outbound_caller_id

    string

    required

    Call queue's outbound caller id.
  • sla_time

    integer

    required

    format : uint32

  • enable_announce_caller_position

    boolean

    required

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

    boolean

    required

    enable play intro prompt.
  • forward

    object

    required

    Show child attributes
  • enable_play_full_intro

    boolean

    required

    enable play full intro prompt.
  • enable_black_list_prompt

    boolean

    required

    enable play blacklist prompt.
  • ring_time

    integer

    required

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

    integer

    required

    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.
  • name

    string

    required

    Call queue's name.
  • black_list_metadata_id

    integer

    required

    black_list_metadata_id.

    format : int64

  • blacklist

    array

    required

  • skip_busy_member

    boolean

    required

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

    string

    required

    RING_SIMULTANEOUSLY: Ring Simultaneously. PRIORITIZED_HUNT: Prioritized Hunt. CYCLIC_HUNT: Cyclic Hunt. LEAST_WORKED_HUNT: To ring extension who has least answering hours. PAGING/INTERCOM: Paging or Intercom. RING_SIMULTANEOUSLY: To ring all the extensions simultaneously.

    enum : ['RING_SIMULTANEOUSLY', 'PRIORITIZED_HUNT', 'CYCLIC_HUNT', 'LEAST_WORKED_HUNT', 'PAGING/INTERCOM']

  • queue_manager_members

    array

    required

    Extension managers in current call queue.
  • notify_when_queuecall_islost

    boolean

    required

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

    array

    required

    Extension ids in current call queue.
  • moh_metadata_id

    integer

    required

    Music ON Hold file metadata ID.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "notify_when_callback_ismade": "tue",
    "max_callers": 123,
    "enable_play_full_intro": false,
    "notify_when_slatime_breached": true,
    "id": 1234,
    "intro_prompt_metadata_id": 123,
    "max_wait_time": 123,
    "outbound_caller_id": "1234",
    "sla_time": 123,
    "enable_announce_caller_position": true,
    "enable_intro_prompt": false,
    "language": "ch",
    "notify_when_callback_fails": true,
    "ring_time": 123,
    "announce_caller_position_interval": 123,
    "name": "1234",
    "black_list_metadata_id": 123,
    "enable_black_list_prompt": false,
    "skip_busy_member": false,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "notify_when_queuecall_islost": true,
    "moh_metadata_id": 123
}'

Responses

200
Successful operation

Sample Response

call queue delete all blacklist

POST /blacklist/destroy_all
call queue delete all blacklist
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/blacklist/destroy_all \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
400
Invalid call queue ID supplied

Sample Response

Retrieve call queue

GET /show
Retrieve call queue
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The call queue's ID.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_queues/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • queue_manager_members

    array

    Show child attributes
  • notify_when_callback_ismade

    boolean

    notify_when_callback_ismade.
  • intro_prompt_fileid

    string

    intro_prompt file download id.
  • max_callers

    integer

    The maximum number of callers allowed in queue.
  • notify_when_callback_fails

    boolean

    notify_when_callback_fails.
  • blacklist

    array

    Show child attributes
  • black_list_fileid

    string

    blacklist file download ID.
  • notify_when_slatime_breached

    boolean

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

    string

    blacklist filename
  • intro_prompt_metadata_id

    integer

    intro_prompt_metadata_id.

    format : int64

  • max_wait_time

    integer

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

    string

    moh_filename
  • intro_prompt_filename

    string

    intro_prompt_filename.
  • outbound_caller_id

    string

    Call queue's outbound caller id.
  • sla_time

    integer

    format : uint32

  • enable_announce_caller_position

    boolean

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

    integer

    The ID of the call queue.

    format : int64

  • enable_intro_prompt

    boolean

    enable play intro prompt.
  • forward

    object

    Show child attributes
  • enable_play_full_intro

    boolean

    enable play full intro prompt.
  • language

    string

    language.
  • moh_fileid

    string

    Music ON Hold file download ID.
  • ring_time

    integer

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

    integer

    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.
  • name

    string

    Call queue's name.
  • black_list_metadata_id

    integer

    black_list_metadata_id.

    format : int64

  • enable_black_list_prompt

    boolean

    enable play blacklist prompt.
  • polling_strategy

    string

    RING_SIMULTANEOUSLY: Ring Simultaneously. PRIORITIZED_HUNT: Prioritized Hunt. CYCLIC_HUNT: Cyclic Hunt. LEAST_WORKED_HUNT: To ring extension who has least answering hours. PAGING/INTERCOM: Paging or Intercom. RING_SIMULTANEOUSLY: To ring all the extensions simultaneously.

    enum : ['RING_SIMULTANEOUSLY', 'PRIORITIZED_HUNT', 'CYCLIC_HUNT', 'LEAST_WORKED_HUNT', 'PAGING/INTERCOM']

  • notify_when_queuecall_islost

    boolean

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

    string

    Call queue's extension number.
  • members

    array

    Show child attributes
  • moh_metadata_id

    integer

    Music ON Hold file metadata ID.

    format : int64

Sample Response

                      
{
    "notify_when_callback_ismade": "tue",
    "intro_prompt_fileid": "123",
    "max_callers": 123,
    "enable_play_full_intro": false,
    "black_list_fileid": "123",
    "notify_when_slatime_breached": true,
    "id": 1234,
    "intro_prompt_metadata_id": 123,
    "max_wait_time": 123,
    "moh_filename": "123",
    "black_list_metadata_id": 123,
    "outbound_caller_id": "1234",
    "sla_time": 123,
    "enable_announce_caller_position": true,
    "name": "1234",
    "enable_intro_prompt": false,
    "language": "ch",
    "notify_when_callback_fails": true,
    "moh_fileid": "123",
    "ring_time": 123,
    "announce_caller_position_interval": 123,
    "black_list_filename": "123",
    "intro_prompt_filename": "filename",
    "enable_black_list_prompt": false,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "notify_when_queuecall_islost": true,
    "moh_metadata_id": 123,
    "extension_number": "1234"
}

call queue delete blacklist

POST /blacklist/destroy
call queue delete blacklist
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • blacklist_ids

    array

    required

    blacklist ids.
  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/blacklist/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
400
Invalid call queue ID supplied

Sample Response

Retrieve a collection of call queues

GET /list
Retrieve a collection of call queues
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    required

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

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

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_queues/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • pagesize

    integer

  • count

    integer

  • queues

    array

    Show child attributes
  • pagination

    integer

  • sort_by

    string

Sample Response

                      
{
    "pagesize": 10,
    "count": 100,
    "pagination": 8,
    "sort_by": "DEFAULT"
}

Retrieve a collection of call wait queues

GET /wait/list
Retrieve a collection of call wait queues
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The call queue's ID.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_queues/wait/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • wait_members

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "count": 100
}

call queue anwser specified call

POST /specifiedcall/anwser
call queue anwser specified call
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • session_id

    integer

    required

    The ID of the session.

    format : int64

  • manager_id

    integer

    required

    The ID of the extension.

    format : int64

  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/specifiedcall/anwser \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "session_id": 1234,
    "manager_id": 1234,
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
400
Invalid call queue ID supplied

Sample Response

Retrieve a collection of call queues blacklist

GET /blacklist/list
Retrieve a collection of call queues blacklist
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The call queue's ID.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_queues/blacklist/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • wait_members

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "count": 100
}

Create call queue

POST /create
Add a new call queue.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • language

    string

    required

    language.
  • notify_when_callback_ismade

    boolean

    required

    notify_when_callback_ismade.
  • max_callers

    integer

    required

    The maximum number of callers allowed in queue.
  • notify_when_callback_fails

    boolean

    required

    notify_when_callback_fails.
  • notify_when_slatime_breached

    boolean

    required

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

    integer

    required

    intro_prompt_metadata_id.

    format : int64

  • 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.
  • outbound_caller_id

    string

    required

    Call queue's outbound caller id.
  • sla_time

    integer

    required

    format : uint32

  • enable_announce_caller_position

    boolean

    required

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

    boolean

    required

    enable play intro prompt.
  • forward

    object

    required

    Show child attributes
  • enable_play_full_intro

    boolean

    required

    enable play full intro prompt.
  • enable_black_list_prompt

    boolean

    required

    enable play blacklist prompt.
  • ring_time

    integer

    required

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

    integer

    required

    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.
  • name

    string

    required

    Call queue's name.
  • black_list_metadata_id

    integer

    required

    black_list_metadata_id.

    format : int64

  • blacklist

    array

    required

  • skip_busy_member

    boolean

    required

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

    string

    required

    RING_SIMULTANEOUSLY: Ring Simultaneously. PRIORITIZED_HUNT: Prioritized Hunt. CYCLIC_HUNT: Cyclic Hunt. LEAST_WORKED_HUNT: To ring extension who has least answering hours. PAGING/INTERCOM: Paging or Intercom. RING_SIMULTANEOUSLY: To ring all the extensions simultaneously.

    enum : ['RING_SIMULTANEOUSLY', 'PRIORITIZED_HUNT', 'CYCLIC_HUNT', 'LEAST_WORKED_HUNT', 'PAGING/INTERCOM']

  • queue_manager_members

    array

    required

    Extension managers in current call queue.
  • notify_when_queuecall_islost

    boolean

    required

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

    integer

    required

    Music ON Hold file metadata ID.

    format : int64

  • members

    array

    required

    Extension ids in current call queue.
  • extension_number

    string

    required

    Call queue's extension number.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "notify_when_callback_ismade": "tue",
    "max_callers": 123,
    "enable_play_full_intro": false,
    "notify_when_slatime_breached": true,
    "intro_prompt_metadata_id": 123,
    "max_wait_time": 123,
    "outbound_caller_id": "1234",
    "sla_time": 123,
    "enable_announce_caller_position": true,
    "enable_intro_prompt": false,
    "language": "ch",
    "notify_when_callback_fails": true,
    "ring_time": 123,
    "announce_caller_position_interval": 123,
    "name": "1234",
    "black_list_metadata_id": 123,
    "enable_black_list_prompt": false,
    "skip_busy_member": false,
    "polling_strategy": "RING_SIMULTANEOUSLY",
    "notify_when_queuecall_islost": true,
    "extension_number": "1234",
    "moh_metadata_id": 123
}'

Responses

200
Created call queue
application/json
  • id

    integer

    The ID of the call queue.

    format : int64

Sample Response

                      
{
    "id": 1234
}

Update call queue member_state

POST /member_state/update
Update call queue member_state
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • status

    boolean

    required

    is_logined.
  • extension_id

    integer

    required

    The ID of the extension.

    format : int64

  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/member_state/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "extension_id": 1234,
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
400
Invalid call queue ID supplied

Sample Response

Destroy call queue

POST /destroy
Destroy call queue
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
400
Invalid call queue ID supplied

Sample Response

call queue add blacklist

POST /blacklist/create
call queue add blacklist
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • description

    string

    required

  • number

    string

    required

    Call queue's extension number.
  • id

    integer

    required

    The ID of the call queue.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/call_queues/blacklist/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "description": "c  description",
    "number": "1234",
    "id": 1234
}'

Responses

404
User not found
200
Successful operation
application/json
  • id

    integer

    The ID of the blacklist.

    format : int64

400
Invalid call queue ID supplied

Sample Response

                      
{}