Genesys

Genesys Conversations API

The Conversations API from Genesys — 231 operation(s) for conversations.

GitHub OpenAPI

Operations 314

Showing the first 250 of 314. The full set is in the contract, and via get_provider_operations.

POST /api/v2/analytics/conversations/aggregates/query Query for conversation aggregates #
GET /api/v2/analytics/conversations/{conversationId}/details Get a conversation by id #
POST /api/v2/analytics/conversations/aggregates/jobs Query for conversation aggregates asynchronously #
GET /api/v2/analytics/conversations/aggregates/jobs/{jobId} Get status for async query for conversation aggregates #
DELETE /api/v2/analytics/conversations/aggregates/jobs/{jobId} Delete/cancel an async request for conversation aggregates #
GET /api/v2/analytics/conversations/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/conversations/activity/query Query for conversation activity observations #
POST /api/v2/analytics/conversations/details/query Query for conversation details #
GET /api/v2/analytics/conversations/details Gets multiple conversations by id #
POST /api/v2/analytics/conversations/{conversationId}/details/properties Index conversation properties #
POST /api/v2/analytics/conversations/details/jobs Query for conversation details asynchronously #
GET /api/v2/analytics/conversations/details/jobs/{jobId} Get status for async query for conversation details #
DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Delete/cancel an async details job #
GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Fetch a page of results for an async details job #
GET /api/v2/analytics/conversations/details/jobs/availability Lookup the datalake availability date and time #
POST /api/v2/conversations/{conversationId}/cobrowse Creates a cobrowse session. #
GET /api/v2/conversations/keyconfigurations/{keyconfigurationsId} Get the encryption key configurations #
PUT /api/v2/conversations/keyconfigurations/{keyconfigurationsId} Update the encryption key configurations #
GET /api/v2/conversations/keyconfigurations Get a list of key configurations data #
POST /api/v2/conversations/keyconfigurations Setup configurations for encryption key creation #
POST /api/v2/conversations/keyconfigurations/validate Validate encryption key configurations without saving it #
POST /api/v2/conversations/participants/attributes/search Search conversations #
GET /api/v2/conversations/{conversationId} Get conversation #
DELETE /api/v2/conversations/{conversationId} Update a conversation by disconnecting all of the participants #
PATCH /api/v2/conversations/{conversationId}/recordingstate Update a conversation by setting its recording state #
POST /api/v2/conversations/{conversationId}/barge Barge a conversation creating a barged in conference of connected participants #
POST /api/v2/conversations/{conversationId}/disconnect Performs a full conversation teardown. #
POST /api/v2/conversations/{conversationId}/assign Attempts to manually assign a specified conversation to a specified user. #
PUT /api/v2/conversations/{conversationId}/tags Update the tags on a conversation #
PATCH /api/v2/conversations/{conversationId}/utilizationlabel Update the utilization label on a conversation. #
GET /api/v2/conversations/{conversationId}/secureattributes Get the secure attributes on a conversation #
PUT /api/v2/conversations/{conversationId}/secureattributes Set the secure attributes on a conversation #
PATCH /api/v2/conversations/{conversationId}/secureattributes Update the secure attributes on a conversation #
GET /api/v2/conversations Get active conversations for the logged in user #
POST /api/v2/conversations/faxes Create Fax Conversation #
GET /api/v2/conversations/settings Get Settings #
PATCH /api/v2/conversations/settings Update Settings #
POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize API invoked to finalize agent checklist evaluation #
GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId} Get checklist info for a single checklist #
POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId} Agent Checklist activation API #
POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs Create inference job #
GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId} Get inference job status #
GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists Get information of all checklists associated with a conversation #
POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction API invoked to capture an agent action #
GET /api/v2/conversations/{conversationId}/customattributes Get a list of custom attributes for a conversation #
PUT /api/v2/conversations/{conversationId}/customattributes Create or update a single custom attributes record. #
PATCH /api/v2/conversations/{conversationId}/customattributes Update a single custom attributes record by amending the data with only the… #
GET /api/v2/conversations/{conversationId}/customattributes/{attributesId} Get custom attributes by id #
DELETE /api/v2/conversations/{conversationId}/customattributes/{attributesId} Delete a custom attributes record #
PUT /api/v2/conversations/{conversationId}/customattributes/bulk Create or update a list of custom attributes records. #
PATCH /api/v2/conversations/{conversationId}/customattributes/bulk Update a list of custom attributes record by amending the data with only the… #
POST /api/v2/conversations/customattributes/search Search resources #
GET /api/v2/conversations/customattributes/schemas/coretypes/{coreTypeName} Get the core types from which all schemas are built #
GET /api/v2/conversations/customattributes/schemas/coretypes Get the list of core types enabled for a specific namespace #
GET /api/v2/conversations/customattributes/schemas/limits Get quantitative limits on schemas #
GET /api/v2/conversations/customattributes/schemas/{schemaId} Get a schema #
PUT /api/v2/conversations/customattributes/schemas/{schemaId} Update a schema #
GET /api/v2/conversations/customattributes/schemas/{schemaId}/versions Get all versions of a CCA schema #
GET /api/v2/conversations/customattributes/schemas/{schemaId}/versions/{versionId} Get a specific version of a schema #
GET /api/v2/conversations/customattributes/schemas Get a list of schemas #
POST /api/v2/conversations/customattributes/schemas Create a schema #
PATCH /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId} Update after-call work for this conversation communication #
POST /api/v2/conversations/callbacks/bulk/update Update multiple scheduled callbacks #
POST /api/v2/conversations/callbacks/bulk/disconnect Disconnect multiple scheduled callbacks #
GET /api/v2/conversations/calls Get the logged-in user's active conversations and their Call participants state #
POST /api/v2/conversations/calls Create a call conversation #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor Listen in on the conversation from the point of view of a given participant #
GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
GET /api/v2/conversations/calls/{conversationId} Get call conversation #
POST /api/v2/conversations/calls/{conversationId} Place a new call as part of a callback conversation #
PATCH /api/v2/conversations/calls/{conversationId} Update a conversation by setting its recording state, merging in other… #
PUT /api/v2/conversations/calls/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it. #
GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId} Update conversation participant #
POST /api/v2/conversations/calls/user/{userId} Create a call conversation on behalf of a user #
GET /api/v2/conversations/calls/maximumconferenceparties Get the maximum number of participants that this user can have on a conference #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach Listen in on the conversation from the point of view of a given participant… #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge Barge a given participant's call creating a barged in conference of connected… #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Initiate and update consult transfer (Deprecated) #
DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Cancel the transfer #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Change who can speak #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/voice/consult Initiate voice consult transfer #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent Initiate a consult transfer to an agent #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue Initiate a consult transfer to a queue #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external Initiate a consult transfer to an external contact (Deprecated) #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external Initiate a consult transfer to an external contact #
PATCH /api/v2/conversations/calls/{conversationId}/conference Update a conversation by merging in other conversations to create a conference #
POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record Start/stop the snippet recording for a participant #
POST /api/v2/conversations/calls/{conversationId}/participants Add participants to a conversation #
POST /api/v2/conversations/calls/{conversationId}/participants/user/{userId} Add participants to a conversation on behalf of a user #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId} Update conversation participant on behalf of a user #
GET /api/v2/conversations/calls/history Get call history #
PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata Set uuiData to be sent on future commands #
DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/postflowaction Remove mandatory post call actions #
PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/postflowaction Set mandatory post call actions. #
GET /api/v2/conversations/callbacks Get the logged-in user's active conversations and their Callback participants… #
POST /api/v2/conversations/callbacks Create a Callback #
PATCH /api/v2/conversations/callbacks Update a scheduled callback #
POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
GET /api/v2/conversations/callbacks/{conversationId} Get callback conversation #
PATCH /api/v2/conversations/callbacks/{conversationId} Update a conversation by disconnecting all of the participants #
PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it #
GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId} Update conversation participant #
GET /api/v2/conversations/chats/{conversationId}/messages/{messageId} Get a web chat conversation message #
GET /api/v2/conversations/chats/{conversationId}/messages Get the messages of a chat conversation #
POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages Send a message on behalf of a communication in a chat conversation #
POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing Send a typing-indicator on behalf of a communication in a chat conversation #
GET /api/v2/conversations/chats Get active chat conversations for the logged in user #
POST /api/v2/conversations/chats Create a web chat conversation #
POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
GET /api/v2/conversations/chats/{conversationId} Get chat conversation #
PATCH /api/v2/conversations/chats/{conversationId} Update a conversation by disconnecting all of the participants #
PUT /api/v2/conversations/chats/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId} Update conversation participant #
PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it. #
GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
GET /api/v2/conversations/cobrowsesessions Get active cobrowse conversations for the logged in user #
GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
GET /api/v2/conversations/cobrowsesessions/{conversationId} Get cobrowse conversation #
PATCH /api/v2/conversations/cobrowsesessions/{conversationId} Update a conversation by disconnecting all of the participants #
PUT /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it #
GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId} Update conversation participant #
POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
GET /api/v2/conversations/emails/{conversationId}/messages/{messageId} Get conversation message #
GET /api/v2/conversations/emails Get the logged-in user's active conversations and their Email participants state #
POST /api/v2/conversations/emails Create an email conversation #
GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
GET /api/v2/conversations/emails/{conversationId}/messages Get conversation messages #
POST /api/v2/conversations/emails/{conversationId}/messages Send an email reply #
GET /api/v2/conversations/emails/{conversationId} Get email conversation #
PATCH /api/v2/conversations/emails/{conversationId} Update a conversation by disconnecting all of the participants #
PUT /api/v2/conversations/emails/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId} Update conversation participant #
PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it. #
GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
GET /api/v2/conversations/emails/{conversationId}/settings Get emails settings for a given conversation #
POST /api/v2/conversations/emails/{conversationId}/reconnect Reconnect the user to the most recently disconnected customer on a fully… #
DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId} Delete attachment from draft #
POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy Copy attachments from an email message to the current draft #
POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/uploads Create a URL to upload a message attachment file #
GET /api/v2/conversations/emails/{conversationId}/messages/draft Get conversation draft reply #
PUT /api/v2/conversations/emails/{conversationId}/messages/draft Update conversation draft reply #
PATCH /api/v2/conversations/emails/{conversationId}/messages/draft Reset conversation draft to its initial state and/or auto-fill draft content #
POST /api/v2/conversations/emails/{conversationId}/inboundmessages Send an email to an external conversation. #
PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate Update conversation by setting its parking state #
POST /api/v2/conversations/emails/agentless Create an email conversation, per API #
GET /api/v2/conversations/internalmessages Get the logged-in user's active conversations and their InternalMessage… #
GET /api/v2/conversations/internalmessages/{conversationId} Get internal message conversation #
GET /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId} Get a cached media item #
DELETE /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId} Remove a cached media item asychronously #
GET /api/v2/conversations/messages/cachedmedia Get a list of cached media items #
POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace Replace this participant with the specified user and/or address #
GET /api/v2/conversations/messages/{messageId}/details Get message #
GET /api/v2/conversations/messages Get the logged-in user's active conversations and their Message participants… #
POST /api/v2/conversations/messages Create an outbound messaging conversation #
POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor Listen in on the conversation from the point of view of a given participant #
GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes Get list of wrapup codes for this conversation participant #
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages Send message #
POST /api/v2/conversations/messages/{conversationId}/messages/bulk Get messages in batch #
GET /api/v2/conversations/messages/{conversationId} Get message conversation #
PATCH /api/v2/conversations/messages/{conversationId} Update a conversation by disconnecting all of the participants #
PUT /api/v2/conversations/messages/{conversationId}/recordingstate Update a conversation by setting its recording state #
PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes Update the attributes on a conversation participant #
GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup Get the wrap-up for this conversation participant #
PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId} Update conversation participant #
PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId} Update conversation participant's communication by disconnecting it. #
GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate Update conversation by setting its parking state #
GET /api/v2/conversations/messages/{conversationId}/messages/{messageId} Get conversation message #
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages Send a social media message #
GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media Get message media list by status #
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media Create media #
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads Create a URL to upload a message media file #
GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId} Get media #
POST /api/v2/conversations/messages/agentless Send an agentless outbound message #
POST /api/v2/conversations/messages/inbound/open Send an inbound Open Message #
POST /api/v2/conversations/messages/{integrationId}/inbound/open/event Send an inbound Open Event Message #
POST /api/v2/conversations/messages/{integrationId}/inbound/open/message Send inbound Open Message #
POST /api/v2/conversations/messages/{integrationId}/inbound/open/structured/response Send inbound Open Response #
POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt Send an inbound Open Receipt Message #
POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing Send message typing event #
PUT /api/v2/conversations/screenshares/{conversationId}/recordingstate Update a conversation by setting its recording state #
GET /api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PUT /api/v2/conversations/socials/{conversationId}/recordingstate Update a conversation by setting its recording state #
GET /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
PUT /api/v2/conversations/videos/{conversationId}/recordingstate Update a conversation by setting its recording state #
GET /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Get the wrap-up for this conversation communication #
POST /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Apply wrap-up for this conversation communication #
GET /api/v2/conversations/videos/meetings/{meetingId} Gets a record for a given meetingId #
POST /api/v2/conversations/videos/meetings Generate a meetingId for a given conferenceId #
GET /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId} Get message #
GET /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages Get messages for communication #
POST /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages Send internal message #
GET /api/v2/conversations/messaging/integrations Get a list of Integrations #
GET /api/v2/conversations/messaging/threadingtimeline Get conversation threading window timeline for each messaging type #
PUT /api/v2/conversations/messaging/threadingtimeline Update conversation threading window timeline for each messaging type #
GET /api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId} Get Apple messaging integration identity resolution settings #
PUT /api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId} Create an identity resolution settings for a Apple messaging integration #
GET /api/v2/conversations/messaging/integrations/apple/{integrationId} Get an Apple messaging integration #
DELETE /api/v2/conversations/messaging/integrations/apple/{integrationId} Delete an Apple messaging integration #
PATCH /api/v2/conversations/messaging/integrations/apple/{integrationId} Update an Apple messaging integration #
GET /api/v2/conversations/messaging/integrations/apple Get a list of Apple Integrations #
POST /api/v2/conversations/messaging/integrations/apple Create Apple Integration #
GET /api/v2/conversations/messaging/facebook/app Get Genesys Facebook App Id #
GET /api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId} Get Facebook messaging integration identity resolution settings #
PUT /api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId} Create an identity resolution settings for a Facebook messaging integration #
GET /api/v2/conversations/messaging/integrations/facebook/{integrationId} Get a Facebook messaging integration #
DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId} Delete a Facebook messaging integration #
PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId} Update Facebook messaging integration #
GET /api/v2/conversations/messaging/integrations/facebook Get a list of Facebook Integrations #
POST /api/v2/conversations/messaging/integrations/facebook Create a Facebook Integration #
GET /api/v2/conversations/messaging/facebook/permissions Get a list of Facebook Permissions #
GET /api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId} Get an Instagram integration identity resolution settings #
PUT /api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId} Create identity resolution settings for an Instagram messaging integration #
GET /api/v2/conversations/messaging/integrations/instagram/{integrationId} Get Instagram messaging integration #
DELETE /api/v2/conversations/messaging/integrations/instagram/{integrationId} Delete Instagram messaging integration #
PATCH /api/v2/conversations/messaging/integrations/instagram/{integrationId} Update Instagram messaging integration #
GET /api/v2/conversations/messaging/integrations/instagram Get a list of Instagram Integrations #
POST /api/v2/conversations/messaging/integrations/instagram Create Instagram Integration #
GET /api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId} Get an open messaging integration Identity Resolution settings #
PUT /api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId} Update an open messaging integration Identity Resolution settings #
GET /api/v2/conversations/messaging/integrations/open/{integrationId} Get an Open messaging integration #
DELETE /api/v2/conversations/messaging/integrations/open/{integrationId} Delete an Open messaging integration #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-conversations-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-conversations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-conversations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Conversations API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:
- name: Conversations
  description: ''
  externalDocs:
    description: Conversations Documentation
    url: https://developer.genesys.cloud/routing/conversations/conversations-apis
paths:
  /api/v2/analytics/conversations/aggregates/query:
    post:
      tags:
      - Conversations
      summary: Query for conversation aggregates
      description: ''
      operationId: postAnalyticsConversationsAggregatesQuery
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
            general.internal.server.error: An internal server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: postAnalyticsConversationsAggregatesQuery
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationAggregationQuery'
        description: query
        required: true
  /api/v2/analytics/conversations/{conversationId}/details:
    get:
      tags:
      - Conversations
      summary: Get a conversation by id
      description: ''
      operationId: getAnalyticsConversationDetails
      parameters:
      - name: conversationId
        in: path
        description: conversationId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsConversationWithoutAttributes'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationDetails
  /api/v2/analytics/conversations/aggregates/jobs:
    post:
      tags:
      - Conversations
      summary: Query for conversation aggregates asynchronously
      description: ''
      operationId: postAnalyticsConversationsAggregatesJobs
      responses:
        '202':
          description: Accepted - Running query asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: postAnalyticsConversationsAggregatesJobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationAsyncAggregationQuery'
        description: query
        required: true
  /api/v2/analytics/conversations/aggregates/jobs/{jobId}:
    get:
      tags:
      - Conversations
      summary: Get status for async query for conversation aggregates
      description: ''
      operationId: getAnalyticsConversationsAggregatesJob
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: getAnalyticsConversationsAggregatesJob
    delete:
      tags:
      - Conversations
      summary: Delete/cancel an async request for conversation aggregates
      description: ''
      operationId: deleteAnalyticsConversationsAggregatesJob
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
 

# --- truncated at 32 KB (3111 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-conversations-api-openapi.yml