Personal Phone List Services¶
Create a user’s personal phone list entry¶
-
POST
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
¶ The API is mapped to UserPersonalPhoneListAddListRequest
Additional restrictions
- Request JSON Object:
entries (array) – See Phone List attributes.
Display user’s personal phone list entries¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
¶ The API is mapped to UserPersonalPhoneListGetListRequest
When paging is used, the API is used is UserPersonalPhoneListGetPagedSortedListRequest (from rel22 with some patches).
Additional informations
- Response JSON Object:
responseSizeLimit (integer) – See responseSizeLimit from Search criteria.
Delete a user’s personal phone list entries¶
-
DELETE
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
¶ The API is mapped to UserPersonalPhoneListDeleteListRequest
Additional restrictions
- Request JSON Object:
entries (array) – See Phone List attributes.
Retrieve a user’s personal phone list entry¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
(string: personal_phone_name)/
¶ The API is mapped to UserPersonalPhoneListGetInstanceRequest
Additional informations
Virtual class not supported by Broadsoft.
Update a user’s personal phone list entry¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
(string: personal_phone_name)/
¶ The API is mapped to UserPersonalPhoneListModifyRequest
Additional restrictions
- Request JSON Object:
name (string) – See name from Phone List attributes.
phoneNumber (string) – See phoneNumber from Phone List attributes.
Delete a user’s personal phone list entry¶
-
DELETE
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/personal_phone_list/
(string: personal_phone_name)/
¶ The API is mapped to UserPersonalPhoneListDeleteRequest
Additional informations
Virtual class not supported by Broadsoft.
Additional restrictions
- Request JSON Object:
name (string) – See name from Phone List attributes.