User Immediate Trunking Connectivity

Display user’s immediate trunking connectivity

GET /api/v1/tenant/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/immediate_trunking_connectivity/

Retrieve the settings of the Immediate Trunking Connectivity service of the user.

Example request:

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

Example response:

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

{
    "treatOriginationsAndPBXRedirectionsAsScreened": true,
    "useImmediateTrunkingConnectivityIdentityForNonEmergencyCalls": true,
    "useImmediateTrunkingConnectivityIdentityForEmergencyCalls": true,
    "numbers":
    [
        {
            "minPhoneNumber": "+3226127000",
            "maxPhoneNumber": "+3226127002",
            "active": true,
            "extensionLength": ""
        }
    ],
    "prefixes":
    [
        {
            "prefix": "+32-01",
            "active": true,
            "extensionRangeStart": "",
            "extensionRangeEnd": ""
        }
    ]
}
Response JSON Object:

  • treatOriginationsAndPBXRedirectionsAsScreened (boolean) – Specify if to treat call originations and PBX redirections from numbers within the ranges assigned.

  • useImmediateTrunkingConnectivityIdentityForNonEmergencyCalls (boolean) – Specify if to use the phone numbers in the number ranges assigned for non-emergency calls.

  • useImmediateTrunkingConnectivityIdentityForEmergencyCalls (boolean) – Specify if to use the phone numbers in the enterprise trunk number ranges assigned for emergency calls.

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

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

Status Codes:

Update a user’s immediate trunking connectivity

PUT /api/v1/tenant/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/immediate_trunking_connectivity/

Update the settings of the Immediate Trunking Connectivity service of the user.

Example request:

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

{
    "treatOriginationsAndPBXRedirectionsAsScreened": true,
    "useImmediateTrunkingConnectivityIdentityForNonEmergencyCalls": true,
    "useImmediateTrunkingConnectivityIdentityForEmergencyCalls": true,
    "numbers":
    [
        {
            "minPhoneNumber": "+3226127000",
            "maxPhoneNumber": "+3226127002",
            "active": true,
        }
    ],
    "prefixes":
    [
        {
            "prefix": "+32-01",
            "active": true,
        }
    ]
}
Request JSON Object:

  • treatOriginationsAndPBXRedirectionsAsScreened (boolean) – Specify if to treat call originations and PBX redirections from numbers within the ranges assigned.

  • useImmediateTrunkingConnectivityIdentityForNonEmergencyCalls (boolean) – Specify if to use the phone numbers in the number ranges assigned for non-emergency calls.

  • useImmediateTrunkingConnectivityIdentityForEmergencyCalls (boolean) – Specify if to use the phone numbers in the enterprise trunk number ranges assigned for emergency calls.

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

  • prefixes (array) – A replacement list of prefix objects as defined as Immediate Trunking Connectivity Prefixes attributes.

Example response:

HTTP/1.1 200 OK
Status Codes:

Display users’s immediate trunking connectivity available numbers

GET /api/v1/tenant/(string: tenant_id)/group/(string: group_id)/user/(string: user_id)/services/immediate_trunking_connectivity/available_numbers/

Retrieve the list of available numbers of the immediate trunking connectivity service of the user.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/user/foouser/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
              }
          ]
}
Response JSON Object:
Status Codes:

Display user’s immediate trunking connectivity available prefixes

GET /api/v1/tenant/(string: tenant_id)/group/(string: group_id)/user/(string: user_id)/services/immediate_trunking_connectivity/available_prefixes/

Retrieve the list of available prefixes of the immediate trunking connectivity service of the user.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/user/foouser/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
            },
            {
                "prefix": "+32-02",
                "active": true
            }
        ]
}
Response JSON Object:
Status Codes: