Receptionist Small Business Service

The Receptionist Small Business is the medium flavor of the Receptionist Services. It is limited to maximum 30 end users monitored. In Enterprise mode, monitored end users can be part of an other Group of the Enterprise.

Display the users part of monitored list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_sb/

Retrieve the list of monitored users.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
     "monitoredUsers": [
         {
             "userId": "ApioDummyUserTest@sip.netaxis.be",
             "firstName": "Test",
             "lastName": "Dummy",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "department": {
                  "tenantId": "foo",
                  "groupId": "foogroup",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         }
     ]
}
Response JSON Object:
Status Codes:

Update the list of monitored users

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_sb/

Update the list of monitored users. It is a full replacement operation.

Authorization rights: minimum End User.

Example request:

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

{
    "monitoredUserIds": [
        "ApioDummyUserTest@sip.netaxis.be",
        "ApioUserTest1@sip.netaxis.be",
    ]
}

Example response:

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

{
     "monitoredUsers": [
         {
             "userId": "ApioUserTest1@sip.netaxis.be",
             "firstName": "Test",
             "lastName": "User1",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "department": {
                  "tenantId": "foo",
                  "groupId": "foogroup",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         },
         {
             "userId": "ApioDummyUserTest@sip.netaxis.be",
             "firstName": "Test",
             "lastName": "Dummy",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         }
     ]
}
Request JSON Object:

  • monitoredUserIds (array) – the list of user IDs to be monitored. Empty list to delete all entries.

Response JSON Object:
Status Codes:

Retrieve the list of available users

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_sb/available_users/

Retrieve the list of available users to be used in the monitored list of the user.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/receptionist_sb/available_users/ HTTP/1.1
Host: example.com

Example response:

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

{
     "availableUsers": [
         {
             "userId": "ApioUserTest2@sip.netaxis.be",
             "firstName": "Test2",
             "lastName": "Test2",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "department": {
                  "tenantId": "foo",
                  "groupId": "foogroup",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         }
     ]
}
Request JSON Object:

  • sensitiveDepartmentEquals (object) – See sensitiveDepartmentEquals from Search criteria.

  • sensitiveUserGroupEquals (object) – See sensitiveUserGroupEquals from Search criteria.

  • sameGroupOnly (boolean) – to filter the list to the same Group only.

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

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

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

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

  • includeHiddenUsers (boolean) – See includeHiddenUsers from Search criteria.

Response JSON Object:
Status Codes: