Anywhere Reachability¶
This service is mapped on the Broadsoft Anywhere service
Display user’s anywhere¶
-
GET/api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/anywhere/¶ The API is mapped to UserBroadWorksAnywhereGetRequest16sp2
- 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.
Update a user’s anywhere¶
-
PUT/api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/anywhere/¶ The API is mapped to UserBroadWorksAnywhereModifyRequest
- 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.
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. Length >= 1 |
outboundAlternateNumber |
String |
A |
O |
O |
F |
Is used when an alternate number needs to be dialed to reach the service location. Phone Number or SIP URI. |
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 defined as Criteria attributes. |