Anywhere Reachability

Display user’s anywhere reachability

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

Retrieve the settings of the Anywhere service of the user. This service allow the user to be reached on different “devices” not necessarily managed by the appplication server (such a mobile phone, private fixed line, …).

Example request:

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

Example response:

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

{
     "alertAllLocationsForClickToDialCalls": true,
     "alertAllLocationsForGroupPagingCalls": true,
     "phoneNumbers": [
          {
               "active": true,
               "phoneNumber": "+3225126777",
               "description": "test_phone_number",
               "answerConfirmationRequired": false,
               "callControl": false,
               "useDiversionInhibitor": false,
               "criteria": [
                    {
                         "name": "test_criteria",
                         "timeSchedule": {
                              "level": "User",
                              "name": "Every Friday"
                         },
                         "holidaySchedule": {
                              "level": "User",
                              "name": "Every Easter"
                         },
                         "fromDnCriteria": {
                              "selection": "Specified Only",
                              "phoneNumbers": ["+3225126787"]
                         }
                    }
               ]
          }
     ]
}

Response JSON Object:

• alertAllLocationsForClickToDialCalls (boolean) – if set, the service will enable all locations for click-to-dial calls.

• alertAllLocationsForGroupPagingCalls (boolean) – if set, the service will enable all locations for group paging calls.

• phoneNumbers (array) – a list of phone number objects as defined as Phone Number Attributes.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

Update a user’s anywhere reachability

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

Update the settings of the Anywhere service of the user.

Example request:

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

{
     "alertAllLocationsForClickToDialCalls": true,
     "alertAllLocationsForGroupPagingCalls": true,
     "phoneNumbers": [
          {
               "active": true,
               "phoneNumber": "+3225126777",
               "description": "test_phone_number",
               "answerConfirmationRequired": false,
               "callControl": false,
               "useDiversionInhibitor": false,
               "criteria": [
                    {
                         "name": "test_criteria",
                         "newName": "new_test_criteria",
                         "timeSchedule": {
                              "level": "User",
                              "name": "Every Friday"
                         },
                         "fromDnCriteria": {
                              "selection": "Specified Only",
                              "phoneNumbers": ["+3225126787"]
                         }
                    },
                    {
                         "name": "new_test_criteria",
                         "delete": true
                    }
               ]
          },
          {
               "phoneNumber": "+322356554",
               "delete": true
          }
     ]
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

• alertAllLocationsForClickToDialCalls (boolean) – if set, the service will enable all locations for click-to-dial calls.

• alertAllLocationsForGroupPagingCalls (boolean) – if set, the service will enable all locations for group paging calls.

• phoneNumbers (array) – a list of phone number objects as defined as Phone Number 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 check the body for more information). The following error code could be returned specifically:

  • 11 (ALREADY_EXISTS) : One of the number asked to be used is already used by an other user in his Anywhere service.

Phone Number Attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
phoneNumber	String	A	R	R	R	The phone number (if configured, empty or absent otherwise) (See Phone Number).
newPhoneNumber	String	F	F	O	F	The new phone number. Only update.
active	Boolean	A	O	O	F	The status of the phone number.
description	String	A	O	O	F	A description to understand, at a glance, why you have specified this phone number.
outboundAlternateNumber	String	A	O	O	F	Is used when an alternate number needs to be dialed to reach the service location.
callControl	Boolean	A	O	O	F	This attribute determines whether call control is to be performed.
useDiversionInhibitor	Boolean	A	O	O	F	This attribute enables a diversion inhibitor when extending a call leg.
answerConfirmationRequired	Boolean	A	O	O	F	This attribute determines if the Application Server needs to prompt for an answer confirmation.
criteria	Array	A	O	O	F	A list of criteria objects as in Criteria in List attributes (GET) and Criteria attributes.