Receptionist Enterprise Service¶

The Receptionist Enterprise is the large flavor of the Receptionist Services. The limit of end users monitored is defined at System level (see Receptionist Capacity) with a maximum value of 1000. 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_enterprise/¶

Retrieve the list of monitored users.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/receptionist_enterprise/ 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:

monitoredUsers (list) – a list of monitored users as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update the list of monitored users¶

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

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_enterprise/ 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:

monitoredUsers (list) – the new list of monitored users as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Add users to the monitored users¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_enterprise/¶

Incremental addition of end users to the list of monitored users.

Authorization rights: minimum End User.

Example request:

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

{
    "monitoredUserIds": [
        "ApioUserTest2@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"
         },
         {
             "userId": "ApioUserTest2@sip.netaxis.be",
             "firstName": "Test",
             "lastName": "User2",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         }
     ]
}

Request JSON Object:

monitoredUserIds (array) – the list of additional user IDs to be monitored.

Response JSON Object:

monitoredUsers (list) – the new list of monitored users as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Remove users from the monitored users¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_enterprise/¶

Removal of some end users from the list of monitored users.

Authorization rights: minimum End User.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/receptionist_enterprise/ 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": "ApioUserTest2@sip.netaxis.be",
             "firstName": "Test",
             "lastName": "User2",
             "extension": "",
             "phoneNumber": "",
             "mobileNumber": "",
             "emailAddress": "",
             "impId": "",
             "title": "",
             "groupId": "foogroup"
         }
     ]
}

Request JSON Object:

monitoredUserIds (array) – the list of user IDs to be removed from the monitoring list.

Response JSON Object:

monitoredUsers (list) – the new list of monitored users as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

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": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "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.
sensitiveReceptionistNoteStarts (string) – See sensitiveReceptionistNoteStarts from Search criteria.
sensitiveReceptionistNoteContains (string) – See sensitiveReceptionistNoteContains from Search criteria.
sensitiveReceptionistNoteEquals (string) – See sensitiveReceptionistNoteEquals from Search criteria.
insensitiveReceptionistNoteStarts (string) – See insensitiveReceptionistNoteStarts from Search criteria.
insensitiveReceptionistNoteContains (string) – See insensitiveReceptionistNoteContains from Search criteria.
insensitiveReceptionistNoteEquals (string) – See insensitiveReceptionistNoteEquals from Search criteria.
includeHiddenUsers (boolean) – See includeHiddenUsers from Search criteria.

Response JSON Object:

availableUsers (array) – a list of available users for monitoring as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Display the note associated to a (non-)monitored user¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_enterprise/notes/(string: target_user_id)/¶

Retrieve the note associated to a target user. Be aware that this is working also for users who are not yet (or no more) monitored.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/receptionist_enterprise/notes/ApioUserTest2@sip.netaxis.be/ HTTP/1.1
Host: example.com

Example response:

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

{
     "receptionistNote": "This is a good candidate"
}

Response JSON Object:

receptionistNote (string) – the note associated to the target user.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update the note associated to a (non-)monitored user¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/receptionist_enterprise/(string: target_user_id)/¶

Update the note associated to a target user. Be aware that this is working also for users who are not yet (or no more) monitored.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/receptionist_enterprise/notes/ApioUserTest2@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
    "receptionistNote": "This is a very good candidate"
}

Example response:

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

{
    "receptionistNote": "This is a very good candidate"
}

Request JSON Object:

receptionistNote (string) – the note to be associated to the target user.

Response JSON Object:

receptionistNote (string) – the note associated to the target user.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update