Outgoing Calling Plan Services¶

Outgoing Calling Plan Redirecting¶

Display user’s external outgoing calling plan redirecting¶

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

Retrieve the settings of the Outgoing Calling Plan Redirecting service of the user.

If configured (see below), this API will also include the status of the Outgoing Digit Plan.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
      "useCustomSettings": false,
      "userPermissions": {
         "group": "Allow",
         "local": "Allow",
         "tollFree": "Allow",
         "toll": "Allow",
         "international": "Allow",
         "operatorAssisted": "Allow",
         "chargeableDirectoryAssisted": "Allow",
         "specialServicesI": "Allow",
         "specialServicesII": "Allow",
         "premiumServicesI": "Disallow",
         "premiumServicesII": "Disallow",
         "casual": "Disallow",
         "urlDialing": "Allow",
         "unknown": "Allow",
         "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.

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/redirecting/¶

Update the settings of the Outgoing Calling Plan Redirecting service of the user.

If configured (see below), this API will also allow to update the Outgoing Digit Plan.

Authorization rights: minimum Group Admin.

Example request:

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

{
     "useCustomSettings": true,
     "userPermissions": {
         "group": "Allow",
         "local": "Allow",
         "tollFree": "Allow",
         "toll": "Allow",
         "international": "Allow",
         "operatorAssisted": "Allow",
         "chargeableDirectoryAssisted": "Allow",
         "specialServicesI": "Allow",
         "specialServicesII": "Allow",
         "premiumServicesI": "Disallow",
         "premiumServicesII": "Disallow",
         "casual": "Disallow",
         "urlDialing": "Allow",
         "unknown": "Allow",
         "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.

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. Specific error cases:
- 2: INVALID_PARAMETERS, “It is not allowed to modify the permission {}.”, with a value in place of {} can occur if USER_OCP_UPDATES_ONLY is configure

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/originating/¶

Retrieve the settings of the Outgoing Calling Plan Originating service of the user.

If configured (see below), this API will also include the status of the Outgoing Digit Plan.

Example request:

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

Example response:

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

{
      "useCustomSettings": false,
      "userPermissions": {
         "group": "Allow",
         "local": "Allow",
         "tollFree": "Allow",
         "toll": "Allow",
         "international": "Allow",
         "operatorAssisted": "Allow",
         "chargeableDirectoryAssisted": "Allow",
         "specialServicesI": "Allow",
         "specialServicesII": "Allow",
         "premiumServicesI": "Disallow",
         "premiumServicesII": "Disallow",
         "casual": "Disallow",
         "urlDialing": "Allow",
         "unknown": "Allow",
         "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.

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/originating/¶

Update the settings of the Outgoing Calling Plan Originating service of the user.

If configured (see below), this API will also allow to update the Outgoing Digit Plan.

Example request:

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

{
     "useCustomSettings": true,
     "userPermissions": {
         "group": "Allow",
         "local": "Allow",
         "tollFree": "Allow",
         "toll": "Allow",
         "international": "Allow",
         "operatorAssisted": "Allow",
         "chargeableDirectoryAssisted": "Allow",
         "specialServicesI": "Allow",
         "specialServicesII": "Allow",
         "premiumServicesI": "Disallow",
         "premiumServicesII": "Disallow",
         "casual": "Disallow",
         "urlDialing": "Allow",
         "unknown": "Allow",
         "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.

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. Specific error cases:
- 2: INVALID_PARAMETERS, “It is not allowed to modify the permission {}.”, with a value in place of {} can occur if USER_OCP_UPDATES_ONLY is configure

Configuration Information for OCP¶

The APIO behaviour is controlled by the following settings:

"USER_OCP_EXPOSES_ONLY": ["group", "local", "tollFree", "toll", "international", "operatorAssisted", "chargeableDirectoryAssisted", "specialServicesI", "specialServicesII", "premiumServicesI", "premiumServicesII", "casual", "urlDialing", "unknown"],
"USER_OCP_UPDATES_ONLY": ["group", "local", "tollFree", "toll", "international", "operatorAssisted", "chargeableDirectoryAssisted", "specialServicesI", "specialServicesII", "premiumServicesI", "premiumServicesII", "casual", "urlDialing", "unknown"],
"USER_OCP_WITH_DIGITS" : false

Explanation for the parameters:

USER_OCP_EXPOSES_ONLY: If this parameter is set, only the categories listed will be returned in the answers. By default all are returned.
USER_OCP_UPDATES_ONLY: If this parameter is set, only the categories listed will be allowed in a modify, if not set and USER_OCP_EXPOSES_ONLY is ste then that settings will be used. By default no filtering.