McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 170

↗ View in doc context
page
170
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::154

200: Success 400: Bad Request (the request body is invalid) 400: Finesse API error (for example, the object does not exist, the object is stale, or violation of the DB constraint) 401: Authorization Failure 401: Invalid Authorization 404: Not Found (for example, the teamId does not exist or has been deleted) 500: Internal Server Error HTTP Response: <MediaPropertiesLayouts> <MediaPropertiesLayout> ... Full MediaPropertiesLayout Object ... </MediaPropertiesLayout> <MediaPropertiesLayout> ... Full MediaPropertiesLayout Object ... </MediaPropertiesLayout> <MediaPropertiesLayout> ... Full MediaPropertiesLayout Object ... </MediaPropertiesLayout> </MediaPropertiesLayouts> Example Response: <ApiErrors> <ApiError> <ErrorType>Authorization Failure</ErrorType> <ErrorMessage>UNAUTHORIZED</ErrorMessage> <ErrorData>1234</ErrorData> </ApiError> </ApiErrors> Example Failure Response: TeamResource—Get Phone Books This API allows an agent or supervisor to get phone books and the first associated contacts for the team, based on the defined range (1 to 6000). Contacts are retrieved from the global phone books first, followed by the team phone books, up to the maximum limit of 6000. For more information about the PhoneBook object, see PhoneBook, on page 271. https://<FQDN>/finesse/api/TeamResource/<teamId>/PhoneBooks URI: https://finesse1.xyz.com/finesse/api/TeamResource/1234/PhoneBooks Example URI: Agents and supervisors who are part of the team can use this API. To get the phone book for the team, the user must be signed in or provide valid authorization credentials. Security Constraints: "Range: objects=16000" The range of contacts to retrieve. Additional Headers: GET HTTP Method: — Content Type: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 154 Cisco Finesse Desktop APIs TeamResource—Get Phone Books