Alternate Numbers Services¶
Display user’s Alternate Numbers¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/alternate_numbers/
¶ The API is mapped to UserAlternateNumbersGetRequest17
Additional information
- Response JSON Object:
distinctiveRing (boolean) – determines if the ring should be different when the calls are to alternate phone numbers.
alternateNumbers (array) – a list of alternate numbers as defined as Alternate Numbers attributes. Limit to 10 entries.
Update a user’s Alternate Numbers¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/alternate_numbers/
¶ The API is mapped to UserAlternateNumbersModifyRequest
Additional restrictions
- Request JSON Object:
distinctiveRing (boolean) – determines if the ring should be different when the calls are to alternate phone numbers.
alternateNumbers (array) – a list of alternate numbers as defined as Alternate Numbers attributes. Limit to 10 entries.
Alternate Numbers attributes¶
Name |
Type |
Methods |
Description |
|
---|---|---|---|---|
GET |
PUT |
|||
id |
String |
A |
R |
The ID of the entry |
phoneNumber |
String |
A |
R |
The user’s phone number (if configured, empty or absent otherwise) (see Phone Number) |
extension |
String |
A |
O |
The user extension. (see Extension) |
ringPattern |
String |
A |
O |
The ring pattern for each phone number. One of {‘Normal’|’Long-Long’|’Short-Short-Long’|’Short-Long-Short’} |
delete |
Boolean |
F |
O |
If set it will delete the entry |