Tenant Trunking Users¶

Display tenant’s trunking assigned users list¶

GET /api/v1/tenants/(string: tenant_id)/services/trunk_users/(string: instance_name)/¶

Get the details about the list of the users assigned to a trunk group.

Example request:

GET /api/v1/tenants/foo/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com

Example response:

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

{
   "users": [
      {
          "userId": "ApioTrunkGroupUser_1",
          "groupId": "ApioEntGrpTest",
          "lastName": "Last_ApioTrunkGroupUser_1",
          "firstName": "First_ApioTrunkGroupUser_1",
          "phoneNumber": "",
          "alternateTrunkIdentity": "",
          "extension": "",
          "department": "",
          "emailAddress": ""
      },
      {
          "userId": "ApioTrunkGroupUser_2",
          "groupId": "ApioEntGrpTest",
          "lastName": "Last_ApioTrunkGroupUser_2",
          "firstName": "First_ApioTrunkGroupUser_2",
          "phoneNumber": "",
          "alternateTrunkIdentity": "",
          "extension": "",
          "department": "",
          "emailAddress": ""
      }
   ]
}

Response JSON Object:

users (array) – a list of objects as defined in Tenant Trunking User List Entry.

Status Codes:

200 OK – no error

Retrieve the list of the users assigned to a trunk group with search criteria.

Example request:

GET /api/v1/tenants/foo/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com

{
   "insensitiveUserIdStarts": "ApioTrunk",
   "insensitiveUserLastNameContains": "1",
}

Request JSON Object:

sensitiveGroupIdStarts (string) – See sensitiveGroupIdStarts from Search criteria.
sensitiveGroupIdContains (string) – See sensitiveGroupIdContains from Search criteria.
sensitiveGroupIdEquals (string) – See sensitiveGroupIdEquals from Search criteria.
insensitiveGroupIdStarts (string) – See insensitiveGroupIdStarts from Search criteria.
insensitiveGroupIdContains (string) – See insensitiveGroupIdContains from Search criteria.
insensitiveGroupIdEquals (string) – See insensitiveGroupIdEquals from Search criteria.
sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.
sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.
sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.
insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.
insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.
insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.
sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.
sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.
sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.
insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.
insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.
insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.
sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.
sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.
sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.
insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.
insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.
insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.
insensitivePhoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.
insensitivePhoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.
insensitivePhoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.
sensitiveAlternateTrunkIdentityStarts (string) – See sensitiveAlternateTrunkIdentityStarts from Search criteria.
sensitiveAlternateTrunkIdentityContains (string) – See sensitiveAlternateTrunkIdentityContains from Search criteria.
sensitiveAlternateTrunkIdentityEquals (string) – See sensitiveAlternateTrunkIdentityEquals from Search criteria.
insensitiveAlternateTrunkIdentityStarts (string) – See insensitiveAlternateTrunkIdentityStarts from Search criteria.
insensitiveAlternateTrunkIdentityContains (string) – See insensitiveAlternateTrunkIdentityContains from Search criteria.
insensitiveAlternateTrunkIdentityEquals (string) – See insensitiveAlternateTrunkIdentityEquals from Search criteria.
sensitiveEmailAddressStarts (string) – See sensitiveEmailAddressStarts from Search criteria.
sensitiveEmailAddressContains (string) – See sensitiveEmailAddressContains from Search criteria.
sensitiveEmailAddressEquals (string) – See sensitiveEmailAddressEquals from Search criteria.
insensitiveEmailAddressStarts (string) – See insensitiveEmailAddressStarts from Search criteria.
insensitiveEmailAddressContains (string) – See insensitiveEmailAddressContains from Search criteria.
insensitiveEmailAddressEquals (string) – See insensitiveEmailAddressEquals from Search criteria.
insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.
insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.
insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.
responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

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

{
   "users": [
      {
         "userId": "ApioTrunkGroupUser_1",
         "groupId": "ApioEntGrpTest",
         "lastName": "Last_ApioTrunkGroupUser_1",
         "firstName": "First_ApioTrunkGroupUser_1",
         "phoneNumber": "",
         "alternateTrunkIdentity": "",
         "extension": "",
         "department": "",
         "emailAddress": ""
      }
}

Status Codes:

200 OK – no error

Assign users list to tenant’s trunking¶

POST /api/v1/tenants/(string: tenant_id)/services/trunk_users/(string: instance_name)/¶

Assign a list of users to the trunk group.

Example request:

POST /api/v1/tenants/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "users": [
      "ApioTrunkGroupUser_1",
      "ApioTrunkGroupUser_2"
   ]
}

Request JSON Object:

users (array) – (required) the list of users (IDs) to be assigned to a trunk group.

Response:

Similar to GET instance method response.

Status Codes:

201 Created – no error
207 Multi Status – partial success (some trunk users are assigned, others not)
400 Bad Request – full error

Move users list to another tenant’s trunking¶

POST /api/v1/tenants/(string: tenant_id)/services/trunk_users/(string: instance_name)/¶

Move a list of users to a specified trunk group.

Example request:

POST /api/v1/tenants/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "migrateUsers": [
      "+3221234567@sip.netaxis.be",
      "+3241234567@sip.netaxis.be"
   ]
}

Request JSON Object:

migrateUsers (array) – (required) the list of users (IDs) to be moved to this tenant trunk.

Example response:

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

{
   "result": [
      {"userId": "+3221234567@sip.netaxis.be", "status": "migrated"},
      {"userId": "+3241234567@sip.netaxis.be", "status": "failed"}

   ]
}

Status Codes:

201 Created – no error
207 Multi Status – partial success (some trunk users are moved, other not)
400 Bad Request – full error

Move numbers list to another tenant’s trunking¶

