Genesys Conversations API
The Conversations API from Genesys — 231 operation(s) for conversations.
Genesys Conversations API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 314 operations across 231 paths, and defines 620 schemas. It is described by OpenAPI 2.0, at version v2.
Requests are made against the base URL https://api.mypurecloud.com.
314 operations
231 paths
620 schemas
19 DELETE115 GET52 PATCH101 POST27 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Genesys Conversations API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope.
An API key is passed in the header as Authorization (Guest Chat JWT).
Paths & Operations 314
Across 231 paths, the API surfaces 314 operations — 19 DELETE, 115 GET, 52 PATCH, 101 POST, 27 PUT. Each is listed below with its method, path, parameters, and response codes.
Conversations 314
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. Requires "conversation:cobrowse:add" (for web messaging) or "conversation:cobrowsevoice:add" permission.
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. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the n…
POST
/api/v2/conversations/{conversationId}/assign
Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
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. When there is no value provided, the system default label is applied
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. Updating replaces all data with the provided fields.
PATCH
/api/v2/conversations/{conversationId}/customattributes
Update a single custom attributes record by amending the data with only the provided fields.
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. Updating replaces all data with the provided fields.
PATCH
/api/v2/conversations/{conversationId}/customattributes/bulk
Update a list of custom attributes record by amending the data with only the provided fields.
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 conversations to create a conference, or disconnecting all of the participants
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. This endpoint does not update wrapup.
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 while speaking to just the given participant.
POST
/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge
Barge a given participant's call creating a barged in conference of connected participants.
POST
/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consultdeprecated
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/externaldeprecated
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. If both values are null or blank error will occur.
GET
/api/v2/conversations/callbacks
Get the logged-in user's active conversations and their Callback participants state.
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}deprecated
Get a web chat conversation message
GET
/api/v2/conversations/chats/{conversationId}/messagesdeprecated
Get the messages of a chat conversation.
POST
/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messagesdeprecated
Send a message on behalf of a communication in a chat conversation.
POST
/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typingdeprecated
Send a typing-indicator on behalf of a communication in a chat conversation.
GET
/api/v2/conversations/chatsdeprecated
Get active chat conversations for the logged in user
POST
/api/v2/conversations/chatsdeprecated
Create a web chat conversation
POST
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replacedeprecated
Replace this participant with the specified user and/or address
GET
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodesdeprecated
Get list of wrapup codes for this conversation participant
GET
/api/v2/conversations/chats/{conversationId}deprecated
Get chat conversation
PATCH
/api/v2/conversations/chats/{conversationId}deprecated
Update a conversation by disconnecting all of the participants
PUT
/api/v2/conversations/chats/{conversationId}/recordingstatedeprecated
Update a conversation by setting its recording state
PATCH
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributesdeprecated
Update the attributes on a conversation participant.
GET
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupdeprecated
Get the wrap-up for this conversation participant.
PATCH
/api/v2/conversations/chats/{conversationId}/participants/{participantId}deprecated
Update conversation participant
PATCH
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}deprecated
Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
GET
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
Get the wrap-up for this conversation communication.
POST
/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
Apply wrap-up for this conversation communication
POST
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replacedeprecated
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}/wrapupcodesdeprecated
Get list of wrapup codes for this conversation participant
GET
/api/v2/conversations/cobrowsesessions/{conversationId}
Get cobrowse conversation
PATCH
/api/v2/conversations/cobrowsesessions/{conversationId}deprecated
Update a conversation by disconnecting all of the participants
PUT
/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstatedeprecated
Update a conversation by setting its recording state
PATCH
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributesdeprecated
Update the attributes on a conversation participant.
GET
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupdeprecated
Get the wrap-up for this conversation participant.
PATCH
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}deprecated
Update conversation participant's communication by disconnecting it.
GET
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
Get the wrap-up for this conversation communication.
POST
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
Apply wrap-up for this conversation communication
PATCH
/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}deprecated
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. This endpoint does not update wrapup.
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 disconnected email conversation
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. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new mess…
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 participants state.
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 state.
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. This endpoint does not update wrapup.
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/mediadeprecated
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/opendeprecated
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}/recordingstatedeprecated
Update a conversation by setting its recording state
GET
/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
Get the wrap-up for this conversation communication.
POST
/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapupdeprecated
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
PATCH
/api/v2/conversations/messaging/integrations/open/{integrationId}
Update an Open messaging integration
GET
/api/v2/conversations/messaging/integrations/open
Get a list of Open messaging integrations
POST
/api/v2/conversations/messaging/integrations/open
Create an Open messaging integration
GET
/api/v2/conversations/messaging/settings/default
Get the organization's default settings that will be used as the default when creating an integration.
PUT
/api/v2/conversations/messaging/settings/default
Set the organization's default setting that may be applied to to integrations without settings
DELETE
/api/v2/conversations/messaging/settings/default
Delete the organization's default setting, a global default will be applied to integrations without settings
GET
/api/v2/conversations/messaging/settings
Get a list of messaging settings
POST
/api/v2/conversations/messaging/settings
Create a messaging setting
GET
/api/v2/conversations/messaging/settings/{messageSettingId}
Get a messaging setting
DELETE
/api/v2/conversations/messaging/settings/{messageSettingId}
Delete a messaging setting
PATCH
/api/v2/conversations/messaging/settings/{messageSettingId}
Update a messaging setting
GET
/api/v2/conversations/messaging/supportedcontent/default
Get the organization's default supported content profile that will be used as the default when creating an integration.
PUT
/api/v2/conversations/messaging/supportedcontent/default
Set the organization's default supported content profile that may be assigned to an integration when it is created.
GET
/api/v2/conversations/messaging/supportedcontent/{supportedContentId}
Get a supported content profile
DELETE
/api/v2/conversations/messaging/supportedcontent/{supportedContentId}
Delete a supported content profile
PATCH
/api/v2/conversations/messaging/supportedcontent/{supportedContentId}
Update a supported content profile
GET
/api/v2/conversations/messaging/supportedcontent
Get a list of Supported Content profiles
POST
/api/v2/conversations/messaging/supportedcontent
Create a Supported Content profile
GET
/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}
Get X (Formally Twitter) messaging integration identity resolution settings
PUT
/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}
Create an identity resolution settings for an X (Formally Twitter) messaging integration
GET
/api/v2/conversations/messaging/integrations/twitter/{integrationId}
Get Twitter messaging integration
DELETE
/api/v2/conversations/messaging/integrations/twitter/{integrationId}
Delete Twitter messaging integration
PATCH
/api/v2/conversations/messaging/integrations/twitter/{integrationId}
Update a Twitter messaging integration
GET
/api/v2/conversations/messaging/integrations/twitter
Get a list of Twitter Integrations
POST
/api/v2/conversations/messaging/integrations/twitter
Create Twitter Integration
GET
/api/v2/conversations/messaging/integrations/twitter/oauth/settings
Get twitter oauth settings
GET
/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings
Get twitter oauth settings to patch an integration
PATCH
/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}
Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
POST
/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup
Create a WhatsApp Integration using the WhatsApp embedded signup flow
GET
/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}
Get a whatsApp integration Identity Resolution settings
PUT
/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}
Update a whatsApp integration Identity Resolution settings
GET
/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
Get a WhatsApp messaging integration
DELETE
/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
Delete a WhatsApp messaging integration
PATCH
/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
Update a WhatsApp messaging integration
GET
/api/v2/conversations/messaging/integrations/whatsapp
Get a list of WhatsApp Integrations
POST
/api/v2/conversations/messaging/integrations/whatsappdeprecated
[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
DELETE
/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}
Delete a code used to add a communication to this participant
PATCH
/api/v2/conversations/{conversationId}/participants/{participantId}
Update a participant.
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/replacedeprecated
Replace this participant (Deprecated)
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/transfer
Replace this participant by another one using the address of the destination.
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/digits
Sends DTMF to the participant
GET
/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes
Get list of wrapup codes for this conversation participant
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks
Create a new callback for the specified participant on the conversation.
PATCH
/api/v2/conversations/{conversationId}/participants/{participantId}/attributes
Update the attributes on a conversation participant.
GET
/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup
Get the wrap-up for this conversation participant.
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent
Replace this participant with the specified agent
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue
Replace this participant with the specified queue
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/replace/externaldeprecated
Replace this participant with the an external contact (Deprecated)
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external
Replace this participant with the an external contact
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications
Setup internal message communication with user
PUT
/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason
Set flagged reason on conversation participant to indicate bad conversation quality.
DELETE
/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason
Remove flagged reason from conversation participant.
GET
/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}
Fetch info on a secure session
GET
/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
Get a list of secure sessions for this participant.
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
POST
/api/v2/conversations/{conversationId}/suggestions/feedbackdeprecated
Suggestion feedback.
GET
/api/v2/conversations/{conversationId}/suggestions
Get all suggestions for a conversation.
GET
/api/v2/conversations/{conversationId}/suggestions/{suggestionId}
Get Suggestion.
POST
/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement
Save an engagement on the suggestion.
GET
/api/v2/conversations/{conversationId}/summaries
Get the summaries of the conversation.
PATCH
/api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements
Update agent's engagement for the summary.
POST
/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback
Submit feedback for the summary.
PATCH
/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback
Update the feedback for the summary.
GET
/api/v2/conversations/messaging/oauth/apple/callback
Call Authentication provider callback to validate state and code
Schemas 620
The contract defines 620 schemas that model the data the API accepts and returns. The most detailed are AnalyticsSession (89 properties), CallMediaParticipant (57 properties), Participant (50 properties), MessageMediaParticipant (47 properties). Each schema is shown below with its type and property counts.
ActivationTrigger
object
4 properties
OpenInboundNormalizedMessage
object
Open Messaging rich media message structure
4 properties
1 required
JsonSchemaDocument
object
A JSON Schema document.
8 properties
MessagingSettingRequestReference
object
Messaging Setting for messaging platform integrations
1 property
1 required
InstagramIntegration
object
20 properties
4 required
WritableDivision
object
3 properties
FaxStatus
object
8 properties
TwitterId
object
User information for a twitter account. Either id OR screenName (or both) must be present
5 properties
RoutingData
object
9 properties
1 required
Conversation
object
17 properties
2 required
ConversationEnrichment
object
Metadata enrichments provided by the platform.
2 properties
AppleIntegrationRequest
object
11 properties
2 required
AdjustableLiveSpeakerDetection
object
6 properties
Script
object
15 properties
FeedbackAddRequest
object
2 properties
1 required
ConversationAggregationView
object
4 properties
3 required
CreateWebChatMessageRequest
object
2 properties
1 required
FacebookPermissionEntityListing
object
1 property
Disposition
object
7 properties
1 required
StatisticalSummary
object
14 properties
MediaSummary
object
2 properties
ConversationContentButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
4 properties
2 required
TextMessageListing
object
1 property
AnalyticsSurvey
object
13 properties
ConversationContext
object
3 properties
3 required
WhatsAppIntegration
object
19 properties
4 required
ConversationActivityData
object
4 properties
InternalMessageDataEntityListing
object
10 properties
MediaTypeAccess
object
Media type access definitions
2 properties
ConversationNotificationTemplateFooter
object
Template footer object.
1 property
AnalyticsConversationWithoutAttributes
object
22 properties
ConversationContentNotificationTemplate
object
Template notification object.
6 properties
1 required
AiScoringSettings
object
3 properties
ConversationChannelMetadata
object
Information about the channel.
1 property
FeedbackUpdateRequest
object
2 properties
EvaluationReference
object
2 properties
ConversationAggregateDataContainer
object
2 properties
AggregationResult
object
5 properties
InstagramIntegrationEntityListing
object
10 properties
GenerateMeetingIdRequest
object
3 properties
1 required
MediaSummaryDetail
object
2 properties
ConversationDetailQueryClause
object
2 properties
2 required
ConversationEnrichmentLanguage
object
Detected language of this message.
1 property
1 required
AnalyticsScoredAgent
object
2 properties
ConversationContentDatePicker
object
DateTimePicker content object.
9 properties
Email
object
27 properties
Participant
object
50 properties
ConversationSummary
object
13 properties
ConversationContentWheelPicker
object
Wheel Picker object for representing single selection of selectable items.
2 properties
1 required
CreateOutboundMessagingConversationResponse
object
2 properties
EvaluationQuestionGroupScore
object
16 properties
SupportedContentListing
object
10 properties
TransferToAgentRequest
object
6 properties
JourneyAction
object
2 properties
2 required
ConversationActivityScoredAgent
object
2 properties
PatchCallbackRequest
object
8 properties
2 required
InternalMessageData
object
9 properties
1 required
CallbackIdentifier
object
2 properties
2 required
DispositionParameters
object
1 property
MessageSubtypeSettings
object
2 properties
SegmentDetailQueryPredicate
object
8 properties
ConversationParticipantSearchRequest
object
6 properties
ConversationThreadingWindow
object
3 properties
1 required
ConsultTransferToAddress
object
3 properties
1 required
CallHistoryConversationEntityListing
object
10 properties
TransferResponseModifiedBy
object
2 properties
EvaluationSettingsAssignee
object
2 properties
WebChatTyping
object
4 properties
4 required
Calibration
object
16 properties
JourneyCustomer
object
2 properties
2 required
AgentlessEmailSendResponseDto
object
9 properties
5 required
ConversationThreadingWindowSetting
object
2 properties
2 required
SearchSort
object
2 properties
ServiceLevel
object
2 properties
UpdateConferenceRequest
object
1 property
ConversationActivityQueryClause
object
2 properties
2 required
OrgUser
object
39 properties
1 required
AnalyticsConversationAsyncQueryResponse
object
3 properties
ConversationPushProviderIntegration
object
A Push provider integration.
2 properties
2 required
RecordersState
object
4 properties
OpenReceiptNormalizedMessage
object
Open Messaging rich media message structure
7 properties
5 required
SuggestionCannedResponse
object
2 properties
OAuthAppleAuthorizationResponseError
object
3 properties
2 required
MessageMediaUploadData
object
5 properties
AdditionalSocialMediaMessage
object
3 properties
1 required
AnalyticsConversation
object
22 properties
CallHistoryConversation
object
13 properties
MessagingIntegrationEntityListing
object
10 properties
CustomAttributesIdResponse
object
1 property
DefaultAnswersTo
object
4 properties
ConversationCustomAttributesSearchRequest
object
6 properties
OutOfOffice
object
8 properties
ConversationEntityListing
object
10 properties
ConversationEventPresence
object
A Presence event.
3 properties
1 required
ConsultTransfer
object
3 properties
2 required
ScoredAgent
object
2 properties
CarouselParameters
object
Template parameters for carousel components
1 property
AiScoringSetting
object
1 property
MessageDetails
object
10 properties
Call
object
35 properties
PropertyIndexRequest
object
3 properties
3 required
AppleIMessageApp
object
3 properties
3 required
ConversationChat
object
22 properties
ConversationActivityQuery
object
4 properties
2 required
AdditionalMessage
object
3 properties
1 required
RoutingStatus
object
3 properties
ResourceConditionValue
object
2 properties
ChatMediaParticipant
object
40 properties
MessageMediaData
object
10 properties
ConversationAggregationSort
object
2 properties
2 required
CobrowseMediaParticipant
object
43 properties
AgentlessEmailSendRequestDto
object
8 properties
3 required
DialerPreview
object
6 properties
AppleIntegrationUpdateRequest
object
10 properties
InternalMessage
object
15 properties
OpenMessageEvent
object
Message event element.
2 properties
1 required
ConversationActivityEntityData
object
23 properties
1 required
Feedback
object
3 properties
2 required
EvaluationQuestionGroup
object
12 properties
AgentOwnedRouting
object
3 properties
UserConversationSummary
object
8 properties
Education
object
5 properties
Callback
object
29 properties
MessageMedia
object
5 properties
UserReferenceWithName
object
3 properties
ConversationContentListPickerSection
object
List Picker object for presenting a section of selectable items.
3 properties
MediaParticipantRequest
object
8 properties
TwitterIdentityResolutionConfig
object
3 properties
1 required
MessagingConferWithUserRequest
object
1 property
1 required
ConversationPushNotificationMessageLabel
object
A Push notification message label.
2 properties
2 required
ConversationContentCard
object
Card content object.
6 properties
2 required
EmailMessagePreview
object
17 properties
2 required
ConversationContentForm
object
Form content object.
8 properties
1 required
ErrorBody
object
11 properties
CopyAttachmentsRequest
object
2 properties
2 required
LocationImage
object
2 properties
AnalyticsConversationWithoutAttributesMultiGetResponse
object
1 property
ConditionalGroupActivationSimpleMetric
object
2 properties
TemplateParameter
object
2 properties
ConversationSecureAttributes
object
2 properties
SuggestionEngagement
object
2 properties
1 required
InstagramScopedId
object
Scoped ID for an Instagram user interacting with a page or app
1 property
1 required
ContentButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
4 properties
3 required
MessagingSettingRequest
object
Messaging setting for messaging platform integrations
5 properties
1 required
EvaluationSettings
object
4 properties
ConditionalGroupRouting
object
1 property
MediaSettings
object
5 properties
JourneyActionMap
object
2 properties
2 required
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
MessageMediaListing
object
10 properties
MessageMediaSettings
object
8 properties
ConversationFormPageComponent
object
Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.
5 properties
OpenInboundNormalizedReceipt
object
Open Messaging rich media message structure
5 properties
3 required
ConversationAggregateQueryPredicate
object
5 properties
OpenEventNormalizedMessage
object
Open Messaging rich media message structure
4 properties
2 required
AsyncConversationQuery
object
10 properties
1 required
MandatoryPostCallActionInput
object
2 properties
MessageSticker
object
2 properties
EmailConversation
object
9 properties
AnalyticsSessionMetric
object
3 properties
EvaluationDetailQueryClause
object
2 properties
2 required
AppleOpaqueId
object
1 property
PhoneNumber
object
7 properties
AnalyticsProperty
object
3 properties
TransferResponse
object
7 properties
DomainEntityListingEvaluationForm
object
10 properties
MessagingSettingDefaultRequest
object
1 property
1 required
ExternalId
object
2 properties
2 required
OpenInboundStructuredResponseNormalizedMessageContent
object
Message content element.
2 properties
1 required
InboundOnlySetting
object
1 property
CustomAttributesBulkUpdateResponse
object
3 properties
AnalyticsParticipantWithoutAttributes
object
10 properties
InstagramIntegrationRequest
object
10 properties
1 required
ConversationActivityMetricValue
object
5 properties
CreateSecureSession
object
4 properties
2 required
ResourcePermissionPolicy
object
11 properties
AiScoring
object
3 properties
ConversationContentRequiredContactField
object
Contact fields a merchant requires to complete a payment request.
1 property
1 required
DiagnosticsSettings
object
1 property
WhatsAppId
object
User information for a WhatsApp account
2 properties
1 required
InternalMessageRequest
object
1 property
1 required
ConversationContentDatePickerAvailableTime
object
A datetimepicker available time that a user can take.
2 properties
ConsultTransferToExternal
object
3 properties
1 required
TwitterIntegrationUpdateRequest
object
8 properties
ConsultTransferToExternalContact
object
4 properties
3 required
OpenMessagingFromRecipient
object
Information about the recipient the message is received from.
7 properties
2 required
ConversationSessionSummary
object
14 properties
QuestionSettings
object
2 properties
ConditionalGroupActivationPilotRule
object
2 properties
ChecklistActivationPayload
object
10 properties
2 required
AssignedWrapupCode
object
5 properties
AcwSettings
object
2 properties
ContactAddress
object
6 properties
SettingDirection
object
2 properties
MessageTypingEventRequest
object
2 properties
1 required
DirectRoutingMediaSettings
object
1 property
ConversationSummaryWrapupCode
object
5 properties
ConversationSummaryReason
object
3 properties
Geolocation
object
11 properties
TransferToAddressRequest
object
3 properties
Destination
object
4 properties
MessagingIntegration
object
14 properties
4 required
CallConversation
object
12 properties
CreateWebChatRequest
object
7 properties
2 required
ConversationEncryptionConfigurationListing
object
3 properties
RestErrorDetail
object
3 properties
1 required
ConversationContentPaymentRequest
object
Payment Request object used to request payment from a customer.
9 properties
4 required
CreateCallRequest
object
16 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
ConditionalGroupActivationCondition
object
3 properties
CustomAttributes
object
11 properties
StorySetting
object
2 properties
TopicDuration
object
1 property
AnalyticsParticipant
object
11 properties
AsyncQueryResponse
object
1 property
WebChatConversation
object
4 properties
ConversationContentInteractiveApplication
object
InteractiveApplication content object.
4 properties
ConversationFormPage
object
Form page object.
3 properties
2 required
Biography
object
5 properties
OpenContentAttachment
object
Attachment object.
7 properties
3 required
ExternalDataSource
object
Describes a link to a record in an external system that contributed data to a Relate record
2 properties
TrusteeAuthorization
object
1 property
OpenMessageContent
object
Message content element.
2 properties
1 required
FacebookIntegration
object
18 properties
4 required
ConsultTransferResponse
object
1 property
1 required
SupportedContentReference
object
4 properties
1 required
ConversationDivisionMembership
object
2 properties
ConversationContentText
object
Message content element containing text only.
2 properties
1 required
Workspace
object
12 properties
1 required
FaxSendRequest
object
9 properties
1 required
OpenMessagingChannel
object
Channel-specific information that describes the message and the message channel/provider.
8 properties
3 required
MessagingConferResponse
object
4 properties
4 required
SupportedContent
object
Supported content profile for inbound and outbound messages
9 properties
2 required
MergeOperation
object
3 properties
ApplePay
object
12 properties
7 required
BulkCallbackDisconnectRequest
object
1 property
1 required
EmailAddress
object
2 properties
MeetingIdRecord
object
5 properties
1 required
SendMessagingTemplateRequest
object
6 properties
EvaluationQuestionScore
object
10 properties
TransferToExternalRequest
object
3 properties
EvaluationVersion
object
3 properties
BulkResult
object
2 properties
InactivityTimeoutSettings
object
3 properties
DomainRole
object
2 properties
ChecklistInferenceJobCreationResponse
object
2 properties
EvaluationDetailQueryFilter
object
3 properties
1 required
CachedMediaItemEntityListing
object
10 properties
UploadAttachmentRequest
object
4 properties
2 required
EmailMediaParticipant
object
44 properties
OpenIntegrationUpdateRequest
object
8 properties
1 required
ContentSetting
object
1 property
PresenceDefinition
object
3 properties
ConversationRoutingData
object
8 properties
ConversationContentLocation
object
Location object.
5 properties
WhatsAppIntegrationRequest
object
7 properties
3 required
CobrowseWebMessagingSession
object
7 properties
ValidationLimits
object
6 properties
CreateCallResponse
object
3 properties
Entity
object
1 property
CoverSheet
object
2 properties
MessageMediaParticipant
object
47 properties
SuggestionListing
object
4 properties
ConversationFormResponseContent
object
Message content element for form responses
2 properties
Attachment
object
6 properties
PhoneNumberColumn
object
3 properties
MaxParticipants
object
1 property
Suggestion
object
16 properties
OpenInboundMessagingReceiptChannel
object
Open Channel-specific information that describes the message and the message channel/provider.
2 properties
2 required
AppleIntegration
object
20 properties
3 required
SnippetRecordingRequest
object
2 properties
1 required
SuggestionKnowledgeAnswer
object
3 properties
ConsultTransferToQueue
object
4 properties
1 required
AfterCallWorkUpdate
object
1 property
1 required
ChecklistFinalizePayload
object
1 property
1 required
Voicemail
object
2 properties
AnalyticsFlowOutcome
object
5 properties
ConversationContentReceivedReplyMessage
object
ReceivedReplyMessage content object.
5 properties
OpenNormalizedMessage
object
Open Messaging rich media message structure
10 properties
2 required
CallbackMediaSettings
object
18 properties
TransferDestination
object
2 properties
ConversationContentQuickReply
object
Quick reply object.
5 properties
2 required
AnalyticsResolution
object
4 properties
SuggestionFeedback
object
1 property
1 required
ConversationMessagingChannel
object
Channel-specific information that describes the message and the message channel/provider.
10 properties
CreateCallbackCommand
object
12 properties
1 required
GroupContact
object
5 properties
3 required
InstagramIdentityResolutionConfig
object
3 properties
1 required
FacebookId
object
User information for a Facebook user interacting with a page or app
2 properties
1 required
LocationDefinition
object
16 properties
ConversationNotificationTemplateParameter
object
Template parameters for placeholders in template.
2 properties
1 required
ConversationEventCoBrowse
object
A CoBrowse event.
3 properties
1 required
Image
object
2 properties
CallHistoryParticipant
object
19 properties
EvaluationForm
object
12 properties
2 required
TransferInitiator
object
1 property
WrapupInput
object
8 properties
WebChatMessageEntityList
object
5 properties
DivisionEntityRef
object
4 properties
AnalyticsMediaEndpointStat
object
11 properties
ConversationContentReaction
object
User reaction to public message.
2 properties
1 required
AssistanceCondition
object
2 properties
OpenInboundMessageMessagingChannel
object
Open Channel-specific information that describes the message and the message channel/provider, with additional message information
4 properties
2 required
UploadMediaRequest
object
3 properties
2 required
Bullseye
object
1 property
DisconnectReason
object
4 properties
ConversationSummaryFollowup
object
3 properties
OpenInboundMessageContent
object
Message content element.
1 property
CustomAttributesBulkUpdateResponseMap
object
1 property
PagingSpec
object
2 properties
2 required
SetUuiDataRequest
object
1 property
AnalyticsEvaluation
object
18 properties
AggregationResultEntry
object
4 properties
ConversationMessageContent
object
Message content element. If contentType = "Attachment" only one item is allowed.
20 properties
1 required
SendAgentlessOutboundMessageResponse
object
12 properties
AppleIdentityResolutionConfig
object
3 properties
1 required
IdentityResolutionExternalSource
object
2 properties
ExternalOrganization
object
24 properties
1 required
ExternalContact
object
38 properties
ParkingStateRequest
object
2 properties
1 required
MediaType
object
Media type definition
1 property
Message
object
33 properties
ConversationEncryptionConfiguration
object
5 properties
2 required
EmailMessageReply
object
13 properties
3 required
FacebookAppCredentials
object
1 property
1 required
ChatConversation
object
9 properties
ConversationTagsUpdate
object
1 property
1 required
DataAvailabilityResponse
object
1 property
Schema
object
5 properties
WhatsAppIdentityResolutionConfig
object
3 properties
1 required
CannedResponseLibraries
object
2 properties
ResolutionDetailQueryFilter
object
3 properties
1 required
ResolutionDetailQueryPredicate
object
5 properties
LocationAddress
object
7 properties
ItemValidationLimits
object
2 properties
2 required
SurveyDetailQueryFilter
object
3 properties
1 required
Team
object
8 properties
1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
OAuthAppleAuthorizationResponse
object
2 properties
1 required
AsyncQueryStatus
object
5 properties
SegmentDetailQueryClause
object
2 properties
2 required
ScreenMonitoring
object
12 properties
ConversationContentQuickReplyV2
object
Quick reply object V2.
2 properties
2 required
WhatsAppIntegrationUpdateRequest
object
5 properties
ConversationActivityQueryPredicate
object
4 properties
ContactSort
object
3 properties
Ring
object
3 properties
TransferRequest
object
7 properties
Wrapup
object
7 properties
ConversationEnrichmentSentimentV2
object
Sentiment analysis of this message.
1 property
1 required
CoretypeListing
object
3 properties
ConversationContentCarousel
object
Carousel content object.
1 property
1 required
LocationAddressVerificationDetails
object
4 properties
WhatsAppEmbeddedSignupIntegrationRequest
object
6 properties
2 required
MediaTypes
object
Media types
1 property
OpenMessageNormalizedMessage
object
Open Messaging rich media message structure
7 properties
2 required
HistoryHeadersTranslation
object
9 properties
8 required
ConversationContentStory
object
An ephemeral story.
3 properties
Screenshare
object
16 properties
ConversationNotificationTemplateBody
object
Template body object.
2 properties
1 required
ExpansionCriterium
object
2 properties
MaxLength
object
2 properties
2 required
FacebookScopedId
object
Scoped ID for a Facebook user interacting with a page or app
1 property
1 required
ExternalSource
object
5 properties
1 required
AnalyticsProposedAgent
object
2 properties
MessagingSettingReference
object
Messaging Setting for messaging platform integrations
10 properties
1 required
FacebookIntegrationRequest
object
10 properties
1 required
EmailMessagePreviewListing
object
10 properties
Page
object
8 properties
ConversationAggregateQueryFilter
object
3 properties
1 required
ConversationAggregationQuery
object
12 properties
2 required
OpenIntegrationRequest
object
8 properties
3 required
ConversationFormResponseComponent
object
A response component from a form
2 properties
2 required
ParticipantAttributes
object
1 property
ConversationActivityResponse
object
2 properties
FacebookIntegrationEntityListing
object
10 properties
BulkCallbackPatchResponse
object
3 properties
ConversationJsonSchemaRequest
object
A JSON Schema for create/update requests.
5 properties
3 required
ChatConversationEntityListing
object
10 properties
CallbackDisconnectIdentifier
object
2 properties
2 required
LineId
object
User information for a Line account
2 properties
1 required
TypingSetting
object
1 property
AnswerOption
object
6 properties
InstagramIntegrationUpdateRequest
object
7 properties
ConditionalGroupActivation
object
2 properties
OpenInboundNormalizedEvent
object
Open Event Messaging rich media message structure
2 properties
2 required
NumericRange
object
4 properties
OpenMessagingToRecipient
object
Information about the recipient the message is sent to.
7 properties
1 required
MinLength
object
2 properties
2 required
TwitterSignupOAuthSettings
object
3 properties
DomainEntityRef
object
3 properties
ConversationMessagingToRecipient
object
Information about the recipient the message is sent to.
9 properties
1 required
AgentActionPayload
object
2 properties
1 required
ConversationContentWheelPickerItem
object
Represents a selectable item in a Wheel Picker
3 properties
2 required
ResolutionDetailQueryClause
object
2 properties
2 required
DynamicLineBalancingSettings
object
2 properties
ConversationMessageEvent
object
Message event element. Examples include: system messages, typing indicators, cobrowse offerings.
5 properties
1 required
EmailMessage
object
18 properties
3 required
ConversationSchemaUpdateRequest
object
Schema update request.
3 properties
3 required
Campaign
object
42 properties
6 required
MessageData
object
16 properties
3 required
ConversationEventTyping
object
A Typing event.
2 properties
1 required
Article
object
7 properties
Detail
object
4 properties
UserAuthorization
object
4 properties
EvaluationScoringSet
object
11 properties
MetadataAttribute
object
1 property
Address
object
5 properties
OpenInboundStructuredResponseMessage
object
3 properties
3 required
ExternalOrganizationIdentifier
object
5 properties
2 required
UserPresence
object
10 properties
TransferToQueueRequest
object
4 properties
AgentChecklistResponse
object
21 properties
5 required
CreateCallbackResponse
object
2 properties
2 required
DirectRouting
object
6 properties
ConversationContentLineItem
object
Item included in an order.
4 properties
2 required
ConversationUser
object
1 property
1 required
ConversationJsonSchemaDocument
object
A Conversation Custom Attributes JSON Schema
5 properties
PhoneColumn
object
2 properties
2 required
Cobrowsesession
object
19 properties
ConversationDetailQueryFilter
object
3 properties
1 required
SkillsToRemove
object
3 properties
OpenIntegration
object
16 properties
4 required
SuggestionScript
object
3 properties
ConversationContentListPicker
object
List Picker object for presenting multiple sections of selectable items.
4 properties
Limit
object
3 properties
BulkCallbackPatchRequest
object
1 property
1 required
ConversationSummaryResolution
object
4 properties
WhatsAppAvailablePhoneNumberDetails
object
3 properties
2 required
ConversationMessageMetadata
object
Metadata information about a message.
3 properties
ConversationPublicMetadata
object
Information about a public message.
3 properties
ChecklistItem
object
12 properties
2 required
WhatsAppAvailablePhoneNumberDetailsListing
object
1 property
FacebookPermission
object
Facebook Permissions Model
2 properties
ConversationContentAttachment
object
Attachment object.
8 properties
1 required
Contact
object
7 properties
ConversationRecipientAdditionalIdentifier
object
Additional identifiers for describing messaging recipient.
2 properties
2 required
ConversationActivityQueryMetric
object
2 properties
1 required
CallMediaParticipant
object
57 properties
SurveyDetailQueryClause
object
2 properties
2 required
AfterCallWork
object
3 properties
ConsultTransferToAgent
object
4 properties
1 required
ConversationPushFailedMessageReferences
object
References of failed messages requiring a push.
1 property
1 required
CreateOutboundMessagingConversationRequest
object
6 properties
3 required
ConditionalGroupRoutingRule
object
6 properties
ConversationNotificationTemplateHeader
object
Template header object.
4 properties
1 required
Faq
object
6 properties
AgentAction
object
4 properties
3 required
SetRecordingState
object
1 property
ConversationContentListPickerItem
object
Represents a selectable item in a list picker.
4 properties
Division
object
3 properties
ConversationReference
object
2 properties
ConversationMessageMetadataEvent
object
Metadata information about a message event.
2 properties
SocialExpression
object
20 properties
JourneyCustomerSession
object
2 properties
2 required
MessagingSetting
object
Messaging setting for messaging platform integrations
10 properties
1 required
InternalMessageConversationEntityListing
object
10 properties
CallbackMediaParticipant
object
47 properties
DefaultAnswer
object
2 properties
ConversationDataSchemaListing
object
3 properties
EvaluationSource
object
4 properties
PatchCallbackResponse
object
2 properties
2 required
QueueMediaSettings
object
5 properties
SuggestionKnowledgeArticle
object
6 properties
MessagingConfigListing
object
10 properties
ConversationDataSchema
object
7 properties
ErrorInfo
object
2 properties
CreateEmailRequest
object
18 properties
1 required
Video
object
19 properties
CustomAttributesPatchRequest
object
4 properties
2 required
InternalMessageMediaParticipant
object
44 properties
ConversationEditedInput
object
2 properties
WebChatMemberInfo
object
13 properties
1 required
MessageConversationEntityListing
object
10 properties
OpenIntegrationEntityListing
object
10 properties
AnalyticsConversationQueryResponse
object
3 properties
Trustor
object
7 properties
1 required
CallCommand
object
2 properties
1 required
SuggestionContext
object
7 properties
ConversationNormalizedMessage
object
General rich media message structure with normalized feature support across many messaging channels.
15 properties
1 required
ConversationAggregateQueryResponse
object
1 property
FacebookIdentityResolutionConfig
object
3 properties
1 required
ConversationDetailQueryPredicate
object
6 properties
StatisticalResponse
object
3 properties
ConversationAsyncAggregateQueryResponse
object
2 properties
AggregateViewData
object
2 properties
UserStations
object
4 properties
OAuthLastTokenIssued
object
1 property
ConversationMessageMetadataContent
object
Metadata information about a message content.
2 properties
ConversationContentCardAction
object
A card action that a user can take.
4 properties
Queue
object
41 properties
SocialMediaMessageData
object
14 properties
2 required
AnalyticsConversationSegment
object
25 properties
TransferToExternalContactRequest
object
4 properties
2 required
AgentChecklistInfo
object
4 properties
3 required
ConversationContentIntroduction
object
Introduction content object.
4 properties
2 required
UploadAttachmentResponse
object
5 properties
ConversationActivityQueryFilter
object
3 properties
1 required
MessagingSettingPatchRequest
object
Messaging setting for messaging platform integrations
5 properties
ConversationContentPaymentResponse
object
Payment response object representing the status of a payment transaction.
3 properties
2 required
ConversationNotificationTemplateButton
object
Template button object
7 properties
2 required
ConversationUtilizationLabelUpdate
object
1 property
ConversationAggregateQueryClause
object
2 properties
2 required
DispositionSilentCallTimeout
object
3 properties
ConversationParticipantSearchCriteria
object
9 properties
1 required
PagelessDomainEntityListingEvaluationVersion
object
3 properties
CachedMediaItem
object
Defines an external media that has been ingested and cached by Genesys Cloud for conversation messaging
8 properties
User
object
39 properties
1 required
InternalMessageDetails
object
2 properties
AnalyticsFlow
object
15 properties
TwitterIntegrationRequest
object
9 properties
5 required
CallConversationEntityListing
object
10 properties
ConsultTransferUpdate
object
2 properties
1 required
TwitterOAuthSettings
object
2 properties
EmailMediaSettings
object
5 properties
FaxSendResponse
object
6 properties
InternalMessageConversation
object
9 properties
OpenEvent
object
Message event element.
1 property
1 required
ConversationQuery
object
10 properties
1 required
ContactAddressableEntityRef
object
2 properties
ResourceConditionNode
object
5 properties
AnalyticsSession
object
89 properties
SecureSessionEntityListing
object
1 property
EvaluationQuestion
object
14 properties
ConversationContentNotificationResponse
object
Inbound response to a notification, such as an Apple Invitations acceptance.
4 properties
2 required
ConversationEventVideo
object
A Video event.
3 properties
1 required
AppleAuthentication
object
4 properties
ArrayNode
object
OpenMessagingIdentityResolutionConfig
object
4 properties
1 required
Empty
object
AiAnswer
object
3 properties
AppleIntegrationEntityListing
object
10 properties
EventSetting
object
1 property
SuggestionKnowledgeSearch
object
8 properties
QueueMessagingAddresses
object
3 properties
InboundMessageRequest
object
12 properties
1 required
WrapupCode
object
9 properties
1 required
CardParameters
object
Template parameters for a single carousel card
3 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
ConversationSummariesGetResponse
object
Defines the summaries of a conversation.
3 properties
Signature
object
4 properties
AnalyticsAgentGroup
object
2 properties
WhatsAppIntegrationEntityListing
object
10 properties
MemberGroup
object
6 properties
CustomAttributesUpdateRequest
object
5 properties
2 required
CallbackConversationEntityListing
object
10 properties
FacebookIntegrationUpdateRequest
object
7 properties
Organization
object
15 properties
1 required
DataSchema
object
9 properties
2 required
InstagramId
object
User information for an Instagram account
3 properties
1 required
ConversationContentInput
object
Single or multiline text input component.
8 properties
2 required
TwitterIntegrationEntityListing
object
10 properties
QuestionGroupSettings
object
2 properties
JsonSearchResponse
object
7 properties
6 required
StarrableDivision
object
3 properties
MessageConversation
object
9 properties
LocationEmergencyNumber
object
3 properties
LineUserId
object
Channel-specific User ID for Line accounts
1 property
1 required
WhatsAppEmbeddedSignupIntegrationActivationRequest
object
5 properties
2 required
SurveyDetailQueryPredicate
object
6 properties
EmployerInfo
object
4 properties
SendAgentlessOutboundMessageRequest
object
6 properties
2 required
ContactIdentifier
object
5 properties
2 required
AggregateMetricData
object
3 properties
Ticker
object
2 properties
2 required
TwitterIntegration
object
14 properties
3 required
RoutingRule
object
3 properties
CreateCallbackOnConversationCommand
object
12 properties
1 required
AnalyticsQueryAggregation
object
5 properties
InboundRoute
object
19 properties
2 required
ChecklistInferenceJobResponse
object
14 properties
2 required
CallbackConversation
object
9 properties
UserParam
object
2 properties
OpenStructuredResponseNormalizedMessage
object
Open Messaging rich media response normalized message structure
6 properties
2 required
Settings
object
6 properties
Chat
object
1 property
CobrowseConversation
object
9 properties
EmailConversationEntityListing
object
10 properties
JourneyContext
object
3 properties
1 required
QueueEmailAddress
object
2 properties
WorkspaceSummary
object
2 properties
JsonCursorSearchResponse
object
4 properties
2 required
Items
object
2 properties
SchemaQuantityLimits
object
16 properties
Actions
object
1 property
TranscriptTopic
object
9 properties
ConversationQueueMediaSettings
object
4 properties
Coretype
object
11 properties
UserReference
object
2 properties
DispositionAmdTimeout
object
4 properties
ConversationReason
object
Reasons for a failed message receipt.
2 properties
1 required
SegmentDetailQueryFilter
object
3 properties
1 required
DraftManipulationRequest
object
2 properties
CustomAttributesListing
object
1 property
ConversationContentPush
object
A Push object
7 properties
7 required
EngagementRequest
object
2 properties
VisibilityCondition
object
2 properties
TopicOffset
object
2 properties
Digits
object
1 property
WritableStarrableDivision
object
3 properties
EvaluationDetailQueryPredicate
object
6 properties
SecureSession
object
7 properties
2 required
AgentChecklistResponseList
object
4 properties
OpenInboundMessagingChannel
object
Open Channel-specific information that describes the message and the message channel/provider.
2 properties
2 required
WebChatMessage
object
8 properties
5 required
Group
object
17 properties
4 required
Evaluation
object
43 properties
DynamicContactQueueingSettings
object
2 properties
Location
object
5 properties
EmailsSettings
object
1 property
ConversationAsyncAggregationQuery
object
13 properties
2 required
Segment
object
5 properties
2 required
CobrowseConversationEntityListing
object
10 properties
ChecklistInferenceJobPayload
object
1 property
1 required
LinkConfiguration
object
1 property
1 required
AggregationRange
object
2 properties
BulkError
object
2 properties
ConversationMessagingFromRecipient
object
Information about the recipient the message is received from.
9 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Genesys 12
Other APIs Genesys publishes across the network.
Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
#Conversations
Where this information came from
This is an independent, third-party profile of Genesys Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.