{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Conversations API", "version": "v2" }, "items": [ { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Query for conversation aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/query" }, "docs": "Query for conversation aggregates" }, { "info": { "name": "Get a conversation by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/:conversationId/details", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get a conversation by id" }, { "info": { "name": "Query for conversation aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs" }, "docs": "Query for conversation aggregates asynchronously" }, { "info": { "name": "Get status for async query for conversation aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for conversation aggregates" }, { "info": { "name": "Delete/cancel an async request for conversation aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for conversation aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for conversation activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for conversation activity observations" }, { "info": { "name": "Query for conversation details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/query" }, "docs": "Query for conversation details" }, { "info": { "name": "Gets multiple conversations by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details", "params": [ { "name": "id", "value": "", "type": "query", "description": "Comma-separated conversation ids" } ] }, "docs": "Gets multiple conversations by id" }, { "info": { "name": "Index conversation properties", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/:conversationId/details/properties", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Index conversation properties" }, { "info": { "name": "Query for conversation details asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs" }, "docs": "Query for conversation details asynchronously" }, { "info": { "name": "Get status for async query for conversation details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for conversation details" }, { "info": { "name": "Delete/cancel an async details job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async details job" }, { "info": { "name": "Fetch a page of results for an async details job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" }, { "name": "pageSize", "value": "", "type": "query", "description": "The desired maximum number of results" } ] }, "docs": "Fetch a page of results for an async details job" }, { "info": { "name": "Lookup the datalake availability date and time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/availability" }, "docs": "Lookup the datalake availability date and time" }, { "info": { "name": "Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/cobrowse", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission." }, { "info": { "name": "Get the encryption key configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/keyconfigurations/:keyconfigurationsId", "params": [ { "name": "keyconfigurationsId", "value": "", "type": "path", "description": "Key Configurations Id" } ] }, "docs": "Get the encryption key configurations" }, { "info": { "name": "Update the encryption key configurations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/keyconfigurations/:keyconfigurationsId", "params": [ { "name": "keyconfigurationsId", "value": "", "type": "path", "description": "Key Configurations Id" } ] }, "docs": "Update the encryption key configurations" }, { "info": { "name": "Get a list of key configurations data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/keyconfigurations" }, "docs": "Get a list of key configurations data" }, { "info": { "name": "Setup configurations for encryption key creation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/keyconfigurations" }, "docs": "Setup configurations for encryption key creation" }, { "info": { "name": "Validate encryption key configurations without saving it", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/keyconfigurations/validate" }, "docs": "Validate encryption key configurations without saving it" }, { "info": { "name": "Search conversations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/participants/attributes/search" }, "docs": "Search conversations" }, { "info": { "name": "Get conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Get conversation" }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update a conversation by disconnecting all of the participants" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Barge a conversation creating a barged in conference of connected participants.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/barge", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Barge a conversation creating a barged in conference of connected participants." }, { "info": { "name": "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 normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/disconnect", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "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 normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs i" }, { "info": { "name": "Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/assign", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages." }, { "info": { "name": "Update the tags on a conversation.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/tags", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update the tags on a conversation." }, { "info": { "name": "Update the utilization label on a conversation. When there is no value provided, the system default label is applied", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/utilizationlabel", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update the utilization label on a conversation. When there is no value provided, the system default label is applied" }, { "info": { "name": "Get the secure attributes on a conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/secureattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Get the secure attributes on a conversation." }, { "info": { "name": "Set the secure attributes on a conversation.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/secureattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Set the secure attributes on a conversation." }, { "info": { "name": "Update the secure attributes on a conversation.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/secureattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update the secure attributes on a conversation." }, { "info": { "name": "Get active conversations for the logged in user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations", "params": [ { "name": "communicationType", "value": "", "type": "query", "description": "Call or Chat communication filtering" } ] }, "docs": "Get active conversations for the logged in user" }, { "info": { "name": "Create Fax Conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/faxes" }, "docs": "Create Fax Conversation" }, { "info": { "name": "Get Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/settings" }, "docs": "Get Settings" }, { "info": { "name": "Update Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/settings" }, "docs": "Update Settings" }, { "info": { "name": "API invoked to finalize agent checklist evaluation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/finalize", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" } ] }, "docs": "API invoked to finalize agent checklist evaluation." }, { "info": { "name": "Get checklist info for a single checklist.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/:agentChecklistId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" }, { "name": "agentChecklistId", "value": "", "type": "path", "description": "Agent Checklist ID" } ] }, "docs": "Get checklist info for a single checklist." }, { "info": { "name": "Agent Checklist activation API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/:agentChecklistId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" }, { "name": "agentChecklistId", "value": "", "type": "path", "description": "Agent Checklist ID" } ] }, "docs": "Agent Checklist activation API" }, { "info": { "name": "Create inference job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/:agentChecklistId/jobs", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" }, { "name": "agentChecklistId", "value": "", "type": "path", "description": "Agent Checklist ID" } ] }, "docs": "Create inference job" }, { "info": { "name": "Get inference job status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/:agentChecklistId/jobs/:jobId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" }, { "name": "agentChecklistId", "value": "", "type": "path", "description": "Agent Checklist ID" }, { "name": "jobId", "value": "", "type": "path", "description": "Inference Job ID" } ] }, "docs": "Get inference job status" }, { "info": { "name": "Get information of all checklists associated with a conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" } ] }, "docs": "Get information of all checklists associated with a conversation." }, { "info": { "name": "API invoked to capture an agent action.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/agentchecklists/:agentChecklistId/agentaction", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "communicationId", "value": "", "type": "path", "description": "Communication ID" }, { "name": "agentChecklistId", "value": "", "type": "path", "description": "Agent Checklist ID" } ] }, "docs": "API invoked to capture an agent action." }, { "info": { "name": "Get a list of custom attributes for a conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Get a list of custom attributes for a conversation." }, { "info": { "name": "Create or update a single custom attributes record. Updating replaces all data with the provided fields.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Create or update a single custom attributes record. Updating replaces all data with the provided fields." }, { "info": { "name": "Update a single custom attributes record by amending the data with only the provided fields.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update a single custom attributes record by amending the data with only the provided fields." }, { "info": { "name": "Get custom attributes by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes/:attributesId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "attributesId", "value": "", "type": "path", "description": "attributesId" } ] }, "docs": "Get custom attributes by id" }, { "info": { "name": "Delete a custom attributes record.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes/:attributesId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "attributesId", "value": "", "type": "path", "description": "attributesId" } ] }, "docs": "Delete a custom attributes record." }, { "info": { "name": "Create or update a list of custom attributes records. Updating replaces all data with the provided fields.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes/bulk", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Create or update a list of custom attributes records. Updating replaces all data with the provided fields." }, { "info": { "name": "Update a list of custom attributes record by amending the data with only the provided fields.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/customattributes/bulk", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" } ] }, "docs": "Update a list of custom attributes record by amending the data with only the provided fields." }, { "info": { "name": "Search resources.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/customattributes/search" }, "docs": "Search resources." }, { "info": { "name": "Get the core types from which all schemas are built.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/coretypes/:coreTypeName", "params": [ { "name": "coreTypeName", "value": "", "type": "path", "description": "Name of the core type" } ] }, "docs": "Get the core types from which all schemas are built." }, { "info": { "name": "Get the list of core types enabled for a specific namespace.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/coretypes" }, "docs": "Get the list of core types enabled for a specific namespace." }, { "info": { "name": "Get quantitative limits on schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/limits" }, "docs": "Get quantitative limits on schemas" }, { "info": { "name": "Get a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get a schema" }, { "info": { "name": "Update a schema", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Update a schema" }, { "info": { "name": "Get all versions of a CCA schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/:schemaId/versions", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get all versions of a CCA schema" }, { "info": { "name": "Get a specific version of a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas/:schemaId/versions/:versionId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Schema version" } ] }, "docs": "Get a specific version of a schema" }, { "info": { "name": "Get a list of schemas.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas" }, "docs": "Get a list of schemas." }, { "info": { "name": "Create a schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/customattributes/schemas" }, "docs": "Create a schema" }, { "info": { "name": "Update after-call work for this conversation communication.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/aftercallwork/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Update after-call work for this conversation communication." }, { "info": { "name": "Update multiple scheduled callbacks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/callbacks/bulk/update" }, "docs": "Update multiple scheduled callbacks" }, { "info": { "name": "Disconnect multiple scheduled callbacks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/callbacks/bulk/disconnect" }, "docs": "Disconnect multiple scheduled callbacks" }, { "info": { "name": "Get the logged-in user's active conversations and their Call participants state.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls" }, "docs": "This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?" }, { "info": { "name": "Create a call conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls" }, "docs": "Create a call conversation" }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Replace this participant with the specified user and/or address" }, { "info": { "name": "Listen in on the conversation from the point of view of a given participant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/monitor", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Listen in on the conversation from the point of view of a given participant." }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Get list of wrapup codes for this conversation participant" }, { "info": { "name": "Get call conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get call conversation" }, { "info": { "name": "Place a new call as part of a callback conversation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Place a new call as part of a callback conversation." }, { "info": { "name": "Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update the attributes on a conversation participant." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation participant. " }, { "info": { "name": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup." }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation participant" }, { "info": { "name": "Create a call conversation on behalf of a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/user/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Create a call conversation on behalf of a user" }, { "info": { "name": "Get the maximum number of participants that this user can have on a conference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/maximumconferenceparties" }, "docs": "Get the maximum number of participants that this user can have on a conference" }, { "info": { "name": "Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/coach", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Listen in on the conversation from the point of view of a given participant while speaking to just the given participant." }, { "info": { "name": "Barge a given participant's call creating a barged in conference of connected participants.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/barge", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Barge a given participant's call creating a barged in conference of connected participants." }, { "info": { "name": "Initiate and update consult transfer (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external." }, { "info": { "name": "Change who can speak", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Change who can speak" }, { "info": { "name": "Cancel the transfer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Cancel the transfer" }, { "info": { "name": "Initiate voice consult transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/voice/consult", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Initiate voice consult transfer" }, { "info": { "name": "Initiate a consult transfer to an agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult/agent", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Initiate a consult transfer to an agent" }, { "info": { "name": "Initiate a consult transfer to a queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult/queue", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Initiate a consult transfer to a queue" }, { "info": { "name": "Initiate a consult transfer to an external contact (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult/external", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Use /consult/contact/external endpoints instead." }, { "info": { "name": "Initiate a consult transfer to an external contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/consult/contact/external", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Initiate a consult transfer to an external contact" }, { "info": { "name": "Update a conversation by merging in other conversations to create a conference", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/conference", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by merging in other conversations to create a conference" }, { "info": { "name": "Start/stop the snippet recording for a participant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/snippet/record", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Start/stop the snippet recording for a participant" }, { "info": { "name": "Add participants to a conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Add participants to a conversation" }, { "info": { "name": "Add participants to a conversation on behalf of a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/user/:userId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Add participants to a conversation on behalf of a user" }, { "info": { "name": "Update conversation participant on behalf of a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/user/:userId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Update conversation participant on behalf of a user" }, { "info": { "name": "Get call history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/calls/history", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size, maximum 50" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "interval", "value": "", "type": "query", "description": "Interval string; format is ISO-8601. Separate start and end times with forward slash '/'" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Get call history" }, { "info": { "name": "Set uuiData to be sent on future commands.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId/uuidata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Set uuiData to be sent on future commands." }, { "info": { "name": "Set mandatory post call actions. If both values are null or blank error will occur.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId/postflowaction", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Set mandatory post call actions. If both values are null or blank error will occur." }, { "info": { "name": "Remove mandatory post call actions.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/calls/:conversationId/participants/:participantId/communications/:communicationId/postflowaction", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Remove mandatory post call actions." }, { "info": { "name": "Get the logged-in user's active conversations and their Callback participants state.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/callbacks" }, "docs": "This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?" }, { "info": { "name": "Create a Callback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/callbacks" }, "docs": "Create a Callback" }, { "info": { "name": "Update a scheduled callback", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/callbacks" }, "docs": "Update a scheduled callback" }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Replace this participant with the specified user and/or address" }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Get list of wrapup codes for this conversation participant" }, { "info": { "name": "Get callback conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get callback conversation" }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by disconnecting all of the participants" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update the attributes on a conversation participant." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation participant. " }, { "info": { "name": "Update conversation participant's communication by disconnecting it.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Update conversation participant's communication by disconnecting it." }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/callbacks/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation participant" }, { "info": { "name": "Get a web chat conversation message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/messages/:messageId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "messageId", "value": "", "type": "path", "description": "messageId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages." }, { "info": { "name": "Get the messages of a chat conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "after", "value": "", "type": "query", "description": "If specified, get the messages chronologically after the id of this message" }, { "name": "before", "value": "", "type": "query", "description": "If specified, get the messages chronologically before the id of this message" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "maxResults", "value": "", "type": "query", "description": "Limit the returned number of messages, up to a maximum of 100" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages." }, { "info": { "name": "Send a message on behalf of a communication in a chat conversation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/communications/:communicationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Send a typing-indicator on behalf of a communication in a chat conversation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/communications/:communicationId/typing", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Get active chat conversations for the logged in user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats" }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Create a web chat conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/chats" }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Get chat conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/chats/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/." }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Get active cobrowse conversations for the logged in user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions" }, "docs": "Get active cobrowse conversations for the logged in user" }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Get cobrowse conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get cobrowse conversation" }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Update conversation participant's communication by disconnecting it.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/cobrowsesessions/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Replace this participant with the specified user and/or address" }, { "info": { "name": "Get conversation message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/:messageId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "messageId", "value": "", "type": "path", "description": "messageId" } ] }, "docs": "Get conversation message" }, { "info": { "name": "Get the logged-in user's active conversations and their Email participants state.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails" }, "docs": "This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?" }, { "info": { "name": "Create an email conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails" }, "docs": "If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue." }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Get list of wrapup codes for this conversation participant" }, { "info": { "name": "Get conversation messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "includeAgentlessStitchedMessages", "value": "", "type": "query", "description": "Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message." } ] }, "docs": "Get conversation messages" }, { "info": { "name": "Send an email reply", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Send an email reply" }, { "info": { "name": "Get email conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get email conversation" }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by disconnecting all of the participants" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update the attributes on a conversation participant." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation participant. " }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation participant" }, { "info": { "name": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup." }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Get emails settings for a given conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/settings", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get emails settings for a given conversation" }, { "info": { "name": "Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/reconnect", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This request is not valid when using the Client Credentials OAuth grant." }, { "info": { "name": "Delete attachment from draft", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft/attachments/:attachmentId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "attachmentId", "value": "", "type": "path", "description": "attachmentId" } ] }, "docs": "Delete attachment from draft" }, { "info": { "name": "Copy attachments from an email message to the current draft.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft/attachments/copy", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Copy attachments from an email message to the current draft." }, { "info": { "name": "Create a URL to upload a message attachment file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft/attachments/uploads", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "See https://developer.genesys.cloud/analyticsdatamanagement/uploads/upload-email-attachment-files for example usage." }, { "info": { "name": "Get conversation draft reply", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get conversation draft reply" }, { "info": { "name": "Update conversation draft reply", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update conversation draft reply" }, { "info": { "name": "Reset conversation draft to its initial state and/or auto-fill draft content", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/messages/draft", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "autoFill", "value": "", "type": "query", "description": "autoFill" }, { "name": "discard", "value": "", "type": "query", "description": "discard" } ] }, "docs": "Reset conversation draft to its initial state and/or auto-fill draft content" }, { "info": { "name": "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 message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/inboundmessages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "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 message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it." }, { "info": { "name": "Update conversation by setting its parking state", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/emails/:conversationId/participants/:participantId/parkingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation by setting its parking state" }, { "info": { "name": "Create an email conversation, per API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/emails/agentless" }, "docs": "Create an email conversation, per API" }, { "info": { "name": "Get the logged-in user's active conversations and their InternalMessage participants state.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/internalmessages" }, "docs": "This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?" }, { "info": { "name": "Get internal message conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/internalmessages/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get internal message conversation" }, { "info": { "name": "Get a cached media item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/cachedmedia/:cachedMediaItemId", "params": [ { "name": "cachedMediaItemId", "value": "", "type": "path", "description": "cachedMediaItemId" } ] }, "docs": "Get a cached media item" }, { "info": { "name": "Remove a cached media item asychronously", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messages/cachedmedia/:cachedMediaItemId", "params": [ { "name": "cachedMediaItemId", "value": "", "type": "path", "description": "cachedMediaItemId" } ] }, "docs": "Remove a cached media item asychronously" }, { "info": { "name": "Get a list of cached media items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/cachedmedia", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "url", "value": "", "type": "query", "description": "URL to search for" } ] }, "docs": "Get a list of cached media items" }, { "info": { "name": "Replace this participant with the specified user and/or address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Replace this participant with the specified user and/or address" }, { "info": { "name": "Get message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:messageId/details", "params": [ { "name": "messageId", "value": "", "type": "path", "description": "messageId" }, { "name": "useNormalizedMessage", "value": "", "type": "query", "description": "If true, response removes deprecated fields (textBody, media)" } ] }, "docs": "Get message" }, { "info": { "name": "Get the logged-in user's active conversations and their Message participants state.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages" }, "docs": "This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?" }, { "info": { "name": "Create an outbound messaging conversation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages" }, "docs": "If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExisti" }, { "info": { "name": "Listen in on the conversation from the point of view of a given participant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/monitor", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Listen in on the conversation from the point of view of a given participant." }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Get list of wrapup codes for this conversation participant" }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "useNormalizedMessage", "value": "", "type": "query", "description": "If true, response removes deprecated fields (textBody, media)" } ] }, "docs": "Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate." }, { "info": { "name": "Get messages in batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/messages/bulk", "params": [ { "name": "conversationId", "value": "", "type": "path" }, { "name": "useNormalizedMessage", "value": "", "type": "query", "description": "If true, response removes deprecated fields (textBody, media)" } ] }, "docs": "The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default." }, { "info": { "name": "Get message conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get message conversation" }, { "info": { "name": "Update a conversation by disconnecting all of the participants", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by disconnecting all of the participants" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update the attributes on a conversation participant." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation participant. " }, { "info": { "name": "Update conversation participant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation participant" }, { "info": { "name": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/communications/:communicationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup." }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Update conversation by setting its parking state", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/participants/:participantId/parkingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" } ] }, "docs": "Update conversation by setting its parking state" }, { "info": { "name": "Get conversation message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/messages/:messageId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "messageId", "value": "", "type": "path", "description": "messageId" }, { "name": "useNormalizedMessage", "value": "", "type": "query", "description": "If true, response removes deprecated fields (textBody, media)" } ] }, "docs": "Get conversation message" }, { "info": { "name": "Send a social media message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/socialmedia/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Send a social media message on existing conversation/communication." }, { "info": { "name": "Get message media list by status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/messages/media", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "status", "value": "", "type": "query", "description": "The status on which to filter the response." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get message media list by status" }, { "info": { "name": "Create media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/messages/media", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage." }, { "info": { "name": "Create a URL to upload a message media file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/messages/media/uploads", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage." }, { "info": { "name": "Get media", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/messages/media/:mediaId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "mediaId", "value": "", "type": "path", "description": "mediaId" } ] }, "docs": "See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage." }, { "info": { "name": "Send an agentless outbound message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/agentless", "params": [ { "name": "useNormalizedMessage", "value": "", "type": "query", "description": "If true, response removes deprecated fields (textBody, messagingTemplate)" } ] }, "docs": "Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and recipient specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation." }, { "info": { "name": "Send an inbound Open Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/inbound/open" }, "docs": "[This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials" }, { "info": { "name": "Send an inbound Open Event Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:integrationId/inbound/open/event", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integrationId" } ] }, "docs": "Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage." }, { "info": { "name": "Send inbound Open Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:integrationId/inbound/open/message", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integrationId" }, { "name": "prefetchConversationId", "value": "", "type": "query", "description": "Indicates whether or not to prefetch conversationId" } ] }, "docs": "Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage." }, { "info": { "name": "Send inbound Open Response", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:integrationId/inbound/open/structured/response", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integrationId" } ] }, "docs": "Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage." }, { "info": { "name": "Send an inbound Open Receipt Message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:integrationId/inbound/open/receipt", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integrationId" } ] }, "docs": "Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage." }, { "info": { "name": "Send message typing event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messages/:conversationId/communications/:communicationId/typing", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Send message typing event for existing conversation/communication." }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/screenshares/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/screenshares/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/screenshares/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/socials/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/socials/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/socials/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Update a conversation by setting its recording state", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/videos/:conversationId/recordingstate", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Update a conversation by setting its recording state" }, { "info": { "name": "Get the wrap-up for this conversation communication. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/videos/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates whether or not to fetch provisional wrap-up code." } ] }, "docs": "Get the wrap-up for this conversation communication. " }, { "info": { "name": "Apply wrap-up for this conversation communication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/videos/:conversationId/participants/:participantId/communications/:communicationId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "participantId", "value": "", "type": "path", "description": "participantId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Apply wrap-up for this conversation communication" }, { "info": { "name": "Gets a record for a given meetingId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/videos/meetings/:meetingId", "params": [ { "name": "meetingId", "value": "", "type": "path", "description": "meetingId" } ] }, "docs": "Gets a record for a given meetingId" }, { "info": { "name": "Generate a meetingId for a given conferenceId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/videos/meetings" }, "docs": "Generate a meetingId for a given conferenceId" }, { "info": { "name": "Get message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/internalmessages/:messageId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "messageId", "value": "", "type": "path", "description": "messageId" } ] }, "docs": "Get message" }, { "info": { "name": "Get messages for communication", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/internalmessages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" }, { "name": "pageSize", "value": "", "type": "query", "description": "Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get messages for communication" }, { "info": { "name": "Send internal message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/communications/:communicationId/internalmessages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "communicationId", "value": "", "type": "path", "description": "communicationId" } ] }, "docs": "Send a new internal message for an existing communication." }, { "info": { "name": "Get a list of Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of Integrations" }, { "info": { "name": "Get conversation threading window timeline for each messaging type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/threadingtimeline" }, "docs": "Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline e" }, { "info": { "name": "Update conversation threading window timeline for each messaging type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/threadingtimeline" }, "docs": "PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType." }, { "info": { "name": "Get Apple messaging integration identity resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/apple/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get Apple messaging integration identity resolution settings" }, { "info": { "name": "Create an identity resolution settings for a Apple messaging integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/apple/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Create an identity resolution settings for a Apple messaging integration" }, { "info": { "name": "Get an Apple messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/apple/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "Get an Apple messaging integration" }, { "info": { "name": "Update an Apple messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/apple/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update an Apple messaging integration" }, { "info": { "name": "Delete an Apple messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/apple/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Delete an Apple messaging integration" }, { "info": { "name": "Get a list of Apple Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/apple", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of Apple Integrations" }, { "info": { "name": "Create Apple Integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/apple" }, "docs": "Create Apple Integration" }, { "info": { "name": "Get Genesys Facebook App Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/facebook/app" }, "docs": "Get Genesys Facebook App Id" }, { "info": { "name": "Get Facebook messaging integration identity resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/facebook/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get Facebook messaging integration identity resolution settings" }, { "info": { "name": "Create an identity resolution settings for a Facebook messaging integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/facebook/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Create an identity resolution settings for a Facebook messaging integration" }, { "info": { "name": "Get a Facebook messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/facebook/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "Get a Facebook messaging integration" }, { "info": { "name": "Update Facebook messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/facebook/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update Facebook messaging integration" }, { "info": { "name": "Delete a Facebook messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/facebook/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Delete a Facebook messaging integration" }, { "info": { "name": "Get a list of Facebook Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/facebook", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of Facebook Integrations" }, { "info": { "name": "Create a Facebook Integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/facebook" }, "docs": "Create a Facebook Integration" }, { "info": { "name": "Get a list of Facebook Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/facebook/permissions" }, "docs": "Get a list of Facebook Permissions" }, { "info": { "name": "Get an Instagram integration identity resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/instagram/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get an Instagram integration identity resolution settings" }, { "info": { "name": "Create identity resolution settings for an Instagram messaging integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/instagram/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Create identity resolution settings for an Instagram messaging integration" }, { "info": { "name": "Get Instagram messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/instagram/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "Get Instagram messaging integration" }, { "info": { "name": "Update Instagram messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/instagram/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update Instagram messaging integration" }, { "info": { "name": "Delete Instagram messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/instagram/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Delete Instagram messaging integration" }, { "info": { "name": "Get a list of Instagram Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/instagram", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of Instagram Integrations" }, { "info": { "name": "Create Instagram Integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/instagram" }, "docs": "Create Instagram Integration" }, { "info": { "name": "Get an open messaging integration Identity Resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/open/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get an open messaging integration Identity Resolution settings" }, { "info": { "name": "Update an open messaging integration Identity Resolution settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/open/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update an open messaging integration Identity Resolution settings" }, { "info": { "name": "Get an Open messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/open/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "See https://developer.genesys.cloud/api/digital/openmessaging/ for more information." }, { "info": { "name": "Update an Open messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/open/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "See https://developer.genesys.cloud/api/digital/openmessaging/ for more information." }, { "info": { "name": "Delete an Open messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/open/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "See https://developer.genesys.cloud/api/digital/openmessaging/ for more information." }, { "info": { "name": "Get a list of Open messaging integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/open", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "See https://developer.genesys.cloud/api/digital/openmessaging/ for more information." }, { "info": { "name": "Create an Open messaging integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/open" }, "docs": "See https://developer.genesys.cloud/api/digital/openmessaging/ for more information." }, { "info": { "name": "Get the organization's default settings that will be used as the default when creating an integration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/default" }, "docs": "When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it." }, { "info": { "name": "Set the organization's default setting that may be applied to to integrations without settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/default" }, "docs": "When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it." }, { "info": { "name": "Delete the organization's default setting, a global default will be applied to integrations without settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/default" }, "docs": "When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it." }, { "info": { "name": "Get a list of messaging settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of messaging settings" }, { "info": { "name": "Create a messaging setting", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings" }, "docs": "Create a messaging setting" }, { "info": { "name": "Get a messaging setting", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/:messageSettingId", "params": [ { "name": "messageSettingId", "value": "", "type": "path", "description": "Message Setting ID" } ] }, "docs": "Get a messaging setting" }, { "info": { "name": "Update a messaging setting", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/:messageSettingId", "params": [ { "name": "messageSettingId", "value": "", "type": "path", "description": "Message Setting ID" } ] }, "docs": "Update a messaging setting" }, { "info": { "name": "Delete a messaging setting", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/settings/:messageSettingId", "params": [ { "name": "messageSettingId", "value": "", "type": "path", "description": "Message Setting ID" } ] }, "docs": "Delete a messaging setting" }, { "info": { "name": "Get the organization's default supported content profile that will be used as the default when creating an integration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent/default" }, "docs": "When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it." }, { "info": { "name": "Set the organization's default supported content profile that may be assigned to an integration when it is created.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent/default" }, "docs": "When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it." }, { "info": { "name": "Get a supported content profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent/:supportedContentId", "params": [ { "name": "supportedContentId", "value": "", "type": "path", "description": "Supported Content ID" } ] }, "docs": "Get a supported content profile" }, { "info": { "name": "Update a supported content profile", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent/:supportedContentId", "params": [ { "name": "supportedContentId", "value": "", "type": "path", "description": "Supported Content ID" } ] }, "docs": "Update a supported content profile" }, { "info": { "name": "Delete a supported content profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent/:supportedContentId", "params": [ { "name": "supportedContentId", "value": "", "type": "path", "description": "Supported Content ID" } ] }, "docs": "Delete a supported content profile" }, { "info": { "name": "Get a list of Supported Content profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of Supported Content profiles" }, { "info": { "name": "Create a Supported Content profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/supportedcontent" }, "docs": "Create a Supported Content profile" }, { "info": { "name": "Get X (Formally Twitter) messaging integration identity resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/twitter/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" } ] }, "docs": "Get X (Formally Twitter) messaging integration identity resolution settings" }, { "info": { "name": "Create an identity resolution settings for an X (Formally Twitter) messaging integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/twitter/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" } ] }, "docs": "Create an identity resolution settings for an X (Formally Twitter) messaging integration" }, { "info": { "name": "Get Twitter messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "Get Twitter messaging integration" }, { "info": { "name": "Update a Twitter messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update a Twitter messaging integration" }, { "info": { "name": "Delete Twitter messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Delete Twitter messaging integration" }, { "info": { "name": "Get a list of Twitter Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of Twitter Integrations" }, { "info": { "name": "Create Twitter Integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter" }, "docs": "Create Twitter Integration" }, { "info": { "name": "Get twitter oauth settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/twitter/oauth/settings" }, "docs": "Get twitter oauth settings" }, { "info": { "name": "Get twitter oauth settings to patch an integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/:integrationId/twitter/oauth/settings", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id of an existing integration that needs to be patched with new oauth settings" } ] }, "docs": "Get twitter oauth settings to patch an integration" }, { "info": { "name": "Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active." }, { "info": { "name": "Create a WhatsApp Integration using the WhatsApp embedded signup flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup" }, "docs": "Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one o" }, { "info": { "name": "Get a whatsApp integration Identity Resolution settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get a whatsApp integration Identity Resolution settings" }, { "info": { "name": "Update a whatsApp integration Identity Resolution settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update a whatsApp integration Identity Resolution settings" }, { "info": { "name": "Get a WhatsApp messaging integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." } ] }, "docs": "Get a WhatsApp messaging integration" }, { "info": { "name": "Update a WhatsApp messaging integration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Update a WhatsApp messaging integration" }, { "info": { "name": "Delete a WhatsApp messaging integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Delete a WhatsApp messaging integration" }, { "info": { "name": "Get a list of WhatsApp Integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value." }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter integrations returned based on the supported content ID" }, { "name": "messagingSetting.id", "value": "", "type": "query", "description": "Filter integrations returned based on the setting ID" } ] }, "docs": "Get a list of WhatsApp Integrations" }, { "info": { "name": "[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/messaging/integrations/whatsapp" }, "docs": "[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation." }, { "info": { "name": "Delete a code used to add a communication to this participant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/codes/:addCommunicationCode", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" }, { "name": "addCommunicationCode", "value": "", "type": "path", "description": "addCommunicationCode" } ] }, "docs": "Delete a code used to add a communication to this participant" }, { "info": { "name": "Update a participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Update conversation participant." }, { "info": { "name": "Replace this participant (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/replace", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external." }, { "info": { "name": "Replace this participant by another one using the address of the destination.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/transfer", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Replace this participant by another one using the address of the destination." }, { "info": { "name": "Sends DTMF to the participant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/digits", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Sends DTMF to the participant" }, { "info": { "name": "Get list of wrapup codes for this conversation participant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/wrapupcodes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Get list of wrapup codes for this conversation participant" }, { "info": { "name": "Create a new callback for the specified participant on the conversation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/callbacks", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Create a new callback for the specified participant on the conversation." }, { "info": { "name": "Update the attributes on a conversation participant.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/attributes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Update the attributes on a conversation participant." }, { "info": { "name": "Get the wrap-up for this conversation participant. ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/wrapup", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" }, { "name": "provisional", "value": "", "type": "query", "description": "Indicates if the wrap-up code is provisional." } ] }, "docs": "Get the wrap-up for this conversation participant. " }, { "info": { "name": "Replace this participant with the specified agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/replace/agent", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Replace this participant with the specified agent" }, { "info": { "name": "Replace this participant with the specified queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/replace/queue", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Replace this participant with the specified queue" }, { "info": { "name": "Replace this participant with the an external contact (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/replace/external", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "This endpoint is deprecated. Use /replace/contact/external endpoint instead." }, { "info": { "name": "Replace this participant with the an external contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/replace/contact/external", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Replace this participant with the an external contact" }, { "info": { "name": "Setup internal message communication with user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/internalmessages/users/communications", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission." }, { "info": { "name": "Set flagged reason on conversation participant to indicate bad conversation quality.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/flaggedreason", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Set flagged reason on conversation participant to indicate bad conversation quality." }, { "info": { "name": "Remove flagged reason from conversation participant.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/flaggedreason", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Remove flagged reason from conversation participant." }, { "info": { "name": "Fetch info on a secure session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/secureivrsessions/:secureSessionId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" }, { "name": "secureSessionId", "value": "", "type": "path", "description": "secure IVR session ID" } ] }, "docs": "Fetch info on a secure session" }, { "info": { "name": "Get a list of secure sessions for this participant.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/secureivrsessions", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Get a list of secure sessions for this participant." }, { "info": { "name": "Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/participants/:participantId/secureivrsessions", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversation ID" }, { "name": "participantId", "value": "", "type": "path", "description": "participant ID" } ] }, "docs": "Create secure IVR session. Only a participant in the conversation can invoke a secure IVR." }, { "info": { "name": "Suggestion feedback.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/suggestions/feedback", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Google Agent Assist offering within Genesys will no longer be supported" }, { "info": { "name": "Get all suggestions for a conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/suggestions", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "type", "value": "", "type": "query", "description": "Suggestion type to filter by." }, { "name": "state", "value": "", "type": "query", "description": "Suggestion state to filter Copilot suggestions." } ] }, "docs": "Get all suggestions for a conversation." }, { "info": { "name": "Get Suggestion.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/suggestions/:suggestionId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "suggestionId", "value": "", "type": "path", "description": "Suggestion ID" } ] }, "docs": "Get Suggestion." }, { "info": { "name": "Save an engagement on the suggestion.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/suggestions/:suggestionId/engagement", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "suggestionId", "value": "", "type": "path", "description": "Suggestion ID" } ] }, "docs": "Save an engagement on the suggestion." }, { "info": { "name": "Get the summaries of the conversation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/summaries", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Get the summaries of the conversation." }, { "info": { "name": "Update agent's engagement for the summary.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/summaries/:summaryId/engagements", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "summaryId", "value": "", "type": "path", "description": "Summary ID" } ] }, "docs": "Update agent's engagement for the summary." }, { "info": { "name": "Submit feedback for the summary.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/summaries/:summaryId/feedback", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "summaryId", "value": "", "type": "path", "description": "Summary ID" } ] }, "docs": "Submit feedback for the summary." }, { "info": { "name": "Update the feedback for the summary.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/summaries/:summaryId/feedback", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "summaryId", "value": "", "type": "path", "description": "Summary ID" } ] }, "docs": "Update the feedback for the summary." }, { "info": { "name": "Call Authentication provider callback to validate state and code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/messaging/oauth/apple/callback", "params": [ { "name": "code", "value": "", "type": "query", "description": "The authorization code to be sent to the authentication server during the token request." }, { "name": "state", "value": "", "type": "query", "description": "The state/nonce value generated by Genesys Auth-Client Service." }, { "name": "error", "value": "", "type": "query", "description": "Error parameter from OAuth provider" } ] }, "docs": "Call Authentication provider callback to validate state and code" } ] } ], "bundled": true }