Shared Call Appearance¶
Display user’s shared call appearance¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/
¶ The API is mapped to UserSharedCallAppearanceGetRequest16sp2
Update a user’s shared call appearance¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/
¶ The API is mapped to UserSharedCallAppearanceModifyRequest
Additional restrictions
- Request JSON Object:
bridgeWarningTone (string) – (Optional) the tone to alert all the users on a call that the call has been bridged. One of “None”, “Barge-In”, or “Barge-In and Repeat”
Display user’s shared call appearance endpoint¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/endpoint/
¶ The API is mapped to UserSharedCallAppearanceGetEndpointRequest
Additional information
- Response JSON Object:
endpoint (boolean) – see Endpoint Attributes.
Assign a user’s shared call appearance endpoint¶
-
POST
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/endpoint/
¶ The API is mapped to UserSharedCallAppearanceAddEndpointRequest14sp2
Additional restrictions
- Request JSON Object:
endpoint (boolean) – see Endpoint Attributes.
Update a user’s shared call appearance endpoint¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/endpoint
¶ The API is mapped to UserSharedCallAppearanceModifyEndpointRequest
Additional restrictions
- Request JSON Object:
endpoint (boolean) – see Endpoint Attributes.
Disassign a user’s shared call appearance endpoint¶
-
DELETE
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/shared_call_appearance/
¶ The API is mapped to UserSharedCallAppearanceDeleteEndpointListRequest14
Additional restrictions
- Request JSON Object:
name (string) – a list of endpoint objects as defined as Endpoint Attributes.
Endpoint Attributes¶
Name |
Type |
Methods |
Description |
|||
---|---|---|---|---|---|---|
GET |
POST |
PUT |
DELETE |
|||
accessDevice |
Object |
A |
R |
R |
R |
An object as defined in Access Device. |
linePort |
String |
A |
R |
R |
R |
Identifies a device endpoint in standalone mode. Must be a valid SIP URI. |
contact |
Array |
A |
O |
O |
O |
A contact. |
lineNumber |
Integer |
A |
O |
O |
O |
Access Device Port number value. Between 1 and 1024. |
Access Device¶
Name |
Type |
Methods |
Description |
|||
---|---|---|---|---|---|---|
GET |
POST |
PUT |
DELETE |
|||
name |
String |
A |
R |
R |
R |
The name. |
level |
String |
A |
R |
R |
R |
The level. One of “System”, “Service Provider”, or “Group” |
type |
String |
F |
O |
O |
O |
The type. |
management |
Boolean |
F |
O |
O |
O |
If is of management. |