Tenant Virtual On Net Extensions

List all virtual users in an Enterprise

GET /api/v1/tenants/(string: tenant_id)/services/virtual_users/

List all virtual users in an Enterprise.

It must be noted that the virtual users are created at Group level, this end point provides only a global view.

Example request:

GET /api/v1/tenants/footenant/services/virtual_users/ HTTP/1.1
Host: example.com

{
   "sensitiveDeviceNameContains": "Test"
}

Request JSON Object:

• 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.

• sensitiveGroupLocationCodeStarts (string) – See sensitiveGroupLocationCodeStarts from Search criteria.

• sensitiveGroupLocationCodeContains (string) – See sensitiveGroupLocationCodeContains from Search criteria.

• sensitiveGroupLocationCodeEquals (string) – See sensitiveGroupLocationCodeEquals from Search criteria.

• insensitiveGroupLocationCodeStarts (string) – See insensitiveGroupLocationCodeStarts from Search criteria.

• insensitiveGroupLocationCodeContains (string) – See insensitiveGroupLocationCodeContains from Search criteria.

• insensitiveGroupLocationCodeEquals (string) – See insensitiveGroupLocationCodeEquals from Search criteria.

• phoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.

• phoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.

• phoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.

• extensionStarts (string) – See insensitiveExtensionStarts from Search criteria.

• extensionContains (string) – See insensitiveExtensionContains from Search criteria.

• extensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

• callTypeEquals (string) – See sensitiveCallTypeEquals from Search criteria.

• responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

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

{
      "users": [
                  {
                      "groupId": "ApioEntGrpTest",
                      "lastName": "testVE",
                      "firstName": "testVE",
                      "phoneNumber": "+3271777555",
                      "extension": "7555",
                      "callType": "default"
                  }
      ]
}

Response JSON Object:

• users (array) – a list of objects as defined as Tenant virtual on net user in get list attributes.

Status Codes:

• 200 OK – no error

• 400 Bad Request – bad request due to invalid parameters or NOT_AVAILABLE_IN_SP_MODE error.