Outgoing Digit Plan Services¶

Outgoing Digit Plan Redirecting¶

Display user’s external outgoing digit plan redirecting¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/outgoing_calling_plan_digitplan/redirecting/¶

Retrieve the settings of the Outgoing Digit Plan Redirecting service of the User.

It must be noted that this API is useless if the combined mode is used for the Outgoing Calling Plan (Outgoing Calling Plan Services).

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
      "useCustomSettings": false,
      "userPermissions": {
         "digitPatternPermission": [
              {"digitPatternName": "Test Digit String", "permission": 'Allow'}
         ],
      }
}

Response JSON Object:

useCustomSettings (boolean) – the status of the service.
userPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.

Status Codes:

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

Update a user’s external outgoing calling plan redirecting¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/outgoing_calling_plan_digitplan/redirecting/¶

Update the settings of the Outgoing Digit Plan Redirecting service of the User.

It must be noted that this API is useless if the combined mode is used for the Outgoing Calling Plan (Outgoing Calling Plan Services).

Authorization rights: minimum Group Admin.

Example request:

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

{
     "useCustomSettings": true,
     "userPermissions": {
         "digitPatternPermission": [
              {"digitPatternName": "Test Digit String", "permission": "Disallow"}
         ],
     }
}

Request JSON Object:

useCustomSettings (boolean) – the status of the service.
userPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.

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.

Outgoing Calling Plan Originating¶

Display user’s external outgoing calling plan originating¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/outgoing_calling_plan_digitplan/originating/¶

Retrieve the settings of the Outgoing Digit Plan Originating service of the User.

It must be noted that this API is useless if the combined mode is used for the Outgoing Calling Plan (Outgoing Calling Plan Services).

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
      "useCustomSettings": false,
      "userPermissions": {
         "digitPatternPermission": [
           {"digitPatternName": "Test Digit String", "permission": "Allow"}
         ],
      }
}

Response JSON Object:

useCustomSettings (boolean) – the status of the service.
userPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.

Status Codes:

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

Update a user’s external outgoing calling plan originating¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/outgoing_calling_plan_digitplan/originating/¶

Update the settings of the Outgoing Digit Plan Originating service of the User.

It must be noted that this API is useless if the combined mode is used for the Outgoing Calling Plan (Outgoing Calling Plan Services).

Authorization rights: minimum Group Admin.

Example request:

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

{
     "useCustomSettings": true,
     "userPermissions": {
         "digitPatternPermission": [
             {"digitPatternName": "Test Digit String", "permission": "Allow"}
         ],
     }
}

Request JSON Object:

useCustomSettings (boolean) – the status of the service.
userPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.

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.