Group Immediate Trunking Connectivity¶

Display group’s immediate trunking connectivity numbers¶

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

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

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/services/immediate_trunking_connectivity/numbers/ HTTP/1.1
Host: example.com

Example response:

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

{
     "numbers":
          [
              {
                  "minPhoneNumber": "+3226127000",
                  "maxPhoneNumber": "+3226127002",
                  "groupId": "ApioGrpTest",
                  "userId": "ApioUserTest@sip.netaxis.be",
                  "lastName": "Test",
                  "firstName": "Test",
                  "phoneNumber": "",
                  "extension": "4000",
                  "department": {
                      "tenantId": "ApioSpTest",
                      "groupId": "ApioGrpTest",
                      "departmentName": "test_department_initial",
                      "fullPathName": "test_department_parent_1 \\ test_department_initial"
                  },
                  "emailAddress": "test_mail@test.netaxis.be",
                  "enterpriseTrunk": "",
                  "active": true,
                  "extensionLength": ""
              },
              {
                  "minPhoneNumber": "+3226127007",
                  "maxPhoneNumber": "+3226127009",
                  "groupId": "ApioGrpTest",
                  "userId": "",
                  "lastName": "",
                  "firstName": "",
                  "phoneNumber": "",
                  "extension": "",
                  "emailAddress": "",
                  "enterpriseTrunk": "",
                  "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
400 Bad Request –
invalid data due to bad parameters, with possible sub-error codes:
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

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

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

Assign a list of immediate trunking connectivity numbers to a Group.

Authorization rights: minimum Tenant Admin.

Example request:

POST /api/v1/tenant/footenant/group/foogroup/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 –
invalid data due to bad parameters, with possible sub-error codes:
- 19: NOT_AVAILABLE_FOR_ASSIGNMENT, “The number range provided is not available to the groups of this Tenant.”
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

Display group’s immediate trunking connectivity available numbers¶

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

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

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/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": "+3226127000",
                  "maxPhoneNumber": "+3226127002",
                  "active": true,
                  "extensionLength": ""
              }
          ]
}

Response JSON Object:

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

Status Codes:

200 OK – no error
400 Bad Request –
invalid data due to bad parameters, with possible sub-error codes:
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

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

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

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

Authorization rights: minimum Tenant Admin.

Example request:

DELETE /api/v1/tenant/footenant/group/foogroup/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 –
invalid data due to bad parameters, with possible sub-error codes:
- 19: NOT_AVAILABLE_FOR_ASSIGNMENT, “The number range provided is not available to the groups of this Tenant.”
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

Display group’s immediate trunking connectivity prefixes¶

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

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

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/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",
                "groupId": "ApioGrpTest",
                "userId": "ApioUserTest@sip.netaxis.be",
                "lastName": "Test",
                "firstName": "Test",
                "phoneNumber": "",
                "extension": "4000",
                "department": {
                    "tenantId": "ApioSpTest",
                    "groupId": "ApioGrpTest",
                    "departmentName": "test_department_initial",
                    "fullPathName": "test_department_parent_1 \\ test_department_initial"
                },
                "emailAddress": "test_mail@test.netaxis.be",
                "enterpriseTrunk": "",
                "active": true,
                "extensionRangeStart": "",
                "extensionRangeEnd": ""
            },
            {
                "prefix": "+32-02",
                "groupId": "ApioGrpTest",
                "userId": "",
                "lastName": "",
                "firstName": "",
                "phoneNumber": "",
                "extension": "",
                "emailAddress": "",
                "enterpriseTrunk": "",
                "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
400 Bad Request –
invalid data due to bad parameters, with possible sub-error codes:
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

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

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

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

Authorization rights: minimum Tenant Admin.

Example request:

POST /api/v1/tenant/footenant/group/foogroup/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:

numbers (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 –
invalid data due to bad parameters, with possible sub-error codes:
- 19: NOT_AVAILABLE_FOR_ASSIGNMENT, “The prefix provided is not available to the groups of this Tenant.”
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

Display group’s immediate trunking connectivity available prefixes¶

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

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

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenant/footenant/group/foogroup/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": ""
            }
        ]
}

Response JSON Object:

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

Status Codes:

200 OK – no error
400 Bad Request –
invalid data due to bad parameters, with possible sub-error codes:
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group

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

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

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

Authorization rights: minimum Tenant Admin.

Example request:

DELETE /api/v1/tenant/footenant/group/foogroup/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 –
invalid data due to bad parameters, with possible sub-error codes:
- 19: NOT_AVAILABLE_FOR_ASSIGNMENT, “The prefix provided is not available to the groups of this Tenant.”
- 46: NOT_AVAILABLE_IN_ENTERPRISE_MODE, “This API is not available in Enterprise Mode.”
404 Not Found – service is not assigned to this group