{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Integrations API", "version": "v2" }, "items": [ { "info": { "name": "Integrations", "type": "folder" }, "items": [ { "info": { "name": "List multiple sets of credentials using cursor-based paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/credentials/listing", "params": [ { "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." } ] }, "docs": "List multiple sets of credentials using cursor-based paging" }, { "info": { "name": "Get a single credential with sensitive fields redacted", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/credentials/:credentialId", "params": [ { "name": "credentialId", "value": "", "type": "path", "description": "Credential ID" } ] }, "docs": "Get a single credential with sensitive fields redacted" }, { "info": { "name": "Update a set of credentials", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/credentials/:credentialId", "params": [ { "name": "credentialId", "value": "", "type": "path", "description": "Credential ID" } ] }, "docs": "Update a set of credentials" }, { "info": { "name": "Delete a set of credentials", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/integrations/credentials/:credentialId", "params": [ { "name": "credentialId", "value": "", "type": "path", "description": "Credential ID" } ] }, "docs": "Delete a set of credentials" }, { "info": { "name": "List all credential types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/credentials/types" }, "docs": "List all credential types" }, { "info": { "name": "List multiple sets of credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/credentials", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)" }, { "info": { "name": "Create a set of credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/credentials" }, "docs": "Create a set of credentials" }, { "info": { "name": "List permitted client app integrations for the logged in user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/clientapps", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" } ] }, "docs": "List permitted client app integrations for the logged in user" }, { "info": { "name": "Get integration configuration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/:integrationId/config/current", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" } ] }, "docs": "Get integration configuration." }, { "info": { "name": "Update integration configuration.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/:integrationId/config/current", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" } ] }, "docs": "Update integration configuration." }, { "info": { "name": "Get integration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" } ] }, "docs": "Get integration." }, { "info": { "name": "Update an integration.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/integrations/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" } ] }, "docs": "Update an integration." }, { "info": { "name": "Delete integration.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/integrations/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration Id" } ] }, "docs": "Delete integration." }, { "info": { "name": "Get properties config schema for an integration type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/types/:typeId/configschemas/:configType", "params": [ { "name": "typeId", "value": "", "type": "path", "description": "Integration Type Id" }, { "name": "configType", "value": "", "type": "path", "description": "Config schema type" } ] }, "docs": "Get properties config schema for an integration type." }, { "info": { "name": "Get integration type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/types/:typeId", "params": [ { "name": "typeId", "value": "", "type": "path", "description": "Integration Type Id" } ] }, "docs": "Get integration type." }, { "info": { "name": "List integration types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/types", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" } ] }, "docs": "List integration types" }, { "info": { "name": "List integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of integration IDs to filter by (max 100)" }, { "name": "integrationType", "value": "", "type": "query", "description": "Filter integrations by integration type ID" }, { "name": "reportedState", "value": "", "type": "query", "description": "Filter integrations by reported state (case-insensitive)" }, { "name": "credentialId", "value": "", "type": "query", "description": "Filter integrations by credential ID" } ] }, "docs": "List integrations" }, { "info": { "name": "Create an integration.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations" }, "docs": "Create an integration." }, { "info": { "name": "List permitted user app integrations for the logged in user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/userapps", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "appHost", "value": "", "type": "query", "description": "The type of UserApp to filter by" } ] }, "docs": "List permitted user app integrations for the logged in user" }, { "info": { "name": "Retrieves all categories of available Actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/categories", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "sortBy", "value": "", "type": "query", "description": "Root level field name to sort on. Only 'name' is supported on this endpoint." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Direction to sort 'sortBy' field." }, { "name": "secure", "value": "", "type": "query", "description": "Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions." } ] }, "docs": "Retrieves all categories of available Actions" }, { "info": { "name": "Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/certificates", "params": [ { "name": "status", "value": "", "type": "query", "description": "Indicates the validity of the certificate in question." }, { "name": "type", "value": "", "type": "query", "description": "Indicates the type of the certificate." } ] }, "docs": "Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress." }, { "info": { "name": "Retrieves basic info about trusted root CA certificates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/certificates/truststore" }, "docs": "Retrieves basic info about trusted root CA certificates" }, { "info": { "name": "Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/test", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." } ] }, "docs": "Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging." }, { "info": { "name": "Retrieve a Draft", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "expand", "value": "", "type": "query", "description": "Indicates a field in the response which should be expanded." }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." }, { "name": "includeConfig", "value": "", "type": "query", "description": "Return config in response." } ] }, "docs": "Retrieve a Draft" }, { "info": { "name": "Create a new Draft from existing Action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Create a new Draft from existing Action" }, { "info": { "name": "Update an existing Draft", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Update an existing Draft" }, { "info": { "name": "Delete a Draft", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Delete a Draft" }, { "info": { "name": "Retrieve schema for a Draft based on filename.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/schemas/:fileName", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "fileName", "value": "", "type": "path", "description": "Name of schema file to be retrieved for this draft." }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." } ] }, "docs": "Retrieve schema for a Draft based on filename." }, { "info": { "name": "Retrieve templates for a Draft based on filename.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/templates/:fileName", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "fileName", "value": "", "type": "path", "description": "Name of template file to be retrieved for this action draft." } ] }, "docs": "Retrieve templates for a Draft based on filename." }, { "info": { "name": "Publish a Draft and make it the active Action configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/publish", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Publish a Draft and make it the active Action configuration" }, { "info": { "name": "Validate current Draft configuration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/validation", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Validate current Draft configuration." }, { "info": { "name": "Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/execute", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." } ] }, "docs": "Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error." }, { "info": { "name": "Retrieves a single Action matching id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "expand", "value": "", "type": "query", "description": "Indicates a field in the response which should be expanded." }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." }, { "name": "includeConfig", "value": "", "type": "query", "description": "Return config in response." } ] }, "docs": "Retrieves a single Action matching id." }, { "info": { "name": "Patch an Action", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Patch an Action" }, { "info": { "name": "Delete an Action", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Delete an Action" }, { "info": { "name": "Retrieve text of templates for an action based on filename.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/templates/:fileName", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "fileName", "value": "", "type": "path", "description": "Name of template file to be retrieved for this action." } ] }, "docs": "Retrieve text of templates for an action based on filename." }, { "info": { "name": "Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/test", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." } ] }, "docs": "Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging." }, { "info": { "name": "Retrieve schema for an action based on filename.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/schemas/:fileName", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" }, { "name": "fileName", "value": "", "type": "path", "description": "Name of schema file to be retrieved for this action." }, { "name": "flatten", "value": "", "type": "query", "description": "Indicates the response should be reformatted, based on Architect's flattening format." } ] }, "docs": "Retrieve schema for an action based on filename." }, { "info": { "name": "Get draft function settings for Action", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/function", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Get draft function settings for Action" }, { "info": { "name": "Update draft function settings.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/function", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Update draft function settings." }, { "info": { "name": "Create upload presigned URL for draft function package file.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/draft/function/upload", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Create upload presigned URL for draft function package file." }, { "info": { "name": "Retrieves all action drafts associated with the filters passed in via query param.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/drafts", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "sortBy", "value": "", "type": "query", "description": "Root level field name to sort on." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Direction to sort 'sortBy' field." }, { "name": "category", "value": "", "type": "query", "description": "Filter by category name." }, { "name": "name", "value": "", "type": "query", "description": "Filter by partial or complete action name." }, { "name": "ids", "value": "", "type": "query", "description": "Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids." }, { "name": "secure", "value": "", "type": "query", "description": "Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions." }, { "name": "includeAuthActions", "value": "", "type": "query", "description": "Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions." }, { "name": "includeConfig", "value": "", "type": "query", "description": "Return config in response." } ] }, "docs": "Retrieves all action drafts associated with the filters passed in via query param." }, { "info": { "name": "Create a new Draft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions/drafts" }, "docs": "Create a new Draft" }, { "info": { "name": "Get published function settings for Action", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/:actionId/function", "params": [ { "name": "actionId", "value": "", "type": "path", "description": "actionId" } ] }, "docs": "Get published function settings for Action" }, { "info": { "name": "Get action function settings for Action", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions/functions/runtimes" }, "docs": "Get action function settings for Action" }, { "info": { "name": "Retrieves all actions associated with filters passed in via query param.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/actions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "sortBy", "value": "", "type": "query", "description": "Root level field name to sort on." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Direction to sort 'sortBy' field." }, { "name": "category", "value": "", "type": "query", "description": "Filter by category name." }, { "name": "name", "value": "", "type": "query", "description": "Filter by partial or complete action name." }, { "name": "ids", "value": "", "type": "query", "description": "Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids." }, { "name": "secure", "value": "", "type": "query", "description": "Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions." }, { "name": "includeAuthActions", "value": "", "type": "query", "description": "Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions." }, { "name": "includeConfig", "value": "", "type": "query", "description": "Return config in response." } ] }, "docs": "Retrieves all actions associated with filters passed in via query param." }, { "info": { "name": "Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/actions" }, "docs": "Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action." }, { "info": { "name": "Get a list of botConnector bots for this integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/botconnector/:integrationId/bots", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" } ] }, "docs": "Get a list of botConnector bots for this integration" }, { "info": { "name": "Set a list of botConnector bots plus versions for this integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/botconnector/:integrationId/bots", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" } ] }, "docs": "Set a list of botConnector bots plus versions for this integration" }, { "info": { "name": "Get a specific botConnector bot, plus versions, for this integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/botconnector/:integrationId/bots/:botId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "botId", "value": "", "type": "path", "description": "The botID for this bot" }, { "name": "version", "value": "", "type": "query", "description": "Specific Version" } ] }, "docs": "Get a specific botConnector bot, plus versions, for this integration" }, { "info": { "name": "Get a summary list of botConnector bots for this integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/botconnector/:integrationId/bots/summaries", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get a summary list of botConnector bots for this integration" }, { "info": { "name": "Get a list of bot versions for a bot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/botconnector/:integrationId/bots/:botId/versions", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID for this bot group" }, { "name": "botId", "value": "", "type": "path", "description": "The botID for this bot" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get a list of bot versions for a bot" }, { "info": { "name": "Get an Audio Connector integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/audioconnector/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "The integration ID" } ] }, "docs": "Get an Audio Connector integration" }, { "info": { "name": "Get a list of Audio Connector integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/audioconnector", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get a list of Audio Connector integrations" }, { "info": { "name": "Get details about a Dialogflow agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/dialogflow/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ] }, "docs": "Get details about a Dialogflow agent" }, { "info": { "name": "Get a list of Dialogflow agents in the customers' Google accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/dialogflow/agents", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Filter on agent name" } ] }, "docs": "Get a list of Dialogflow agents in the customers' Google accounts" }, { "info": { "name": "Get details about a Dialogflow CX agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/dialogflowcx/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ] }, "docs": "Get details about a Dialogflow CX agent" }, { "info": { "name": "Get a list of Dialogflow CX agents in the customers' Google accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/dialogflowcx/agents", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Filter on agent name" } ] }, "docs": "Get a list of Dialogflow CX agents in the customers' Google accounts" }, { "info": { "name": "Get details about a Lex bot alias", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lex/bot/alias/:aliasId", "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "The alias ID" } ] }, "docs": "Get details about a Lex bot alias" }, { "info": { "name": "Get a list of aliases for a bot in the customer's AWS accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lex/bot/:botId/aliases", "params": [ { "name": "botId", "value": "", "type": "path", "description": "The bot ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "status", "value": "", "type": "query", "description": "Filter on alias status" }, { "name": "name", "value": "", "type": "query", "description": "Filter on alias name" } ] }, "docs": "Get a list of aliases for a bot in the customer's AWS accounts" }, { "info": { "name": "Get a list of Lex bots in the customers' AWS accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lex/bots", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Filter on bot name" } ] }, "docs": "Get a list of Lex bots in the customers' AWS accounts" }, { "info": { "name": "Get details about a Lex V2 bot alias", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lexv2/bot/alias/:aliasId", "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "The Alias ID" } ] }, "docs": "Get details about a Lex V2 bot alias" }, { "info": { "name": "Get a list of aliases for a Lex V2 bot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lexv2/bot/:botId/aliases", "params": [ { "name": "botId", "value": "", "type": "path", "description": "The Bot ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "status", "value": "", "type": "query", "description": "Filter on alias status" }, { "name": "name", "value": "", "type": "query", "description": "Filter on alias name" } ] }, "docs": "Get a list of aliases for a Lex V2 bot" }, { "info": { "name": "Get a list of Lex V2 bots", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/lexv2/bots", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Filter on bot name" } ] }, "docs": "Get a list of Lex V2 bots" }, { "info": { "name": "Get the result of an asynchronous Nuance bot GET job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/:botId/jobs/:jobId/results", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "botId", "value": "", "type": "path", "description": "The Nuance bot ID" }, { "name": "jobId", "value": "", "type": "path", "description": "The asynchronous job ID" } ] }, "docs": "Get the result of an asynchronous Nuance bot GET job" }, { "info": { "name": "Get the status of an asynchronous Nuance bot GET job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/:botId/jobs/:jobId", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "botId", "value": "", "type": "path", "description": "The Nuance bot ID" }, { "name": "jobId", "value": "", "type": "path", "description": "The asynchronous job ID" } ] }, "docs": "Get the status of an asynchronous Nuance bot GET job" }, { "info": { "name": "Get a Nuance bot in the specified Integration asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/:botId/jobs", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "botId", "value": "", "type": "path", "description": "The Nuance bot ID" }, { "name": "expand", "value": "", "type": "query", "description": "expand" } ] }, "docs": "Get a Nuance bot in the specified Integration asynchronously" }, { "info": { "name": "Get a Nuance bot in the specified Integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/:botId", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "botId", "value": "", "type": "path", "description": "The Nuance bot ID to get" }, { "name": "expand", "value": "", "type": "query", "description": "expand" }, { "name": "targetChannel", "value": "", "type": "query", "description": "targetChannel" } ] }, "docs": "Get a Nuance bot in the specified Integration" }, { "info": { "name": "Get the result of an asynchronous Nuance bots GET job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/jobs/:jobId/results", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "jobId", "value": "", "type": "path", "description": "The asynchronous job ID" } ] }, "docs": "Get the result of an asynchronous Nuance bots GET job" }, { "info": { "name": "Get the status of an asynchronous Nuance bots GET job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/jobs/:jobId", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "jobId", "value": "", "type": "path", "description": "The asynchronous job ID" } ] }, "docs": "Get the status of an asynchronous Nuance bots GET job" }, { "info": { "name": "Get a list of Nuance bots in the specified Integration asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/jobs", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "onlyRegisteredBots", "value": "", "type": "query", "description": "Limit bots to the ones configured for Genesys Cloud usage" } ] }, "docs": "Get a list of Nuance bots in the specified Integration asynchronously" }, { "info": { "name": "Try out a single credential for a Nuance bot to know if the secret is correct", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/launch/validate", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" } ] }, "docs": "Try out a single credential for a Nuance bot to know if the secret is correct" }, { "info": { "name": "Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots/launch/settings", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" } ] }, "docs": "Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration" }, { "info": { "name": "Get a list of Nuance bots available in the specified Integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/nuance/:nuanceIntegrationId/bots", "params": [ { "name": "nuanceIntegrationId", "value": "", "type": "path", "description": "The integration ID for this group of bots" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "onlyRegisteredBots", "value": "", "type": "query", "description": "Limit bots to the ones configured for Genesys Cloud usage" } ] }, "docs": "If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned." }, { "info": { "name": "Get details about a STT engine", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/stt/engines/:engineId", "params": [ { "name": "engineId", "value": "", "type": "path", "description": "The engine ID" } ] }, "docs": "Get details about a STT engine" }, { "info": { "name": "Get a list of STT engines enabled for org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/stt/engines", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Filter on engine name" } ] }, "docs": "Get a list of STT engines enabled for org" }, { "info": { "name": "Get details about a TTS engine", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/engines/:engineId", "params": [ { "name": "engineId", "value": "", "type": "path", "description": "The engine ID" }, { "name": "includeVoices", "value": "", "type": "query", "description": "Include voices for the engine" } ] }, "docs": "Get details about a TTS engine" }, { "info": { "name": "Get a list of TTS engines enabled for org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/engines", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "includeVoices", "value": "", "type": "query", "description": "Include voices for the engine" }, { "name": "name", "value": "", "type": "query", "description": "Filter on engine name" }, { "name": "language", "value": "", "type": "query", "description": "Filter on supported language. If includeVoices=true then the voices are also filtered." } ] }, "docs": "Get a list of TTS engines enabled for org" }, { "info": { "name": "Get TTS settings for an org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/settings" }, "docs": "Get TTS settings for an org" }, { "info": { "name": "Update TTS settings for an org", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/settings" }, "docs": "Update TTS settings for an org" }, { "info": { "name": "Get details about a specific voice for a TTS engine", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/engines/:engineId/voices/:voiceId", "params": [ { "name": "engineId", "value": "", "type": "path", "description": "The engine ID" }, { "name": "voiceId", "value": "", "type": "path", "description": "The voice ID" } ] }, "docs": "Get details about a specific voice for a TTS engine" }, { "info": { "name": "Get a list of voices for a TTS engine", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/speech/tts/engines/:engineId/voices", "params": [ { "name": "engineId", "value": "", "type": "path", "description": "The engine ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get a list of voices for a TTS engine" }, { "info": { "name": "Invoke Webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/integrations/webhooks/:tokenId/events", "params": [ { "name": "tokenId", "value": "", "type": "path", "description": "The token of the webhook to be invoked" } ] }, "docs": "Invoke Webhook" }, { "info": { "name": "UC integration client application configuration.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/unifiedcommunications/clientapps/:ucIntegrationId", "params": [ { "name": "ucIntegrationId", "value": "", "type": "path", "description": "3rd Party Service Type" } ] }, "docs": "This endpoint returns basic UI configuration data for the specified Unified Communications integration client application." }, { "info": { "name": "List UC integration client application configurations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/integrations/unifiedcommunications/clientapps", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" } ] }, "docs": "This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled." }, { "info": { "name": "Bulk integration presence ingestion", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/integrations/unifiedcommunications/:ucIntegrationId/thirdpartypresences", "params": [ { "name": "ucIntegrationId", "value": "", "type": "path", "description": "UC Integration ID" } ] }, "docs": "This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value." } ] } ], "bundled": true }