Incoming Calling Plan Services

Display user’s external incoming calling plan

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

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

Example request:

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

Example response:

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

{
    "useCustomSettings": false,
    "userPermissions": {
       "allowFromWithinGroup": true,
       "allowFromOutsideGroup": "Allow",
       "allowCollectCalls": true,
       "digitPatternPermission": [
          {
             "allow": true,
             "digitPatternName": "Test Digit String"
          }
       ]
    }
}
Response JSON Object:

  • useCustomSettings (boolean) – use custom settings for this user, other than the ones set at group level.

  • userPermissions (object) – an object as defined in Incoming Calling Plan Permissions.

Status Codes:

Update a user’s external incoming calling plan

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

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

Example request:

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

{
   "useCustomSettings": true,
   "userPermissions": {
      "allowFromWithinGroup": true,
      "allowFromOutsideGroup": "Allow",
      "allowCollectCalls": true,
      "digitPatternPermission": [
         {
            "allow": true,
            "digitPatternName": "Test Digit String"
         }
      ]
   }
}
Request JSON Object:

  • useCustomSettings (boolean) – use custom settings for this user, other than the ones set at group level.

  • userPermissions (object) – an object as defined in Incoming Calling Plan Permissions.

Example response:

Response:

Similar to GET instance method response.

Status Codes: