McDewey

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

Page 55

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

The URI for this API contains two query parameters: • type: (optional) Set the type to return voice or nonvoice dialogs for a user. You can include both types to return all dialogs for a user (type=voice&type=non-voice). If you do not include the type query parameter, only voice dialogs are returned. • media: (optional) Use this parameter to filter nonvoice dialog results by a specific media id. This parameter is only applicable when the "type=non-voice" query parameter is used. https://<FQDN>/finesse/api/User/<id>/Dialogs?type={voice|non-voice}&media={id} URI: https://finesse1.xyz.com/finesse/api/User/1234/Dialogs Example URI: Agents can only get a list of their own dialogs, supervisors can get a list of dialogs associated to the agents in their teams, and administrators can get a list of dialogs associated with any user. To get a list of dialogs, a user must be signed in or provide valid authorization credentials when challenged. Security Constraints: GET HTTP Method: — Content Type: XML Input/Output Format: — HTTP Request: 200: Success 401: Authorization Failure 500: Internal Server Error 503: Service Unavailable HTTP Response: <Dialogs> <Dialog> ... Full Dialog Object ... </Dialog> <Dialog> ... Full Dialog Object ... </Dialog> <Dialog> ... Full Dialog Object ... </Dialog> <Dialog> ... Full Dialog Object ... </Dialog> <Dialog> ... Full Dialog Object ... </Dialog> ... Additional Dialogs... </Dialogs> Example Response: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 39 Cisco Finesse Desktop APIs User—Get List of Dialogs (Voice Only by Default)