Group Paging Instances¶

Retrieve list instances¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/¶

Retrieve the list of paging groups.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/group_pagings/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "instantGroupCalls": [
      {
         "serviceUserId": "APIOTestGP@sip.netaxis.be",
         "name": "Test User Basic",
         "phoneNumber": "",
         "extension": "",
         "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
         }
      }
   ]
}

Response JSON Object:

instantGroupCalls (array) – The list of instant group calls. See Group Paging List Item.

Status Codes:

200 OK –

Create instance¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/¶

Create a new paging group in a Group.

Authorization rights: minimum Group Admin.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/services/group_pagings/ HTTP/1.1
Host: example.com

{
   "serviceUserId": "APIOTestGP@sip.netaxis.be",
   "serviceInstanceProfile": {
      "name": "Test User",
      "department": {
          "tenantId": "ApioSpTest",
          "groupId": "ApioGrpTest",
          "departmentName": "test_department_initial"
      },
      "cliFirstName": "First Name",
      "cliLastName": "Last Name",
      "language": "English",
      "timeZone": "Europe/Brussels"
   },
   "confirmationToneTimeoutSeconds": 5,
   "deliverOriginatorCLIDInstead": true,
   "originatorCLIDPrefix": "myPrefix7"
   "templateName": "basic",
   "active": true
}

Request JSON Object:

serviceUserId (string) – (Optional) See serviceUserId from Group Paging Instance.
serviceInstanceProfile (object) – (Required) See serviceInstanceProfile from Group Paging Instance.
networkClassOfService (string) – See networkClassOfService from Group Paging Instance.
confirmationToneTimeoutSeconds (integer) – See confirmationToneTimeoutSeconds from Group Paging Instance.
deliverOriginatorCLIDInstead (boolean) – See deliverOriginatorCLIDInstead from Group Paging Instance.
originatorCLIDPrefix (string) – See originatorCLIDPrefix from Group Paging Instance.
templateName (string) – (Optional) As defined as Template Name. The template category used is group_paging.
active (boolean) – (Optional) Specify if the GP is active or not.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

201 Created – instance created

Retrieve instance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/¶

Retrieve a paging group.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "serviceInstanceProfile": {
      "name": "Test User",
      "department": {
          "tenantId": "ApioSpTest",
          "groupId": "ApioGrpTest",
          "departmentName": "test_department_initial"
      },
      "cliFirstName": "First Name",
      "cliLastName": "Last Name",
      "language": "English",
      "timeZone": "Europe/Brussels"
   },
   "confirmationToneTimeoutSeconds": 5,
   "deliverOriginatorCLIDInstead": true,
   "originatorCLIDPrefix": "myPrefix7"
   "active": true
}

Response JSON Object:

serviceInstanceProfile (object) – (Required) See serviceInstanceProfile from Group Paging Instance.
networkClassOfService (string) – See networkClassOfService from Group Paging Instance.
confirmationToneTimeoutSeconds (integer) – See confirmationToneTimeoutSeconds from Group Paging Instance.
deliverOriginatorCLIDInstead (boolean) – See deliverOriginatorCLIDInstead from Group Paging Instance.
originatorCLIDPrefix (string) – See originatorCLIDPrefix from Group Paging Instance.
active (boolean) – (Conditional) Specify if the GP is active or not.

Status Codes:

200 OK –

Update instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/¶

Update a paging group.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/ HTTP/1.1
Host: example.com

{
   "serviceInstanceProfile": {
       "language": "French"
   },
   "confirmationToneTimeoutSeconds": 14
}

Request JSON Object:

serviceInstanceProfile (object) – (Required) See serviceInstanceProfile from Group Paging Instance.
networkClassOfService (string) – See networkClassOfService from Group Paging Instance.
confirmationToneTimeoutSeconds (integer) – See confirmationToneTimeoutSeconds from Group Paging Instance.
deliverOriginatorCLIDInstead (boolean) – See deliverOriginatorCLIDInstead from Group Paging Instance.
originatorCLIDPrefix (string) – See originatorCLIDPrefix from Group Paging Instance.
active (boolean) – (Optional) Specify if the GP is active or not.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated

Delete instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/¶

Delete a paging group.

Authorization rights: minimum Group Admin.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – instance deleted

Update Group Paging’s active status¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings_active/¶

Update the active status of paging groups.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/group_pagings_active/ HTTP/1.1
Host: example.com

{
   "services": [
      {
          "serviceUserId": "APIOTestGP@sip.netaxis.be",
          "active": true
      }
   ]
}

Request JSON Object:

services (array) – List of services to modify. See Active Instance List Item.

Example response:

HTTP/1.1 200 OK

{}

Status Codes:

200 OK – instance updated

Configuration Information for Group Paging Management¶

In the POST API, when creating a paging group, it is possible to configure APIO to generate automatically the service user ID according to a specific rule.

The APIO behaviour for the paging group automatic service user ID generation is controlled by the following setting:

"AUTOMATIC_ID_RULES": {
    "SUID_GROUP_PAGING_AUTO_GENERATE": true,
    "SUID_GROUP_PAGING_RULE": "{{group_id}}_gp{{RND_4}}@{{domain}}"
}

Settings description:

SUID_GROUP_PAGING_AUTO_GENERATE: APIO will enable the auto-generation of paging group service ids. Default is false, it must be set to true to have this feature working.
SUID_GROUP_PAGING_RULE: the formatting rule for the paging group service user id. Default is “{{group_id}}_gp{{RND_4}}@{{domain}}”.

If the service user id number is built using the phone number in the generation rule, it is possible to configure APIO to change the service user io according to phone number modification on PUT request.

The APIO behaviour for the automatic service user id modification is controlled by the following global setting (valid for all types service users):

"AUTOMATIC_ID_RULES": {
     "SERVICE_USERS_UPDATE_ID_PHONE_NUMBER": true
 }

Settings description:

SERVICE_USERS_UPDATE_ID_PHONE_NUMBER: APIO will enable the auto-update of the service ids of all type of service users. Default is False, it must be set to have this feature working with phone numbers based service user ids and containing any of “{{phone_number_e164}}”, “{{country_code}}” or “{{national_no_0}}” placeholders in id generation rule.

The formatting of the phone Number in the List answer is controlled by the following settings:

"GROUP_NUMBERS_USE_CC_CLI": false

With following parameters:

GROUP_NUMBERS_USE_CC_CLI, the OCI documentation says explicitly the numbers will be returned in E164. But it has been reported that sometimes it is not the case, and we have no info from Cisco about this. This parameter is used in some APIs (in this page the answer of the GET Group Paging List) to implement a workaround that will assume that the number is in national format if same country code as Group CLi. It is based on observations and not on Cisco doc. Therefore to be used carefully

In the GET/PUT/POST instance answers, the active information can be provided. This is controlled by the following global setting (valid for all types service users):

"SERVICE_USERS_RETURN_ACTIVE_STATUS": false

Settings description:

SERVICE_USERS_RETURN_ACTIVE_STATUS: APIO will get the list of paging groups to extract the active status of the requested one. Default is False, because the enrichment is a costly operation, so not to be done if not needed.