POST /api/v1/tenants/(string: tenant_id)/services/trunk_users/(string: instance_name)/¶

Move a list of numbers to a specified trunk group.

Example request:

POST /api/v1/tenants/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "migrateNumbers": [
      "+3228001101",
      "+3241234567"
   ]
}

Request JSON Object:

migrateNumbers (array) – (required) the list of numbers to be moved to this tenant trunk.

Example response:

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

{
   "result": [
      {"phoneNumber": "+3228001101", "status": "migrated"},
      {"phoneNumber": "+3241234567", "status": "failed"}

   ]
}

Status Codes:

201 Created – no error
207 Multi Status – partial success (some trunk users are moved, other not)
400 Bad Request – full error

Unassign users list to tenant’s trunking¶

DELETE /api/v1/tenants/(string: tenant_id)/services/trunk_users/(string: instance_name)/¶

Unassign a list of users to the trunk group.

Example request:

DELETE /api/v1/tenants/services/trunk_users/footrunkgroup/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "users": [
      "ApioTrunkGroupUser_1"
   ]
}

Request JSON Object:

users (array) – (required) the list of users (IDs) to be assigned to a trunk group.

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
400 Bad Request – full error

Retrieves tenant’s trunking available trunk user list¶

GET /api/v1/tenants/(string: tenant_id)/services/trunk_groups/available/users/¶

Retrieves the list of tenant’s available users.

Example request:

GET /api/v1/tenants/foo/services/trunk_groups/available/users/ HTTP/1.1
Host: example.com

Response JSON Object:

responseSizeLimit (integer) – See responseSizeLimit from Search criteria.
sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.
sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.
sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.
insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.
insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.
insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.
sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.
sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.
sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.
insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.
insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.
insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.
sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.
sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.
sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.
insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.
insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.
insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.
insensitivePhoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.
insensitivePhoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.
insensitivePhoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.
sensitiveGroupIdStarts (string) – See sensitiveGroupIdStarts from Search criteria.
sensitiveGroupIdContains (string) – See sensitiveGroupIdContains from Search criteria.
sensitiveGroupIdEquals (string) – See sensitiveGroupIdEquals from Search criteria.
insensitiveGroupIdStarts (string) – See insensitiveGroupIdStarts from Search criteria.
insensitiveGroupIdContains (string) – See insensitiveGroupIdContains from Search criteria.
insensitiveGroupIdEquals (string) – See insensitiveGroupIdEquals from Search criteria.
sensitiveAlternateTrunkIdentityStarts (string) – See sensitiveAlternateTrunkIdentityStarts from Search criteria.
sensitiveAlternateTrunkIdentityContains (string) – See sensitiveAlternateTrunkIdentityContains from Search criteria.
sensitiveAlternateTrunkIdentityEquals (string) – See sensitiveAlternateTrunkIdentityEquals from Search criteria.
insensitiveAlternateTrunkIdentityStarts (string) – See insensitiveAlternateTrunkIdentityStarts from Search criteria.
insensitiveAlternateTrunkIdentityContains (string) – See insensitiveAlternateTrunkIdentityContains from Search criteria.
insensitiveAlternateTrunkIdentityEquals (string) – See insensitiveAlternateTrunkIdentityEquals from Search criteria.
sensitiveAlternateTrunkIdentityDomainStarts (string) – See sensitiveAlternateTrunkIdentityDomainStarts from Search criteria.
sensitiveAlternateTrunkIdentityDomainContains (string) – See sensitiveAlternateTrunkIdentityDomainContains from Search criteria.
sensitiveAlternateTrunkIdentityDomainEquals (string) – See sensitiveAlternateTrunkIdentityDomainEquals from Search criteria.
insensitiveAlternateTrunkIdentityDomainStarts (string) – See insensitiveAlternateTrunkIdentityDomainStarts from Search criteria.
insensitiveAlternateTrunkIdentityDomainContains (string) – See insensitiveAlternateTrunkIdentityDomainContains from Search criteria.
insensitiveAlternateTrunkIdentityDomainEquals (string) – See insensitiveAlternateTrunkIdentityDomainEquals from Search criteria.
insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.
insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.
insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

Example response:

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

{
   "users": [
      {
         "userId": "+3228001101",
         "lastName": "3228001101",
         "firstName": "3228001101",
         "phoneNumber": "+3228001101",
         "extension": "",
         "emailAddress": ""
      },
      {
         "userId": "3228001100@sip.netaxis.be",
         "lastName": "3228001100",
         "firstName": "3228001100",
         "phoneNumber": "+3228001100",
         "extension": "",
         "emailAddress": ""
      }
   ]
}

Response JSON Object:

users (array) – a list of objects as defined in Tenant Trunking Available User List Entry.

Status Codes:

200 OK – no error

Tenant Trunking User List Entry¶

Name	Type	Method	Description
Name	Type	GET	Description
userId	String	A	The unique user Id
groupId	String	A	The unique group Id
firstName	String	A	The user first name. (see First / Last name)
lastName	String	A	The user last name. (see First / Last name)
alternateTrunkIdentity	String	A	The alternate trunk identity
department	Object	A	The department the user belongs to
phoneNumber	String	A	The user’s phone number (see Phone Number)
extension	String	A	The user extension. (see Extension)
emailAddress	String	A	The user email address

Tenant Trunking Available User List Entry¶

Name	Type	Method	Description
Name	Type	GET	Description
userId	String	A	The unique user Id.
firstName	String	A	The user first name. (see First / Last name)
lastName	String	A	The user last name. (see First / Last name)
phoneNumber	String	A	The user’s phone number (see Phone Number)
extension	String	A	The user extension. (see Extension)
department	Object	C	An object as defined as Tenant department key attributes.
emailAddress	String	A	The user email address.