Polycom Phone Services for User Main Phone¶
The Polycom Phone Services offers the possibility to configure additional intergation of the phone with the AS concerning the contacts directories.
Retrieve the configuration¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/access_device/polycom_services/
¶ Retrieve the Polycom phone services configuration of the End User on his Main Device.
Authorization Right: minimum Group Admin.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/users/foouser/access_device/polycom_services/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "integratePhoneDirectory": true, "includeUserPersonalPhoneList": true, "includeGroupCustomContactDirectory": true, "groupCustomContactName" : "OurContacts" }
- Response JSON Object:
integratePhoneDirectory (boolean) – Phone directory service activated. If disabled, all the other partameters will be irrelevant at run-time level.
includeUserPersonalPhoneList (boolean) – Include the personal contact list of the ned user in the directory.
includeGroupCustomContactDirectory (boolean) – Include the Group Custom Directory referenced by groupCustomContactName in the directory (at most one).
groupCustomContactName (string) – Name of the Group Custom Directory to be included if any.
- Status Codes:
200 OK – no error
404 Not Found – the user has no phone linked to him. Or the user is not the primary line of the user.
Update the configuration¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/access_device/polycom_services/
¶ Update the Polycom phone services configuration of the End User on his Main Device.
Authorization Right: minimum Group Admin.
Example request:
PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/access_device/polycom_services/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "integratePhoneDirectory": true, "includeUserPersonalPhoneList": false, "includeGroupCustomContactDirectory": true, "groupCustomContactName" : "OurContacts" }
- Request JSON Object:
integratePhoneDirectory (boolean) – (Optional) Phone directory service activated. If disabled, all the other partameters will be irrelevant at run-time level.
includeUserPersonalPhoneList (boolean) – (Optional) Include the personal contact list of the ned user in the directory.
includeGroupCustomContactDirectory (boolean) – (Optional) Include the Group Custom Directory referenced by groupCustomContactName in the directory (at most one).
groupCustomContactName (string) – (Optional) Name of the Group Custom Directory to be included if any. Empty string to remove the reference.
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "integratePhoneDirectory": true, "includeUserPersonalPhoneList": false, "includeGroupCustomContactDirectory": true, "groupCustomContactName" : "OurContacts" }
- Response JSON Object:
integratePhoneDirectory (boolean) – Phone directory service activated. If disabled, all the other partameters will be irrelevant at run-time level.
includeUserPersonalPhoneList (boolean) – Include the personal contact list of the ned user in the directory.
includeGroupCustomContactDirectory (boolean) – Include the Group Custom Directory referenced by groupCustomContactName in the directory (at most one).
groupCustomContactName (string) – (Name of the Group Custom Directory to be included if any.
- Status Codes:
200 OK – no error
404 Not Found – the user has no phone linked to him. Or the user is not the primary line of the user.
various errors due to input data or status in the AS. Among others:
2: INVALID_PARAMETERS, “The Group Custom Contact is not found”