Ring Groups

Manage your ring groups.

List ring groups.

get

Retrieve a collection of ring groups.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/ring_groups

HTTPcURLJavaScriptPython

GET /api/ring_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "extension_number": "text",
      "ring_time": 20,
      "ring_strategy": "RING_SIMULTANEOUSLY",
      "skip_busy_member": true,
      "enable_paid": false,
      "enable_prid": false,
      "extension_number_as_to_header": false,
      "no_answer_forward_rule": {
        "action": "FORWARD_TO_NUMBER",
        "number": "text"
      },
      "night_mode_forward_rule": {
        "action": "FORWARD_TO_NUMBER",
        "number": "text"
      }
    }
  ]
}

Create a ring group

post

Add a new ring group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestring · min: 1 · max: 64Optional

The name of ring group.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

ring_timeinteger · int32Optional

Duration that each extension will ring, in seconds.

Default: 20

ring_strategystring · enumOptional

Ring strategy:
Can be either:

• RING_SIMULTANEOUSLY: Ring all available members of the group simultaneously.
• PRIORITIZED_HUNT: Ring each available member of the group serially in the configured order.
• CYCLIC_HUNT: Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• LEAST_WORKED_HUNT: Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.
• PAGING_INTERCOM: Ring all available members of the group simultaneously and add an auto answer indication to the calls in order to invoke a page.
• SKILL_BASED_ROUTING_PRIORITIZED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially in the configured order.
• SKILL_BASED_ROUTING_CYCLIC_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• SKILL_BASED_ROUTING_LEAST_WORKED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.

Possible values:

skip_busy_memberbooleanOptional

Indicates if members on call would be skipped.

enable_paidbooleanOptional

Whether to add ring group information into P-Asserted-Identity header.

Default: false

enable_pridbooleanOptional

Whether to add ring group information into Remote-Party-ID header.

Default: false

extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false

Responses

200

Created ring group

application/json

idall ofOptional

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post

/ring_groups

HTTPcURLJavaScriptPython

POST /api/ring_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 448

{
  "name": "text",
  "extension_number": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": false,
  "enable_prid": false,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "night_mode_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a ring group

get

Retrieve ring group by ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of ring group.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

ring_timeinteger · int32Optional

Duration that each extension will ring, in seconds.

Default: 20

ring_strategystring · enumOptional

Ring strategy:
Can be either:

• RING_SIMULTANEOUSLY: Ring all available members of the group simultaneously.
• PRIORITIZED_HUNT: Ring each available member of the group serially in the configured order.
• CYCLIC_HUNT: Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• LEAST_WORKED_HUNT: Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.
• PAGING_INTERCOM: Ring all available members of the group simultaneously and add an auto answer indication to the calls in order to invoke a page.
• SKILL_BASED_ROUTING_PRIORITIZED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially in the configured order.
• SKILL_BASED_ROUTING_CYCLIC_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• SKILL_BASED_ROUTING_LEAST_WORKED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.

Possible values:

skip_busy_memberbooleanOptional

Indicates if members on call would be skipped.

enable_paidbooleanOptional

Whether to add ring group information into P-Asserted-Identity header.

Default: false

enable_pridbooleanOptional

Whether to add ring group information into Remote-Party-ID header.

Default: false

extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false

4XX

Error

get

/ring_groups/{id}

HTTPcURLJavaScriptPython

GET /api/ring_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "extension_number": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": false,
  "enable_prid": false,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "night_mode_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}

Update a ring group

post

Update a ring group

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

namestring · min: 1 · max: 64Optional

The name of ring group.

ring_timeinteger · int32Optional

Duration that each extension will ring, in seconds.

Default: 20

ring_strategystring · enumOptional

Ring strategy:
Can be either:

• RING_SIMULTANEOUSLY: Ring all available members of the group simultaneously.
• PRIORITIZED_HUNT: Ring each available member of the group serially in the configured order.
• CYCLIC_HUNT: Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• LEAST_WORKED_HUNT: Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.
• PAGING_INTERCOM: Ring all available members of the group simultaneously and add an auto answer indication to the calls in order to invoke a page.
• SKILL_BASED_ROUTING_PRIORITIZED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially in the configured order.
• SKILL_BASED_ROUTING_CYCLIC_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first.
• SKILL_BASED_ROUTING_LEAST_WORKED_HUNT: The call assign to the agents in the level "1" skill group first,
  and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group.
  Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.

Possible values:

skip_busy_memberbooleanOptional

Indicates if members on call would be skipped.

enable_paidbooleanOptional

Whether to add ring group information into P-Asserted-Identity header.

Default: false

enable_pridbooleanOptional

Whether to add ring group information into Remote-Party-ID header.

Default: false

extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false

Responses

200

OK

No content

4XX

Error

post

/ring_groups/{id}

HTTPcURLJavaScriptPython

POST /api/ring_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "name": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": false,
  "enable_prid": false,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "night_mode_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}

No content

List ring group agents

get

Retrieve a collection of ring group agents.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/ring_groups/{id}/agents

HTTPcURLJavaScriptPython

GET /api/ring_groups/{id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "extension_number": "text",
      "display_name": "text",
      "skill_level": 1
    }
  ]
}

Update ring group member list

post

Update ring group member list.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

Responses

200

OK

No content

4XX

Error

post

/ring_groups/{id}/agents

HTTPcURLJavaScriptPython

POST /api/ring_groups/{id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "items": [
    {
      "extension_number": "text",
      "skill_level": 1
    }
  ]
}

No content

Retrieve ring group agent details.

get

Retrieve information of ring group agent.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

agent_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

application/json

extension_numberall ofOptional

The extension number of agent.

string · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

display_nameall ofRead-onlyOptional

The display name of agent.

string · max: 1024Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

The skill level of agent in ring group.
Only valid when ring_strategy is skill based.

Default: 1

4XX

Error

get

/ring_groups/{id}/agents/{agent_number}

HTTPcURLJavaScriptPython

GET /api/ring_groups/{id}/agents/{agent_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "text",
  "display_name": "text",
  "skill_level": 1
}

Destroy a ring group

post

Destroy a ring group

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid ring group ID supplied.

post

/ring_groups/{id}/destroy

HTTPcURLJavaScriptPython

POST /api/ring_groups/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content