Tenant Immediate Trunking Connectivity¶

The Immediate Trunking Connectivity is a feature allowing to define ranges of numbers or prefixes at Tenant level and then link them to an existing Trunk Group this will provide basic trunking features for this numbers without the possibility to customize them number by number.

Display tenant’s immediate trunking connectivity numbers¶

GET /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/numbers/¶

Retrieve the list of numbers of the immediate trunking connectivity service of the tenant.

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/foo/services/immediate_trunking_connectivity/numbers/ HTTP/1.1
Host: example.com

Example response:

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

{
     "numbers":
          [
              {
                  "minPhoneNumber": "+3225126999",
                  "maxPhoneNumber": "+3225126999",
                  "active": true,
                  "extensionLength": ""
              }
          ]
}

Response JSON Object:

numbers (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Numbers Range attributes.

Status Codes:

200 OK – no error
404 Not Found – service is not assigned to this tenant

Assign a list of immediate trunking connectivity numbers to a Tenant¶

POST /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/numbers/¶

Assign a list of immediate trunking connectivity rnages of numbers to a Tenant.

It must be noted that a range is a whole. It is not possible to assign or remove part of it, it is always the full range.

Authorization rights: minimum System Admin.

Example request:

POST /api/v1/tenant/footenant/services/immediate_trunking_connectivity/numbers/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "numbers":
          [
              {
                  "minPhoneNumber": "+3225126999",
                  "maxPhoneNumber": "+3225126999"
              }
          ]
}

Request JSON Object:

numbers (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Numbers Range attributes.

Example response:

HTTP/1.1 201 CREATED
Content-Type: "application/json"

{}

Status Codes:

201 Created – no error.
400 Bad Request – bad request due to invalid parameters
404 Not Found – service is not assigned to this tenant

Display tenant’s immediate trunking connectivity available numbers¶

GET /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/available_numbers/¶

Retrieve the list of available numbers of the immediate trunking connectivity service of the tenant. It means the range of numbers not yet assigned to a Group or a User.

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/foo/services/immediate_trunking_connectivity/available_numbers/ HTTP/1.1
Host: example.com

Example response:

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

{
     "available_numbers":
          [
              {
                  "minPhoneNumber": "+3225126999",
                  "maxPhoneNumber": "+3225126999",
                  "active": true,
                  "extensionLength": ""
              }
          ]
}

Response JSON Object:

available_numbers (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Numbers Range attributes.

Status Codes:

200 OK – no error
404 Not Found – service is not assigned to this tenant

Remove a list of immediate trunking connectivity numbers from a Tenant¶

DELETE /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/numbers/¶

Remove a list of immediate trunking connectivity numbers from a Tenant.

Authorization rights: minimum System Admin.

Example request:

DELETE /api/v1/tenant/footenant/services/immediate_trunking_connectivity/numbers/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "numbers":
          [
              {
                  "minPhoneNumber": "+3225126999"
              }
          ]
}

Request JSON Object:

numbers (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Numbers Range attributes.

Example response:

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

{}

Status Codes:

200 OK – no error.
400 Bad Request – bad request due to invalid parameters
404 Not Found – service is not assigned to this tenant

Display tenant’s immediate trunking connectivity prefixes¶

GET /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/prefixes/¶

Retrieve the list of prefixes of the immediate trunking connectivity service of the tenant.

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/foo/services/immediate_trunking_connectivity/prefixes/ HTTP/1.1
Host: example.com

Example response:

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

{
    "prefixes":
        [
            {
                "prefix": "+32-01",
                "active": true,
                "extensionRangeStart": "",
                "extensionRangeEnd": ""
            },
            {
                "prefix": "+32-02",
                "active": true,
                "extensionRangeStart": "",
                "extensionRangeEnd": ""
            }
        ]
}

Response JSON Object:

prefixes (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Prefixes attributes.

Status Codes:

200 OK – no error
404 Not Found – service is not assigned to this tenant

Assign a list of immediate trunking connectivity prefixes to a Tenant¶

POST /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/prefixes/¶

Assign a list of immediate trunking connectivity prefixes to a Tenant.

Authorization rights: minimum System Admin.

Example request:

POST /api/v1/tenant/footenant/services/immediate_trunking_connectivity/prefixes/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "prefixes":
        [
            {
                "prefix": "+32-01"
            },
            {
                "prefix": "+32-02"
            }
        ]
}

Request JSON Object:

prefixes (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Prefixes attributes.

Example response:

HTTP/1.1 201 CREATED
Content-Type: "application/json"

{}

Status Codes:

201 Created – no error.
400 Bad Request – bad request due to invalid parameters
404 Not Found – service is not assigned to this tenant

Display tenant’s immediate trunking connectivity available prefixes¶

GET /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/available_prefixes/¶

Retrieve the list of available prefixes of the immediate trunking connectivity service of the tenant. It means the prefixes not yet assigned to a Group or a User.

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/foo/services/immediate_trunking_connectivity/available_prefixes/ HTTP/1.1
Host: example.com

Example response:

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

{
     "available_prefixes":
        [
            {
                "prefix": "+32-01",
                "active": true,
                "extensionRangeStart": "",
                "extensionRangeEnd": ""
            },
            {
                "prefix": "+32-02",
                "active": true,
                "extensionRangeStart": "",
                "extensionRangeEnd": ""
            }
        ]
}

Response JSON Object:

available_prefixes (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Prefixes attributes.

Status Codes:

200 OK – no error
404 Not Found – service is not assigned to this tenant

Remove a list of immediate trunking connectivity prefixes from a Tenant¶

DELETE /api/v1/tenant/(string: tenant_id)/services/immediate_trunking_connectivity/prefixes/¶

Remove a list of immediate trunking connectivity prefixes from a Tenant.

Authorization rights: minimum System Admin.

Example request:

DELETE /api/v1/tenant/footenant/services/immediate_trunking_connectivity/prefixes/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "prefixes":
        [
            {
                "prefix": "+32-01"
            },
            {
                "prefix": "+32-02"
            }
        ]
}

Request JSON Object:

prefixes (array) – A list of number ranges objects as defined as Immediate Trunking Connectivity Prefixes attributes.

Example response:

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

{}

Status Codes:

200 OK – no error.
400 Bad Request – bad request due to invalid parameters
404 Not Found – service is not assigned to this tenant