Retrieve ring group

GET /show
Retrieve ring group by ID.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The unique ID of the ring group.

    format : int64

    minLength: 64

    maxLength: 64

Sample Request

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

Responses

200
Successful operation
application/json
  • id

    integer

    The unique ID of ring group.

    format : int64

  • ring_strategy

    string

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

  • ring_time

    integer

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

    string

    The extension number for ring group. This must be unique to the tenant, i.e. it cannot be an already used extension number.
  • forwards

    object

    Show child attributes
  • name

    string

    The name of ring group.
  • members

    array

    Members in current Ring Group.
    Show child attributes
  • skip_busy_member

    boolean

    Indicates if members on call would be skipped.

Sample Response

                      
{
    "id": 1234
}

Destroy ring group

POST /destroy
Destroy ring group
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 unique ID of ring group.

    format : int64

Sample Request

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

Responses

200
Successful operation
400
Invalid ring group ID supplied.

Sample Response

Update ring group

POST /update
Update ring group
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • forward

    object

    required

    Show child attributes
  • skip_busy_member

    boolean

    required

    Indicates if members on call would be skipped.
  • ring_strategy

    string

    required

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

  • outbound_caller_id

    string

    required

    outbound caller id of ringgroup.
  • ring_time

    integer

    required

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

    string

    required

    The name of ring group.
  • members

    array

    required

    Members in current Ring Group.
  • id

    integer

    required

    The unique ID of ring group.

    format : int64

Sample Request

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

Responses

200
Successful operation

Sample Response

Create ring group

POST /create
Add a new ring group. Please make sure you have at least one ring group created before creating a new ring group.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • forward

    object

    required

    Show child attributes
  • skip_busy_member

    boolean

    required

    Indicates if members on call would be skipped.
  • outbound_caller_id

    string

    required

    outbound caller id of ringgroup.
  • ring_time

    integer

    required

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

    string

    required

    The extension number for ring group. This must be unique to the tenant, i.e. it cannot be an already used extension number.
  • name

    string

    required

    The name of ring group.
  • members

    array

    required

    Extension's ids in current Ring Group.
  • ring_strategy

    string

    required

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

Sample Request

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

Responses

200
Created ring group
application/json
  • id

    integer

    The unique ID of ring group.

    format : int64

Sample Response

                      
{
    "id": 1234
}

Retrieve a collection of ring groups.

GET /list
Retrieve a collection of ring groups.
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/ring_groups/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • pagesize

    integer

  • count

    integer

  • pagination

    integer

  • groups

    array

    Show child attributes
  • sort_by

    string

Sample Response

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