Retrieve ring groups

GET /ring_groups/list
Retrive a list of ring groups.

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 does not specify value for this field.

Sample Request

https://example.com/api/ring_groups/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 does not specify value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • groups

    array

    required

    The count of ring groups.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "groups": [
        {
            "ring_group_number": "9999",
            "name": "Sample ring group name",
            "ring_time": 20,
            "ring_strategy": "RING_SIMULTANEOUSLY"
        }
    ]
}

Retrieve settings for ring group

GET /ring_groups/show
Retrieves the settings of a ring group.

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Extension number of ring group

Sample Request

https://example.com/api/ring_groups/show?access_token=196ACE20C6F34027895F7F95402BB164&ring_group_number=1000

Response

Placeholders
  • name

    string

    required

    Name of ring group.
  • ring_group_number

    string

    required

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

    integer

    required

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

    string

    required

    Ring strategy Values:
    RING_SIMULTANEOUSLY – Ring Simultaneously;
    PRIORITIZED_HUNT – Prioritized Hunt;
    CYCLIC_HUNT – Cyclic Hunt;
    LEAST_WORKED_HUNT – Least Worked Hunt;
    PAGING/INTERCOM – Paging/Intercom;
  • enable_skip_busy_member

    boolean

    required

    Indicates if members on call would be skipped.
  • no_answer_action

    string

    required

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

    string

    required

    Value of actions if no answer in ring group.
  • members

    array

    required

    Members in current Ring Group.

Sample Response

{
    "ring_group_number": "9999",
    "name": "rg9999",
    "ring_time": 20,
    "ring_strategy": "END_CALL",
    "enable_skip_busy_member": true,
    "members": [
        "101"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Create a ring group

POST /ring_groups/create
Create a new ring group. Ignore enable_skip_busy_member, ring_time, no_answer_action, and no_answer_action_value if the ring_strategy is 5 (paging/intercom).

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Name of ring group.
  • ring_group_number

    string

    required

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

    integer

    required

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

    string

    required

    Ring strategy Values:
    RING_SIMULTANEOUSLY – Ring Simultaneously;
    PRIORITIZED_HUNT – Prioritized Hunt;
    CYCLIC_HUNT – Cyclic Hunt;
    LEAST_WORKED_HUNT – Least Worked Hunt;
    PAGING/INTERCOM – Paging/Intercom;
  • enable_skip_busy_member

    boolean

    required

    Indicates if members on call would be skipped.
  • no_answer_action

    string

    required

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

    string

    required

    Value of actions if no answer in ring group.
  • members

    array

    required

    Members in current Ring Group.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "ring_group_number": "9999",
    "name": "rg9999",
    "ring_time": 20,
    "ring_strategy": "END_CALL",
    "enable_skip_busy_member": true,
    "members": [
        "101"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Response

Placeholders

Sample Response

Update a ring group

POST /ring_groups/update
Modify the settings of a ring group. Ignore ring_time and no_answer_action, no_answer_action_value if the ring_strategy is 5 (paging/intercom).

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Name of ring group.
  • ring_group_number

    string

    required

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

    integer

    required

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

    string

    required

    Ring strategy Values:
    RING_SIMULTANEOUSLY – Ring Simultaneously;
    PRIORITIZED_HUNT – Prioritized Hunt;
    CYCLIC_HUNT – Cyclic Hunt;
    LEAST_WORKED_HUNT – Least Worked Hunt;
    PAGING/INTERCOM – Paging/Intercom;
  • enable_skip_busy_member

    boolean

    required

    Indicates if members on call would be skipped.
  • no_answer_action

    string

    required

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

    string

    required

    Value of actions if no answer in ring group.
  • members

    array

    required

    Members in current Ring Group.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "ring_group_number": "9999",
    "name": "rg9999",
    "ring_time": 20,
    "ring_strategy": "END_CALL",
    "enable_skip_busy_member": true,
    "members": [
        "101"
    ],
    "no_answer_action": "END_CALL",
    "no_answer_action_value": ""
}

Response

Placeholders

Sample Response

Remove a ring group

POST /ring_groups/destroy
Deletes a ring group.

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Extension number of ring group to be deleted.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "ring_group_number": "1000"
}

Response

Placeholders

Sample Response