Outgoing Digit Plan Services¶

Outgoing Digit Plan Originating¶

Display group’s external outgoing digit plan originating¶

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

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

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:

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

Example response:

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

{
      "groupPermissions": {
         "digitPatternPermission": [
              {"digitPatternName": "Test Digit String", "permission": "Allow"}
         ],
      },
      "departmentsPermissions": [
          {
              "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_available_parent_1",
                  "fullPathName": "test_department_available_parent_1"
              },
              "permissions": {
                  "digitPatternPermission": [
                      {"digitPatternName": "Test Digit String", "permission": "Allow"}
                  ],
              }
          }
     ]
}

Response JSON Object:

groupPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.
departmentsPermissions (array) – a list of objects as defined in Outgoing Calling Plan Department Permissions, but with only the digitPatternPermission element.

Status Codes:

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

Update a group’s external outgoing digit plan originating¶

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

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

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/services/outgoing_calling_plan_digitplan/originating/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "groupPermissions": {
         "digitPatternPermission": [
             {"digitPatternName": "Test Digit String", "permission": "Allow"}
         ],
      },
      "departmentsPermissions": [
          {
              "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_available_parent_1"
              },
              "permissions": {
                  "digitPatternPermission": [
                      {"digitPatternName": "Test Digit String", "permission": "allow"}
                  ],
              }
          }
     ]
}

Request JSON Object:

groupPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.
departmentsPermissions (array) – a list of objects as defined in Outgoing Calling Plan Department 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 group
400 Bad Request – error during the update.

Outgoing Digit Plan Redirecting¶

Display group’s external outgoing digit plan redirecting¶

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

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

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:

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

Example response:

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

{
      "groupPermissions": {
         "digitPatternPermission": [
                      {"digitPatternName": "Test Digit String", "permission": "Allow"}
         ],
      },
      "departmentsPermissions": [
          {
              "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_available_parent_1",
                  "fullPathName": "test_department_available_parent_1"
              },
              "permissions": {
                  "digitPatternPermission": [
                      {"digitPatternName": "Test Digit String", "permission": "Allow"}
                  ],
              }
          }
     ]
}

Response JSON Object:

groupPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.
departmentsPermissions (array) – a list of objects as defined in Outgoing Calling Plan Department Permissions, but with only the digitPatternPermission element.

Status Codes:

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

Update a group’s external outgoing digit plan redirecting¶

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

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

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/services/outgoing_calling_plan_digitplan/redirecting/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "groupPermissions": {
         "digitPatternPermission": [
              {"digitPatternName": "Test Digit String", "allow": True}
         ],
      },
      "departmentsPermissions": [
          {
              "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_available_parent_1"
              },
              "permissions": {
                  "digitPatternPermission": [
                      {"digitPatternName": "Test Digit String", "allow": True}
                  ],
              }
          }
     ]
}

Request JSON Object:

groupPermissions (object) – an object as defined in Outgoing Calling Plan Permissions, but with only the digitPatternPermission element.
departmentsPermissions (array) – a list of objects as defined in Outgoing Calling Plan Department 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 group
400 Bad Request – error during the update.