Incoming Calling Plan Services¶

Display group’s external incoming calling plan¶

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

Retrieve the settings of the Incoming Calling Plan service of the group.

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "groupPermissions": {
      "allowFromWithinGroup": false,
      "allowFromOutsideGroup": "Allow Only If Redirected From Another User",
      "allowCollectCalls": true,
      "digitPatternPermission": [
         {
            "allow": false,
            "digitPatternName": "Test Digit String"
         }
      ]
   },
   "departmentsPermissions": [
      {
         "department": {
            "tenantId": "t_7962",
            "groupId": "t_7962_g_6059",
            "departmentName": "Developments",
            "fullPathName": "Developments (t_7962_g_6059)"
         },
         "allowFromWithinGroup": true,
         "allowFromOutsideGroup": "Disallow",
         "allowCollectCalls": true,
         "digitPatternPermission": [
            {
               "allow": true,
               "digitPatternName": "Test Digit String"
            }
         ]
      }
   ]
}

Response JSON Object:

groupPermissions (object) – an object as defined in Incoming Calling Plan Permissions.
departmentsPermissions (array) – a list of objects as defined in Incoming Calling Plan Department Permissions.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update a group’s external incoming calling plan¶

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

Update the settings of the Incoming Calling Plan service of the group.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/incoming_calling_plan/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "groupPermissions": {
      "allowFromWithinGroup": false,
      "allowFromOutsideGroup": "Allow Only If Redirected From Another User",
      "allowCollectCalls": true,
      "digitPatternPermission": [
         {
            "allow": false,
            "digitPatternName": "Test Digit String"
         }
      ]
   },
   "departmentsPermissions": [
      {
         "department": {
            "tenantId": "t_7962",
            "groupId": "t_7962_g_6059",
            "departmentName": "Developments",
            "fullPathName": "Developments (t_7962_g_6059)"
         },
         "allowFromWithinGroup": true,
         "allowFromOutsideGroup": "Disallow",
         "allowCollectCalls": true,
         "digitPatternPermission": [
            {
               "allow": true,
               "digitPatternName": "Test Digit String"
            }
         ]
      }
   ]
}

Request JSON Object:

groupPermissions (object) – an object as defined in Incoming Calling Plan Permissions.
departmentsPermissions (array) – a list of objects as defined in Incoming Calling Plan Department Permissions.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update