swagger: '2.0' info: description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more. version: v2 title: PureCloud Platform Agent Assistants Conversations API termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/ contact: name: PureCloud Developer Evangelists url: https://developer.genesys.cloud/ email: DeveloperEvangelists@genesys.com license: name: UNLICENSED url: https://help.genesys.cloud/articles/terms-and-conditions/ host: api.mypurecloud.com schemes: - https consumes: - application/json produces: - application/json tags: - name: Conversations description: '' externalDocs: description: Conversations Documentation url: https://developer.genesys.cloud/routing/conversations/conversations-apis paths: /api/v2/analytics/conversations/aggregates/query: post: tags: - Conversations summary: Query for conversation aggregates description: '' operationId: postAnalyticsConversationsAggregatesQuery produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/ConversationAggregationQuery' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationAggregateQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). general.internal.server.error: An internal server error has occurred. '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationAggregate:view x-purecloud-method-name: postAnalyticsConversationsAggregatesQuery /api/v2/analytics/conversations/{conversationId}/details: get: tags: - Conversations summary: Get a conversation by id description: '' operationId: getAnalyticsConversationDetails produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AnalyticsConversationWithoutAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: getAnalyticsConversationDetails /api/v2/analytics/conversations/aggregates/jobs: post: tags: - Conversations summary: Query for conversation aggregates asynchronously description: '' operationId: postAnalyticsConversationsAggregatesJobs produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/ConversationAsyncAggregationQuery' responses: '202': description: Accepted - Running query asynchronously schema: $ref: '#/definitions/AsyncQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationAggregate:view x-purecloud-method-name: postAnalyticsConversationsAggregatesJobs /api/v2/analytics/conversations/aggregates/jobs/{jobId}: get: tags: - Conversations summary: Get status for async query for conversation aggregates description: '' operationId: getAnalyticsConversationsAggregatesJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AsyncQueryStatus' '202': description: Accepted - Running query asynchronously schema: $ref: '#/definitions/AsyncQueryStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationAggregate:view x-purecloud-method-name: getAnalyticsConversationsAggregatesJob delete: tags: - Conversations summary: Delete/cancel an async request for conversation aggregates description: '' operationId: deleteAnalyticsConversationsAggregatesJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '204': description: Deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics x-inin-requires-permissions: type: ANY permissions: - analytics:conversationAggregate:view x-purecloud-method-name: deleteAnalyticsConversationsAggregatesJob /api/v2/analytics/conversations/aggregates/jobs/{jobId}/results: get: tags: - Conversations summary: Fetch a page of results for an async aggregates query description: '' operationId: getAnalyticsConversationsAggregatesJobResults produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string - name: cursor in: query description: Cursor token to retrieve next page required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationAsyncAggregateQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationAggregate:view x-purecloud-method-name: getAnalyticsConversationsAggregatesJobResults /api/v2/analytics/conversations/activity/query: post: tags: - Conversations summary: Query for conversation activity observations description: '' operationId: postAnalyticsConversationsActivityQuery produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/ConversationActivityQuery' - name: pageSize in: query description: The desired page size required: false type: integer format: int32 - name: pageNumber in: query description: The desired page number required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationActivityResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:queueObservation:view x-purecloud-method-name: postAnalyticsConversationsActivityQuery /api/v2/analytics/conversations/details/query: post: tags: - Conversations summary: Query for conversation details description: '' operationId: postAnalyticsConversationsDetailsQuery produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/ConversationQuery' responses: '200': description: successful operation schema: $ref: '#/definitions/AnalyticsConversationQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: payload.too.large: The response payload was too large. request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). general.internal.server.error: An internal server error has occurred. '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: postAnalyticsConversationsDetailsQuery /api/v2/analytics/conversations/details: get: tags: - Conversations summary: Gets multiple conversations by id description: '' operationId: getAnalyticsConversationsDetails produces: - application/json parameters: - name: id in: query description: Comma-separated conversation ids required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: getAnalyticsConversationsDetails /api/v2/analytics/conversations/{conversationId}/details/properties: post: tags: - Conversations summary: Index conversation properties description: '' operationId: postAnalyticsConversationDetailsProperties produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: request required: true schema: $ref: '#/definitions/PropertyIndexRequest' responses: '202': description: Accepted - Indexing properties schema: $ref: '#/definitions/PropertyIndexRequest' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics x-inin-requires-permissions: type: ANY permissions: - analytics:conversationProperties:index x-purecloud-method-name: postAnalyticsConversationDetailsProperties /api/v2/analytics/conversations/details/jobs: post: tags: - Conversations summary: Query for conversation details asynchronously description: '' operationId: postAnalyticsConversationsDetailsJobs produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/AsyncConversationQuery' responses: '202': description: Accepted - Running query asynchronously schema: $ref: '#/definitions/AsyncQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: postAnalyticsConversationsDetailsJobs /api/v2/analytics/conversations/details/jobs/{jobId}: get: tags: - Conversations summary: Get status for async query for conversation details description: '' operationId: getAnalyticsConversationsDetailsJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AsyncQueryStatus' '202': description: Accepted - Running query asynchronously schema: $ref: '#/definitions/AsyncQueryStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: getAnalyticsConversationsDetailsJob delete: tags: - Conversations summary: Delete/cancel an async details job description: '' operationId: deleteAnalyticsConversationsDetailsJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '204': description: Deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: deleteAnalyticsConversationsDetailsJob /api/v2/analytics/conversations/details/jobs/{jobId}/results: get: tags: - Conversations summary: Fetch a page of results for an async details job description: '' operationId: getAnalyticsConversationsDetailsJobResults produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string - name: cursor in: query description: Indicates where to resume query results (not required for first page) required: false type: string - name: pageSize in: query description: The desired maximum number of results required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/AnalyticsConversationAsyncQueryResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view - analytics:agentConversationDetail:view x-purecloud-method-name: getAnalyticsConversationsDetailsJobResults /api/v2/analytics/conversations/details/jobs/availability: get: tags: - Conversations summary: Lookup the datalake availability date and time description: '' operationId: getAnalyticsConversationsDetailsJobsAvailability produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/DataAvailabilityResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - analytics - analytics:readonly x-inin-requires-permissions: type: ANY permissions: - analytics:conversationDetail:view x-purecloud-method-name: getAnalyticsConversationsDetailsJobsAvailability /api/v2/conversations/{conversationId}/cobrowse: post: tags: - Conversations summary: Creates a cobrowse session. Requires "conversation:cobrowse:add" (for web messaging) or "conversation:cobrowsevoice:add" permission. description: '' operationId: postConversationCobrowse produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CobrowseWebMessagingSession' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:cobrowse:add - conversation:cobrowseVoice:add x-purecloud-method-name: postConversationCobrowse /api/v2/conversations/keyconfigurations/{keyconfigurationsId}: get: tags: - Conversations summary: Get the encryption key configurations description: '' operationId: getConversationsKeyconfiguration produces: - application/json parameters: - name: keyconfigurationsId in: path description: Key Configurations Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEncryptionConfiguration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:encryptionKey:view x-purecloud-method-name: getConversationsKeyconfiguration put: tags: - Conversations summary: Update the encryption key configurations description: '' operationId: putConversationsKeyconfiguration produces: - application/json parameters: - name: keyconfigurationsId in: path description: Key Configurations Id required: true type: string - in: body name: body description: Encryption key configuration metadata required: true schema: $ref: '#/definitions/ConversationEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEncryptionConfiguration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:encryptionKey:edit x-purecloud-method-name: putConversationsKeyconfiguration /api/v2/conversations/keyconfigurations: get: tags: - Conversations summary: Get a list of key configurations data description: '' operationId: getConversationsKeyconfigurations produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEncryptionConfigurationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:encryptionKey:view x-purecloud-method-name: getConversationsKeyconfigurations post: tags: - Conversations summary: Setup configurations for encryption key creation description: '' operationId: postConversationsKeyconfigurations produces: - application/json parameters: - in: body name: body description: Encryption Configuration required: true schema: $ref: '#/definitions/ConversationEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEncryptionConfiguration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:encryptionKey:edit x-purecloud-method-name: postConversationsKeyconfigurations /api/v2/conversations/keyconfigurations/validate: post: tags: - Conversations summary: Validate encryption key configurations without saving it description: '' operationId: postConversationsKeyconfigurationsValidate produces: - application/json parameters: - in: body name: body description: Encryption Configuration required: true schema: $ref: '#/definitions/ConversationEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEncryptionConfiguration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:encryptionKey:edit x-purecloud-method-name: postConversationsKeyconfigurationsValidate /api/v2/conversations/participants/attributes/search: post: tags: - Conversations summary: Search conversations description: '' operationId: postConversationsParticipantsAttributesSearch produces: - application/json parameters: - in: body name: body description: Search request options required: true schema: $ref: '#/definitions/ConversationParticipantSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/JsonCursorSearchResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' access.denied: You are not authorized to perform the requested action. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:participant:attributesview x-purecloud-method-name: postConversationsParticipantsAttributesSearch /api/v2/conversations/{conversationId}: get: tags: - Conversations summary: Get conversation description: '' operationId: getConversation produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: division.authorization.timeout: Division authorization timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:communication:view x-purecloud-method-name: getConversation delete: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: '' operationId: deleteConversation produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: deleteConversation /api/v2/conversations/{conversationId}/recordingstate: patch: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: patchConversationRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: patchConversationRecordingstate /api/v2/conversations/{conversationId}/barge: post: tags: - Conversations summary: Barge a conversation creating a barged in conference of connected participants. description: '' operationId: postConversationBarge produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.barge.target: Unable to determine a barge targeted participant. conversation.error.no.user.station: A station is required to place a call. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.barge.conference: A participant cannot be barged when conversation is a conference. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:call:barge x-purecloud-method-name: postConversationBarge /api/v2/conversations/{conversationId}/disconnect: post: tags: - Conversations summary: 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. description: '' operationId: postConversationDisconnect produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '202': description: Accepted schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: postConversationDisconnect /api/v2/conversations/{conversationId}/assign: post: tags: - Conversations summary: Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages. description: '' operationId: postConversationAssign produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: Targeted user required: true schema: $ref: '#/definitions/ConversationUser' responses: '202': description: The manual assignment request was accepted schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.status: The user's current routing status does not allow for new conversation assignments. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] feature.not.enabled: The feature allowing manual assignment is not enabled for this queue. operation.failed: The manual assignment attempt failed. invalid.id: The targeted user ID is missing or invalid. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' forbidden: You do not have the required permission for this operation. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The conversation or queue could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: An internal server error occurred. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Too many active requests. Try again later. '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:call:pull - conversation:call:assign - conversation:callback:pull - conversation:callback:assign - conversation:webchat:pull - conversation:webchat:assign - conversation:email:pull - conversation:email:assign - conversation:message:pull - conversation:message:assign x-purecloud-method-name: postConversationAssign /api/v2/conversations/{conversationId}/tags: put: tags: - Conversations summary: Update the tags on a conversation. description: '' operationId: putConversationTags produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: Conversation Tags required: true schema: $ref: '#/definitions/ConversationTagsUpdate' responses: '202': description: The tags update request was accepted. schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:externalTag:edit x-purecloud-method-name: putConversationTags /api/v2/conversations/{conversationId}/utilizationlabel: patch: tags: - Conversations summary: Update the utilization label on a conversation. When there is no value provided, the system default label is applied description: '' operationId: patchConversationUtilizationlabel produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: Conversation Utilization Label required: true schema: $ref: '#/definitions/ConversationUtilizationLabelUpdate' responses: '202': description: The utilization label update request was accepted. schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. utilization.label.id.not.found: Utilization label id was not found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: An internal server error occurred. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:utilizationLabel:edit x-purecloud-method-name: patchConversationUtilizationlabel /api/v2/conversations/{conversationId}/secureattributes: get: tags: - Conversations summary: Get the secure attributes on a conversation. description: '' operationId: getConversationSecureattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '200': description: Secure attributes retrieved successfully schema: $ref: '#/definitions/ConversationSecureAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. secure.attributes.not.found: Secure attributes could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:participant:attributesview x-purecloud-method-name: getConversationSecureattributes put: tags: - Conversations summary: Set the secure attributes on a conversation. description: '' operationId: putConversationSecureattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: Conversation Secure Attributes required: true schema: $ref: '#/definitions/ConversationSecureAttributes' responses: '202': description: The secure attributes set request was accepted. schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.error.secure.attribute.conflict: A conflict occurred setting the secure attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:attributesedit x-purecloud-method-name: putConversationSecureattributes patch: tags: - Conversations summary: Update the secure attributes on a conversation. description: '' operationId: patchConversationSecureattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body description: Conversation Secure Attributes required: true schema: $ref: '#/definitions/ConversationSecureAttributes' responses: '202': description: The secure attributes update request was accepted. schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.error.secure.attribute.conflict: A conflict occurred updating the secure attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:attributesedit x-purecloud-method-name: patchConversationSecureattributes /api/v2/conversations: get: tags: - Conversations summary: Get active conversations for the logged in user description: '' operationId: getConversations produces: - application/json parameters: - name: communicationType in: query description: Call or Chat communication filtering required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversations /api/v2/conversations/faxes: post: tags: - Conversations summary: Create Fax Conversation description: '' operationId: postConversationsFaxes produces: - application/json parameters: - in: body name: body description: Fax required: true schema: $ref: '#/definitions/FaxSendRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/FaxSendResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: fax.content.type.not.supported: The fax content type is not supported. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] fax.missing.field: Missing required field. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: fax.forbidden: You are not permitted to send faxes. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. fax.internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationsFaxes /api/v2/conversations/settings: get: tags: - Conversations summary: Get Settings description: '' operationId: getConversationsSettings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/Settings' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: division.authorization.timeout: Division authorization timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:settings:view x-purecloud-method-name: getConversationsSettings patch: tags: - Conversations summary: Update Settings description: '' operationId: patchConversationsSettings produces: - application/json parameters: - in: body name: body description: Settings required: true schema: $ref: '#/definitions/Settings' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:settings:edit x-purecloud-method-name: patchConversationsSettings /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize: post: tags: - Conversations summary: API invoked to finalize agent checklist evaluation. description: '' operationId: postConversationCommunicationAgentchecklistsFinalize produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - in: body name: body description: Agent checklist finalize payload required: true schema: $ref: '#/definitions/ChecklistFinalizePayload' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentChecklistResponseList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:edit x-purecloud-method-name: postConversationCommunicationAgentchecklistsFinalize /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}: get: tags: - Conversations summary: Get checklist info for a single checklist. description: '' operationId: getConversationCommunicationAgentchecklist produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - name: agentChecklistId in: path description: Agent Checklist ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentChecklistResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:view x-purecloud-method-name: getConversationCommunicationAgentchecklist post: tags: - Conversations summary: Agent Checklist activation API description: '' operationId: postConversationCommunicationAgentchecklist produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - name: agentChecklistId in: path description: Agent Checklist ID required: true type: string - in: body name: body description: Agent checklist activation payload required: true schema: $ref: '#/definitions/ChecklistActivationPayload' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentChecklistResponse' '202': description: Agent Checklist activated successfully. schema: $ref: '#/definitions/AgentChecklistResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:edit x-purecloud-method-name: postConversationCommunicationAgentchecklist /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs: post: tags: - Conversations summary: Create inference job description: '' operationId: postConversationCommunicationAgentchecklistJobs produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - name: agentChecklistId in: path description: Agent Checklist ID required: true type: string - in: body name: body description: Agent checklist inference job payload required: true schema: $ref: '#/definitions/ChecklistInferenceJobPayload' responses: '200': description: successful operation schema: $ref: '#/definitions/ChecklistInferenceJobCreationResponse' '202': description: Agent Checklist inference job created successfully. schema: $ref: '#/definitions/ChecklistInferenceJobCreationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:edit x-purecloud-method-name: postConversationCommunicationAgentchecklistJobs /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}: get: tags: - Conversations summary: Get inference job status description: '' operationId: getConversationCommunicationAgentchecklistJob produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - name: agentChecklistId in: path description: Agent Checklist ID required: true type: string - name: jobId in: path description: Inference Job ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ChecklistInferenceJobResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:view x-purecloud-method-name: getConversationCommunicationAgentchecklistJob /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists: get: tags: - Conversations summary: Get information of all checklists associated with a conversation. description: '' operationId: getConversationCommunicationAgentchecklists produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentChecklistResponseList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:view x-purecloud-method-name: getConversationCommunicationAgentchecklists /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction: post: tags: - Conversations summary: API invoked to capture an agent action. description: '' operationId: postConversationCommunicationAgentchecklistAgentaction produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: communicationId in: path description: Communication ID required: true type: string - name: agentChecklistId in: path description: Agent Checklist ID required: true type: string - in: body name: body description: Agent action payload required: true schema: $ref: '#/definitions/AgentActionPayload' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentChecklistResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:agentchecklist:edit x-purecloud-method-name: postConversationCommunicationAgentchecklistAgentaction /api/v2/conversations/{conversationId}/customattributes: get: tags: - Conversations summary: Get a list of custom attributes for a conversation. description: '' operationId: getConversationCustomattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CustomAttributesListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:view x-purecloud-method-name: getConversationCustomattributes put: tags: - Conversations summary: Create or update a single custom attributes record. Updating replaces all data with the provided fields. description: '' operationId: putConversationCustomattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CustomAttributesUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CustomAttributesIdResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.invalid.id: The record id is in an invalid format bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.custom.attributes.invalid.uuid: One or more values are not a valid UUID constraint.validation: '%s' conversation.custom.attributes.cannot.update.schema.id: SchemaId cannot be updated. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.custom.attributes.property.required: A property in the request is required. conversation.custom.attributes.schema.validation.error: Schema validation error. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.schema.not.found: Schema not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.custom.attributes.version.conflict: Incorrect version of Custom Attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:edit x-purecloud-method-name: putConversationCustomattributes patch: tags: - Conversations summary: Update a single custom attributes record by amending the data with only the provided fields. description: '' operationId: patchConversationCustomattributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CustomAttributesPatchRequest' responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversation.custom.attributes.invalid.uuid: One or more values are not a valid UUID conversation.custom.attributes.property.required: A property in the request is required. conversation.custom.attributes.schema.validation.error: Schema validation error. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.custom.attributes.cannot.update.schema.id: SchemaId cannot be updated. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.not.found: Custom Attributes not found. conversation.custom.attributes.schema.not.found: Schema not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.custom.attributes.version.conflict: Incorrect version of Custom Attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:edit x-purecloud-method-name: patchConversationCustomattributes /api/v2/conversations/{conversationId}/customattributes/{attributesId}: get: tags: - Conversations summary: Get custom attributes by id description: '' operationId: getConversationCustomattribute produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: attributesId in: path description: attributesId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CustomAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.not.found: Custom Attributes not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:view x-purecloud-method-name: getConversationCustomattribute delete: tags: - Conversations summary: Delete a custom attributes record. description: '' operationId: deleteConversationCustomattribute produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: attributesId in: path description: attributesId required: true type: string responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.not.found: Custom Attributes not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:delete x-purecloud-method-name: deleteConversationCustomattribute /api/v2/conversations/{conversationId}/customattributes/bulk: put: tags: - Conversations summary: Create or update a list of custom attributes records. Updating replaces all data with the provided fields. description: '' operationId: putConversationCustomattributesBulk produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body required: false schema: type: array items: $ref: '#/definitions/CustomAttributesUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CustomAttributesBulkUpdateResponseMap' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.invalid.id: The record id is in an invalid format bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.custom.attributes.invalid.uuid: One or more values are not a valid UUID constraint.validation: '%s' conversation.custom.attributes.cannot.update.schema.id: SchemaId cannot be updated. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.custom.attributes.property.required: A property in the request is required. conversation.custom.attributes.schema.validation.error: Schema validation error. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.schema.not.found: Schema not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.custom.attributes.version.conflict: Incorrect version of Custom Attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:edit x-purecloud-method-name: putConversationCustomattributesBulk patch: tags: - Conversations summary: Update a list of custom attributes record by amending the data with only the provided fields. description: '' operationId: patchConversationCustomattributesBulk produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - in: body name: body required: false schema: type: array items: $ref: '#/definitions/CustomAttributesPatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CustomAttributesBulkUpdateResponseMap' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversation.custom.attributes.invalid.uuid: One or more values are not a valid UUID conversation.custom.attributes.property.required: A property in the request is required. conversation.custom.attributes.schema.validation.error: Schema validation error. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.custom.attributes.cannot.update.schema.id: SchemaId cannot be updated. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' conversation.custom.attributes.division.access.forbidden: User does not have access to divisions. missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.custom.attributes.not.found: Custom Attributes not found. conversation.custom.attributes.schema.not.found: Schema not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.custom.attributes.version.conflict: Incorrect version of Custom Attributes. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:edit x-purecloud-method-name: patchConversationCustomattributesBulk /api/v2/conversations/customattributes/search: post: tags: - Conversations summary: Search resources. description: '' operationId: postConversationsCustomattributesSearch produces: - application/json parameters: - in: body name: body description: Search request options required: true schema: $ref: '#/definitions/ConversationCustomAttributesSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/JsonSearchResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.search.criteria: search criteria exceeded limit bad.request: A required field was not provided response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] search.criteria.values.exceed.limit: search criteria values exceeded limit constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' too.many.requested.results: too many requested results '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: You are not authorized to perform the requested action. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:view x-purecloud-method-name: postConversationsCustomattributesSearch /api/v2/conversations/customattributes/schemas/coretypes/{coreTypeName}: get: tags: - Conversations summary: Get the core types from which all schemas are built. description: '' operationId: getConversationsCustomattributesSchemasCoretype produces: - application/json parameters: - name: coreTypeName in: path description: Name of the core type required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Coretype' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemasCoretype /api/v2/conversations/customattributes/schemas/coretypes: get: tags: - Conversations summary: Get the list of core types enabled for a specific namespace. description: '' operationId: getConversationsCustomattributesSchemasCoretypes produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CoretypeListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemasCoretypes /api/v2/conversations/customattributes/schemas/limits: get: tags: - Conversations summary: Get quantitative limits on schemas description: '' operationId: getConversationsCustomattributesSchemasLimits produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/SchemaQuantityLimits' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemasLimits /api/v2/conversations/customattributes/schemas/{schemaId}: get: tags: - Conversations summary: Get a schema description: '' operationId: getConversationsCustomattributesSchema produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchema put: tags: - Conversations summary: Update a schema description: '' operationId: putConversationsCustomattributesSchema produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string - in: body name: body description: Schema update request body required: true schema: $ref: '#/definitions/ConversationSchemaUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas cannot exceed 2500. dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 50 schemas. bad.request: The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present. invalid.property: Value [%s] is not a valid property for object [%s] dynamic.schema.invalid.json.schema: An invalid JSON schema was provided. dynamic.schema.duplicate.schema.title: The schema title has to be unique. constraint.validation: '%s' dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 50 fields dynamic.schema.duplicate.enum.properties.title: The title of the enum options has to be unique. dynamic.schema.validation.limit.error: The JSON schema provided for update has a validation limit error. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version. dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters dynamic.schema.validation.limit.missing: The new JSON schema provided for update is missing a validation limit. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. dynamic.schema.length.limits.would.be.exceeded: The schema title should not exceed 50 characters. The schema description should not exceed 200 characters. dynamic.schema.duplicate.property.title: The property title in the schema has to be unique. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. dynamic.schema.version.conflict: A valid version is required. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.payload.too.large: Payload too large. request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaEdit x-purecloud-method-name: putConversationsCustomattributesSchema /api/v2/conversations/customattributes/schemas/{schemaId}/versions: get: tags: - Conversations summary: Get all versions of a CCA schema description: '' operationId: getConversationsCustomattributesSchemaVersions produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchemaListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: The schema to expand has parse errors security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemaVersions /api/v2/conversations/customattributes/schemas/{schemaId}/versions/{versionId}: get: tags: - Conversations summary: Get a specific version of a schema description: '' operationId: getConversationsCustomattributesSchemaVersion produces: - application/json parameters: - name: schemaId in: path description: Schema ID required: true type: string - name: versionId in: path description: Schema version required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: The schema to expand has parse errors security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemaVersion /api/v2/conversations/customattributes/schemas: get: tags: - Conversations summary: Get a list of schemas. description: '' operationId: getConversationsCustomattributesSchemas produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchemaListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaView x-purecloud-method-name: getConversationsCustomattributesSchemas post: tags: - Conversations summary: Create a schema description: '' operationId: postConversationsCustomattributesSchemas produces: - application/json parameters: - in: body name: body description: Schema create request body required: true schema: $ref: '#/definitions/ConversationJsonSchemaRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationDataSchema' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas would exceed 2500. dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 50 schemas. bad.request: The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present. invalid.property: Value [%s] is not a valid property for object [%s] dynamic.schema.invalid.json.schema: An invalid JSON schema was provided. dynamic.schema.duplicate.schema.title: The schema title has to be unique. constraint.validation: '%s' dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 50 fields dynamic.schema.duplicate.enum.properties.title: The title of the enum options has to be unique. dynamic.schema.validation.limit.error: The schema has a validation limit error. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version. dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters dynamic.schema.validation.limit.missing: The schema is missing a validation limit. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. dynamic.schema.length.limits.would.be.exceeded: The schema title should not exceed 50 characters. The schema description should not exceed 200 characters. dynamic.schema.duplicate.property.title: The property title in the schema has to be unique. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. dynamic.schema.version.conflict: A valid version is required. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.payload.too.large: Payload too large. request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dynamic.schema.expand.failed: Unable to expand the schema. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:customAttributes:schemaAdd x-purecloud-method-name: postConversationsCustomattributesSchemas /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update after-call work for this conversation communication. description: '' operationId: patchConversationsAftercallworkConversationIdParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: AfterCallWorkUpdate required: true schema: $ref: '#/definitions/AfterCallWorkUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/AfterCallWorkUpdate' '202': description: Accepted schema: $ref: '#/definitions/AfterCallWorkUpdate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: patchConversationsAftercallworkConversationIdParticipantCommunication /api/v2/conversations/callbacks/bulk/update: post: tags: - Conversations summary: Update multiple scheduled callbacks description: '' operationId: postConversationsCallbacksBulkUpdate produces: - application/json parameters: - in: body name: body description: BulkCallbackPatchRequest required: true schema: $ref: '#/definitions/BulkCallbackPatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/BulkCallbackPatchResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. callback.error.too.many.entities: There were too many entities in the bulk edit request. invalid.property: Value [%s] is not a valid property for object [%s] callback.error.scheduled.time.too.far.in.future: Callback is scheduled to far in the future. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:callback:edit x-purecloud-method-name: postConversationsCallbacksBulkUpdate /api/v2/conversations/callbacks/bulk/disconnect: post: tags: - Conversations summary: Disconnect multiple scheduled callbacks description: '' operationId: postConversationsCallbacksBulkDisconnect produces: - application/json parameters: - in: body name: body description: BulkCallbackDisconnectRequest required: true schema: $ref: '#/definitions/BulkCallbackDisconnectRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. callback.error.too.many.entities: There were too many entities in the bulk disconnect request. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: postConversationsCallbacksBulkDisconnect /api/v2/conversations/calls: get: tags: - Conversations summary: Get the logged-in user's active conversations and their Call participants state. description: 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? operationId: getConversationsCalls produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CallConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCalls post: tags: - Conversations summary: Create a call conversation description: '' operationId: postConversationsCalls produces: - application/json parameters: - in: body name: body description: Call request required: true schema: $ref: '#/definitions/CreateCallRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CreateCallResponse' '202': description: Accepted schema: $ref: '#/definitions/CreateCallResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.create.conversation.parameters: Only a single destination can be supplied in a create conversation request. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] missing.create.conversation.destination.parameter: At least one destination should be supplied in a create conversation request. constraint.validation: '%s' conversation.error.no.user.station: A station is required to place a call. conversation.error.cannot.create.conference: Unable to create a conference. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.invalid.external.contact: The external contact supplied is not valid. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: The resource could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. providerapi.error.station.cannot.resolve: Cannot resolve station. providerapi.error.user.does.not.have.a.station: User does not have a station. conversation.error.media.failed: The media request failed. conversation.error.outbound.call.cannot.be.placed: Outbound call cannot be placed. providerapi.error.edge.cannot.resolve: Cannot resolve edge. providerapi.error.ccxml.uri.not_found: Failed to get CCXML URI from edge config. providerapi.error.edge.no.active: Could not find an active Edge in Site. providerapi.error.phone.cannot.resolve: Cannot resolve phone. providerapi.error.phone.no.active.edge: The phone is not assigned to active Edges. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. providerapi.error.no.station.for.edge: Station assignment for station found, but no primary or secondary Edge id was assigned to it. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:conference:add x-purecloud-method-name: postConversationsCalls /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: '' operationId: postConversationsCallParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' callback.error.transfer.not.connected: Only connected participants can be transferred. conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsCallParticipantReplace /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor: post: tags: - Conversations summary: Listen in on the conversation from the point of view of a given participant. description: '' operationId: postConversationsCallParticipantMonitor produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.monitor.own.conversation: A user cannot monitor a conversation where they are an active participant. conversation.error.no.user.station: A station is required to place a call. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.error.monitor.consultation.conversation: A user cannot monitor a conversation that is indicated as a consultation conversation. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:call:monitor x-purecloud-method-name: postConversationsCallParticipantMonitor /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: '' operationId: getConversationsCallParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallParticipantWrapupcodes /api/v2/conversations/calls/{conversationId}: get: tags: - Conversations summary: Get call conversation description: '' operationId: getConversationsCall produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CallConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.no.common.user: This conference can not be created because there is no common user among all the active participants. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.media.failed: The media request failed. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. providerapi.error.no.station.for.edge: Station assignment for station found, but no primary or secondary Edge id was assigned to it. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCall post: tags: - Conversations summary: Place a new call as part of a callback conversation. description: '' operationId: postConversationsCall produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/CallCommand' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.no.user.station: A station is required to place a call. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.callback.call.cannot.be.placed: An error occurred while trying to place the callback. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.error.participant.no.active.conversations: The participant has no active conversation. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. providerapi.error.no.station.for.edge: Station assignment for station found, but no primary or secondary Edge id was assigned to it. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationsCall patch: tags: - Conversations summary: Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants description: '' operationId: patchConversationsCall produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.cannot.merge.acd.conference: A conference cannot be created from a connected ACD call. conversation.error.cannot.merge.ivr: A conference cannot be created from an IVR call. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.call.disconnected: Call is disconnected, cannot alter recordingState conversation.error.cannot.merge.group.ring: A conference cannot be created from a group ring. constraint.validation: '%s' conversation.error.empty.conversation.list: An empty list of conversations is invalid. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.merge.monitor.coach.barge: A conference cannot be created from a monitor, coach, or barge call. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.merge.alerting.conference: A conference cannot be created from an alerting call. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCall /api/v2/conversations/calls/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsCallRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsCallRecordingstate /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: '' operationId: patchConversationsCallParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Participant attributes required: true schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsCallParticipantAttributes /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: '' operationId: getConversationsCallParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallParticipantWrapup /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. description: '' operationId: patchConversationsCallParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. communication.state.required: Can only update a communication's state to disconnected. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsCallParticipantCommunication /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsCallParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsCallParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsCallParticipantCommunicationWrapup /api/v2/conversations/calls/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: '' operationId: patchConversationsCallParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Participant request required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.call.disconnected: The call is already disconnected. conversation.error.user.not.party: The participant for this request does not belong to the user making the request. constraint.validation: '%s' conversation.error.wrapup.cannot.skip: Wrap-up cannot be skipped for this participant. conversation.error.participant.no.active.conversations: The participant has no active conversation. conversation.error.hold.alerting: An alerting call cannot be placed on hold. conversation.error.cannot.create.conference: Unable to create a conference. conversation.participant.update.invalid: Failed to update all properties on conversation participant. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable callback.error.answer.not.alerting: Only alerting calls can be answered. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.confine.party: The participant for this request cannot be confined. conversation.error.wrapup.code.required: Wrapup code is a required field and cannot be empty. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: Conversation not found. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCallParticipant /api/v2/conversations/calls/user/{userId}: post: tags: - Conversations summary: Create a call conversation on behalf of a user description: '' operationId: postConversationsCallsUserUserId produces: - application/json parameters: - in: body name: body description: Call request required: true schema: $ref: '#/definitions/CreateCallRequest' - name: userId in: path description: userId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CreateCallResponse' '202': description: Accepted schema: $ref: '#/definitions/CreateCallResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.create.conversation.parameters: Only a single destination can be supplied in a create conversation request. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] missing.create.conversation.destination.parameter: At least one destination should be supplied in a create conversation request. constraint.validation: '%s' conversation.error.no.user.station: A station is required to place a call. conversation.error.cannot.create.conference: Unable to create a conference. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.invalid.external.contact: The external contact supplied is not valid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: The resource could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. providerapi.error.station.cannot.resolve: Cannot resolve station. providerapi.error.user.does.not.have.a.station: User does not have a station. conversation.error.media.failed: The media request failed. conversation.error.outbound.call.cannot.be.placed: Outbound call cannot be placed. providerapi.error.edge.cannot.resolve: Cannot resolve edge. providerapi.error.ccxml.uri.not_found: Failed to get CCXML URI from edge config. providerapi.error.edge.no.active: Could not find an active Edge in Site. providerapi.error.phone.cannot.resolve: Cannot resolve phone. providerapi.error.phone.no.active.edge: The phone is not assigned to active Edges. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. providerapi.error.no.station.for.edge: Station assignment for station found, but no primary or secondary Edge id was assigned to it. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:agentlessCall:add - conversation:call:add x-purecloud-method-name: postConversationsCallsUserUserId /api/v2/conversations/calls/maximumconferenceparties: get: tags: - Conversations summary: Get the maximum number of participants that this user can have on a conference description: '' operationId: getConversationsCallsMaximumconferenceparties produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/MaxParticipants' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallsMaximumconferenceparties /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach: post: tags: - Conversations summary: Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. description: '' operationId: postConversationsCallParticipantCoach produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.no.user.station: A station is required to place a call. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.multiple.coaches: Multiple coaches on the conversation. constraint.validation: '%s' conversation.error.coach.consultation.conversation: A user cannot coach a conversation that is indicated as a consultation conversation. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:call:coach x-purecloud-method-name: postConversationsCallParticipantCoach /api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge: post: tags: - Conversations summary: Barge a given participant's call creating a barged in conference of connected participants. description: '' operationId: postConversationsCallParticipantBarge produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.barge.not.consult.initiator: A user cannot barge a consult transfer party that is not the initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.no.user.station: A station is required to place a call. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.multiple.barges: A user cannot barge a participant that is already being barged. conversation.error.barge.consultation.conversation: A user cannot barge a conversation that is indicated as a consultation conversation. conversation.error.barge.conference: A participant cannot be barged when conversation is a conference. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:call:barge x-purecloud-method-name: postConversationsCallParticipantBarge /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult: post: tags: - Conversations summary: Initiate and update consult transfer (Deprecated) description: 'This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.' operationId: postConversationsCallParticipantConsult produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination address & initial speak to required: true schema: $ref: '#/definitions/ConsultTransfer' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer x-purecloud-method-name: postConversationsCallParticipantConsult delete: tags: - Conversations summary: Cancel the transfer description: '' operationId: deleteConversationsCallParticipantConsult produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversation.error.consult.transfer.not.started: The consult transfer can't be canceled since it hasn't started yet. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: deleteConversationsCallParticipantConsult patch: tags: - Conversations summary: Change who can speak description: '' operationId: patchConversationsCallParticipantConsult produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: new speak to required: true schema: $ref: '#/definitions/ConsultTransferUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsCallParticipantConsult /api/v2/conversations/calls/{conversationId}/participants/{participantId}/voice/consult: post: tags: - Conversations summary: Initiate voice consult transfer description: '' operationId: postConversationsCallParticipantVoiceConsult produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination address & initial speak to required: true schema: $ref: '#/definitions/ConsultTransferToAddress' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer x-purecloud-method-name: postConversationsCallParticipantVoiceConsult /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent: post: tags: - Conversations summary: Initiate a consult transfer to an agent description: '' operationId: postConversationsCallParticipantConsultAgent produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination agent & initial speak to required: true schema: $ref: '#/definitions/ConsultTransferToAgent' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer - conversation:communication:consultTransferAgent x-purecloud-method-name: postConversationsCallParticipantConsultAgent /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue: post: tags: - Conversations summary: Initiate a consult transfer to a queue description: '' operationId: postConversationsCallParticipantConsultQueue produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination queue & initial speak to required: true schema: $ref: '#/definitions/ConsultTransferToQueue' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer - conversation:communication:consultTransferQueue x-purecloud-method-name: postConversationsCallParticipantConsultQueue /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external: post: tags: - Conversations summary: Initiate a consult transfer to an external contact (Deprecated) description: This endpoint is deprecated. Use /consult/contact/external endpoints instead. operationId: postConversationsCallParticipantConsultExternal produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination address & initial speak to required: true schema: $ref: '#/definitions/ConsultTransferToExternal' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer - conversation:communication:consultTransferExternal x-purecloud-method-name: postConversationsCallParticipantConsultExternal /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external: post: tags: - Conversations summary: Initiate a consult transfer to an external contact description: '' operationId: postConversationsCallParticipantConsultContactExternal produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Destination address & initial speak to required: true schema: $ref: '#/definitions/ConsultTransferToExternalContact' responses: '200': description: successful operation schema: $ref: '#/definitions/ConsultTransferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.consult.transfer.no.initiator: The transfer request has no initiator. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] object.participant.id.required: A connected object participant is required. constraint.validation: '%s' conversation.error.consult.transfer.no.destination: The transfer request has no destination. conversation.error.cannot.transfer.to.self: A user cannot transfer a call to their own number not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.transfer.conference: Performing a consult transfer on a conference is not allowed. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. not.a.participant: You are not a connected participant on the call dest.address.not.specified: The destination address was not specified. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. conversation.error.consult.transfer.pending.not.found: The pending consult transfer does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:consultTransfer - conversation:communication:consultTransferExternalContact x-purecloud-method-name: postConversationsCallParticipantConsultContactExternal /api/v2/conversations/calls/{conversationId}/conference: patch: tags: - Conversations summary: Update a conversation by merging in other conversations to create a conference description: '' operationId: patchConversationsCallConference produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: UpdateConferenceRequest required: true schema: $ref: '#/definitions/UpdateConferenceRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.cannot.merge.acd.conference: A conference cannot be created from a connected ACD call. conversation.error.cannot.merge.ivr: A conference cannot be created from an IVR call. conversation.error.cannot.conference.self: A conversation cannot be merged with itself. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.cannot.merge.group.ring: A conference cannot be created from a group ring. constraint.validation: '%s' conversation.error.empty.conversation.list: An empty list of conversations is invalid. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.cannot.merge.monitor.coach.barge: A conference cannot be created from a monitor, coach, or barge call. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.merge.alerting.conference: A conference cannot be created from an alerting call. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:conference:add x-purecloud-method-name: patchConversationsCallConference /api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record: post: tags: - Conversations summary: Start/stop the snippet recording for a participant description: '' operationId: postConversationsCallParticipantSnippetRecord produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: snippetRecordingRequest required: true schema: $ref: '#/definitions/SnippetRecordingRequest' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when capturing the snippet recording of a participant schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. conversation.error.conversation.disconnected: Conversation is disconnected, cannot capture recording bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot capture recording '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:snippetRecord x-purecloud-method-name: postConversationsCallParticipantSnippetRecord /api/v2/conversations/calls/{conversationId}/participants: post: tags: - Conversations summary: Add participants to a conversation description: '' operationId: postConversationsCallParticipants produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.merge.alerting.conference: A conference cannot be created from an alerting call. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.error.outbound.call.cannot.be.placed: Outbound call cannot be placed. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationsCallParticipants /api/v2/conversations/calls/{conversationId}/participants/user/{userId}: post: tags: - Conversations summary: Add participants to a conversation on behalf of a user description: '' operationId: postConversationsCallParticipantsUserUserId produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' - name: userId in: path description: userId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.merge.alerting.conference: A conference cannot be created from an alerting call. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. conversation.error.outbound.call.cannot.be.placed: Outbound call cannot be placed. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:agentlessCall:add x-purecloud-method-name: postConversationsCallParticipantsUserUserId /api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}: patch: tags: - Conversations summary: Update conversation participant on behalf of a user description: '' operationId: patchConversationsCallParticipantUserUserId produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: userId in: path description: userId required: true type: string - in: body name: body description: Participant request required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.call.disconnected: The call is already disconnected. conversation.error.user.not.party: The participant for this request does not belong to the user making the request. constraint.validation: '%s' conversation.error.wrapup.cannot.skip: Wrap-up cannot be skipped for this participant. conversation.error.participant.no.active.conversations: The participant has no active conversation. conversation.error.hold.alerting: An alerting call cannot be placed on hold. conversation.error.cannot.create.conference: Unable to create a conference. conversation.participant.update.invalid: Failed to update all properties on conversation participant. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable callback.error.answer.not.alerting: Only alerting calls can be answered. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.confine.party: The participant for this request cannot be confined. conversation.error.wrapup.code.required: Wrapup code is a required field and cannot be empty. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: Conversation not found. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect - conversation:agentlessCall:add x-purecloud-method-name: patchConversationsCallParticipantUserUserId /api/v2/conversations/calls/history: get: tags: - Conversations summary: Get call history description: '' operationId: getConversationsCallsHistory produces: - application/json parameters: - name: pageSize in: query description: Page size, maximum 50 required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: interval in: query description: Interval string; format is ISO-8601. Separate start and end times with forward slash '/' required: false type: string - name: expand in: query description: Which fields, if any, to expand. required: false type: array items: type: string enum: - externalorganization - externalcontact - user - queue - group collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/CallHistoryConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: division.authorization.timeout: Division authorization timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallsHistory /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata: put: tags: - Conversations summary: Set uuiData to be sent on future commands. description: '' operationId: putConversationsCallParticipantCommunicationUuidata produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: UUIData Request required: true schema: $ref: '#/definitions/SetUuiDataRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: putConversationsCallParticipantCommunicationUuidata /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/postflowaction: delete: tags: - Conversations summary: Remove mandatory post call actions. description: '' operationId: deleteConversationsCallParticipantCommunicationPostflowaction produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversation.error.cannot.set.post.flow.actions: The communication for this request cannot have mandatory post flow actions '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:call:deleteMandatoryPostFlowAction x-purecloud-method-name: deleteConversationsCallParticipantCommunicationPostflowaction patch: tags: - Conversations summary: Set mandatory post call actions. If both values are null or blank error will occur. description: '' operationId: patchConversationsCallParticipantCommunicationPostflowaction produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Action required: false schema: $ref: '#/definitions/MandatoryPostCallActionInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.cannot.set.post.flow.actions: The communication for this request cannot have mandatory post flow actions invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:call:setMandatoryPostFlowAction x-purecloud-method-name: patchConversationsCallParticipantCommunicationPostflowaction /api/v2/conversations/callbacks: get: tags: - Conversations summary: Get the logged-in user's active conversations and their Callback participants state. description: 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? operationId: getConversationsCallbacks produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CallbackConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallbacks post: tags: - Conversations summary: Create a Callback description: '' operationId: postConversationsCallbacks produces: - application/json parameters: - in: body name: body description: Callback required: true schema: $ref: '#/definitions/CreateCallbackCommand' responses: '200': description: successful operation schema: $ref: '#/definitions/CreateCallbackResponse' '202': description: Accepted - Creating and Processing a Callback '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.missing.callback.numbers: Callback numbers missing callback.error.missing.queue.id: Callback missing queue ID bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] callback.error.scheduled.time.too.far.in.future: Callback is scheduled to far in the future. constraint.validation: '%s' callback.error.scheduled.callback.limit.exceeded: Number of callbacks has been exceeded for a single conversation response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. callback.error.scheduled.callback.number.limit.exceeded: Number of attributes has exceeded the limit callback.error.cannot.create.agent.owned.callback: Cannot create agent owned callback on queue that does not have agent owned callbacks enabled. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:callback:create x-purecloud-method-name: postConversationsCallbacks patch: tags: - Conversations summary: Update a scheduled callback description: '' operationId: patchConversationsCallbacks produces: - application/json parameters: - in: body name: body description: PatchCallbackRequest required: true schema: $ref: '#/definitions/PatchCallbackRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/PatchCallbackResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.parse.call.number: A callback number cannot be parsed as a phone address bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] callback.error.missing.required.information.for.patch.request: The patch request requires either a scheduled time or queueId. callback.error.scheduled.time.too.far.in.future: Callback is scheduled to far in the future. constraint.validation: '%s' callback.error.conversation.not.found: conversation not found. callback.error.cannot.update.non.agent.owned.callback: Cannot update non agent owned callback response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. callback.error.queue.not.found: queue not found callback.error.agent.not.member.of.queue: Agent is not a member of the queue invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. callback.error.scheduled.callback.job.id.not.found: The scheduled callback job id was not found callback.error.callback.not.found: The callback was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. callback.error.unable.to.update.schedule.callback: Unable to update scheduled callback '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '412': description: Precondition Failed schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.already.triggered: Unable to update an already triggered callback. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:callback:edit x-purecloud-method-name: patchConversationsCallbacks /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: '' operationId: postConversationsCallbackParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.parse.call.number: A callback number cannot be parsed as a phone address. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' callback.error.transfer.not.connected: Only connected participants can be transferred callback.error.additional.info.value.length.invalid: The length of the additional info value is invalid. conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. conversations.error.transfer.acd.call.unattended.: An ACD call cannot be transferred unattended. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.unable.to.schedule.callback: Server error unable to schedule callback. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsCallbackParticipantReplace /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: '' operationId: getConversationsCallbackParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallbackParticipantWrapupcodes /api/v2/conversations/callbacks/{conversationId}: get: tags: - Conversations summary: Get callback conversation description: '' operationId: getConversationsCallback produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CallbackConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallback patch: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: '' operationId: patchConversationsCallback produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.empty.conversation.list: An empty list of conversations is invalid. conversation.error.cannot.conference.self: A conversation cannot be merged with itself. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCallback /api/v2/conversations/callbacks/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsCallbackRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsCallbackRecordingstate /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: '' operationId: patchConversationsCallbackParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Attributes required: true schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsCallbackParticipantAttributes /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: '' operationId: getConversationsCallbackParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.error.participant.no.active.conversations: The participant has no active conversation. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallbackParticipantWrapup /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. description: '' operationId: patchConversationsCallbackParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: communication.state.required: Can only update a communication's state to disconnected. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsCallbackParticipantCommunication /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsCallbackParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCallbackParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsCallbackParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.communication.not.found: Communication could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsCallbackParticipantCommunicationWrapup /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: '' operationId: patchConversationsCallbackParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. callback.error.transfer.canceled: Answer failed because a pending attended transfer was canceled. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.participant.no.active.conversations: The participant has no active conversation. callback.error.conversation.not.found: Conversation not found. conversation.participant.update.invalid: Failed to update all properties on conversation participant. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable callback.error.answer.not.alerting: Only alerting calls can be answered. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCallbackParticipant /api/v2/conversations/chats/{conversationId}/messages/{messageId}: get: tags: - Conversations summary: Get a web chat conversation message description: 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. operationId: getConversationsChatMessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: messageId in: path description: messageId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WebChatMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.not.found: Chat conversation message is not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChatMessage /api/v2/conversations/chats/{conversationId}/messages: get: tags: - Conversations summary: Get the messages of a chat conversation. description: 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. operationId: getConversationsChatMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: after in: query description: If specified, get the messages chronologically after the id of this message required: false type: string - name: before in: query description: If specified, get the messages chronologically before the id of this message required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: ascending enum: - ascending - descending - name: maxResults in: query description: Limit the returned number of messages, up to a maximum of 100 required: false type: integer default: 100 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/WebChatMessageEntityList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.not.found: Chat conversation message is not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChatMessages /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages: post: tags: - Conversations summary: Send a message on behalf of a communication in a chat conversation. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: postConversationsChatCommunicationMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Message required: true schema: $ref: '#/definitions/CreateWebChatMessageRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WebChatMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.notnull.createconversationmessagerequest.body: chat error occurred due to null request body. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable chat.error.conversation.state: The conversation is in a state which does not permit this action. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] chat.error.member.state: The conversation member is in a state which does not permit this action. chat.error.bad.request: Chat error occurred due to bad request. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.not.found: Chat conversation message is not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: postConversationsChatCommunicationMessages /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing: post: tags: - Conversations summary: Send a typing-indicator on behalf of a communication in a chat conversation. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: postConversationsChatCommunicationTyping produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WebChatTyping' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable chat.error.conversation.state: The conversation is in a state which does not permit this action. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] chat.error.member.state: The conversation member is in a state which does not permit this action. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.not.found: chat conversation typing-indicator is not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: postConversationsChatCommunicationTyping /api/v2/conversations/chats: get: tags: - Conversations summary: Get active chat conversations for the logged in user description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: getConversationsChats produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ChatConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChats post: tags: - Conversations summary: Create a web chat conversation description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: postConversationsChats produces: - application/json parameters: - in: body name: body description: Create web chat request required: true schema: $ref: '#/definitions/CreateWebChatRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ChatConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: chat.error.notnull.createconversationrequest.provider: The provider property may not be null. chat.error.queue.not.found: The queue does not exist. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] chat.error.notnull.createconversationrequest.queueid: The queueId property may not be null. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ALL permissions: - conversation:webchat:create x-purecloud-method-name: postConversationsChats /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: postConversationsChatParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsChatParticipantReplace /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: getConversationsChatParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChatParticipantWrapupcodes /api/v2/conversations/chats/{conversationId}: get: tags: - Conversations summary: Get chat conversation description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: getConversationsChat produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ChatConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChat patch: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: patchConversationsChat produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: patchConversationsChat /api/v2/conversations/chats/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: putConversationsChatRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsChatRecordingstate /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: patchConversationsChatParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Participant attributes required: true schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-purecloud-method-name: patchConversationsChatParticipantAttributes /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: getConversationsChatParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChatParticipantWrapup /api/v2/conversations/chats/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: patchConversationsChatParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Update request required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.invalid: Failed to update all properties on conversation participant. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.wrapup.code.required: Wrapup code is a required field and cannot be empty. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.error.wrapup.cannot.skip: Wrap-up cannot be skipped for this participant. conversation.error.participant.no.active.conversations: The participant has no active conversation. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationsChatParticipant /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: patchConversationsChatParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: communication.state.required: Can only update a communication's state to disconnected. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-purecloud-method-name: patchConversationsChatParticipantCommunication /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: getConversationsChatParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsChatParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. operationId: postConversationsChatParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsChatParticipantCommunicationWrapup /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: postConversationsCobrowsesessionParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsCobrowsesessionParticipantReplace /api/v2/conversations/cobrowsesessions: get: tags: - Conversations summary: Get active cobrowse conversations for the logged in user description: '' operationId: getConversationsCobrowsesessions produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/CobrowseConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCobrowsesessions /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: getConversationsCobrowsesessionParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsCobrowsesessionParticipantWrapupcodes /api/v2/conversations/cobrowsesessions/{conversationId}: get: tags: - Conversations summary: Get cobrowse conversation description: '' operationId: getConversationsCobrowsesession produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CobrowseConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsCobrowsesession patch: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: patchConversationsCobrowsesession produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCobrowsesession /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: putConversationsCobrowsesessionRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsCobrowsesessionRecordingstate /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: patchConversationsCobrowsesessionParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-purecloud-method-name: patchConversationsCobrowsesessionParticipantAttributes /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: getConversationsCobrowsesessionParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsCobrowsesessionParticipantWrapup /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: patchConversationsCobrowsesessionParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: communication.state.required: Can only update a communication's state to disconnected. This endpoint does not update wrapup. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-purecloud-method-name: patchConversationsCobrowsesessionParticipantCommunication ? /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup : get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: getConversationsCobrowsesessionParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsCobrowsesessionParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: postConversationsCobrowsesessionParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsCobrowsesessionParticipantCommunicationWrapup /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: patchConversationsCobrowsesessionParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.invalid: Failed to update all properties on conversation participant. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationsCobrowsesessionParticipant /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: '' operationId: postConversationsEmailParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] postino.error.transfer.replace.external: External participants may not be replaced. constraint.validation: '%s' conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' postino.error.transfer.not.connected: Only connected participants can be transferred. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsEmailParticipantReplace /api/v2/conversations/emails/{conversationId}/messages/{messageId}: get: tags: - Conversations summary: Get conversation message description: '' operationId: getConversationsEmailMessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: messageId in: path description: messageId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' postino.error.org.missing: OrganizationId header is required. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.error.get.message.body: An error occurred retrieving a message body. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.temporarily.unavailable: The service is currently unavailable service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.request.timeout: The service timeout out waiting on a response. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailMessage /api/v2/conversations/emails: get: tags: - Conversations summary: Get the logged-in user's active conversations and their Email participants state. description: 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? operationId: getConversationsEmails produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/EmailConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmails post: tags: - Conversations summary: Create an email conversation description: 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. operationId: postConversationsEmails produces: - application/json parameters: - in: body name: body description: Create email request required: true schema: $ref: '#/definitions/CreateEmailRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. email.error.invalid.queue: An invalid queue ID was specified. email.outbound.invalid.external.contact: The external contact supplied is not valid. invalid.property: Value [%s] is not a valid property for object [%s] email.outbound.queue.address.required: The queue does not have an outbound email address configured. constraint.validation: '%s' postino.error.notnull.createconversationrequest.queueid: The queueId property may not be null. too.many.create.email.parameters: One of queueId or flowId must be supplied. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable postino.error.notnull.createconversationrequest.provider: The provider property may not be null. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. bad.flow.id: Invalid flow ID was specified. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' email.outbound.queue.required: An outbound email conversation requires a queue ID. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:email:create x-purecloud-method-name: postConversationsEmails /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: '' operationId: getConversationsEmailParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailParticipantWrapupcodes /api/v2/conversations/emails/{conversationId}/messages: get: tags: - Conversations summary: Get conversation messages description: '' operationId: getConversationsEmailMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: includeAgentlessStitchedMessages in: 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. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessagePreviewListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.request.timeout: The service timeout out waiting on a response. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailMessages post: tags: - Conversations summary: Send an email reply description: '' operationId: postConversationsEmailMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Reply required: true schema: $ref: '#/definitions/EmailMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessageReply' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.attachments.upload.size: Upload too large. email.error.external.provider: Operation not supported on emails with external providers. email.error.domain.not.verified: The email domain has not been verified. bad.request: The request could not be understood by the server due to malformed syntax. postino.error.reply.no.body: Replies must have a textBody or htmlBody. postino.error.reply.no.sender: No connected internal participant found for the reply. postino.error.reply.no.to: Replies must have a to address. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.reply.no.receiver: No connected external participant found for the reply. postino.error.reply.no.userid: Reply emails must have a userId. email.error.invalid.email: Attempted to send an email with an invalid parameter. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' postino.error.forbidden: User is not an active participant on the conversation. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.reply.sending: Error sending an email reply. request.conflict: The request conflicts with the current state of the target resource. email.error.communication.conflict: The email sending has communication conflict error. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.temporarily.unavailable: The service is currently unavailable service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.request.timeout: The request has timed out. authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:email:send x-purecloud-method-name: postConversationsEmailMessages /api/v2/conversations/emails/{conversationId}: get: tags: - Conversations summary: Get email conversation description: '' operationId: getConversationsEmail produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EmailConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' postino.error.wrong.org: Request organization is incorrect for this conversation. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmail patch: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: '' operationId: patchConversationsEmail produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.not.found: The resource could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect x-purecloud-method-name: patchConversationsEmail /api/v2/conversations/emails/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsEmailRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsEmailRecordingstate /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: '' operationId: patchConversationsEmailParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Participant attributes required: true schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsEmailParticipantAttributes /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: '' operationId: getConversationsEmailParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailParticipantWrapup /api/v2/conversations/emails/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: '' operationId: patchConversationsEmailParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Update request required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. postino.error.answer.not.alerting: Only alerting calls can be answered. conversation.error.cannot.park.conversation.with.internal.message: Cannot park conversation with active internal message. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.participant.no.active.conversations: The participant has no active conversation. conversation.participant.update.invalid: Failed to update all properties on conversation participant. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.transfer.canceled: Answer failed because a pending attended transfer was canceled. postino.error.wrong.org: Request organization is incorrect for this conversation. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect - conversation:email:park x-purecloud-method-name: patchConversationsEmailParticipant /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. description: '' operationId: patchConversationsEmailParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: communication.state.required: Can only update a communication's state to disconnected. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsEmailParticipantCommunication /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsEmailParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsEmailParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsEmailParticipantCommunicationWrapup /api/v2/conversations/emails/{conversationId}/settings: get: tags: - Conversations summary: Get emails settings for a given conversation description: '' operationId: getConversationsEmailSettings produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EmailsSettings' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' postino.error.org.missing: OrganizationId header is required invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' postino.error.wrong.org: The provided conversationId doesn't belong to the current organization invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.domain.not.found: The domain that should be used for sending, which is therefore used to determinate the emails settings, cannot be found postino.error.not.found: Either the conversation or related elements that permit to retrieve the concerned domain cannot be found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailSettings /api/v2/conversations/emails/{conversationId}/reconnect: post: tags: - Conversations summary: Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation description: This request is not valid when using the Client Credentials OAuth grant. operationId: postConversationsEmailReconnect produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.reconnect.already.connected: Cannot reconnect. Not all communications are disconnected. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] email.reconnect.expired: Cannot reconnect. Conversation is expired based on this organization's email threading settings. constraint.validation: '%s' email.reconnect.agent.limit.exceeded: Cannot reconnect. Agent has reached the maximum number of active email conversations. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. email.reconnect.no.internal: Cannot reconnect. No previous Agent communication found on the conversation. email.reconnect.no.external: Cannot reconnect. No previous customer communication found on the conversation. postino.route.not.found: Cannot reconnect. No inbound route found. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:reconnect x-purecloud-method-name: postConversationsEmailReconnect /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}: delete: tags: - Conversations summary: Delete attachment from draft description: '' operationId: deleteConversationsEmailMessagesDraftAttachment produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: attachmentId in: path description: attachmentId required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable postino.error.org.missing: OrganizationId header is required. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' postino.error.forbidden: User is not an active participant on the conversation. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.not.found: The resource could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: deleteConversationsEmailMessagesDraftAttachment /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy: post: tags: - Conversations summary: Copy attachments from an email message to the current draft. description: '' operationId: postConversationsEmailMessagesDraftAttachmentsCopy produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Copy Attachment Request required: true schema: $ref: '#/definitions/CopyAttachmentsRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.error.external.provider: Operation not supported on emails with external providers. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. postino.error.reply.no.userid: Reply emails must have a userId. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' postino.error.wrong.org: Request organization is incorrect for this conversation. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' postino.error.forbidden: User is not an active participant on the conversation. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationsEmailMessagesDraftAttachmentsCopy /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/uploads: post: tags: - Conversations summary: Create a URL to upload a message attachment file description: See https://developer.genesys.cloud/analyticsdatamanagement/uploads/upload-email-attachment-files for example usage. operationId: postConversationsEmailMessagesDraftAttachmentsUploads produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Create attachment pre-signed URL request required: true schema: $ref: '#/definitions/UploadAttachmentRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/UploadAttachmentResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.error.external.provider: Operation not supported on emails with external providers. email.error.missing.field: Missing required field bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' email.error.wrong.org: Request organization is incorrect for this conversation. email.connected.conversation.required.for.upload: A connected conversation communication is required to upload an attachment email.error.reply.no.userid: Reply emails must have a userId. email.invalid.content.length: The content length must be greater than 0 bytes email.content.length.too.large: The content length cannot exceeds the maximum allowed value response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. email.invalid.md5.hash: The content MD5 is not base64 invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s email.error.forbidden: User is not part of an active communication on the conversation. missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:emailAttachment:add x-purecloud-method-name: postConversationsEmailMessagesDraftAttachmentsUploads /api/v2/conversations/emails/{conversationId}/messages/draft: get: tags: - Conversations summary: Get conversation draft reply description: '' operationId: getConversationsEmailMessagesDraft produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' postino.error.org.missing: OrganizationId header is required. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.not.found: The resource could not be found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.error.get.message.body: An error occurred retrieving a message body. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.temporarily.unavailable: The service is currently unavailable service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsEmailMessagesDraft put: tags: - Conversations summary: Update conversation draft reply description: '' operationId: putConversationsEmailMessagesDraft produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Draft required: true schema: $ref: '#/definitions/EmailMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.error.external.provider: Operation not supported on emails with external providers. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' postino.error.forbidden: User is not an active participant on the conversation. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.not.found: The resource could not be found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.temporarily.unavailable: The service is currently unavailable service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: putConversationsEmailMessagesDraft patch: tags: - Conversations summary: Reset conversation draft to its initial state and/or auto-fill draft content description: '' operationId: patchConversationsEmailMessagesDraft produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: autoFill in: query description: autoFill required: false type: boolean - name: discard in: query description: discard required: false type: boolean - in: body name: body description: Draft Manipulation Request required: false schema: $ref: '#/definitions/DraftManipulationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax or missing field(s). invalid.property: Value [%s] is not a valid property for object [%s] postino.route.not.found: The inbound route does not exist. constraint.validation: '%s' postino.error.wrong.org: OrganizationId does not match the resources organization. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' feature.forbidden: This feature is not enabled for this organization. postino.error.forbidden: User is not an active participant on the conversation authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.not.found: The resource could not be found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. email.draft.initialized: The draft is already initialized. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error.temporarily.unavailable: The service is currently unavailable service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsEmailMessagesDraft /api/v2/conversations/emails/{conversationId}/inboundmessages: post: tags: - Conversations summary: 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. description: '' operationId: postConversationsEmailInboundmessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Send external email reply required: true schema: $ref: '#/definitions/InboundMessageRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. email.error.invalid.queue: An invalid queue ID was specified. email.error.internal.provider: Operation not supported on emails with PureCloud providers invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable postino.error.notnull.createconversationrequest.provider: The provider property may not be null. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. bad.flow.id: Invalid flow ID was specified. too.many.external.email.parameters: Only one of queueId or flowId may be provided invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationsEmailInboundmessages /api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate: patch: tags: - Conversations summary: Update conversation by setting its parking state description: '' operationId: patchConversationsEmailParticipantParkingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Parking update request required: true schema: $ref: '#/definitions/ParkingStateRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.park.communication.not.internal: Only internal communications can be parked. conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. conversation.error.cannot.park.conversation.with.internal.message: Cannot park conversation with active internal message. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' email.park.communication.not.connected: Communication must be in CONNECTED state to park. email.unpark.communication.not.parked: Communication must be in PARK state to unpark. conversation.error.unexpected.parking.state: Unexpected parking state. conversation.error.park.user.concurrent.max.exceeded: Park failed because maximum concurrent parked communications exceeded. email.park.user.not.communication.owner: User is not owner of the communication. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. postino.error.bad.request: Bad Request invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:email:park x-purecloud-method-name: patchConversationsEmailParticipantParkingstate /api/v2/conversations/emails/agentless: post: tags: - Conversations summary: Create an email conversation, per API description: '' operationId: postConversationsEmailsAgentless produces: - application/json parameters: - in: body name: body description: Create agentless email request required: true schema: $ref: '#/definitions/AgentlessEmailSendRequestDto' responses: '200': description: successful operation schema: $ref: '#/definitions/AgentlessEmailSendResponseDto' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.property: Value [%s] is not a valid property for object [%s] postino.error.subject.too.long: The subject message was too long. postino.error.invalid.sender.type: The sender type is invalid constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.not.verified: The outbound domain is not verified. postino.error.missing.field: Missing required field invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' feature.forbidden: This feature is not enabled for this organization. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: email.conversation.not.found: The conversation does not exist or is not an email interaction. postino.error.not.found: The outbound domain does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: postino.error: An error has occurred. Please contact support. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. postino.error.internal: An internal service error has occurred. Please contact support. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:email:create - conversation:agentlessEmail:send x-purecloud-method-name: postConversationsEmailsAgentless /api/v2/conversations/internalmessages: get: tags: - Conversations summary: Get the logged-in user's active conversations and their InternalMessage participants state. description: 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? operationId: getConversationsInternalmessages produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/InternalMessageConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:view x-purecloud-method-name: getConversationsInternalmessages /api/v2/conversations/internalmessages/{conversationId}: get: tags: - Conversations summary: Get internal message conversation description: '' operationId: getConversationsInternalmessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/InternalMessageConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:view x-purecloud-method-name: getConversationsInternalmessage /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}: get: tags: - Conversations summary: Get a cached media item description: '' operationId: getConversationsMessagesCachedmediaCachedMediaItemId produces: - application/json parameters: - name: cachedMediaItemId in: path description: cachedMediaItemId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CachedMediaItem' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:cachedMedia:view x-purecloud-method-name: getConversationsMessagesCachedmediaCachedMediaItemId delete: tags: - Conversations summary: Remove a cached media item asychronously description: '' operationId: deleteConversationsMessagesCachedmediaCachedMediaItemId produces: - application/json parameters: - name: cachedMediaItemId in: path description: cachedMediaItemId required: true type: string responses: '202': description: Request accepted to delete media from cache '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:cachedMedia:delete x-purecloud-method-name: deleteConversationsMessagesCachedmediaCachedMediaItemId /api/v2/conversations/messages/cachedmedia: get: tags: - Conversations summary: Get a list of cached media items description: '' operationId: getConversationsMessagesCachedmedia produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: url in: query description: URL to search for required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CachedMediaItemEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:cachedMedia:view x-purecloud-method-name: getConversationsMessagesCachedmedia /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant with the specified user and/or address description: '' operationId: postConversationsMessageParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on call and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationsMessageParticipantReplace /api/v2/conversations/messages/{messageId}/details: get: tags: - Conversations summary: Get message description: '' operationId: getConversationsMessageDetails produces: - application/json parameters: - name: messageId in: path description: messageId required: true type: string - name: useNormalizedMessage in: query description: If true, response removes deprecated fields (textBody, media) required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/MessageData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:message:view - conversation:webmessaging:view x-purecloud-method-name: getConversationsMessageDetails /api/v2/conversations/messages: get: tags: - Conversations summary: Get the logged-in user's active conversations and their Message participants state. description: 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? operationId: getConversationsMessages produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/MessageConversationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsMessages post: tags: - Conversations summary: Create an outbound messaging conversation. description: 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 useExistingConversation is set to true. operationId: postConversationsMessages produces: - application/json parameters: - in: body name: body description: Create outbound messaging conversation required: true schema: $ref: '#/definitions/CreateOutboundMessagingConversationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CreateOutboundMessagingConversationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.phone.numbers: SMS phone number addresses are not in a valid E.164 format. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] queue.address.required: The queue does not have an outbound messaging address configured. invalid.whatsapp.address: WhatsApp address must only contain numeric characters of destination phone number. queue.membership.required: Queue membership is invalid. constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.phone.number: The SMS phone number address is not a valid E.164 format. active.conversation: An alerting or connected conversation is already in progress. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' existing.conversation: An existing conversation within the conversation window is in progress. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:create x-purecloud-method-name: postConversationsMessages /api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor: post: tags: - Conversations summary: Listen in on the conversation from the point of view of a given participant. description: '' operationId: postConversationsMessageParticipantMonitor produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.monitor.own.conversation: A user cannot monitor a conversation where they are an active participant. too.many.monitors: Only one monitor is allowed per conversation. not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:message:monitor x-purecloud-method-name: postConversationsMessageParticipantMonitor /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: '' operationId: getConversationsMessageParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsMessageParticipantWrapupcodes /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages: post: tags: - Conversations summary: Send message description: 'Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.' operationId: postConversationsMessageCommunicationMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: useNormalizedMessage in: query description: If true, response removes deprecated fields (textBody, media) required: false type: boolean default: false - in: body name: body description: Message required: true schema: $ref: '#/definitions/AdditionalMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/MessageData' '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: max.length.exceeded: One or more attributes is longer than the maximum length allowed. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] not.found: Message not found. conversation.message.limit.exceeded: Conversation max message limit has been reached. constraint.validation: '%s' media.too.large: Media must comply with the size limits of the channel invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: organization.outbound.usage.limit.exceeded: Max outbound message usage exceeded. request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:message:create - conversation:webmessaging:create x-purecloud-method-name: postConversationsMessageCommunicationMessages /api/v2/conversations/messages/{conversationId}/messages/bulk: post: tags: - Conversations summary: Get messages in batch description: '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.' operationId: postConversationsMessageMessagesBulk produces: - application/json parameters: - name: conversationId in: path required: true type: string - name: useNormalizedMessage in: query description: If true, response removes deprecated fields (textBody, media) required: false type: boolean default: false - in: body name: body description: messageIds required: false schema: type: array items: type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TextMessageListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:message:view - conversation:webmessaging:view x-purecloud-method-name: postConversationsMessageMessagesBulk /api/v2/conversations/messages/{conversationId}: get: tags: - Conversations summary: Get message conversation description: '' operationId: getConversationsMessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessageConversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsMessage patch: tags: - Conversations summary: Update a conversation by disconnecting all of the participants description: '' operationId: patchConversationsMessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: Conversation required: true schema: $ref: '#/definitions/Conversation' responses: '200': description: successful operation schema: $ref: '#/definitions/Conversation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:disconnect - conversation:message:park x-purecloud-method-name: patchConversationsMessage /api/v2/conversations/messages/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsMessageRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsMessageRecordingstate /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: '' operationId: patchConversationsMessageParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted schema: $ref: '#/definitions/ParticipantAttributes' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsMessageParticipantAttributes /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: '' operationId: getConversationsMessageParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsMessageParticipantWrapup /api/v2/conversations/messages/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update conversation participant description: '' operationId: patchConversationsMessageParticipant produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.invalid: Failed to update all properties on conversation participant. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.park.conversation.with.internal.message: Cannot park conversation with active internal message. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' conversation.error.participant.no.active.conversations: Participant has no active conversations '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationsMessageParticipant /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}: patch: tags: - Conversations summary: Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. description: '' operationId: patchConversationsMessageParticipantCommunication produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Participant required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: communication.state.required: Can only update a communication's state to disconnected. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationsMessageParticipantCommunication /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsMessageParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsMessageParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsMessageParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsMessageParticipantCommunicationWrapup /api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate: patch: tags: - Conversations summary: Update conversation by setting its parking state description: '' operationId: patchConversationsMessageParticipantParkingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - in: body name: body description: Parking update request required: true schema: $ref: '#/definitions/ParkingStateRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. conversation.error.cannot.park.conversation.with.internal.message: Cannot park conversation with active internal message. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.unexpected.parking.state: Unexpected parking state. conversation.error.park.user.concurrent.max.exceeded: Park failed because maximum concurrent parked communications exceeded. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:message:park x-purecloud-method-name: patchConversationsMessageParticipantParkingstate /api/v2/conversations/messages/{conversationId}/messages/{messageId}: get: tags: - Conversations summary: Get conversation message description: '' operationId: getConversationsMessageMessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: messageId in: path description: messageId required: true type: string - name: useNormalizedMessage in: query description: If true, response removes deprecated fields (textBody, media) required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/MessageData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:message:view - conversation:webmessaging:view x-purecloud-method-name: getConversationsMessageMessage /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages: post: tags: - Conversations summary: Send a social media message description: Send a social media message on existing conversation/communication. operationId: postConversationsMessageCommunicationSocialmediaMessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Message required: true schema: $ref: '#/definitions/AdditionalSocialMediaMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/SocialMediaMessageData' '202': description: Accepted schema: $ref: '#/definitions/SocialMediaMessageData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: max.length.exceeded: One or more attributes is longer than the maximum length allowed. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] not.found: Message not found. conversation.message.limit.exceeded: Conversation max message limit has been reached. constraint.validation: '%s' media.too.large: Media must comply with the size limits of the channel invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: organization.outbound.usage.limit.exceeded: Max outbound message usage exceeded. request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:socialmedia:create x-purecloud-method-name: postConversationsMessageCommunicationSocialmediaMessages /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media: get: tags: - Conversations summary: Get message media list by status description: '' operationId: getConversationsMessageCommunicationMessagesMedia produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: status in: query description: The status on which to filter the response. required: false type: string enum: - uploading - valid - invalid - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 responses: '200': description: Accepted schema: $ref: '#/definitions/MessageMediaListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:messageMedia:view x-purecloud-method-name: getConversationsMessageCommunicationMessagesMedia post: tags: - Conversations summary: Create media description: See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage. operationId: postConversationsMessageCommunicationMessagesMedia produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string responses: '202': description: Accepted schema: $ref: '#/definitions/MessageMediaData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:message:create - conversation:webmessaging:create - conversation:socialmedia:create x-purecloud-method-name: postConversationsMessageCommunicationMessagesMedia /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads: post: tags: - Conversations summary: Create a URL to upload a message media file description: See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage. operationId: postConversationsMessageCommunicationMessagesMediaUploads produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: request required: true schema: $ref: '#/definitions/UploadMediaRequest' responses: '200': description: Pre-signed url successfully created. schema: $ref: '#/definitions/MessageMediaUploadData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:message:create - conversation:webmessaging:create - conversation:socialmedia:create x-purecloud-method-name: postConversationsMessageCommunicationMessagesMediaUploads /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}: get: tags: - Conversations summary: Get media description: See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage. operationId: getConversationsMessageCommunicationMessagesMediaMediaId produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: mediaId in: path description: mediaId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessageMediaData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:message:view - conversation:webmessaging:view x-purecloud-method-name: getConversationsMessageCommunicationMessagesMediaMediaId /api/v2/conversations/messages/agentless: post: tags: - Conversations summary: Send an agentless outbound message description: 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. operationId: postConversationsMessagesAgentless produces: - application/json parameters: - in: body name: body description: Create agentless outbound messaging request required: true schema: $ref: '#/definitions/SendAgentlessOutboundMessageRequest' - name: useNormalizedMessage in: query description: If true, response removes deprecated fields (textBody, messagingTemplate) required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/SendAgentlessOutboundMessageResponse' '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: max.length.exceeded: One or more attributes is longer than the maximum length allowed. bad.request: The request could not be understood by the server due to malformed syntax. not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.property: Value [%s] is not a valid property for object [%s] invalid.whatsapp.address: WhatsApp address must only contain numeric characters of destination phone number. invalid.webmessaging.text.body: The request needs a textBody not empty and under 4000 characters. constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. active.conversation: An alerting or connected conversation is already in progress. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' existing.conversation: An existing conversation within the conversation window is in progress. response.missing.apple.invitation: The messaging response template is configured as AppleInvitation type but does not contain an appleInvitation object. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: organization.outbound.usage.limit.exceeded: Max outbound message usage exceeded. request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:create x-purecloud-method-name: postConversationsMessagesAgentless /api/v2/conversations/messages/inbound/open: post: tags: - Conversations summary: Send an inbound Open Message description: '[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 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.' operationId: postConversationsMessagesInboundOpen produces: - application/json parameters: - in: body name: body description: NormalizedMessage required: true schema: $ref: '#/definitions/OpenNormalizedMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenNormalizedMessage' '202': description: Accepted schema: $ref: '#/definitions/OpenNormalizedMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' missing.open.channel.date: Missing open channel date. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ALL permissions: - conversation:message:receive x-purecloud-method-name: postConversationsMessagesInboundOpen /api/v2/conversations/messages/{integrationId}/inbound/open/event: post: tags: - Conversations summary: Send an inbound Open Event Message description: 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. operationId: postConversationsMessageInboundOpenEvent produces: - application/json parameters: - name: integrationId in: path description: integrationId required: true type: string - in: body name: body description: NormalizedMessage required: true schema: $ref: '#/definitions/OpenInboundNormalizedEvent' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenEventNormalizedMessage' '202': description: Accepted schema: $ref: '#/definitions/OpenEventNormalizedMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' missing.open.channel.date: Missing open channel date. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:receive x-purecloud-method-name: postConversationsMessageInboundOpenEvent /api/v2/conversations/messages/{integrationId}/inbound/open/message: post: tags: - Conversations summary: Send inbound Open Message description: 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. operationId: postConversationsMessageInboundOpenMessage produces: - application/json parameters: - name: integrationId in: path description: integrationId required: true type: string - name: prefetchConversationId in: query description: Indicates whether or not to prefetch conversationId required: false type: boolean default: false - in: body name: body description: NormalizedMessage required: true schema: $ref: '#/definitions/OpenInboundNormalizedMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenMessageNormalizedMessage' '202': description: Accepted schema: $ref: '#/definitions/OpenMessageNormalizedMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' missing.open.channel.date: Missing open channel date. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:receive x-purecloud-method-name: postConversationsMessageInboundOpenMessage /api/v2/conversations/messages/{integrationId}/inbound/open/structured/response: post: tags: - Conversations summary: Send inbound Open Response description: 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. operationId: postConversationsMessageInboundOpenStructuredResponse produces: - application/json parameters: - name: integrationId in: path description: integrationId required: true type: string - in: body name: body description: OpenInboundStructuredResponseMessage required: true schema: $ref: '#/definitions/OpenInboundStructuredResponseMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenStructuredResponseNormalizedMessage' '202': description: Accepted schema: $ref: '#/definitions/OpenStructuredResponseNormalizedMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' missing.open.channel.date: Missing open channel date. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:receive x-purecloud-method-name: postConversationsMessageInboundOpenStructuredResponse /api/v2/conversations/messages/{integrationId}/inbound/open/receipt: post: tags: - Conversations summary: Send an inbound Open Receipt Message description: 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. operationId: postConversationsMessageInboundOpenReceipt produces: - application/json parameters: - name: integrationId in: path description: integrationId required: true type: string - in: body name: body description: NormalizedMessage required: true schema: $ref: '#/definitions/OpenInboundNormalizedReceipt' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenReceiptNormalizedMessage' '202': description: Accepted schema: $ref: '#/definitions/OpenReceiptNormalizedMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' missing.open.channel.date: Missing open channel date. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:message:receive x-purecloud-method-name: postConversationsMessageInboundOpenReceipt /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing: post: tags: - Conversations summary: Send message typing event description: Send message typing event for existing conversation/communication. operationId: postConversationsMessageCommunicationTyping produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: MessageTypingEvent required: true schema: $ref: '#/definitions/MessageTypingEventRequest' responses: '204': description: Message typing event sent '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:message:create - conversation:webmessaging:create x-purecloud-method-name: postConversationsMessageCommunicationTyping /api/v2/conversations/screenshares/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: putConversationsScreenshareRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsScreenshareRecordingstate /api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: getConversationsScreenshareParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-purecloud-method-name: getConversationsScreenshareParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/ operationId: postConversationsScreenshareParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsScreenshareParticipantCommunicationWrapup /api/v2/conversations/socials/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsSocialRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsSocialRecordingstate /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsSocialParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsSocialParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsSocialParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsSocialParticipantCommunicationWrapup /api/v2/conversations/videos/{conversationId}/recordingstate: put: tags: - Conversations summary: Update a conversation by setting its recording state description: '' operationId: putConversationsVideoRecordingstate produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - in: body name: body description: SetRecordingState required: true schema: $ref: '#/definitions/SetRecordingState' responses: '200': description: successful operation schema: type: string enum: - ACTIVE - PAUSED - NONE '202': description: Accepted - when pausing or resuming recordings (Secure Pause) schema: type: string enum: - ACTIVE - PAUSED - NONE '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.disconnected: Conversation is disconnected, cannot alter recordingState bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' conversation.error.forbidden.not.active.participant: User is not active on conversation and cannot alter recordingState '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:recording:pauseOthers x-purecloud-method-name: putConversationsVideoRecordingstate /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation communication. ' description: '' operationId: getConversationsVideoParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: provisional in: query description: Indicates whether or not to fetch provisional wrap-up code. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationsVideoParticipantCommunicationWrapup post: tags: - Conversations summary: Apply wrap-up for this conversation communication description: '' operationId: postConversationsVideoParticipantCommunicationWrapup produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: participantId in: path description: participantId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Wrap-up required: false schema: $ref: '#/definitions/WrapupInput' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.wrapup.code: Wrapup code is required for non-provisional wrapup. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup x-purecloud-method-name: postConversationsVideoParticipantCommunicationWrapup /api/v2/conversations/videos/meetings/{meetingId}: get: tags: - Conversations summary: Gets a record for a given meetingId description: '' operationId: getConversationsVideosMeeting produces: - application/json parameters: - name: meetingId in: path description: meetingId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MeetingIdRecord' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - video:video:access x-purecloud-method-name: getConversationsVideosMeeting /api/v2/conversations/videos/meetings: post: tags: - Conversations summary: Generate a meetingId for a given conferenceId description: '' operationId: postConversationsVideosMeetings produces: - application/json parameters: - in: body name: body description: MeetingIdRequest required: true schema: $ref: '#/definitions/GenerateMeetingIdRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MeetingIdRecord' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - video:video:access x-purecloud-method-name: postConversationsVideosMeetings /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId}: get: tags: - Conversations summary: Get message description: '' operationId: getConversationCommunicationInternalmessage produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: messageId in: path description: messageId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/InternalMessageData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:view x-purecloud-method-name: getConversationCommunicationInternalmessage /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages: get: tags: - Conversations summary: Get messages for communication description: '' operationId: getConversationCommunicationInternalmessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - name: pageSize in: query description: Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/InternalMessageDataEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:view x-purecloud-method-name: getConversationCommunicationInternalmessages post: tags: - Conversations summary: Send internal message description: Send a new internal message for an existing communication. operationId: postConversationCommunicationInternalmessages produces: - application/json parameters: - name: conversationId in: path description: conversationId required: true type: string - name: communicationId in: path description: communicationId required: true type: string - in: body name: body description: Message required: true schema: $ref: '#/definitions/InternalMessageRequest' responses: '202': description: Accepted schema: $ref: '#/definitions/InternalMessageData' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: max.length.exceeded: Message text is longer than the maximum length allowed. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable max.messages.exceeded: Max messages for communication. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] max.messages.in.conversation: Max communications in conversation. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:create x-purecloud-method-name: postConversationCommunicationInternalmessages /api/v2/conversations/messaging/integrations: get: tags: - Conversations summary: Get a list of Integrations description: '' operationId: getConversationsMessagingIntegrations produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: array items: type: string enum: - supportedContent - messagingSetting - identityresolution collectionFormat: multi - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrations /api/v2/conversations/messaging/threadingtimeline: get: tags: - Conversations summary: Get conversation threading window timeline for each messaging type description: 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 expires, a new conversation is created. operationId: getConversationsMessagingThreadingtimeline produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationThreadingWindow' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:threadingTimeline:view x-purecloud-method-name: getConversationsMessagingThreadingtimeline put: tags: - Conversations summary: Update conversation threading window timeline for each messaging type description: 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. operationId: putConversationsMessagingThreadingtimeline produces: - application/json parameters: - in: body name: body description: ConversationThreadingWindowRequest required: true schema: $ref: '#/definitions/ConversationThreadingWindow' responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationThreadingWindow' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.threading.window.timeout: The provided conversation threading window timeout for a messaging type is invalid invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:threadingTimeline:edit x-purecloud-method-name: putConversationsMessagingThreadingtimeline /api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}: get: tags: - Conversations summary: Get Apple messaging integration identity resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionApple:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId put: tags: - Conversations summary: Create an identity resolution settings for a Apple messaging integration description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: IdentityResolutionConfig required: true schema: $ref: '#/definitions/AppleIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] division.not.found: Division with that ID not found constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit - messaging:identityResolutionApple:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId /api/v2/conversations/messaging/integrations/apple/{integrationId}: get: tags: - Conversations summary: Get an Apple messaging integration description: '' operationId: getConversationsMessagingIntegrationsAppleIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsAppleIntegrationId delete: tags: - Conversations summary: Delete an Apple messaging integration description: '' operationId: deleteConversationsMessagingIntegrationsAppleIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: Apple messaging integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsAppleIntegrationId patch: tags: - Conversations summary: Update an Apple messaging integration description: '' operationId: patchConversationsMessagingIntegrationsAppleIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: AppleIntegrationUpdateRequest required: true schema: $ref: '#/definitions/AppleIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:appleIntegration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsAppleIntegrationId /api/v2/conversations/messaging/integrations/apple: get: tags: - Conversations summary: Get a list of Apple Integrations description: '' operationId: getConversationsMessagingIntegrationsApple produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsApple post: tags: - Conversations summary: Create Apple Integration description: '' operationId: postConversationsMessagingIntegrationsApple produces: - application/json parameters: - in: body name: body description: AppleIntegrationRequest required: true schema: $ref: '#/definitions/AppleIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/AppleIntegration' '202': description: Accepted - If async is true, the integration creation in progress. schema: $ref: '#/definitions/AppleIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: duplicate.integration.for.messages.for.business.id: An integration for this Messages for Business ID already exists. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.messages.for.business.id: The provided Messages for Business ID isn't valid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:appleIntegration:add x-purecloud-method-name: postConversationsMessagingIntegrationsApple /api/v2/conversations/messaging/facebook/app: get: tags: - Conversations summary: Get Genesys Facebook App Id description: '' operationId: getConversationsMessagingFacebookApp produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookAppCredentials' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:add x-purecloud-method-name: getConversationsMessagingFacebookApp /api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}: get: tags: - Conversations summary: Get Facebook messaging integration identity resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionFacebook:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId put: tags: - Conversations summary: Create an identity resolution settings for a Facebook messaging integration description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: IdentityResolutionConfig required: true schema: $ref: '#/definitions/FacebookIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] division.not.found: Division with that ID not found constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit - messaging:identityResolutionFacebook:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId /api/v2/conversations/messaging/integrations/facebook/{integrationId}: get: tags: - Conversations summary: Get a Facebook messaging integration description: '' operationId: getConversationsMessagingIntegrationsFacebookIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsFacebookIntegrationId delete: tags: - Conversations summary: Delete a Facebook messaging integration description: '' operationId: deleteConversationsMessagingIntegrationsFacebookIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: Facebook integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable integration.has.ingestion.rule: Facebook integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsFacebookIntegrationId patch: tags: - Conversations summary: Update Facebook messaging integration description: '' operationId: patchConversationsMessagingIntegrationsFacebookIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: FacebookIntegrationUpdateRequest required: true schema: $ref: '#/definitions/FacebookIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsFacebookIntegrationId /api/v2/conversations/messaging/integrations/facebook: get: tags: - Conversations summary: Get a list of Facebook Integrations description: '' operationId: getConversationsMessagingIntegrationsFacebook produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsFacebook post: tags: - Conversations summary: Create a Facebook Integration description: '' operationId: postConversationsMessagingIntegrationsFacebook produces: - application/json parameters: - in: body name: body description: FacebookIntegrationRequest required: true schema: $ref: '#/definitions/FacebookIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/FacebookIntegration' '202': description: Accepted - The integration creation in progress. schema: $ref: '#/definitions/FacebookIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.permissions: The provided access token is missing Facebook permissions for this feature. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] invalid.access.token.combination: The request requires either the pageId and userAccessToken fields, or the pageAccessToken field. missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. unsupported.message.channel: Unsupported messageChannel. constraint.validation: '%s' facebook.public.not.yet.supported: Facebook Public not yet supported. could.not.find.page.access.token: Could not find Page Access Token for the pageId provided. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.page.access.token.provided: Provided Page Access Token is invalid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. page.already.integrated: There is an existing integration for this page with the requested feature. existing.active.webhook.facebook.subscription: There is another active webhook subscription for this Facebook App. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:add x-purecloud-method-name: postConversationsMessagingIntegrationsFacebook /api/v2/conversations/messaging/facebook/permissions: get: tags: - Conversations summary: Get a list of Facebook Permissions description: '' operationId: getConversationsMessagingFacebookPermissions produces: - application/json parameters: [] responses: '200': description: Completed request for public message. schema: $ref: '#/definitions/FacebookPermissionEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ANY permissions: - messaging:integration:add - messaging:integration:edit - messaging:conversationInstagramIntegration:add x-purecloud-method-name: getConversationsMessagingFacebookPermissions /api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}: get: tags: - Conversations summary: Get an Instagram integration identity resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionInstagram:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId put: tags: - Conversations summary: Create identity resolution settings for an Instagram messaging integration description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: IdentityResolutionConfig required: true schema: $ref: '#/definitions/InstagramIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] division.not.found: Division with that ID not found constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit - messaging:identityResolutionInstagram:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId /api/v2/conversations/messaging/integrations/instagram/{integrationId}: get: tags: - Conversations summary: Get Instagram messaging integration description: '' operationId: getConversationsMessagingIntegrationsInstagramIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsInstagramIntegrationId delete: tags: - Conversations summary: Delete Instagram messaging integration description: '' operationId: deleteConversationsMessagingIntegrationsInstagramIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: Instagram integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable integration.has.ingestion.rule: Instagram integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsInstagramIntegrationId patch: tags: - Conversations summary: Update Instagram messaging integration description: '' operationId: patchConversationsMessagingIntegrationsInstagramIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: InstagramIntegrationUpdateRequest required: true schema: $ref: '#/definitions/InstagramIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsInstagramIntegrationId /api/v2/conversations/messaging/integrations/instagram: get: tags: - Conversations summary: Get a list of Instagram Integrations description: '' operationId: getConversationsMessagingIntegrationsInstagram produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsInstagram post: tags: - Conversations summary: Create Instagram Integration description: '' operationId: postConversationsMessagingIntegrationsInstagram produces: - application/json parameters: - in: body name: body description: InstagramIntegrationRequest required: true schema: $ref: '#/definitions/InstagramIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/InstagramIntegration' '202': description: Accepted - If async is true, the integration creation in progress. schema: $ref: '#/definitions/InstagramIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.permissions: The provided access token is missing Instagram permissions for this feature. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] invalid.access.token.combination: The request requires either the pageId and userAccessToken fields, or the pageAccessToken field. missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' could.not.find.page.access.token: Could not find Page Access Token for the pageId provided. instagram.not.yet.supported: Instagram not yet supported. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. no.instagram.account.associated.with.page: No Instagram account associated with page. invalid.page.access.token.provided: Provided Page Access Token is invalid. page.subscription.error: Encountered an error while subscribing Facebook page to webhooks. Verify that any existing integration linked to this page is in a valid state invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. page.already.integrated: There is an existing integration for this page with the requested feature. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:conversationInstagramIntegration:add x-purecloud-method-name: postConversationsMessagingIntegrationsInstagram /api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}: get: tags: - Conversations summary: Get an open messaging integration Identity Resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OpenMessagingIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. integration.not.found: Integration does not exist '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. integration.not.active: Integration is not active '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionOpen:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId put: tags: - Conversations summary: Update an open messaging integration Identity Resolution settings description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/OpenMessagingIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenMessagingIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] division.not.found: Division with that ID not found constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. integration.not.active: Integration is not active '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit - messaging:identityResolutionOpen:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId /api/v2/conversations/messaging/integrations/open/{integrationId}: get: tags: - Conversations summary: Get an Open messaging integration description: See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. operationId: getConversationsMessagingIntegrationsOpenIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/OpenIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsOpenIntegrationId delete: tags: - Conversations summary: Delete an Open messaging integration description: See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. operationId: deleteConversationsMessagingIntegrationsOpenIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: Open messaging integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. open.wrong.endpoint: Cannot delete open integration with extension via this endpoint. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '412': description: Precondition Failed schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: integration.has.escalation.rules: Integration cannot be deleted with an existing escalation rule(s) associated to it. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsOpenIntegrationId patch: tags: - Conversations summary: Update an Open messaging integration description: See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. operationId: patchConversationsMessagingIntegrationsOpenIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: OpenIntegrationUpdateRequest required: true schema: $ref: '#/definitions/OpenIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' notification.webhook.signature.secret.token.longer.than.15.characters: The notification webhook signature secret token for the integration must be longer than 15 characters. open.wrong.endpoint: Cannot edit open integration with extension via this endpoint. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.outbound.webhook.url: The outboundNotificationWebhookUrl provided is not a valid url. too.many.webhook.headers: Too many webhook headers provided. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsOpenIntegrationId /api/v2/conversations/messaging/integrations/open: get: tags: - Conversations summary: Get a list of Open messaging integrations description: See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. operationId: getConversationsMessagingIntegrationsOpen produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OpenIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsOpen post: tags: - Conversations summary: Create an Open messaging integration description: See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. operationId: postConversationsMessagingIntegrationsOpen produces: - application/json parameters: - in: body name: body description: OpenIntegrationRequest required: true schema: $ref: '#/definitions/OpenIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/OpenIntegration' '202': description: Accepted schema: $ref: '#/definitions/OpenIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' notification.webhook.signature.secret.token.longer.than.15.characters: The notification webhook signature secret token for the integration must be longer than 15 characters. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.outbound.webhook.url: The outboundNotificationWebhookUrl provided is not a valid url. too.many.webhook.headers: Too many webhook headers provided. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:add x-purecloud-method-name: postConversationsMessagingIntegrationsOpen /api/v2/conversations/messaging/settings/default: get: tags: - Conversations summary: Get the organization's default settings that will be used as the default when creating an integration. description: 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. operationId: getConversationsMessagingSettingsDefault produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingSetting' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:setting:view x-purecloud-method-name: getConversationsMessagingSettingsDefault put: tags: - Conversations summary: Set the organization's default setting that may be applied to to integrations without settings description: 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. operationId: putConversationsMessagingSettingsDefault produces: - application/json parameters: - in: body name: body description: MessagingSetting required: true schema: $ref: '#/definitions/MessagingSettingDefaultRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingSetting' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:setting:edit x-purecloud-method-name: putConversationsMessagingSettingsDefault delete: tags: - Conversations summary: Delete the organization's default setting, a global default will be applied to integrations without settings description: 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. operationId: deleteConversationsMessagingSettingsDefault produces: - application/json parameters: [] responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:setting:delete x-purecloud-method-name: deleteConversationsMessagingSettingsDefault /api/v2/conversations/messaging/settings: get: tags: - Conversations summary: Get a list of messaging settings description: '' operationId: getConversationsMessagingSettings produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingConfigListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:setting:view x-purecloud-method-name: getConversationsMessagingSettings post: tags: - Conversations summary: Create a messaging setting description: '' operationId: postConversationsMessagingSettings produces: - application/json parameters: - in: body name: body description: MessagingSetting required: true schema: $ref: '#/definitions/MessagingSettingRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingSetting' '201': description: Operation was successful schema: $ref: '#/definitions/MessagingSetting' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.messaging.setting: The messaging setting request was invalid. One or more errors may be reported. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:setting:add x-purecloud-method-name: postConversationsMessagingSettings /api/v2/conversations/messaging/settings/{messageSettingId}: get: tags: - Conversations summary: Get a messaging setting description: '' operationId: getConversationsMessagingSetting produces: - application/json parameters: - name: messageSettingId in: path description: Message Setting ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingSetting' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:setting:view x-purecloud-method-name: getConversationsMessagingSetting delete: tags: - Conversations summary: Delete a messaging setting description: '' operationId: deleteConversationsMessagingSetting produces: - application/json parameters: - name: messageSettingId in: path description: Message Setting ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:setting:delete x-purecloud-method-name: deleteConversationsMessagingSetting patch: tags: - Conversations summary: Update a messaging setting description: '' operationId: patchConversationsMessagingSetting produces: - application/json parameters: - name: messageSettingId in: path description: Message Setting ID required: true type: string - in: body name: body description: MessagingSetting required: true schema: $ref: '#/definitions/MessagingSettingPatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingSetting' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.messaging.setting: The messaging setting request was invalid. One or more errors may be reported. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:setting:edit x-purecloud-method-name: patchConversationsMessagingSetting /api/v2/conversations/messaging/supportedcontent/default: get: tags: - Conversations summary: Get the organization's default supported content profile that will be used as the default when creating an integration. description: 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. operationId: getConversationsMessagingSupportedcontentDefault produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContent' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:view x-purecloud-method-name: getConversationsMessagingSupportedcontentDefault put: tags: - Conversations summary: Set the organization's default supported content profile that may be assigned to an integration when it is created. description: 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. operationId: putConversationsMessagingSupportedcontentDefault produces: - application/json parameters: - in: body name: body description: Reference to supported content profile required: true schema: $ref: '#/definitions/SupportedContentReference' responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContent' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: supported.content.id.required: The supported content ID is required bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:edit x-purecloud-method-name: putConversationsMessagingSupportedcontentDefault /api/v2/conversations/messaging/supportedcontent/{supportedContentId}: get: tags: - Conversations summary: Get a supported content profile description: '' operationId: getConversationsMessagingSupportedcontentSupportedContentId produces: - application/json parameters: - name: supportedContentId in: path description: Supported Content ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContent' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:view x-purecloud-method-name: getConversationsMessagingSupportedcontentSupportedContentId delete: tags: - Conversations summary: Delete a supported content profile description: '' operationId: deleteConversationsMessagingSupportedcontentSupportedContentId produces: - application/json parameters: - name: supportedContentId in: path description: Supported Content ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: supported.content.in.use: The supported content profile is in use by an integration supported.content.in.use.sms: The supported content profile is in use by an SMS phone number bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:delete x-purecloud-method-name: deleteConversationsMessagingSupportedcontentSupportedContentId patch: tags: - Conversations summary: Update a supported content profile description: '' operationId: patchConversationsMessagingSupportedcontentSupportedContentId produces: - application/json parameters: - name: supportedContentId in: path description: Supported Content ID required: true type: string - in: body name: body description: SupportedContent required: true schema: $ref: '#/definitions/SupportedContent' responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContent' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.media.type: A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] maximum.supported.content.media.types.exceeded: The maximum number of media types defined for the supported content profile has been exceeded invalid.supported.content: The supported content request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:edit x-purecloud-method-name: patchConversationsMessagingSupportedcontentSupportedContentId /api/v2/conversations/messaging/supportedcontent: get: tags: - Conversations summary: Get a list of Supported Content profiles description: '' operationId: getConversationsMessagingSupportedcontent produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContentListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:supportedContent:view x-purecloud-method-name: getConversationsMessagingSupportedcontent post: tags: - Conversations summary: Create a Supported Content profile description: '' operationId: postConversationsMessagingSupportedcontent produces: - application/json parameters: - in: body name: body description: SupportedContent required: true schema: $ref: '#/definitions/SupportedContent' responses: '200': description: successful operation schema: $ref: '#/definitions/SupportedContent' '201': description: Operation was successful schema: $ref: '#/definitions/SupportedContent' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.media.type: A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types. maximum.supported.content.profiles.exceeded: The maximum number of supported content profiles created for an organization has been exceeded bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] maximum.supported.content.media.types.exceeded: The maximum number of media types defined for the supported content profile has been exceeded invalid.supported.content: The supported content request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ANY permissions: - messaging:supportedContent:add x-purecloud-method-name: postConversationsMessagingSupportedcontent /api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}: get: tags: - Conversations summary: Get X (Formally Twitter) messaging integration identity resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionX:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId put: tags: - Conversations summary: Create an identity resolution settings for an X (Formally Twitter) messaging integration description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration Id required: true type: string - in: body name: body description: IdentityResolutionConfig required: true schema: $ref: '#/definitions/TwitterIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:XIntegration:edit - messaging:identityResolutionX:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId /api/v2/conversations/messaging/integrations/twitter/{integrationId}: get: tags: - Conversations summary: Get Twitter messaging integration description: '' operationId: getConversationsMessagingIntegrationsTwitterIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsTwitterIntegrationId delete: tags: - Conversations summary: Delete Twitter messaging integration description: '' operationId: deleteConversationsMessagingIntegrationsTwitterIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '204': description: Operation was successful '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: Twitter integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '412': description: Precondition Failed schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: integration.has.escalation.rules: Integration cannot be deleted with an existing escalation rule(s) associated to it. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsTwitterIntegrationId patch: tags: - Conversations summary: Update a Twitter messaging integration description: '' operationId: patchConversationsMessagingIntegrationsTwitterIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: TwitterIntegrationUpdateRequest required: true schema: $ref: '#/definitions/TwitterIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:XIntegration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsTwitterIntegrationId /api/v2/conversations/messaging/integrations/twitter: get: tags: - Conversations summary: Get a list of Twitter Integrations description: '' operationId: getConversationsMessagingIntegrationsTwitter produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsTwitter post: tags: - Conversations summary: Create Twitter Integration description: '' operationId: postConversationsMessagingIntegrationsTwitter produces: - application/json parameters: - in: body name: body description: TwitterIntegrationRequest required: true schema: $ref: '#/definitions/TwitterIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterIntegration' '202': description: Accepted - If async is true, the integration creation in progress. schema: $ref: '#/definitions/TwitterIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:XIntegration:add x-purecloud-method-name: postConversationsMessagingIntegrationsTwitter /api/v2/conversations/messaging/integrations/twitter/oauth/settings: get: tags: - Conversations summary: Get twitter oauth settings description: '' operationId: getConversationsMessagingIntegrationsTwitterOauthSettings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterSignupOAuthSettings' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:XIntegration:add x-purecloud-method-name: getConversationsMessagingIntegrationsTwitterOauthSettings /api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings: get: tags: - Conversations summary: Get twitter oauth settings to patch an integration description: '' operationId: getConversationsMessagingIntegrationTwitterOauthSettings produces: - application/json parameters: - name: integrationId in: path description: Integration Id of an existing integration that needs to be patched with new oauth settings required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TwitterOAuthSettings' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:XIntegration:add x-purecloud-method-name: getConversationsMessagingIntegrationTwitterOauthSettings /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}: patch: tags: - Conversations summary: Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow description: 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. operationId: patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: WhatsAppEmbeddedSignupIntegrationActivationRequest required: true schema: $ref: '#/definitions/WhatsAppEmbeddedSignupIntegrationActivationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '202': description: Accepted - The integration activation in progress. schema: $ref: '#/definitions/WhatsAppIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.phone.number: The phone number provided is invalid as it is not in E.164 phone format. phone.number.not.found.on.waba: The phone number provided was not found on the WABA. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. please.ensure.two.factor.authentication.is.disabled: Please ensure two-factor authentication is disabled. phone.number.already.in.use: A WhatsApp integration has already been created for this phone number. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup: post: tags: - Conversations summary: Create a WhatsApp Integration using the WhatsApp embedded signup flow description: 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 of the available phone numbers in the PATCH call on the integration to activate it. operationId: postConversationsMessagingIntegrationsWhatsappEmbeddedsignup produces: - application/json parameters: - in: body name: body description: WhatsAppEmbeddedSignupIntegrationRequest required: true schema: $ref: '#/definitions/WhatsAppEmbeddedSignupIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '202': description: Accepted - The integration creation in progress. schema: $ref: '#/definitions/WhatsAppIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. too.many.integrations.for.this.message.channel: There are too many WhatsApp integrations already created. phone.number.already.in.use: A WhatsApp integration has already been created for this phone number. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:whatsappIntegration:add x-purecloud-method-name: postConversationsMessagingIntegrationsWhatsappEmbeddedsignup /api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}: get: tags: - Conversations summary: Get a whatsApp integration Identity Resolution settings description: '' operationId: getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view - messaging:identityResolutionWhatsApp:view x-purecloud-method-name: getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId put: tags: - Conversations summary: Update a whatsApp integration Identity Resolution settings description: '' operationId: putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/WhatsAppIdentityResolutionConfig' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIdentityResolutionConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] division.not.found: Division with that ID not found constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' access.denied.to.field: You are not authorized to view one or more of the referenced entities. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: validation.failed: The configuration you specified is invalid. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit - messaging:identityResolutionWhatsApp:edit x-purecloud-method-name: putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}: get: tags: - Conversations summary: Get a WhatsApp messaging integration description: '' operationId: getConversationsMessagingIntegrationsWhatsappIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsWhatsappIntegrationId delete: tags: - Conversations summary: Delete a WhatsApp messaging integration description: '' operationId: deleteConversationsMessagingIntegrationsWhatsappIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '204': description: Request Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recipient.has.flow: WhatsApp integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:delete x-purecloud-method-name: deleteConversationsMessagingIntegrationsWhatsappIntegrationId patch: tags: - Conversations summary: Update a WhatsApp messaging integration description: '' operationId: patchConversationsMessagingIntegrationsWhatsappIntegrationId produces: - application/json parameters: - name: integrationId in: path description: Integration ID required: true type: string - in: body name: body description: WhatsAppIntegrationUpdateRequest required: true schema: $ref: '#/definitions/WhatsAppIntegrationUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '202': description: Processing Request schema: $ref: '#/definitions/WhatsAppIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging x-inin-requires-permissions: type: ALL permissions: - messaging:integration:edit x-purecloud-method-name: patchConversationsMessagingIntegrationsWhatsappIntegrationId /api/v2/conversations/messaging/integrations/whatsapp: get: tags: - Conversations summary: Get a list of WhatsApp Integrations description: '' operationId: getConversationsMessagingIntegrationsWhatsapp produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - supportedContent - messagingSetting - identityresolution - name: supportedContent.id in: query description: Filter integrations returned based on the supported content ID required: false type: string - name: messagingSetting.id in: query description: Filter integrations returned based on the setting ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegrationEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging - messaging:readonly x-inin-requires-permissions: type: ALL permissions: - messaging:integration:view x-purecloud-method-name: getConversationsMessagingIntegrationsWhatsapp post: tags: - Conversations summary: '[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration' description: '[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. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.' operationId: postConversationsMessagingIntegrationsWhatsapp produces: - application/json parameters: - in: body name: body description: WhatsAppIntegrationRequest required: true schema: $ref: '#/definitions/WhatsAppIntegrationRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppIntegration' '202': description: Accepted - The integration creation in progress. schema: $ref: '#/definitions/WhatsAppIntegration' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.phone.number: The phone number provided is invalid as it is not in E.164 phone format. invalid.property: Value [%s] is not a valid property for object [%s] missing.required.field.value: A required field was not provided or is blank. invalid.integration: The integration request was invalid for this operation. One or more errors may be reported. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. too.many.integrations.for.this.message.channel: There are too many WhatsApp integrations already created. phone.number.already.in.use: A WhatsApp integration has already been created for this phone number. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - messaging deprecated: true x-inin-requires-permissions: type: ALL permissions: - messaging:whatsappIntegration:add x-purecloud-method-name: postConversationsMessagingIntegrationsWhatsapp /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}: delete: tags: - Conversations summary: Delete a code used to add a communication to this participant description: '' operationId: deleteConversationParticipantCode produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - name: addCommunicationCode in: path description: addCommunicationCode required: true type: string responses: default: description: successful operation '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: deleteConversationParticipantCode /api/v2/conversations/{conversationId}/participants/{participantId}: patch: tags: - Conversations summary: Update a participant. description: Update conversation participant. operationId: patchConversationParticipant produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Update request required: true schema: $ref: '#/definitions/MediaParticipantRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.cannot.disconnect.call: The call for this request cannot be disconnected. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversation.error.hold.alerting: An alerting call cannot be placed on hold conversation.participant.update.invalid: Failed to update all properties on conversation participant. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. conversation.error.cannot.confine.party: The participant for this request cannot be confined. conversation.error.wrapup.code.required: Wrapup code is a required field and cannot be empty. conversation.error.participant.attribute.null: Cannot update participant attribute map to a null value. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.participant.update.failed: Failed to update all properties on conversation participant. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:participant:wrapup - conversation:call:record - conversation:communication:disconnect x-purecloud-method-name: patchConversationParticipant /api/v2/conversations/{conversationId}/participants/{participantId}/replace: post: tags: - Conversations summary: Replace this participant (Deprecated) description: 'This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.' operationId: postConversationParticipantReplace produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversation.error.disallowed.transfer.destination: Disallowed transfer destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationParticipantReplace /api/v2/conversations/{conversationId}/participants/{participantId}/transfer: post: tags: - Conversations summary: Replace this participant by another one using the address of the destination. description: '' operationId: postConversationParticipantTransfer produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferToAddressRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversation.error.disallowed.transfer.destination: Disallowed transfer destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer x-purecloud-method-name: postConversationParticipantTransfer /api/v2/conversations/{conversationId}/participants/{participantId}/digits: post: tags: - Conversations summary: Sends DTMF to the participant description: '' operationId: postConversationParticipantDigits produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Digits required: false schema: $ref: '#/definitions/Digits' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: providerapi.error.station.no.active.edge: Unable to place call. Could not find an Edge for this station. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationParticipantDigits /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes: get: tags: - Conversations summary: Get list of wrapup codes for this conversation participant description: '' operationId: getConversationParticipantWrapupcodes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/WrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' general.bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationParticipantWrapupcodes /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks: post: tags: - Conversations summary: Create a new callback for the specified participant on the conversation. description: '' operationId: postConversationParticipantCallbacks produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateCallbackOnConversationCommand' responses: '201': description: Created '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.callback.already.being.routed: A callback is already in the process of being routed on this conversation. callback.error.parse.call.number: A callback number cannot be parsed as a phone address. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversation.error.queue.required: Queue id is required for this request. callback.error.scheduled.time.too.far.in.future: The callback scheduled time cannot be more than 30 days into the future. constraint.validation: '%s' conversation.error.cannot.callback.acd: Cannot create a callback for an ACD participant. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. callback.error.scheduled.callback.already.exists: A callback is already scheduled on this conversation. callback.error.target.communication.cannot.be.acd.or.ivr: Target communication cannot belong to an acd or ivr participant. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:callback:create x-purecloud-method-name: postConversationParticipantCallbacks /api/v2/conversations/{conversationId}/participants/{participantId}/attributes: patch: tags: - Conversations summary: Update the attributes on a conversation participant. description: '' operationId: patchConversationParticipantAttributes produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Participant attributes required: true schema: $ref: '#/definitions/ParticipantAttributes' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: The participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: patchConversationParticipantAttributes /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup: get: tags: - Conversations summary: 'Get the wrap-up for this conversation participant. ' description: '' operationId: getConversationParticipantWrapup produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - name: provisional in: query description: Indicates if the wrap-up code is provisional. required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/AssignedWrapupCode' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationParticipantWrapup /api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent: post: tags: - Conversations summary: Replace this participant with the specified agent description: '' operationId: postConversationParticipantReplaceAgent produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferToAgentRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer - conversation:communication:blindTransferAgent x-purecloud-method-name: postConversationParticipantReplaceAgent /api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue: post: tags: - Conversations summary: Replace this participant with the specified queue description: '' operationId: postConversationParticipantReplaceQueue produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferToQueueRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer - conversation:communication:blindTransferQueue x-purecloud-method-name: postConversationParticipantReplaceQueue /api/v2/conversations/{conversationId}/participants/{participantId}/replace/external: post: tags: - Conversations summary: Replace this participant with the an external contact (Deprecated) description: This endpoint is deprecated. Use /replace/contact/external endpoint instead. operationId: postConversationParticipantReplaceExternal produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferToExternalRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer - conversation:communication:blindTransferExternal x-purecloud-method-name: postConversationParticipantReplaceExternal /api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external: post: tags: - Conversations summary: Replace this participant with the an external contact description: '' operationId: postConversationParticipantReplaceContactExternal produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Transfer request required: true schema: $ref: '#/definitions/TransferToExternalContactRequest' responses: '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversations.error.transfer.chat.external: Participants with chats cannot be transferred to external addresses. bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] conversations.error.transfer.usercall.voicemail: Only personal calls can be transferred to voicemail. constraint.validation: '%s' conversation.error.participant.no.active.conversations: Participant has no active conversations conversations.error.transfer.same.party: The target of the transfer cannot be the same as the destination. conversations.error.transfer.acd.call.unattended: An ACD call cannot be transferred unattended. conversations.error.transfer.destination.required: The destination is a required property for a transfer request. callback.error.user.id.queue.id: In destination, exactly one of userId or queueId is required. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversations.error.transfer.userCall.voicemail: Only personal calls can be transferred to voicemail. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. postino.error.bad.request: The request could not be understood by the server due to malformed syntax. conversations.error.queue.not.found: Interaction cannot be transferred to a queue that does not exist. conversations.error.transfer.not.connected: You can only transfer conversations that are in the connected state. conversations.error.transfer.chat.voicemail: Participants with chats cannot be transferred to voicemail. conversation.error.agent.indicated.address.not.allowed: The agent indicated address is not allowed for the user. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Participant does not exist. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:communication:blindTransfer - conversation:communication:blindTransferExternalContact x-purecloud-method-name: postConversationParticipantReplaceContactExternal /api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications: post: tags: - Conversations summary: Setup internal message communication with user description: The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission. operationId: postConversationParticipantInternalmessagesUsersCommunications produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body description: Confer request required: true schema: $ref: '#/definitions/MessagingConferWithUserRequest' responses: '202': description: Accepted schema: $ref: '#/definitions/MessagingConferResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' conversation.error.not.supported.command: Media not supported. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable conversation.error.internal.message.target.user.not.found: Target user not found. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. general.bad.request: The target is missing. conversation.error.internal.message.target.not.supported: Target type not supported. conversation.error.internal.message.active: There is already an active internal messaging consultation. conversation.error.internal.message.user.concurrent.max.exceeded: Maximum active internal messages for user exceeded. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: Access is forbidden. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.participant.not.found: Unable to determine the participant. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ANY permissions: - conversation:internalMessaging:setupWithUser x-purecloud-method-name: postConversationParticipantInternalmessagesUsersCommunications /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason: put: tags: - Conversations summary: Set flagged reason on conversation participant to indicate bad conversation quality. description: '' operationId: putConversationParticipantFlaggedreason produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string responses: '204': description: The flagged reason was set successfully. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: putConversationParticipantFlaggedreason delete: tags: - Conversations summary: Remove flagged reason from conversation participant. description: '' operationId: deleteConversationParticipantFlaggedreason produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string responses: '204': description: The flagged reason was removed successfully. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. not.found: The requested resource was not found. conversation.error.not.conversation.participant: User is not a participant in the conversation. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: deleteConversationParticipantFlaggedreason /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}: get: tags: - Conversations summary: Fetch info on a secure session description: '' operationId: getConversationParticipantSecureivrsession produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - name: secureSessionId in: path description: secure IVR session ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/SecureSession' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationParticipantSecureivrsession /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions: get: tags: - Conversations summary: Get a list of secure sessions for this participant. description: '' operationId: getConversationParticipantSecureivrsessions produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/SecureSessionEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-purecloud-method-name: getConversationParticipantSecureivrsessions post: tags: - Conversations summary: Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. description: '' operationId: postConversationParticipantSecureivrsessions produces: - application/json parameters: - name: conversationId in: path description: conversation ID required: true type: string - name: participantId in: path description: participant ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/CreateSecureSession' responses: '200': description: successful operation schema: $ref: '#/definitions/SecureSession' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-purecloud-method-name: postConversationParticipantSecureivrsessions /api/v2/conversations/{conversationId}/suggestions/feedback: post: tags: - Conversations summary: Suggestion feedback. description: Google Agent Assist offering within Genesys will no longer be supported operationId: postConversationSuggestionsFeedback produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - in: body name: body description: SuggestionFeedback required: true schema: $ref: '#/definitions/Feedback' responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly deprecated: true x-inin-requires-permissions: type: ANY permissions: - conversation:suggestionFeedback:add x-purecloud-method-name: postConversationSuggestionsFeedback /api/v2/conversations/{conversationId}/suggestions: get: tags: - Conversations summary: Get all suggestions for a conversation. description: '' operationId: getConversationSuggestions produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: before in: query description: The cursor that points to the start of the set of entities that has been returned. required: false type: string - name: after in: query description: The cursor that points to the end of the set of entities that has been returned. required: false type: string - name: pageSize in: query description: Number of entities to return. Maximum of 200. required: false type: string - name: type in: query description: Suggestion type to filter by. required: false type: string enum: - Faq - Article - KnowledgeArticle - KnowledgeSearch - CannedResponse - Script - SuggestedKnowledgeAnswer - ThirdPartySuggestion - name: state in: query description: Suggestion state to filter Copilot suggestions. required: false type: string enum: - Suggested - Accepted - Dismissed - Failed - Rated responses: '200': description: successful operation schema: $ref: '#/definitions/SuggestionListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:suggestion:view x-purecloud-method-name: getConversationSuggestions /api/v2/conversations/{conversationId}/suggestions/{suggestionId}: get: tags: - Conversations summary: Get Suggestion. description: '' operationId: getConversationSuggestion produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: suggestionId in: path description: Suggestion ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Suggestion' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:suggestion:view x-purecloud-method-name: getConversationSuggestion /api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement: post: tags: - Conversations summary: Save an engagement on the suggestion. description: '' operationId: postConversationSuggestionEngagement produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: suggestionId in: path description: Suggestion ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/SuggestionEngagement' responses: '200': description: successful operation schema: $ref: '#/definitions/SuggestionEngagement' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:suggestionEngagement:add x-purecloud-method-name: postConversationSuggestionEngagement /api/v2/conversations/{conversationId}/summaries: get: tags: - Conversations summary: Get the summaries of the conversation. description: '' operationId: getConversationSummaries produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ConversationSummariesGetResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: You do not have the required permission for this operation. missing.division.permissions: At least one of the required division permissions is missing. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations - conversations:readonly x-inin-requires-permissions: type: ALL permissions: - conversation:summary:view x-purecloud-method-name: getConversationSummaries /api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements: patch: tags: - Conversations summary: Update agent's engagement for the summary. description: '' operationId: patchConversationSummaryEngagements produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: summaryId in: path description: Summary ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/EngagementRequest' responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] no.input.payload: Both visibilityStatus and engagementStatus are missing constraint.validation: '%s' invalid.engagementstatus.value: EngagementStatus is not one of COPIED, NOT_COPIED and UNKNOWN invalid.visibilitiystatus.value: VisibilityStatus is not one of PRESENTED, NOT_PRESENTED and UNKNOWN response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.visibilitiystatus.type: VisibilityStatus received is not of type String invalid.engagementstatus.type: EngagementStatus received is not of type String invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: item.not.found.in.db: No summary exists for the hash_key not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: db.update.error: Failed to update DB with visibilityStatus and engagementStatus with received values internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:summaryEngagement:edit x-purecloud-method-name: patchConversationSummaryEngagements /api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback: post: tags: - Conversations summary: Submit feedback for the summary. description: '' operationId: postConversationSummaryFeedback produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: summaryId in: path description: Summary ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/FeedbackAddRequest' responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] summary.not.present: Summary attribute is missing no.input.payload: Payload is missing constraint.validation: '%s' invalid.value: Rating type is invalid '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Summary not found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:summaryFeedback:add x-purecloud-method-name: postConversationSummaryFeedback patch: tags: - Conversations summary: Update the feedback for the summary. description: '' operationId: patchConversationSummaryFeedback produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: summaryId in: path description: Summary ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/FeedbackUpdateRequest' responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] summary.not.present: Summary attribute is missing no.input.payload: Payload is missing constraint.validation: '%s' invalid.value: Rating type is invalid '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: Summary not found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - conversations x-inin-requires-permissions: type: ALL permissions: - conversation:summaryFeedback:edit x-purecloud-method-name: patchConversationSummaryFeedback /api/v2/conversations/messaging/oauth/apple/callback: get: tags: - Conversations summary: Call Authentication provider callback to validate state and code description: '' operationId: getConversationsMessagingOauthAppleCallback produces: - application/json parameters: - name: code in: query description: The authorization code to be sent to the authentication server during the token request. required: true type: string - name: state in: query description: The state/nonce value generated by Genesys Auth-Client Service. required: true type: string - name: error in: query description: Error parameter from OAuth provider required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OAuthAppleAuthorizationResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] parameters.missing: Parameters are missing constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. x-purecloud-method-name: getConversationsMessagingOauthAppleCallback definitions: ActivationTrigger: type: object properties: triggerType: type: string description: Trigger type that activated this checklist. enum: - Intent - ConversationStart triggerDate: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist was triggered. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' intentId: type: string description: The intent ID if checklist was triggered by an intent. intentName: type: string description: The intent name if checklist was triggered by an intent. OpenInboundNormalizedMessage: type: object required: - channel properties: channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenInboundMessageMessagingChannel' text: type: string description: Message text. content: type: array description: List of content elements. items: $ref: '#/definitions/OpenInboundMessageContent' metadata: type: object description: Additional metadata about this message to capture non-channel specific data. additionalProperties: type: string description: Open Messaging rich media message structure JsonSchemaDocument: type: object properties: id: type: string $schema: type: string title: type: string description: type: string type: type: string required: type: array items: type: string properties: type: object additionalProperties: type: object additionalProperties: type: object description: A JSON Schema document. MessagingSettingRequestReference: type: object required: - id properties: id: type: string description: The messaging Setting unique identifier associated with this integration description: Messaging Setting for messaging platform integrations InstagramIntegration: type: object required: - appId - id - name - version properties: id: type: string description: A unique Integration ID. readOnly: true name: type: string description: The name of the Instagram Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' appId: type: string description: The App ID from Facebook pageId: type: string description: The Page ID from Instagram messenger instagramId: type: string description: The ID from Instagram messenger instagramUsername: type: string description: The Username from Instagram messenger instagramName: type: string description: The name from Instagram messenger instagramProfileImageUrl: type: string description: The url of the profile image from Instagram messenger status: type: string description: The status of the Instagram Integration recipient: description: The recipient reference associated to the Instagram Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number required for updates. createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true WritableDivision: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true FaxStatus: type: object properties: direction: type: string description: The fax direction, either "send" or "receive". expectedPages: type: integer format: int64 description: Total number of expected pages, if known. activePage: type: integer format: int64 description: Active page of the transmission. linesTransmitted: type: integer format: int64 description: Number of lines that have completed transmission. bytesTransmitted: type: integer format: int64 description: Number of bytes that have competed transmission. baudRate: type: integer format: int64 description: Current signaling rate of transmission, baud rate. pageErrors: type: integer format: int64 description: Number of page errors. lineErrors: type: integer format: int64 description: Number of line errors. TwitterId: type: object properties: id: type: string description: 'twitter user.id_str. Max: 255 characters' name: type: string description: 'twitter user.name. Max: 255 characters' screenName: type: string description: 'twitter user.screen_name. Max: 255 characters. Must match pattern: ^@?[A-Za-z0-9_]+$' verified: type: boolean description: whether this data has been verified using the twitter API readOnly: true profileUrl: type: string description: url of user's twitter profile readOnly: true description: User information for a twitter account. Either id OR screenName (or both) must be present RoutingData: type: object required: - queueId properties: queueId: type: string description: The identifier of the routing queue languageId: type: string description: The identifier of a language to be considered in routing label: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level priority: type: integer format: int32 description: The priority for routing skillIds: type: array description: A list of skill identifiers to be considered in routing items: type: string skillExpression: type: string description: Optional skill expression for routing when skillIds are present. Used to match agents by a logical expression over skills. preferredAgentIds: type: array description: A list of agents to be preferred in routing items: type: string scoredAgents: type: array description: A list of scored agents for routing decisions. For Agent Owned Callbacks use one scored agent with a score of 100. items: $ref: '#/definitions/ScoredAgent' routingFlags: type: array description: An array of flags indicating how the conversation should be routed. Use "AGENT_OWNED_CALLBACK" when creating an Agent Owned Callback. items: type: string Conversation: type: object required: - participants - startTime properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string externalTag: type: string description: The external tag associated with the conversation. startTime: type: string format: date-time description: 'The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' address: type: string description: The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound. participants: type: array description: The list of all participants in the conversation. items: $ref: '#/definitions/Participant' conversationIds: type: array description: A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference. items: type: string maxParticipants: type: integer format: int32 description: If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. recordingState: type: string description: On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording. enum: - ACTIVE - PAUSED - NONE state: type: string description: On update, 'disconnected' will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none divisions: type: array description: Identifiers of divisions associated with this conversation items: $ref: '#/definitions/ConversationDivisionMembership' recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' securePause: type: boolean description: True when the recording of this conversation is in secure pause status. utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationEnrichment: type: object properties: language: description: Detected language of this message. $ref: '#/definitions/ConversationEnrichmentLanguage' sentimentV2: description: Detected sentiment of this message. $ref: '#/definitions/ConversationEnrichmentSentimentV2' description: Metadata enrichments provided by the platform. AppleIntegrationRequest: type: object required: - messagesForBusinessId - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Apple messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' messagesForBusinessId: type: string description: The Apple Messages for Business Id for the Apple messaging integration. businessName: type: string description: The name of the business. logoUrl: type: string description: The url of the businesses logo. appleIMessageApp: description: Interactive Application (iMessage App) Settings. $ref: '#/definitions/AppleIMessageApp' appleAuthentication: description: The Apple Messages for Business authentication setting. $ref: '#/definitions/AppleAuthentication' applePay: description: Apple Pay settings. $ref: '#/definitions/ApplePay' selfUri: type: string format: uri description: The URI for this object readOnly: true AdjustableLiveSpeakerDetection: type: object properties: mode: type: string description: Modes to tune between speed to live speaker detection vs accuracy. enum: - unknown - disabled - low - medium - high preconnectDuration: type: string description: ISO 8601 formatted relative duration (e.g., PT30.8427419S for 30.8 seconds), calculated on line connect. eventName: type: string description: The name of the event that triggered the ALSD evaluation (e.g., line.connect, speech.generic). isPersonLikely: type: boolean description: The output of the ALSD detector, evaluating whether there is likely a person on the call based on the above inputs, and if so, a person is detected early (person disposition name and speech.person analyzer result) and the associated action taken (e.g., speech.person postconnect entry in the disposition table has the action to transfer to a queue). totalRingbacks: type: integer format: int32 description: Number of tone.ring.* analyzer events detected during the call (expected mostly during pre-connect but the last ringback tone detection could potentially complete after line connect, which will increment totalRingbacks still). lineConnected: type: boolean description: Protocol line connect received (answered by a person, machine, busy, fax). Script: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' versionId: type: string createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' publishedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' versionDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startPageId: type: string startPageName: type: string features: type: object variables: type: object customActions: type: object pages: type: array items: $ref: '#/definitions/Page' selfUri: type: string format: uri description: The URI for this object readOnly: true FeedbackAddRequest: type: object required: - summary properties: rating: type: string description: Agent’s rating for the system-generated summary. enum: - Positive - Negative - Unknown summary: type: string example: Customer wants to cancel the ticket and he is happy with the service. description: Agent's summary for the conversation ConversationAggregationView: type: object required: - function - name - target properties: target: type: string description: Target metric name enum: - nBlindTransferred - nBotInteractions - nCallbackAttempts - nCallbackOverSla - nCallbackScheduled - nCfcOffered - nCobrowseSessions - nConnected - nConsult - nConsultTransferred - nConversations - nError - nOffered - nOutbound - nOutboundAbandoned - nOutboundAttempted - nOutboundConnected - nOverSla - nStateTransitionError - nTakeover - nTransferred - oAudioMessageCount - oCallbackServiceLevel - oExternalAudioMessageCount - oExternalMediaCount - oMediaCount - oMessageCount - oMessageSegmentCount - oMessageTurn - oServiceLevel - oServiceTarget - oSkillExpressionApplications - tAbandon - tAcd - tActiveCallback - tActiveCallbackComplete - tAcw - tAgentResponseTime - tAgentVideoConnected - tAlert - tAnswered - tAverageAgentResponseTime - tAverageCustomerResponseTime - tBarging - tCallbackAbandon - tCallbackConnect - tCallbackNotReached - tCallbackVirtualWait - tCfcAbandon - tCfcAcd - tCfcAnswered - tCfcFlowOut - tCoaching - tCoachingComplete - tConnected - tContacting - tDialing - tFirstConnect - tFirstDial - tFirstEngagement - tFirstResponse - tFlowOut - tHandle - tHeld - tHeldComplete - tIvr - tMonitoring - tMonitoringComplete - tNotResponding - tPark - tParkComplete - tScreenMonitoring - tShortAbandon - tSnippetRecord - tTalk - tTalkComplete - tTransmitting - tUserResponseTime - tVoicemail - tWait name: type: string description: A unique name for this view. Must be distinct from other views and built-in metric names. function: type: string description: Type of view you wish to create enum: - rangeBound range: description: Range of numbers for slicing up data $ref: '#/definitions/AggregationRange' CreateWebChatMessageRequest: type: object required: - body properties: body: type: string description: The message body. Note that message bodies are limited to 4,000 characters. bodyType: type: string description: The purpose of the message within the conversation, such as a standard text entry versus a greeting. enum: - standard - notice - member-join - member-leave - media-request FacebookPermissionEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/FacebookPermission' Disposition: type: object required: - name properties: name: type: string description: Name of the disposition. Either a platform predefined value, or the name of the disposition in the disposition table.. analyzer: type: string description: The final media analyzer result that triggered the disposition result, if any. dispositionParameters: description: Contains various parameters related to call analysis. $ref: '#/definitions/DispositionParameters' detectedSpeechStart: type: string format: date-time description: 'Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' detectedSpeechEnd: type: string format: date-time description: 'Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' amdTimeout: description: Answering Machine Detection timeout configuration. $ref: '#/definitions/DispositionAmdTimeout' silentCallTimeout: description: Silent Call timeout configuration. $ref: '#/definitions/DispositionSilentCallTimeout' StatisticalSummary: type: object properties: max: type: number min: type: number count: type: integer format: int64 countNegative: type: integer format: int64 countPositive: type: integer format: int64 sum: type: number current: type: number ratio: type: number numerator: type: number denominator: type: number target: type: number p95: type: integer format: int64 p99: type: integer format: int64 calculatedMetricValue: type: integer format: int64 MediaSummary: type: object properties: contactCenter: $ref: '#/definitions/MediaSummaryDetail' enterprise: $ref: '#/definitions/MediaSummaryDetail' ConversationContentButtonResponse: type: object required: - payload - text properties: originatingMessageId: type: string description: Reference to the ID of the original message (e.g., list picker) this button response is replying to. type: type: string description: Describes the button that resulted in the Button Response. enum: - Button - QuickReply - DatePicker - ListPicker - Form text: type: string description: The response text from the button click. payload: type: string description: The response payload associated with the clicked button. description: Button response object representing the click of a structured message button, such as a quick reply. TextMessageListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessageData' AnalyticsSurvey: type: object properties: eventTime: type: string format: date-time description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' queueId: type: string description: The ID of the associated queue surveyCompletedDate: type: string format: date-time description: Completion datetime of the survey in ISO 8601 format surveyFormContextId: type: string description: Unique identifier for the survey form, regardless of version surveyFormId: type: string description: ID of the survey form used surveyFormName: type: string description: Name of the survey form used surveyId: type: string description: ID of the survey surveyPartialResponse: type: boolean description: Whether the survey was completed with any required questions unanswered. surveyPromoterScore: type: integer format: int32 description: Score of the survey used with NPS surveyStatus: type: string description: The status of the survey surveyType: type: string description: The type of the survey enum: - Web - Voice userId: type: string description: ID of the agent the survey was performed against oSurveyTotalScore: type: integer format: int64 ConversationContext: type: object required: - id - participant - text properties: id: type: string description: ID of the conversation turn. participant: type: string description: Participant type of the entity. enum: - Internal - External text: type: string description: The conversation text. WhatsAppIntegration: type: object required: - id - name - phoneNumber - version properties: id: type: string description: A unique Integration Id. readOnly: true name: type: string description: The name of the WhatsApp integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' phoneNumber: type: string description: The phone number associated to the WhatsApp integration. availablePhoneNumbers: description: The list of available WhatsApp phone numbers for this account. Please select one phone number from this list to use with the created integration. readOnly: true $ref: '#/definitions/WhatsAppAvailablePhoneNumberDetailsListing' status: type: string description: The status of the WhatsApp Integration enum: - Active - Inactive - Error - Starting - Incomplete - Deleting - DeletionFailed - Failed recipient: description: The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number required for updates. activationStatusCode: type: string description: The status code of WhatsApp Integration activation process readOnly: true enum: - CodeSent - WaitRequired - ActivationFailed - CodeConfirmed - ConfirmationFailed - ResendCode activationErrorInfo: description: The error information of WhatsApp Integration activation process readOnly: true $ref: '#/definitions/ErrorBody' createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' whatsAppBusinessAccountId: type: string description: The WhatsApp Business Account Id (WABA Id) readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationActivityData: type: object properties: group: type: object description: A mapping from grouping dimension to value additionalProperties: type: string data: type: array description: Data for metrics items: $ref: '#/definitions/ConversationActivityMetricValue' truncated: type: boolean description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities. entities: type: array description: Details for active entities items: $ref: '#/definitions/ConversationActivityEntityData' InternalMessageDataEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/InternalMessageData' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 MediaTypeAccess: type: object properties: inbound: type: array description: List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message. items: $ref: '#/definitions/MediaType' outbound: type: array description: List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent. items: $ref: '#/definitions/MediaType' description: Media type access definitions ConversationNotificationTemplateFooter: type: object properties: text: type: string description: Footer text. For WhatsApp, ignored. description: Template footer object. AnalyticsConversationWithoutAttributes: type: object properties: accessAttributes: type: array description: Set of attributes that limit which users can access the conversation items: type: string associatedConversationId: type: string description: ID of the conversation the initiator is signaling this new conversation is associated with conferenceStart: type: string format: date-time description: 'The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' consultationConversationIds: type: array description: Set of conversationIds the initiator has signaled this conversation is associated with items: type: string conversationEnd: type: string format: date-time description: 'The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' conversationId: type: string description: Unique identifier for the conversation conversationInitiator: type: string description: Indicates the participant purpose of the participant initiating a message conversation enum: - acd - agent - api - botflow - campaign - customer - dialer - external - fax - group - inbound - ivr - manual - outbound - station - user - voicemail - voicesurveyflow - workflow conversationStart: type: string format: date-time description: 'The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' customerParticipation: type: boolean description: Indicates a messaging conversation in which the customer participated by sending at least one message divisionIds: type: array description: Identifier(s) of division(s) associated with a conversation items: type: string externalTag: type: string description: External tag for the conversation inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' knowledgeBaseIds: type: array description: The unique identifier(s) of the knowledge base(s) used items: type: string mediaStatsMinConversationMos: type: number format: double description: The lowest estimated average MOS among all the audio streams belonging to this conversation mediaStatsMinConversationRFactor: type: number format: double description: The lowest R-factor value among all of the audio streams belonging to this conversation originatingDirection: type: string description: The original direction of the conversation enum: - inbound - outbound originatingSocialMediaPublic: type: boolean description: Indicates that the conversation originated from a public message on social media selfServed: type: boolean description: Indicates whether all flow sessions were self serviced evaluations: type: array description: Evaluations associated with this conversation items: $ref: '#/definitions/AnalyticsEvaluation' surveys: type: array description: Surveys associated with this conversation items: $ref: '#/definitions/AnalyticsSurvey' resolutions: type: array description: Resolutions associated with this conversation items: $ref: '#/definitions/AnalyticsResolution' participants: type: array description: Participants in the conversation items: $ref: '#/definitions/AnalyticsParticipantWithoutAttributes' ConversationContentNotificationTemplate: type: object required: - body properties: id: type: string description: The identifier of the message template in 'your-namespace@your-template-id/name' format. For External vendor (e.g WhatsApp), 'your-namespace@your-template-name'. For GenesysCloud canned response message template use 'cannedresponse' as your-namespace and use response ID as your-template-id (e.g. response ID=1234 then 'cannedresponse@1234') language: type: string description: Template language. header: description: The template header. $ref: '#/definitions/ConversationNotificationTemplateHeader' body: description: The template body. $ref: '#/definitions/ConversationNotificationTemplateBody' buttons: type: array description: Template buttons items: $ref: '#/definitions/ConversationNotificationTemplateButton' footer: description: The template footer. $ref: '#/definitions/ConversationNotificationTemplateFooter' description: Template notification object. AiScoringSettings: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true questionGroupSettings: type: array items: $ref: '#/definitions/QuestionGroupSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationChannelMetadata: type: object properties: subType: type: string description: Channel subtype readOnly: true enum: - None - GoogleBusinessProfile - RoadsideAssistance - YouTube description: Information about the channel. FeedbackUpdateRequest: type: object properties: rating: type: string description: Agent’s rating for the system-generated summary. enum: - Positive - Negative - Unknown summary: type: string example: Customer wants to cancel the ticket and he is happy with the service. description: Agent's summary for the conversation EvaluationReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationAggregateDataContainer: type: object properties: group: type: object description: A mapping from dimension to value additionalProperties: type: string data: type: array items: $ref: '#/definitions/StatisticalResponse' AggregationResult: type: object properties: type: type: string enum: - termFrequency - numericRange dimension: type: string description: For termFrequency aggregations metric: type: string description: For numericRange aggregations count: type: integer format: int64 results: type: array items: $ref: '#/definitions/AggregationResultEntry' InstagramIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/InstagramIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 GenerateMeetingIdRequest: type: object required: - ephemeral properties: conferenceId: type: string description: The conferenceId for which to generate a meetingId ephemeral: type: boolean description: Boolean flag for ephemeral status of the created record expireTimeDays: type: integer format: int32 description: Number of days the meetingId record will remain active MediaSummaryDetail: type: object properties: active: type: integer format: int32 acw: type: integer format: int32 ConversationDetailQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationDetailQueryPredicate' ConversationEnrichmentLanguage: type: object required: - language properties: language: type: string description: The IETF detected language code of this message. description: Detected language of this message. AnalyticsScoredAgent: type: object properties: agentScore: type: integer format: int32 description: Assigned agent score for this conversation (0 - 100, higher being better) scoredAgentId: type: string description: Unique identifier for the agent that was scored for this conversation ConversationContentDatePicker: type: object properties: id: type: string description: Optional unique identifier to help map component replies to form messages where multiple DatePickers can be present. title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the description. imageUrl: type: string description: URL of an image dateMinimum: type: string format: date-time description: 'The minimum Date Enabled in the datepicker calendar, format: ISO 8601.' dateMaximum: type: string format: date-time description: 'The maximum Date Enabled in the datepicker calendar, format: ISO 8601.' location: description: Location of the event. $ref: '#/definitions/ConversationContentLocation' availableTimes: type: array description: An array of available times objects. items: $ref: '#/definitions/ConversationContentDatePickerAvailableTime' dateDisplayFormat: type: string description: The format the date should be presented to the end user. enum: - dayMonthYear - monthDayYear - yearMonthDay description: DateTimePicker content object. Email: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - disconnected - none - parked - transmitting initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - disconnected - none - parked - transmitting id: type: string description: A globally unique identifier for this communication. held: type: boolean description: True if this call is held and the person on this side hears silence. subject: type: string description: The subject for the initial email that started this conversation. messagesSent: type: integer format: int32 description: The number of email messages sent by this participant. segments: type: array description: The time line of the participant's email, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the email enum: - inbound - outbound recordingId: type: string description: A globally unique identifier for the recording associated with this call. errorInfo: $ref: '#/definitions/ErrorBody' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' autoGenerated: type: boolean description: Indicates that the email was auto-generated like an Out of Office reply. provider: type: string description: The source provider for the email. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. messageId: type: string description: A globally unique identifier for the stored content of this communication. draftAttachments: type: array description: A list of uploaded attachments on the email draft. items: $ref: '#/definitions/Attachment' spam: type: boolean description: Indicates if the inbound email was marked as spam. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' parkTime: type: string format: date-time description: 'Represents the time when an email was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Participant: type: object properties: id: type: string description: A globally unique identifier for this conversation. startTime: type: string format: date-time description: 'The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' name: type: string description: A human readable name identifying the participant. userUri: type: string description: If this participant represents a user, then this will be an URI that can be used to fetch the user. userId: type: string description: If this participant represents a user, then this will be the globally unique identifier for the user. externalContactId: type: string description: If this participant represents an external contact, then this will be the globally unique identifier for the external contact. externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganizationId: type: string description: If this participant represents an external org, then this will be the globally unique identifier for the external org. queueId: type: string description: If present, the queue id that the communication channel came in on. groupId: type: string description: If present, group of users the participant represents. teamId: type: string description: The team id that this participant is a member of when added to the conversation. queueName: type: string description: If present, the queue name that the communication channel came in on. purpose: type: string description: A well known string that specifies the purpose of this participant. participantType: type: string description: A well known string that specifies the type of this participant. consultParticipantId: type: string description: If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred. address: type: string description: The address for the this participant. For a phone call this will be the ANI. ani: type: string description: The address for the this participant. For a phone call this will be the ANI. aniName: type: string description: The ani-based name for this participant. dnis: type: string description: The address for the this participant. For a phone call this will be the ANI. locale: type: string description: An ISO 639 language code specifying the locale for this participant wrapupRequired: type: boolean description: True iff this participant is required to enter wrapup for this conversation. wrapupPrompt: type: string description: This field controls how the UI prompts the agent for a wrapup. enum: - mandatory - optional - agentRequested - timeout - forcedTimeout wrapupTimeoutMs: type: integer format: int32 description: Specifies how long a timed ACW session will last. wrapupSkipped: type: boolean description: The UI sets this field when the agent chooses to skip entering a wrapup for this participant. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc. items: type: string conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. monitoredParticipantId: type: string description: If this participant is a monitor, then this will be the id of the participant that is being monitored. coachedParticipantId: type: string description: If this participant is a coach, then this will be the id of the participant that is being coached. attributes: type: object description: Additional participant attributes additionalProperties: type: string calls: type: array items: $ref: '#/definitions/Call' callbacks: type: array items: $ref: '#/definitions/Callback' chats: type: array items: $ref: '#/definitions/ConversationChat' cobrowsesessions: type: array items: $ref: '#/definitions/Cobrowsesession' emails: type: array items: $ref: '#/definitions/Email' messages: type: array items: $ref: '#/definitions/Message' internalMessages: type: array items: $ref: '#/definitions/InternalMessage' screenMonitorings: type: array items: $ref: '#/definitions/ScreenMonitoring' screenshares: type: array items: $ref: '#/definitions/Screenshare' socialExpressions: type: array items: $ref: '#/definitions/SocialExpression' videos: type: array items: $ref: '#/definitions/Video' evaluations: type: array items: $ref: '#/definitions/Evaluation' screenRecordingState: type: string description: The current screen recording state for this participant. enum: - requested - active - paused - stopped - error - timeout flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' bargedParticipantId: type: string description: If this participant barged in a participant's call, then this will be the id of the targeted participant. ConversationSummary: type: object properties: id: type: string description: The id of the summary. text: type: string description: The text of the summary. confidence: type: number format: float description: The AI confidence value. status: type: string description: The status of the conversation summary. enum: - Pending - Queued - Started - Completed - Error - Processing mediaType: type: string description: The media type of the conversation. enum: - Email - Call - Chat - Message - Webmessaging - Unknown language: type: string description: The language of the conversation. predictedWrapupCodes: type: array description: The wrapup codes of the conversation summary. items: $ref: '#/definitions/ConversationSummaryWrapupCode' editedSummary: description: The edited summary of the conversation. $ref: '#/definitions/ConversationEditedInput' reason: description: The reason of the conversation summary. $ref: '#/definitions/ConversationSummaryReason' followup: description: The followup of the conversation summary. $ref: '#/definitions/ConversationSummaryFollowup' resolution: description: The resolution of the conversation summary. $ref: '#/definitions/ConversationSummaryResolution' dateCreated: type: string format: date-time description: 'The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' participants: type: array description: The list of participants. items: $ref: '#/definitions/AddressableEntityRef' ConversationContentWheelPicker: type: object required: - items properties: id: type: string description: Optional unique identifier to help map component replies to form messages where multiple Wheel Pickers can be present. items: type: array description: The main text displayed for the item. items: $ref: '#/definitions/ConversationContentWheelPickerItem' description: Wheel Picker object for representing single selection of selectable items. CreateOutboundMessagingConversationResponse: type: object properties: id: type: string description: The created outbound messaging conversation ID. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true EvaluationQuestionGroupScore: type: object properties: questionGroupId: type: string totalScore: type: number format: float description: Score of all questions in the group maxTotalScore: type: number format: float description: Maximum possible score of all questions in the group markedNA: type: boolean description: True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system systemMarkedNA: type: boolean description: If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false. totalCriticalScore: type: number format: float description: Score of only the critical questions in the group maxTotalCriticalScore: type: number format: float description: Maximum possible score of only the critical questions in the group totalNonCriticalScore: type: number format: float description: Score of only the non critical questions in the group maxTotalNonCriticalScore: type: number format: float description: Maximum possible score of only the non critical questions in the group totalScoreUnweighted: type: number format: float description: Unweighted score of all questions in the group maxTotalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of all questions in the group totalCriticalScoreUnweighted: type: number format: float description: Unweighted score of only the critical questions in the group maxTotalCriticalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of only the critical questions in the group totalNonCriticalScoreUnweighted: type: number format: float description: Unweighted score of only the non critical questions in the group maxTotalNonCriticalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of only the non critical questions in the group questionScores: type: array items: $ref: '#/definitions/EvaluationQuestionScore' SupportedContentListing: type: object properties: entities: type: array items: $ref: '#/definitions/SupportedContent' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 TransferToAgentRequest: type: object properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. userId: type: string description: The id of the internal user. userName: type: string description: The userName (like user’s email) of the internal user. userDisplayName: type: string description: The name of the internal user. voicemail: type: boolean description: If true, transfer to the voicemail inbox of the participant that is being replaced. JourneyAction: type: object required: - actionMap - id properties: id: type: string description: The ID of an action from the Journey System (an action is spawned from an actionMap) actionMap: description: Details about the action map from the Journey System which triggered this action $ref: '#/definitions/JourneyActionMap' ConversationActivityScoredAgent: type: object properties: agentScore: type: integer format: int32 description: Assigned agent score for this conversation (0 - 100, higher being better) scoredAgentId: type: string description: Unique identifier for the agent that was scored for this conversation PatchCallbackRequest: type: object required: - agentId - conversationId properties: conversationId: type: string description: The conversationId. queueId: type: string description: The identifier of the queue to be used for the callback. agentId: type: string description: The agentId. callbackScheduledTime: type: string format: date-time example: '2015-01-02T16:59:59.000Z' description: 'The scheduled date-time for the callback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' countryCode: type: string description: The countryCode callbackNumbers: type: array description: The callbackNumbers items: type: string validateCallbackNumbers: type: boolean description: validateCallbackNumbers customerFirstCallbackDeliveryMode: type: string description: How customer-first callback agent reservation is applied for this callback. useAgentReservation forces reservation on; noAgentReservation forces it off; useQueueSetting uses the queue configuration. enum: - UseQueueSetting - UseAgentReservation - NoAgentReservation InternalMessageData: type: object required: - timestamp properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversation: description: The conversation of this message. $ref: '#/definitions/AddressableEntityRef' communicationId: type: string description: The id of the communication of this message. timestamp: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' sender: description: The sender of the text message. $ref: '#/definitions/UserReference' recipient: description: The recipient of the text message. $ref: '#/definitions/UserReference' normalizedMessage: description: The message into normalized format readOnly: true $ref: '#/definitions/ConversationNormalizedMessage' selfUri: type: string format: uri description: The URI for this object readOnly: true CallbackIdentifier: type: object required: - id - type properties: type: type: string description: The type of the associated callback participant enum: - ACD - EXTERNAL - DIALER id: type: string description: The identifier of the callback DispositionParameters: type: object properties: adjustableLiveSpeakerDetection: description: ALSD evaluation inputs and output (isPersonalLikely) of the ALSD detector the last time it ran on the call (could be multiple times) $ref: '#/definitions/AdjustableLiveSpeakerDetection' MessageSubtypeSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. enableInactivityTimeout: type: boolean description: Indicates if inactivity timeout is enabled for the given subtype. SegmentDetailQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - addressFrom - addressTo - agentAssistantId - agentOwned - ani - authenticated - bargedParticipantId - callbackNumber - callbackScheduledTime - canonicalExternalContactId - cleared - coachedParticipantId - conference - deliveryPushed - deliveryStatus - destinationAddress - destinationConversationId - detectedSpeechEnd - detectedSpeechStart - direction - disconnectType - dnis - edgeId - engagementSource - errorCode - exitReason - extendedDeliveryStatus - externalContactId - externalOrganizationId - flaggedReason - flowId - flowName - flowOutType - flowOutcome - flowOutcomeId - flowOutcomeValue - flowVersion - groupId - journeyActionId - journeyActionMapId - journeyCustomerId - journeyCustomerIdType - journeyCustomerSessionId - mediaCount - mediaType - messageType - monitoredParticipantId - outboundCampaignId - outboundContactId - outboundContactListId - participantName - protocolCallId - provider - purpose - queueId - recording - remote - remoteNameDisplayable - requestedLanguageId - requestedRouting - requestedRoutingSkillId - scoredAgentId - screenMonitoredUserId - screenRecording - scriptId - segmentEnd - segmentType - sessionDnis - sipResponseCode - skillExpressionId - snippetRecording - subject - teamId - transferTargetAddress - transferTargetName - transferType - usedRouting - userId - wrapUpCode - wrapUpNote x-genesys-entity-type: value: DIMENSION_TYPE propertyType: type: string description: Left hand side for property predicates enum: - bool - integer - real - date - string - uuid property: type: string description: Left hand side for property predicates metric: type: string description: Left hand side for metric predicates enum: - tSegmentDuration operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension, metric, or property predicates x-genesys-entity-type: value: DIMENSION_SELECTOR range: description: Right hand side for dimension, metric, or property predicates $ref: '#/definitions/NumericRange' ConversationParticipantSearchRequest: type: object properties: sortOrder: type: string description: The sort order for results enum: - ASC - DESC - SCORE sortBy: type: string description: The field in the resource that you want to sort the results by sort: type: array description: Multi-value sort order, list of multiple sort values items: $ref: '#/definitions/SearchSort' returnFields: type: array items: type: string query: type: array items: $ref: '#/definitions/ConversationParticipantSearchCriteria' cursor: type: string ConversationThreadingWindow: type: object required: - settings properties: id: type: string description: The globally unique identifier for the object. readOnly: true settings: type: array description: The conversation threading window timeout (Minutes) for each messaging type items: $ref: '#/definitions/ConversationThreadingWindowSetting' defaultTimeoutMinutes: type: integer format: int64 description: The default conversation threading window timeout (Minutes) readOnly: true ConsultTransferToAddress: type: object required: - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID address: type: string description: Destination's address or phone number. CallHistoryConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CallHistoryConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 TransferResponseModifiedBy: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true EvaluationSettingsAssignee: type: object properties: user: description: The user the dispute should be assigned to $ref: '#/definitions/UserReferenceWithName' type: type: string description: 'The assignee type. Valid values: Original, Individual, None' enum: - Original - Individual - None WebChatTyping: type: object required: - conversation - id - sender - timestamp properties: id: type: string description: The event identifier of this typing indicator event (useful to guard against event re-delivery conversation: description: The identifier of the conversation $ref: '#/definitions/WebChatConversation' sender: description: The member who sent the message $ref: '#/definitions/WebChatMemberInfo' timestamp: type: string format: date-time description: The timestamp of the message, in ISO-8601 format Calibration: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string calibrator: $ref: '#/definitions/User' agent: $ref: '#/definitions/User' conversation: $ref: '#/definitions/ConversationReference' evaluationForm: $ref: '#/definitions/EvaluationForm' contextId: type: string averageScore: type: integer format: int32 highScore: type: integer format: int32 lowScore: type: integer format: int32 createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' evaluations: type: array items: $ref: '#/definitions/Evaluation' evaluators: type: array items: $ref: '#/definitions/User' scoringIndex: $ref: '#/definitions/Evaluation' expertEvaluator: $ref: '#/definitions/User' selfUri: type: string format: uri description: The URI for this object readOnly: true JourneyCustomer: type: object required: - id - idType properties: id: type: string description: An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable. idType: type: string description: The type of the customerId within the Journey System (e.g. cookie). AgentlessEmailSendResponseDto: type: object required: - conversationId - dateCreated - fromAddress - senderType - toAddresses properties: id: type: string description: The globally unique identifier for the object. readOnly: true conversationId: type: string description: The identifier of the conversation. senderType: type: string description: The identifier of the external participant of the given conversation. enum: - Outbound fromAddress: description: The sender of the message. $ref: '#/definitions/EmailAddress' toAddresses: type: array description: The recipient of the message. We currently support one recipient only. items: $ref: '#/definitions/EmailAddress' replyToAddress: description: The address to use for reply. $ref: '#/definitions/EmailAddress' subject: type: string description: The subject of the message. dateCreated: type: string format: date-time description: 'The message creation timestamp. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationThreadingWindowSetting: type: object required: - messengerType - timeoutInMinutes properties: messengerType: type: string description: The type of messenger enum: - sms - facebook - twitter - whatsapp - webmessaging - instagram - open - apple timeoutInMinutes: type: integer format: int64 description: The conversation threading window timeout (Minutes) of specified messenger type SearchSort: type: object properties: sortOrder: type: string description: The sort order for results enum: - ASC - DESC - SCORE sortBy: type: string description: The field in the resource that you want to sort the results by ServiceLevel: type: object properties: percentage: type: number format: double description: The desired Service Level. A value between 0 and 1. durationMs: type: integer format: int64 description: Service Level target in milliseconds. UpdateConferenceRequest: type: object properties: conversationIds: type: array description: A list of conversations to merge into this conversation to create a conference. items: type: string ConversationActivityQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationActivityQueryPredicate' OrgUser: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' chat: $ref: '#/definitions/Chat' department: type: string email: type: string primaryContactInfo: type: array description: Auto populated from addresses. readOnly: true items: $ref: '#/definitions/Contact' addresses: type: array description: Email addresses and phone numbers for this user items: $ref: '#/definitions/Contact' state: type: string description: The current state for this user. readOnly: true enum: - active - inactive - deleted title: type: string username: type: string manager: $ref: '#/definitions/User' images: type: array items: $ref: '#/definitions/Image' version: type: integer format: int32 description: Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. certifications: type: array items: type: string biography: $ref: '#/definitions/Biography' employerInfo: $ref: '#/definitions/EmployerInfo' preferredName: type: string description: Preferred full name of the agent routingStatus: description: ACD routing status readOnly: true $ref: '#/definitions/RoutingStatus' presence: description: Active presence readOnly: true $ref: '#/definitions/UserPresence' integrationPresence: description: Integration presence readOnly: true $ref: '#/definitions/UserPresence' conversationSummary: description: Summary of conversion statistics for conversation types. readOnly: true $ref: '#/definitions/UserConversationSummary' outOfOffice: description: Determine if out of office is enabled readOnly: true $ref: '#/definitions/OutOfOffice' geolocation: description: Current geolocation position readOnly: true $ref: '#/definitions/Geolocation' station: description: Effective, default, and last station information readOnly: true $ref: '#/definitions/UserStations' authorization: description: Roles and permissions assigned to the user readOnly: true $ref: '#/definitions/UserAuthorization' profileSkills: type: array description: Profile skills possessed by the user readOnly: true items: type: string locations: type: array description: The user placement at each site location. readOnly: true items: $ref: '#/definitions/Location' groups: type: array description: The groups the user is a member of readOnly: true items: $ref: '#/definitions/Group' team: description: The team the user is a member of readOnly: true $ref: '#/definitions/Team' workPlanBidRanks: description: The WFM work plan bid rank settings for the user readOnly: true $ref: '#/definitions/WorkPlanBidRanks' skills: type: array description: Routing (ACD) skills possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingSkill' languages: type: array description: Routing (ACD) languages possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingLanguage' acdAutoAnswer: type: boolean description: acd auto answer languagePreference: type: string description: preferred language by the user readOnly: true lastTokenIssued: $ref: '#/definitions/OAuthLastTokenIssued' dateLastLogin: type: string format: date-time description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateWelcomeSent: type: string format: date-time description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true organization: $ref: '#/definitions/Organization' AnalyticsConversationAsyncQueryResponse: type: object properties: conversations: type: array items: $ref: '#/definitions/AnalyticsConversation' cursor: type: string description: Optional cursor to indicate where to resume the results dataAvailabilityDate: type: string format: date-time description: 'Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationPushProviderIntegration: type: object required: - id - provider properties: id: type: string description: Genesys Cloud Integration ID provider: type: string description: Type of the integration enum: - FCM - APNS description: A Push provider integration. RecordersState: type: object properties: adhocState: type: string description: Indicates the state of the adhoc recorder. enum: - ACTIVE - PAUSED - NONE customerExperienceState: type: string description: Indicates the state of the customer experience recorder. enum: - ACTIVE - PAUSED - NONE agentExperienceState: type: string description: Indicates the state of the agent experience recorder. enum: - ACTIVE - PAUSED - NONE snippetState: type: string description: Indicates the state of the snippet recording. enum: - ACTIVE - PAUSED - NONE OpenReceiptNormalizedMessage: type: object required: - channel - direction - id - status - type properties: id: type: string description: The original unique message Id generated by the messaging platform, that this receipt message is referencing. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenMessagingChannel' type: type: string description: Message type. enum: - Receipt status: type: string description: Message receipt status. enum: - Sent - Delivered - Failed - Published - Removed reasons: type: array description: List of reasons for a message receipt that indicates the message has failed. Only used with Failed status. items: $ref: '#/definitions/ConversationReason' isFinalReceipt: type: boolean description: Indicates if this is the last message receipt for this message, or if another message receipt can be expected. direction: type: string description: The direction of the message. enum: - Inbound - Outbound description: Open Messaging rich media message structure SuggestionCannedResponse: type: object properties: response: description: The suggested response. readOnly: true $ref: '#/definitions/AddressableEntityRef' library: description: The library from which the canned response is suggested readOnly: true $ref: '#/definitions/AddressableEntityRef' OAuthAppleAuthorizationResponseError: type: object required: - code - message properties: code: type: string description: The error code message: type: string description: The error message details: type: object description: The error details MessageMediaUploadData: type: object properties: id: type: string description: A unique media ID name: type: string description: The name of the file uploadUrl: type: string description: URL to upload the file uploadHeaders: type: object description: Required headers when uploading a file with the upload URL additionalProperties: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true AdditionalSocialMediaMessage: type: object required: - inReplyToMessageId properties: textBody: type: string description: The body of the text message. Maximum character count is 2000 characters. mediaIds: type: array description: The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage. items: type: string inReplyToMessageId: type: string description: The ID of the message to which this request is replying. AnalyticsConversation: type: object properties: accessAttributes: type: array description: Set of attributes that limit which users can access the conversation items: type: string associatedConversationId: type: string description: ID of the conversation the initiator is signaling this new conversation is associated with conferenceStart: type: string format: date-time description: 'The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' consultationConversationIds: type: array description: Set of conversationIds the initiator has signaled this conversation is associated with items: type: string conversationEnd: type: string format: date-time description: 'The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' conversationId: type: string description: Unique identifier for the conversation conversationInitiator: type: string description: Indicates the participant purpose of the participant initiating a message conversation enum: - acd - agent - api - botflow - campaign - customer - dialer - external - fax - group - inbound - ivr - manual - outbound - station - user - voicemail - voicesurveyflow - workflow conversationStart: type: string format: date-time description: 'The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' customerParticipation: type: boolean description: Indicates a messaging conversation in which the customer participated by sending at least one message divisionIds: type: array description: Identifier(s) of division(s) associated with a conversation items: type: string externalTag: type: string description: External tag for the conversation inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' knowledgeBaseIds: type: array description: The unique identifier(s) of the knowledge base(s) used items: type: string mediaStatsMinConversationMos: type: number format: double description: The lowest estimated average MOS among all the audio streams belonging to this conversation mediaStatsMinConversationRFactor: type: number format: double description: The lowest R-factor value among all of the audio streams belonging to this conversation originatingDirection: type: string description: The original direction of the conversation enum: - inbound - outbound originatingSocialMediaPublic: type: boolean description: Indicates that the conversation originated from a public message on social media selfServed: type: boolean description: Indicates whether all flow sessions were self serviced evaluations: type: array description: Evaluations associated with this conversation items: $ref: '#/definitions/AnalyticsEvaluation' surveys: type: array description: Surveys associated with this conversation items: $ref: '#/definitions/AnalyticsSurvey' resolutions: type: array description: Resolutions associated with this conversation items: $ref: '#/definitions/AnalyticsResolution' participants: type: array description: Participants in the conversation items: $ref: '#/definitions/AnalyticsParticipant' CallHistoryConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/CallHistoryParticipant' direction: type: string description: The direction of the call relating to the current user enum: - inbound - outbound wentToVoicemail: type: boolean description: Did the call end in the current user's voicemail missedCall: type: boolean description: Did the user not answer this conversation startTime: type: string format: date-time description: 'The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' wasConference: type: boolean description: Was this conversation a conference wasCallback: type: boolean description: Was this conversation a callback hadScreenShare: type: boolean description: Did this conversation have a screen share session hadCobrowse: type: boolean description: Did this conversation have a cobrowse session wasOutboundCampaign: type: boolean description: Was this conversation associated with an outbound campaign selfUri: type: string format: uri description: The URI for this object readOnly: true MessagingIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessagingIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 CustomAttributesIdResponse: type: object properties: id: type: string description: The id of the newly created or updated Custom Attributes record. DefaultAnswersTo: type: object properties: highestScore: type: boolean description: True, when answer should default to highest score notApplicable: type: boolean description: True, when answer should default to N/A lowestScore: type: boolean description: True, when answer should default to lowest score userDefined: type: boolean description: True, when answer should default to user defined answer ConversationCustomAttributesSearchRequest: type: object properties: expand: type: array description: Expand your search with bulk lookups items: type: string pageSize: type: integer format: int32 description: The number of results per page pageNumber: type: integer format: int32 description: The page of resources you want to retrieve sort: type: array description: Multi-value sort order, list of multiple sort values items: $ref: '#/definitions/SearchSort' sortBy: type: string description: The field in the resource that you want to sort the results by sortOrder: type: string description: The sort order for results enum: - ASC - DESC - SCORE OutOfOffice: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string user: $ref: '#/definitions/User' startDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' active: type: boolean indefinite: type: boolean selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Conversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 ConversationEventPresence: type: object required: - type properties: type: type: string description: Describes the type of Presence event. enum: - Join - Disconnect - Clear - SignIn - SessionExpired - Authenticate - AuthenticateFailure - AuthenticateCancel receivedMessage: description: A sign in prompt message for when the authenticate event is received. $ref: '#/definitions/ConversationContentReceivedReplyMessage' replyMessage: description: A reply message on authentication success. $ref: '#/definitions/ConversationContentReceivedReplyMessage' description: A Presence event. ConsultTransfer: type: object required: - destination - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID destination: description: Destination. Specify one and only one parameter from the list below. $ref: '#/definitions/Destination' ScoredAgent: type: object properties: agent: description: The agent $ref: '#/definitions/DomainEntityRef' score: type: integer format: int32 description: Agent's score for the current conversation, from 0 - 100, higher being better CarouselParameters: type: object properties: cardParameters: type: array description: A list of carousel cards with their respective template parameters items: $ref: '#/definitions/CardParameters' description: Template parameters for carousel components AiScoringSetting: type: object properties: enabled: type: boolean description: True if AI Scoring feature is configured. MessageDetails: type: object properties: messageId: type: string description: UUID identifying the message media. messageURI: type: string format: uri description: A URI for this message entity. messageStatus: type: string description: Indicates the delivery status of the message. enum: - queued - sent - failed - received - delivery-success - delivery-failed - read - removed - published messageSegmentCount: type: integer format: int32 description: The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. messageTime: type: string format: date-time description: 'The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' media: type: array description: 'Deprecated: Use the API /api/v2/conversations/messages/{conversationId}/messages/{messageId} to get the associated media.' items: $ref: '#/definitions/MessageMedia' stickers: type: array description: 'Deprecated: This attribute is no longer used. Messages have not included associated stickers for a long time.' items: $ref: '#/definitions/MessageSticker' messageMetadata: description: Information that describes the content of the message, if any $ref: '#/definitions/ConversationMessageMetadata' socialVisibility: type: string description: For social media messages, the visibility of the message in the originating social platform enum: - private - public errorInfo: description: Provider specific error information for a communication. $ref: '#/definitions/ErrorBody' Call: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - none id: type: string description: A globally unique identifier for this communication. direction: type: string description: The direction of the call enum: - inbound - outbound recording: type: boolean description: True if this call is being recorded. recordingState: type: string description: State of recording on this call. enum: - none - active - paused recordersState: description: Contains the states of different recorders. $ref: '#/definitions/RecordersState' muted: type: boolean description: True if this call is muted so that remote participants can't hear any audio from this end. confined: type: boolean description: True if this call is held and the person on this side hears hold music. held: type: boolean description: True if this call is held and the person on this side hears silence. securePause: type: boolean description: True when the recording of this call is in secure pause status. recordingId: type: string description: A globally unique identifier for the recording associated with this call. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' errorInfo: $ref: '#/definitions/ErrorInfo' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - endpoint.donotdisturb - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' documentId: type: string description: If call is an outbound fax of a document from content management, then this is the id in content management. startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectReasons: type: array description: List of reasons that this call was disconnected. This will be set once the call disconnects. items: $ref: '#/definitions/DisconnectReason' faxStatus: description: Extra information on fax transmission. $ref: '#/definitions/FaxStatus' provider: type: string description: The source provider for the call. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. uuiData: type: string description: User to User Information (UUI) data managed by SIP session application. self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' other: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. agentAssistantId: type: string description: UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. transferSource: type: string description: Indicates how call reaches the agent. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' disposition: description: Call resolution data for Dialer bulk make calls commands. $ref: '#/definitions/Disposition' PropertyIndexRequest: type: object required: - properties - sessionId - targetDate properties: sessionId: type: string description: Attach properties to a segment in the indicated session targetDate: type: string format: date-time description: 'Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' properties: type: array description: The list of properties to index items: $ref: '#/definitions/AnalyticsProperty' AppleIMessageApp: type: object required: - applicationId - applicationName - bundleId properties: applicationName: type: string description: Application Name. applicationId: type: string description: Application ID. bundleId: type: string description: Bundle ID. ConversationChat: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. roomId: type: string description: The room id for the chat. recordingId: type: string description: A globally unique identifier for the recording associated with this chat. segments: type: array description: The time line of the participant's chat, divided into activity segments. items: $ref: '#/definitions/Segment' held: type: boolean description: True if this call is held and the person on this side hears silence. direction: type: string description: The direction of the chat enum: - inbound - outbound disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - transfer - transfer.conference - transfer.consult - transfer.forward - error - peer - other - uncallable - timeout startHoldTime: type: string format: date-time description: 'The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the email. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. avatarImageUrl: type: string description: If available, the URI to the avatar image of this communication. journeyContext: description: A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). $ref: '#/definitions/JourneyContext' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' ConversationActivityQuery: type: object required: - groupBy - metrics properties: metrics: type: array description: List of requested metrics items: $ref: '#/definitions/ConversationActivityQueryMetric' groupBy: type: array description: Dimension(s) to group by uniqueItems: true items: type: string enum: - activeRouting - addressFrom - addressTo - agentScore - ani - conversationId - convertedFrom - convertedTo - direction - dnis - mediaType - participantName - queueId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - routingPriority - scoredAgentId - sessionId - teamId - usedRouting - userId filter: description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters $ref: '#/definitions/ConversationActivityQueryFilter' order: type: string description: Sort the result set in ascending/descending order. Default is ascending enum: - asc - desc - unordered AdditionalMessage: type: object required: - textBody properties: textBody: type: string description: 'The body of the text message. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters.' mediaIds: type: array description: The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage. items: type: string messagingTemplate: description: Pre-defined message templates for structured communications. Supports various template types including WhatsApp business messaging template and form $ref: '#/definitions/SendMessagingTemplateRequest' RoutingStatus: type: object properties: userId: type: string description: The userId of the agent status: type: string description: Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist. enum: - OFF_QUEUE - IDLE - INTERACTING - NOT_RESPONDING - COMMUNICATING startTime: type: string format: date-time description: 'The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ResourceConditionValue: type: object properties: type: type: string enum: - SCALAR - VARIABLE - USER - QUEUE - TEAM value: type: string ChatMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' roomId: type: string description: The ID of the chat room. avatarImageUrl: type: string description: If available, the URI to the avatar image of this communication. MessageMediaData: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string url: type: string description: The location of the media, useful for retrieving it mediaType: type: string description: The detected internet media type of the the media object. If null then the media type should be dictated by the url. contentLengthBytes: type: integer format: int32 description: The optional content length of the the media object, in bytes. uploadUrl: type: string description: The URL returned to upload an attachment status: type: string description: The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid readOnly: true enum: - uploading - valid - invalid conversationId: type: string communicationId: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationAggregationSort: type: object required: - function - name properties: name: type: string description: Name of the metric used for sorting values. enum: - nBlindTransferred - nBotInteractions - nCallbackAttempts - nCallbackOverSla - nCallbackScheduled - nCfcOffered - nCobrowseSessions - nConnected - nConsult - nConsultTransferred - nConversations - nError - nOffered - nOutbound - nOutboundAbandoned - nOutboundAttempted - nOutboundConnected - nOverSla - nStateTransitionError - nTakeover - nTransferred - oAudioMessageCount - oExternalAudioMessageCount - oExternalMediaCount - oMediaCount - oMessageCount - oMessageSegmentCount - oMessageTurn - oServiceTarget - oSkillExpressionApplications - tAbandon - tAcd - tActiveCallback - tActiveCallbackComplete - tAcw - tAgentResponseTime - tAgentVideoConnected - tAlert - tAnswered - tAverageAgentResponseTime - tAverageCustomerResponseTime - tBarging - tCallbackAbandon - tCallbackConnect - tCallbackNotReached - tCallbackVirtualWait - tCfcAbandon - tCfcAcd - tCfcAnswered - tCfcFlowOut - tCoaching - tCoachingComplete - tConnected - tContacting - tDialing - tFirstConnect - tFirstDial - tFirstEngagement - tFirstResponse - tFlowOut - tHandle - tHeld - tHeldComplete - tIvr - tMonitoring - tMonitoringComplete - tNotResponding - tPark - tParkComplete - tScreenMonitoring - tSnippetRecord - tTalk - tTalkComplete - tTransmitting - tUserResponseTime - tVoicemail function: type: string description: Aggregation function used for the sort metric. enum: - average - count - max - min - sum CobrowseMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' cobrowseSessionId: type: string description: The co-browse session ID. cobrowseRole: type: string description: This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). controlling: type: array description: ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). items: type: string viewerUrl: type: string description: The URL that can be used to open co-browse session in web browser. providerEventTime: type: string format: date-time description: 'The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AgentlessEmailSendRequestDto: type: object required: - fromAddress - senderType - toAddresses properties: senderType: type: string description: The type of email domain used to send the agentless message. enum: - Outbound conversationId: type: string description: The identifier of the conversation. This must be an email interaction. fromAddress: description: The sender of the message. $ref: '#/definitions/EmailAddress' toAddresses: type: array description: The recipient of the message. We currently support one recipient only. items: $ref: '#/definitions/EmailAddress' replyToAddress: description: The address to use for reply. $ref: '#/definitions/EmailAddress' subject: type: string description: The subject of the message. textBody: type: string description: The Content of the message, in plain text. htmlBody: type: string description: The Content of the message, in HTML. Links, images and styles are allowed DialerPreview: type: object properties: id: type: string contactId: type: string description: The contact associated with this preview data pop contactListId: type: string description: The contactList associated with this preview data pop. campaignId: type: string description: The campaignId associated with this preview data pop. phoneNumberColumns: type: array description: The phone number columns associated with this campaign items: $ref: '#/definitions/PhoneNumberColumn' callbackAutoAnswer: type: boolean description: Whether or not to auto answer the callback AppleIntegrationUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Apple messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' businessName: type: string description: The name of the business. logoUrl: type: string description: The url of the businesses logo. appleIMessageApp: description: Interactive Application (iMessage App) Settings. $ref: '#/definitions/AppleIMessageApp' appleAuthentication: description: The Apple Messages for Business authentication setting. $ref: '#/definitions/AppleAuthentication' applePay: description: Apple Pay settings. $ref: '#/definitions/ApplePay' selfUri: type: string format: uri description: The URI for this object readOnly: true InternalMessage: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - disconnected initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - disconnected id: type: string description: A globally unique identifier for this communication. segments: type: array description: The time line of the participant's internal message, divided into activity segments. items: $ref: '#/definitions/Segment' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - client - system - peer - transfer startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the message. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. targetUserId: type: string description: The user ID for the participant on receiving side of the internal message conversation. sourceUserId: type: string description: The user ID for the participant on sending side of the internal message conversation. toAddress: description: Address for the participant on receiving side of the internal message communication. $ref: '#/definitions/Address' fromAddress: description: Address for the participant on the sending side of the internal message communication. $ref: '#/definitions/Address' messages: type: array description: The messages sent on this communication channel. items: $ref: '#/definitions/InternalMessageDetails' OpenMessageEvent: type: object required: - eventType properties: eventType: type: string description: Type of this event element enum: - Typing typing: description: Typing event. $ref: '#/definitions/ConversationEventTyping' description: Message event element. ConversationActivityEntityData: type: object required: - activityDate properties: activityDate: type: string format: date-time description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' metric: type: string description: Activity metric enum: - oAlerting - oInteracting - oLongestInteracting - oLongestWaiting - oWaiting activeRouting: type: string description: Active routing method enum: - Bullseye - Conditional - Direct - Last - Manual - Predictive - Preferred - Standard - Vip addressFrom: type: string description: The address that initiated an action addressTo: type: string description: The address receiving an action ani: type: string description: Automatic Number Identification (caller's number) conversationId: type: string description: Unique identifier for the conversation convertedFrom: type: string description: Session media type that was converted from in case of a media type conversion convertedTo: type: string description: Session media type that was converted to in case of a media type conversion direction: type: string description: The direction of the communication enum: - inbound - outbound dnis: type: string description: Dialed number identification service (number dialed by the calling party) mediaType: type: string description: The session media type enum: - callback - chat - cobrowse - email - internalmessage - message - screenmonitoring - screenshare - unknown - video - voice participantName: type: string description: A human readable name identifying the participant queueId: type: string description: Queue identifier requestedLanguageId: type: string description: Unique identifier for the language requested for an interaction requestedRoutingSkillIds: type: array description: Unique identifier(s) for skill(s) requested for an interaction items: type: string requestedRoutings: type: array description: Routing type(s) for requested/attempted routing methods. items: type: string enum: - Bullseye - Conditional - Direct - Last - Manual - Predictive - Preferred - Standard - Vip routingPriority: type: integer format: int64 description: Routing priority for the current interaction sessionId: type: string description: The unique identifier of this session teamId: type: string description: The team ID the user is a member of usedRouting: type: string description: Complete routing method enum: - Bullseye - Conditional - Direct - Last - Manual - Predictive - Preferred - Standard - Vip userId: type: string description: Unique identifier for the user scoredAgents: type: array description: Scored agents items: $ref: '#/definitions/ConversationActivityScoredAgent' Feedback: type: object required: - relevance - suggestionId properties: suggestionId: type: string description: Feedback suggestion id. userProvided: type: boolean description: Indicates whether the answer/item was clicked by the human agent or not. relevance: type: string description: Feedback relevance. enum: - Unknown - Relevant - Irrelevant EvaluationQuestionGroup: type: object properties: id: type: string contextId: type: string description: An identifier for this question group that stays the same across versions of the form. readOnly: true name: type: string type: type: string defaultAnswersToHighest: type: boolean defaultAnswersToNA: type: boolean naEnabled: type: boolean weight: type: number format: float manualWeight: type: boolean questions: type: array items: $ref: '#/definitions/EvaluationQuestion' visibilityCondition: $ref: '#/definitions/VisibilityCondition' defaultAnswersTo: description: Default scoring settings for the questions within this question group. $ref: '#/definitions/DefaultAnswersTo' AgentOwnedRouting: type: object properties: enableAgentOwnedCallbacks: type: boolean description: Indicates if Agent Owned Callbacks are enabled for the queue maxOwnedCallbackHours: type: integer format: int32 description: The max amount of time a callback can be owned (in hours); Allowable range 1 - 168 hour(s) (inclusive) maxOwnedCallbackDelayHours: type: integer format: int32 description: The max amount of time a callback can be scheduled out into the future (in hours); Allowable range 1 - 720 hour(s) (inclusive) UserConversationSummary: type: object properties: userId: type: string call: $ref: '#/definitions/MediaSummary' callback: $ref: '#/definitions/MediaSummary' email: $ref: '#/definitions/MediaSummary' message: $ref: '#/definitions/MediaSummary' chat: $ref: '#/definitions/MediaSummary' socialExpression: $ref: '#/definitions/MediaSummary' video: $ref: '#/definitions/MediaSummary' Education: type: object properties: school: type: string fieldOfStudy: type: string notes: type: string description: Notes about education has a 2000 character limit dateStart: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' dateEnd: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' Callback: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none id: type: string description: A globally unique identifier for this communication. segments: type: array description: The time line of the participant's callback, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the call enum: - inbound - outbound held: type: boolean description: True if this call is held and the person on this side hears silence. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dialerPreview: description: The preview data to be used when this callback is a Preview. $ref: '#/definitions/DialerPreview' voicemail: description: The voicemail data to be used when this callback is an ACD voicemail. $ref: '#/definitions/Voicemail' callbackNumbers: type: array description: The phone number(s) to use to place the callback. items: type: string callbackUserName: type: string description: The name of the user requesting a callback. scriptId: type: string description: The UUID of the script to use. externalCampaign: type: boolean description: True if the call for the callback uses external dialing. skipEnabled: type: boolean description: True if the ability to skip a callback should be enabled. timeoutSeconds: type: integer format: int32 description: The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' callbackScheduledTime: type: string format: date-time description: 'The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' automatedCallbackConfigId: type: string description: The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. provider: type: string description: The source provider for the callback. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. callerId: type: string description: The phone number displayed to recipients of the phone call. The value should conform to the E164 format. callerIdName: type: string description: The name displayed to recipients of the phone call. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' MessageMedia: type: object properties: url: type: string description: The location of the media, useful for retrieving it mediaType: type: string description: The optional internet media type of the the media object. If null then the media type should be dictated by the url contentLengthBytes: type: integer format: int32 description: The optional content length of the the media object, in bytes. name: type: string description: The optional name of the the media object. id: type: string description: The optional id of the the media object. UserReferenceWithName: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationContentListPickerSection: type: object properties: title: type: string description: Required title for the section. multipleSelection: type: boolean description: Whether multiple items can be selected in this section. items: type: array description: List of items to choice from in the section items: $ref: '#/definitions/ConversationContentListPickerItem' description: List Picker object for presenting a section of selectable items. MediaParticipantRequest: type: object properties: wrapup: description: Wrap-up to assign to this participant. $ref: '#/definitions/WrapupInput' state: type: string description: 'The state to update to set for this participant''s communications. Possible values are: ''connected'' and ''disconnected''.' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none recording: type: boolean description: True to enable ad-hoc recording of this participant, otherwise false to disable recording. muted: type: boolean description: True to mute this conversation participant. confined: type: boolean description: True to confine this conversation participant. Should only be used for ad-hoc conferences held: type: boolean description: True to hold this conversation participant. wrapupSkipped: type: boolean description: True to skip wrap-up for this participant. resumeTime: type: string format: date-time description: 'Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' TwitterIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities selfUri: type: string format: uri description: The URI for this object readOnly: true MessagingConferWithUserRequest: type: object required: - targetUserId properties: targetUserId: type: string description: The user ID of the target. ConversationPushNotificationMessageLabel: type: object required: - body - title properties: title: type: string description: Title to use in the push for each language configured in the deploymentId body: type: string description: Body to use in the push for each language configured in the deploymentId description: A Push notification message label. ConversationContentCard: type: object required: - actions - title properties: title: type: string description: Text to show in the title. description: type: string description: Text to show in the description. image: type: string description: URL of an image. video: type: string description: URL of a video. defaultAction: description: The default button action. $ref: '#/definitions/ConversationContentCardAction' actions: type: array description: An array of action objects. items: $ref: '#/definitions/ConversationContentCardAction' description: Card content object. EmailMessagePreview: type: object required: - from - to properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string to: type: array description: The recipients of the email message. items: $ref: '#/definitions/EmailAddress' cc: type: array description: The recipients that were copied on the email message. items: $ref: '#/definitions/EmailAddress' bcc: type: array description: The recipients that were blind copied on the email message. items: $ref: '#/definitions/EmailAddress' from: description: The sender of the email message. $ref: '#/definitions/EmailAddress' replyTo: description: The receiver of the reply email message. $ref: '#/definitions/EmailAddress' subject: type: string description: The subject of the email message. attachments: type: array description: The attachments of the email message. items: $ref: '#/definitions/Attachment' textBodyPreview: type: string description: A truncated version of the textBody time: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' historyIncluded: type: boolean description: Indicates whether the history of previous emails of the conversation is included within the email bodies of this message. state: type: string description: The state of the current draft. enum: - Created - Ready - Edited draftType: type: string description: The type of draft that need to be treated. enum: - Reply - ReplyAll - Forward emailSizeBytes: type: integer format: int32 description: Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form. readOnly: true maxEmailSizeBytes: type: integer format: int32 description: Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationContentForm: type: object required: - cannedResponseId properties: introduction: description: The intro component, used to give an intro into what the form entails $ref: '#/definitions/ConversationContentIntroduction' formPages: type: array description: Form pages items: $ref: '#/definitions/ConversationFormPage' receivedMessage: description: The message prompt to fill out the form received. $ref: '#/definitions/ConversationContentReceivedReplyMessage' replyMessage: description: The reply message after the user has filled out the form received. $ref: '#/definitions/ConversationContentReceivedReplyMessage' showSummary: type: boolean description: Show summary at end of form submission. response: type: array description: Content of the payload included in the Form response. items: $ref: '#/definitions/ConversationFormResponseComponent' originatingMessageId: type: string description: Reference to the ID of the original message. cannedResponseId: type: string description: The id of the canned response which was used to create the form. description: Form content object. ErrorBody: type: object properties: message: type: string code: type: string status: type: integer format: int32 entityId: type: string entityName: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: string contextId: type: string details: type: array items: $ref: '#/definitions/Detail' errors: type: array items: $ref: '#/definitions/ErrorBody' limit: $ref: '#/definitions/Limit' CopyAttachmentsRequest: type: object required: - attachments - sourceMessage properties: sourceMessage: description: A reference to the email message within the current conversation that owns the attachments to be copied $ref: '#/definitions/DomainEntityRef' attachments: type: array description: A list of attachments that will be copied from the source message to the current draft items: $ref: '#/definitions/Attachment' LocationImage: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string AnalyticsConversationWithoutAttributesMultiGetResponse: type: object properties: conversations: type: array items: $ref: '#/definitions/AnalyticsConversationWithoutAttributes' ConditionalGroupActivationSimpleMetric: type: object properties: metric: type: string description: The queue metric being evaluated enum: - EstimatedWaitTime - IdleAgentCount - ServiceLevel queue: description: The queue being evaluated for this rule. If null, the current queue will be used. $ref: '#/definitions/DomainEntityRef' TemplateParameter: type: object properties: id: type: string description: Response substitution identifier value: type: string description: Response substitution value ConversationSecureAttributes: type: object properties: attributes: type: object description: The map of attribute keys to values. additionalProperties: type: string version: type: integer format: int32 description: The version used to detect conflicting updates when using PUT. Not used for PATCH. SuggestionEngagement: type: object required: - engagementType properties: engagementType: type: string description: The type of engagement with the suggestion. enum: - Dismissed - Copied - Opened - Feedback feedback: description: The given feedback on the suggestion, if any. $ref: '#/definitions/SuggestionFeedback' InstagramScopedId: type: object required: - scopedId properties: scopedId: type: string description: 'The unique page/app-specific scopedId for the user. Max: 255 characters. Leading and trailing whitespace stripped.' description: Scoped ID for an Instagram user interacting with a page or app ContentButtonResponse: type: object required: - payload - text - type properties: id: type: string description: An ID assigned to the button response (Deprecated). type: type: string description: Describes the button that resulted in the Button Response. enum: - Button - QuickReply - DatePicker text: type: string description: The response text from the button click. payload: type: string description: The response payload associated with the clicked button. description: Button response object representing the click of a structured message button, such as a quick reply. MessagingSettingRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The messaging Setting profile name content: description: Settings relating to message contents $ref: '#/definitions/ContentSetting' event: description: Settings relating to events which may occur $ref: '#/definitions/EventSetting' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Messaging setting for messaging platform integrations EvaluationSettings: type: object properties: revisionsEnabled: type: boolean description: Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations. disputesEnabled: type: boolean description: Whether disputes are allowed for evaluations. Does not apply for calibration evaluations. disputesAllowedPerEvaluation: type: integer format: int32 description: The maximum number of disputes allowed for an evaluation. disputesAssignees: type: array description: A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation. items: $ref: '#/definitions/EvaluationSettingsAssignee' ConditionalGroupRouting: type: object properties: rules: type: array description: The set of rules to be executed for each conversation items: $ref: '#/definitions/ConditionalGroupRoutingRule' MediaSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. alertingTimeoutSeconds: type: integer format: int32 description: The alerting timeout for the media type, in seconds serviceLevel: description: The targeted service level for the media type $ref: '#/definitions/ServiceLevel' autoAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for an auto-answer interaction manualAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for a manual-answer interaction JourneyActionMap: type: object required: - id - version properties: id: type: string description: The ID of the actionMap in the Journey System which triggered this action version: type: integer format: int32 description: The version number of the actionMap in the Journey System at the time this action was triggered UserStation: type: object properties: id: type: string description: A globally unique identifier for this station readOnly: true name: type: string type: type: string associatedUser: $ref: '#/definitions/User' associatedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' defaultUser: $ref: '#/definitions/User' providerInfo: type: object description: 'Provider-specific info for this station, e.g. { "edgeGroupId": "ffe7b15c-a9cc-4f4c-88f5-781327819a49" }' additionalProperties: type: string webRtcCallAppearances: type: integer format: int32 description: The number of call appearances on the station. readOnly: true ConditionalGroupActivationRule: type: object properties: conditions: type: array description: The list of conditions used in this rule items: $ref: '#/definitions/ConditionalGroupActivationCondition' conditionExpression: type: string description: A string expression that defines the relationships of conditions in this rule groups: type: array description: The group(s) that this rule activates (if rule evaluates as true) or deactivates (if rule evaluates as false) uniqueItems: true items: $ref: '#/definitions/MemberGroup' MessageMediaListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessageMediaData' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 MessageMediaSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. alertingTimeoutSeconds: type: integer format: int32 description: The alerting timeout for the media type, in seconds serviceLevel: description: The targeted service level for the media type $ref: '#/definitions/ServiceLevel' autoAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for an auto-answer interaction manualAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for a manual-answer interaction subTypeSettings: type: object description: Map of media subtype to media subtype specific settings. additionalProperties: $ref: '#/definitions/MessageSubtypeSettings' enableInactivityTimeout: type: boolean description: Indicates if inactivity timeout is enabled for all subtypes. inactivityTimeoutSettings: description: Inactivity timeout settings for messages $ref: '#/definitions/InactivityTimeoutSettings' ConversationFormPageComponent: type: object properties: formComponentType: type: string description: Type of this form component element enum: - ListPicker - DatePicker - WheelPicker - Input datePicker: description: Date Picker content. $ref: '#/definitions/ConversationContentDatePicker' wheelPicker: description: Wheel Picker content. $ref: '#/definitions/ConversationContentWheelPicker' listPicker: description: List Picker content. $ref: '#/definitions/ConversationContentListPicker' input: description: Input content. $ref: '#/definitions/ConversationContentInput' description: 'Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.' OpenInboundNormalizedReceipt: type: object required: - channel - id - status properties: id: type: string description: The original unique message Id generated by the messaging platform, that this receipt message is referencing. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenInboundMessagingReceiptChannel' status: type: string description: Message receipt status. enum: - Sent - Delivered - Failed - Published - Removed reasons: type: array description: List of reasons for a message receipt that indicates the message has failed. Only used with Failed status. items: $ref: '#/definitions/ConversationReason' isFinalReceipt: type: boolean description: Indicates if this is the last message receipt for this message, or if another message receipt can be expected. description: Open Messaging rich media message structure ConversationAggregateQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - activeRouting - activeSkillId - addressFrom - addressTo - agentAssistantId - agentBullseyeRing - agentOwned - agentRank - agentScore - ani - assignerId - authenticated - canonicalExternalContactId - conversationId - conversationInitiator - convertedFrom - convertedTo - customerParticipation - deliveryStatus - destinationAddress - direction - disconnectType - divisionId - dnis - edgeId - eligibleAgentCount - errorCode - extendedDeliveryStatus - externalContactId - externalMediaCount - externalOrganizationId - externalTag - firstQueue - flaggedReason - flowInType - flowOutType - groupId - interactionType - journeyActionId - journeyActionMapId - journeyActionMapVersion - journeyCustomerId - journeyCustomerIdType - journeyCustomerSessionId - journeyCustomerSessionIdType - knowledgeBaseId - mediaCount - mediaType - messageType - originatingDirection - originatingSocialMediaPublic - outboundCampaignId - outboundContactId - outboundContactListId - participantName - peerId - proposedAgentId - provider - purpose - queueId - remote - removedSkillId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - roomId - routingPriority - routingRing - routingRule - routingRuleType - scoredAgentId - selectedAgentId - selectedAgentRank - selfServed - sessionDnis - sessionId - skillExpressionId - stationId - teamId - usedRouting - userId - videoPresent - waitingInteractionCount - wrapUpCode x-genesys-entity-type: value: DIMENSION_TYPE operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension predicates x-genesys-entity-type: value: DIMENSION_SELECTOR range: description: Right hand side for dimension predicates $ref: '#/definitions/NumericRange' OpenEventNormalizedMessage: type: object required: - channel - type properties: id: type: string description: Unique ID of the message generated by Messaging Platform. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenMessagingChannel' type: type: string description: Message type. enum: - Event events: type: array description: List of event elements. items: $ref: '#/definitions/OpenMessageEvent' description: Open Messaging rich media message structure AsyncConversationQuery: type: object required: - interval properties: conversationFilters: type: array description: Filters that target conversation-level data items: $ref: '#/definitions/ConversationDetailQueryFilter' segmentFilters: type: array description: Filters that target individual segments within a conversation items: $ref: '#/definitions/SegmentDetailQueryFilter' evaluationFilters: type: array description: Filters that target evaluations items: $ref: '#/definitions/EvaluationDetailQueryFilter' surveyFilters: type: array description: Filters that target surveys items: $ref: '#/definitions/SurveyDetailQueryFilter' resolutionFilters: type: array description: Filters that target resolutions items: $ref: '#/definitions/ResolutionDetailQueryFilter' order: type: string description: Sort the result set in ascending/descending order. Default is ascending enum: - asc - desc - unordered orderBy: type: string description: 'Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart' enum: - conversationStart - conversationEnd - segmentStart - segmentEnd interval: type: string format: interval description: 'Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' limit: type: integer format: int32 description: Specify number of results to be returned startOfDayIntervalMatching: type: boolean description: Add a filter to only include conversations that started after the beginning of the interval start date (UTC) MandatoryPostCallActionInput: type: object properties: destination: type: string description: The destination phone number or phone id to send the flow to after completion. If null or blank will not update. invocationData: type: string description: The invocation data to send the destination after completion. If null or blank will not update. Invocation data is only supported when the destination is an Inbound Call flow or Voice Survey flow. MessageSticker: type: object properties: url: type: string description: The location of the sticker, useful for retrieving it id: type: string description: The unique id of the the sticker object. EmailConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/EmailMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true AnalyticsSessionMetric: type: object properties: emitDate: type: string format: date-time description: 'Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' name: type: string description: Unique name of this metric value: type: integer format: int64 description: The metric value EvaluationDetailQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/EvaluationDetailQueryPredicate' AppleOpaqueId: type: object properties: value: type: string description: 'Max: 255 characters. Leading and trailing whitespace stripped.' PhoneNumber: type: object properties: display: type: string description: 'The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters.' extension: type: integer format: int64 description: An optional extension for the provided phone number. acceptsSMS: type: boolean description: Whether this phone number can accept SMS messages. normalizationCountryCode: type: string description: The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America). userInput: type: string description: The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system. e164: type: string description: The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. countryCode: type: string description: 'The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters.' AnalyticsProperty: type: object properties: property: type: string description: User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property. propertyType: type: string description: Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match enum: - bool - integer - real - date - string - uuid value: type: string description: What property value to match against TransferResponse: type: object properties: id: type: string description: The id of the command. state: type: string description: The state of the command. enum: - Pending - Active - Complete - Canceled - Failed - Timeout - Unknown dateIssued: type: string format: date-time description: 'The date/time that this command was issued. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' initiator: description: The initiator of the command. $ref: '#/definitions/TransferInitiator' modifiedBy: description: The user or entity that modified the command. $ref: '#/definitions/TransferResponseModifiedBy' destination: description: The destination of the command. $ref: '#/definitions/TransferDestination' transferType: type: string description: The type of transfer to perform. enum: - Attended - Unattended DomainEntityListingEvaluationForm: type: object properties: entities: type: array items: $ref: '#/definitions/EvaluationForm' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 MessagingSettingDefaultRequest: type: object required: - settingId properties: settingId: type: string description: Messaging Setting ID to be used as the default for this Organization. ExternalId: type: object required: - externalSource - value properties: externalSource: description: 'The external source of the identifier. Max: 255 characters. Leading and trailing whitespace stripped.' $ref: '#/definitions/ExternalSource' value: type: string description: 'The string value of the identifier. Max: 255 characters. Leading and trailing whitespace stripped.' OpenInboundStructuredResponseNormalizedMessageContent: type: object required: - contentType properties: contentType: type: string description: Type of this content element enum: - ButtonResponse buttonResponse: description: Button response content. $ref: '#/definitions/ContentButtonResponse' description: Message content element. InboundOnlySetting: type: object properties: inbound: type: string enum: - Enabled - Disabled CustomAttributesBulkUpdateResponse: type: object properties: attributes: description: The Custom Attributes record. $ref: '#/definitions/CustomAttributes' statusCode: type: integer format: int32 description: The status code result of updating the Custom Attributes record. errorMessage: type: string description: The error message if an error occurs while updating the record, otherwise null. AnalyticsParticipantWithoutAttributes: type: object properties: externalContactId: type: string description: External contact identifier externalOrganizationId: type: string description: External organization identifier flaggedReason: type: string description: Reason for which participant flagged conversation enum: - general participantId: type: string description: Unique identifier for the participant participantName: type: string description: A human readable name identifying the participant purpose: type: string description: The participant's purpose enum: - acd - agent - api - botflow - campaign - customer - dialer - external - fax - group - inbound - ivr - manual - outbound - station - user - voicemail - voicesurveyflow - workflow screenRecording: type: boolean description: Flag determining if a screen recording was started or not teamId: type: string description: The team ID the user is a member of userId: type: string description: Unique identifier for the user sessions: type: array description: List of sessions associated to this participant items: $ref: '#/definitions/AnalyticsSession' InstagramIntegrationRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Instagram Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' pageAccessToken: type: string description: "The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required." userAccessToken: type: string description: "The short-lived User Access Token of Instagram user logged into Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required." pageId: type: string description: The page ID of Instagram page. The pageId is required when userAccessToken is provided. appId: type: string description: The app ID of Facebook app. The appId is required when a customer wants to use their own approved Facebook app. appSecret: type: string description: The app Secret of Facebook app. The appSecret is required when appId is provided. selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationActivityMetricValue: type: object properties: metric: type: string description: Metric enum: - oAlerting - oInteracting - oLongestInteracting - oLongestWaiting - oWaiting qualifier: type: string description: Metric qualifier entityIds: type: array description: Entity ids for matching entities if details were requested uniqueItems: true items: type: string count: type: integer format: int32 description: Metric count calculatedMetricValue: type: integer format: int64 description: Calculated metric value CreateSecureSession: type: object required: - flowId - userData properties: sourceParticipantId: type: string description: requesting participant flowId: type: string description: the flow id to execute in the secure session userData: type: string description: user data for the secure session disconnect: type: boolean description: if true, disconnect the agent after creating the session ResourcePermissionPolicy: type: object properties: id: type: string domain: type: string entityName: type: string policyName: type: string policyDescription: type: string actionSetKey: type: string allowConditions: type: boolean resourceConditionNode: $ref: '#/definitions/ResourceConditionNode' namedResources: type: array items: type: string resourceCondition: type: string actionSet: type: array uniqueItems: true items: type: string AiScoring: type: object properties: failureType: type: string description: The type of error that occurred while processing AI scores. It is null where there is no error. readOnly: true enum: - QuotaReached - ParsingError - ServiceError - InvalidRequest - DuplicateFormSameAgent - Unauthorized - DuplicateAutomatedFormWithCopiedScore pending: type: boolean description: Indicates whether AI scoring is currently processing the evaluation. readOnly: true dateLastChanged: type: string format: date-time description: 'The date when the AI scores were last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true ConversationContentRequiredContactField: type: object required: - contactField properties: contactField: type: string description: The name of the contact field enum: - Address - Name - Phone - Email description: Contact fields a merchant requires to complete a payment request. DiagnosticsSettings: type: object properties: reportLowMaxCallsPerAgentAlert: type: boolean description: Whether to report on low max calls per agent alerts. WhatsAppId: type: object required: - phoneNumber properties: phoneNumber: description: The phone number associated with this WhatsApp account. Requires 'E164 without a leading plus' phone number. $ref: '#/definitions/PhoneNumber' displayName: type: string description: 'The displayName of this person''s account in WhatsApp. Max: 100 characters.' description: User information for a WhatsApp account InternalMessageRequest: type: object required: - text properties: text: type: string description: The body of the text message. ConversationContentDatePickerAvailableTime: type: object properties: duration: type: integer format: int64 description: The duration of the scheduling event in seconds. dateTime: type: string format: date-time description: 'The date and time of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' description: A datetimepicker available time that a user can take. ConsultTransferToExternal: type: object required: - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID address: type: string description: The address (like phone number) of the external contact. TwitterIntegrationUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Twitter messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' signupCode: type: string description: The authorization code returned from the signup flow to request access tokens later on codeChallenge: type: string description: The codeChallenge used during the signup flow redirectUri: type: string description: The redirectUri used during the signup flow selfUri: type: string format: uri description: The URI for this object readOnly: true ConsultTransferToExternalContact: type: object required: - contactId - phoneType - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID contactId: type: string description: The external contact id. phoneType: type: string description: The external contact phone type. enum: - WorkPhone - CellPhone - HomePhone - OtherPhone OpenMessagingFromRecipient: type: object required: - id - idType properties: nickname: type: string description: Nickname or display name of the recipient. id: type: string description: The recipient ID specific to the provider. idType: type: string description: The recipient ID type. This is used to indicate the format used for the ID. enum: - Email - Phone - Opaque firstName: type: string description: First name of the recipient. lastName: type: string description: Last name of the recipient. image: type: string description: URL of an image that represents the recipient. readOnly: true email: type: string description: E-mail address of the recipient. description: Information about the recipient the message is received from. ConversationSessionSummary: type: object properties: id: type: string description: The id of the summary. text: type: string description: The text of the summary. confidence: type: number format: float description: The AI confidence value. status: type: string description: The status of the conversation summary. enum: - Pending - Queued - Started - Completed - Error - Processing mediaType: type: string description: The media type of the conversation. enum: - Email - Call - Chat - Message - Webmessaging - Unknown language: type: string description: The language of the conversation. predictedWrapupCodes: type: array description: The wrapup codes of the conversation summary. items: $ref: '#/definitions/ConversationSummaryWrapupCode' editedSummary: description: The edited summary of the conversation. $ref: '#/definitions/ConversationEditedInput' reason: description: The reason of the conversation summary. $ref: '#/definitions/ConversationSummaryReason' followup: description: The followup of the conversation summary. $ref: '#/definitions/ConversationSummaryFollowup' resolution: description: The resolution of the conversation summary. $ref: '#/definitions/ConversationSummaryResolution' dateCreated: type: string format: date-time description: 'The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' communication: description: The communication object of the summary. $ref: '#/definitions/Entity' participants: type: array description: The list of participants. items: $ref: '#/definitions/AddressableEntityRef' QuestionSettings: type: object properties: questionContextId: type: string description: The context id of the question in the group settings: $ref: '#/definitions/AiScoringSetting' ConditionalGroupActivationPilotRule: type: object properties: conditions: type: array description: The list of conditions used in this rule items: $ref: '#/definitions/ConditionalGroupActivationCondition' conditionExpression: type: string description: A string expression that defines the relationships of conditions in this rule ChecklistActivationPayload: type: object required: - activationTriggerType - language properties: activationTriggerType: type: string description: Trigger type that activated this checklist. enum: - Intent - ConversationStart intentId: type: string description: The intent ID if checklist was triggered by an intent. intentName: type: string description: The intent name if checklist was triggered by an intent. language: type: string description: Language associated with the checklist. agentId: type: string description: Agent ID. participantId: type: string description: Participant ID. queueId: type: string description: Queue ID. assistantId: type: string description: Assistant ID. mediaType: type: string description: Media type. enum: - Voice - Message - Email direction: type: string description: Direction of the conversation. enum: - Inbound - Outbound AssignedWrapupCode: type: object properties: code: type: string description: The user configured wrap up code id. notes: type: string description: Text entered by the agent to describe the call or disposition. tags: type: array description: List of tags selected by the agent to describe the call or disposition. items: type: string durationSeconds: type: integer format: int32 description: The duration in seconds of the wrap-up segment. endTime: type: string format: date-time description: 'The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AcwSettings: type: object properties: wrapupPrompt: type: string description: This field controls how the UI prompts the agent for a wrapup. enum: - MANDATORY - OPTIONAL - MANDATORY_TIMEOUT - MANDATORY_FORCED_TIMEOUT - AGENT_REQUESTED timeoutMs: type: integer format: int32 description: 'The amount of time the agent can stay in ACW (Min: 1 sec, Max: 60 min). Can only be used when ACW is AGENT_REQUESTED, MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT.' ContactAddress: type: object properties: address1: type: string description: 'Max: 200 characters. Leading and trailing whitespace stripped.' address2: type: string description: 'Max: 200 characters. Leading and trailing whitespace stripped.' city: type: string description: 'Max: 100 characters. Leading and trailing whitespace stripped.' state: type: string description: 'Max: 50 characters. Leading and trailing whitespace stripped.' postalCode: type: string description: 'Max: 25 characters. Leading and trailing whitespace stripped.' countryCode: type: string description: 'Max: 25 characters. Leading and trailing whitespace stripped.' SettingDirection: type: object properties: inbound: type: string description: Status for the Inbound Direction enum: - Enabled - Disabled outbound: type: string description: Status for the Outbound Direction enum: - Enabled - Disabled MessageTypingEventRequest: type: object required: - typing properties: typing: description: Typing event $ref: '#/definitions/ConversationEventTyping' dateSent: type: string format: date-time description: 'The time when the message typing event was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' DirectRoutingMediaSettings: type: object properties: useAgentAddressOutbound: type: boolean description: Toggle that enables using an agent's Direct Routing address outbound on behalf of queue for this media type. ConversationSummaryWrapupCode: type: object properties: id: type: string description: The id of the wrapup code. name: type: string description: The name of the wrapup code. description: type: string description: The description of the wrapup code. confidence: type: number format: float description: The AI confidence value. selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationSummaryReason: type: object properties: confidence: type: number format: float description: The AI confidence value. text: type: string description: The text of the reason. description: type: string description: The description. Geolocation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc. primary: type: boolean description: A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH latitude: type: number format: double longitude: type: number format: double country: type: string region: type: string city: type: string locations: type: array items: $ref: '#/definitions/LocationDefinition' selfUri: type: string format: uri description: The URI for this object readOnly: true TransferToAddressRequest: type: object properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. address: type: string description: User's name, queue's name, destination's address or phone number. Destination: type: object properties: address: type: string description: Address or phone number. name: type: string description: The name of the internal user. userId: type: string description: The user ID. queueId: type: string description: The queue ID. MessagingIntegration: type: object required: - id - messengerType - name - version properties: id: type: string description: A unique Integration Id readOnly: true name: type: string description: The name of the Integration readOnly: true supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' status: type: string description: The status of the Integration readOnly: true enum: - Active - Inactive - Error - Starting - Incomplete - Deleting - DeletionFailed - Failed messengerType: type: string description: The type of Messaging Integration readOnly: true enum: - sms - facebook - twitter - whatsapp - webmessaging - instagram - open - apple openExtensionType: type: string description: The type of Open Messaging Integration Extension. Only present when 'messengerType' is 'open' and the Open Integration has an extension readOnly: true enum: - None - GoogleBusinessProfile - YouTube recipient: description: The recipient associated to the Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: User reference that created this Integration readOnly: true $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration readOnly: true $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number required for updates. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true CallConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/CallMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' recordingState: type: string enum: - none - active - paused maxParticipants: type: integer format: int32 description: If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. securePause: type: boolean description: True when the recording of this conversation is in secure pause status. selfUri: type: string format: uri description: The URI for this object readOnly: true CreateWebChatRequest: type: object required: - provider - queueId properties: queueId: type: string description: The ID of the queue to use for routing the chat conversation. provider: type: string description: The name of the provider that is sourcing the web chat. skillIds: type: array description: The list of skill ID's to use for routing. items: type: string languageId: type: string description: The ID of the langauge to use for routing. priority: type: integer format: int64 description: The priority to assign to the conversation for routing. attributes: type: object description: The list of attributes to associate with the customer participant. additionalProperties: type: string customerName: type: string description: The name of the customer participating in the web chat. ConversationEncryptionConfigurationListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/ConversationEncryptionConfiguration' selfUri: type: string format: uri RestErrorDetail: type: object required: - error properties: error: type: string description: name of the error readOnly: true details: type: string description: additional information regarding the error readOnly: true userParams: type: array description: parameters to be inserted into details. items: $ref: '#/definitions/UserParam' ConversationContentPaymentRequest: type: object required: - countryCode - currencyCode - orderTotal - paymentPlatform properties: paymentPlatform: type: string description: The payment platform being used (e.g. Apple Pay) readOnly: true enum: - ApplePay countryCode: type: string description: The merchant's two-letter ISO 3166 country code. currencyCode: type: string description: The three-letter ISO 4217 currency code for the payment. orderTotal: type: number format: double description: The total price of the order. lineItems: type: array description: The items that make up the order. items: $ref: '#/definitions/ConversationContentLineItem' shippingOptions: type: array description: The available shipping options. items: $ref: '#/definitions/ConversationContentLineItem' requiredContactFields: type: array description: Contact fields required to complete the order. items: $ref: '#/definitions/ConversationContentRequiredContactField' receivedMessage: description: The message prompt to complete a payment transaction. $ref: '#/definitions/ConversationContentReceivedReplyMessage' replyMessage: description: The reply message after the user has completed the payment transaction. $ref: '#/definitions/ConversationContentReceivedReplyMessage' description: Payment Request object used to request payment from a customer. CreateCallRequest: type: object properties: phoneNumber: type: string description: The phone number to dial. callerId: type: string description: The caller id phone number for this outbound call. callerIdName: type: string description: The caller id name for this outbound call. callFromQueueId: type: string description: The queue ID to call on behalf of. callQueueId: type: string description: The queue ID to call. callUserId: type: string description: The user ID to call. priority: type: integer format: int32 description: The priority to assign to this call (if calling a queue). attributes: type: object description: The list of attributes to associate with the customer participant. additionalProperties: type: string languageId: type: string description: The language skill ID to use for routing this call (if calling a queue). routingSkillsIds: type: array description: The skill ID's to use for routing this call (if calling a queue). items: type: string routingSkillExpression: type: string description: The skill expression to use for routing this call (if calling a queue). conversationIds: type: array description: The list of existing call conversations to merge into a new ad-hoc conference. items: type: string participants: type: array description: The list of participants to call to create a new ad-hoc conference. items: $ref: '#/definitions/Destination' uuiData: type: string description: User to User Information (UUI) data managed by SIP session application. externalContactId: type: string description: The external contact with which to associate the call. label: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level UserRoutingLanguage: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. state: type: string description: Activate or deactivate this routing language. enum: - active - inactive - deleted languageUri: type: string format: uri description: URI to the organization language used by this user language. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id. ConditionalGroupActivationCondition: type: object properties: simpleMetric: description: Instructs this condition to evaluate a simple queue-level metric $ref: '#/definitions/ConditionalGroupActivationSimpleMetric' operator: type: string description: The operator used to compare the actual value against the threshold value enum: - GreaterThan - GreaterThanOrEqualTo - LessThan - LessThanOrEqualTo - EqualTo - NotEqualTo value: type: number format: double description: The threshold value, beyond which a rule evaluates as true CustomAttributes: type: object properties: id: type: string description: The id of the Custom Attributes record. name: type: string conversationId: type: string description: The id of the conversation. divisions: type: array description: The list of division ids that the record is visible in. If [], the record is visible to all divisions (Unassigned Division). items: type: string schema: description: The schema that dictates which attributes can be included. $ref: '#/definitions/ConversationDataSchema' customAttributes: type: object description: The map of attribute values. additionalProperties: type: object customAttributesTimestamps: type: object description: The map of timestamps for when each attribute was last updated. readOnly: true additionalProperties: type: string version: type: integer format: int32 description: The latest version of the Custom Attributes record. dateCreated: type: string format: date-time description: 'The date the record was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'The date the record was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true StorySetting: type: object properties: mention: description: Setting relating to Story Mentions $ref: '#/definitions/InboundOnlySetting' reply: description: Setting relating to Story Replies $ref: '#/definitions/InboundOnlySetting' TopicDuration: type: object properties: totalMilliseconds: type: integer format: int64 description: The total duration of the topic phrase within the conversation readOnly: true AnalyticsParticipant: type: object properties: externalContactId: type: string description: External contact identifier externalOrganizationId: type: string description: External organization identifier flaggedReason: type: string description: Reason for which participant flagged conversation enum: - general participantId: type: string description: Unique identifier for the participant participantName: type: string description: A human readable name identifying the participant purpose: type: string description: The participant's purpose enum: - acd - agent - api - botflow - campaign - customer - dialer - external - fax - group - inbound - ivr - manual - outbound - station - user - voicemail - voicesurveyflow - workflow screenRecording: type: boolean description: Flag determining if a screen recording was started or not teamId: type: string description: The team ID the user is a member of userId: type: string description: Unique identifier for the user sessions: type: array description: List of sessions associated to this participant items: $ref: '#/definitions/AnalyticsSession' attributes: type: object description: List of attributes associated to this participant additionalProperties: type: string AsyncQueryResponse: type: object properties: jobId: type: string description: Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results. WebChatConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string member: description: Chat Member $ref: '#/definitions/WebChatMemberInfo' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationContentInteractiveApplication: type: object properties: name: type: string description: The name of the message app. url: type: string description: Contains the data that is sent to the message app. receivedMessage: description: The message displayed in the received message bubble. $ref: '#/definitions/ConversationContentReceivedReplyMessage' replyMessage: description: The message displayed in the reply message bubble. $ref: '#/definitions/ConversationContentReceivedReplyMessage' description: InteractiveApplication content object. ConversationFormPage: type: object required: - subtitle - title properties: title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the subtitle. pageComponents: type: array description: Page components in this form page. items: $ref: '#/definitions/ConversationFormPageComponent' description: Form page object. Biography: type: object properties: biography: type: string description: Personal detailed description interests: type: array items: type: string hobbies: type: array items: type: string spouse: type: string education: type: array description: User education details items: $ref: '#/definitions/Education' OpenContentAttachment: type: object required: - mediaType - mime - url properties: id: type: string description: Provider specific ID for attachment. For example, middleware media UUID. mediaType: type: string description: The type of attachment this instance represents. enum: - Image - Video - Audio - File - Link url: type: string description: URL of the attachment. mime: type: string description: Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml). text: type: string description: Text associated with attachment such as an image caption. sha256: type: string description: Secure hash of the attachment content. filename: type: string description: Suggested file name for attachment. description: Attachment object. ExternalDataSource: type: object properties: platform: type: string description: 'The platform that was the source of the data. Example: a CRM like SALESFORCE.' enum: - SALESFORCE url: type: string description: An URL that links to the source record that contributed data to the associated entity. description: Describes a link to a record in an external system that contributed data to a Relate record TrusteeAuthorization: type: object properties: permissions: type: array description: Permissions that the trustee user has in the trustor organization readOnly: true items: type: string OpenMessageContent: type: object required: - contentType properties: contentType: type: string description: Type of this content element. If contentType = "Attachment" only one item is allowed. enum: - Attachment attachment: description: Attachment content. $ref: '#/definitions/ConversationContentAttachment' description: Message content element. FacebookIntegration: type: object required: - appId - id - name - version properties: id: type: string description: A unique Integration Id. readOnly: true name: type: string description: The name of the Facebook Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' appId: type: string description: The App Id from Facebook messenger pageId: type: string description: The Page Id from Facebook messenger pageName: type: string description: The name of the Facebook page readOnly: true pageProfileImageUrl: type: string description: The url of the profile image of the Facebook page readOnly: true status: type: string description: The status of the Facebook Integration recipient: description: The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number required for updates. createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true ConsultTransferResponse: type: object required: - destinationParticipantId properties: destinationParticipantId: type: string description: Participant ID to whom the call is being transferred. SupportedContentReference: type: object required: - id properties: id: type: string description: The SupportedContent unique identifier associated with this integration or phone number name: type: string description: The SupportedContent profile name readOnly: true selfUri: type: string format: uri description: The SupportedContent profile URI readOnly: true mediaTypes: description: Media types definition for the supported content readOnly: true $ref: '#/definitions/MediaTypes' ConversationDivisionMembership: type: object properties: division: description: A division the conversation belongs to. $ref: '#/definitions/DomainEntityRef' entities: type: array description: The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions. items: $ref: '#/definitions/DivisionEntityRef' ConversationContentText: type: object required: - body properties: type: type: string description: Type of text content (Deprecated). enum: - Text body: type: string description: Text to be shown for this content element. description: Message content element containing text only. Workspace: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The current name of the workspace. type: type: string enum: - USER - GROUP isCurrentUserWorkspace: type: boolean user: $ref: '#/definitions/DomainEntityRef' bucket: type: string dateCreated: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' summary: $ref: '#/definitions/WorkspaceSummary' acl: type: array items: type: string description: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true FaxSendRequest: type: object required: - addresses properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string addresses: type: array description: A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555 items: type: string documentId: type: string description: DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null contentType: type: string description: The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored enum: - application/pdf - image/tiff - application/msword - application/vnd.oasis.opendocument.text - application/vnd.openxmlformats-officedocument.wordprocessingml.document workspace: description: Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored $ref: '#/definitions/Workspace' coverSheet: description: Data for coversheet generation. $ref: '#/definitions/CoverSheet' timeZoneOffsetMinutes: type: integer format: int32 description: Time zone offset minutes from GMT selfUri: type: string format: uri description: The URI for this object readOnly: true OpenMessagingChannel: type: object required: - from - time - to properties: id: type: string description: The Messaging Platform integration ID. readOnly: true platform: type: string description: The provider type. readOnly: true enum: - Open type: type: string description: Specifies if this message is part of a private or public conversation. enum: - Private messageId: type: string description: Unique provider ID of the message such as a Facebook message ID. to: description: Information about the recipient the message is sent to. $ref: '#/definitions/OpenMessagingToRecipient' from: description: Information about the recipient the message is received from. $ref: '#/definitions/OpenMessagingFromRecipient' time: type: string format: date-time description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' metadata: description: Information about the channel. $ref: '#/definitions/ConversationChannelMetadata' description: Channel-specific information that describes the message and the message channel/provider. MessagingConferResponse: type: object required: - commandId - communicationId - conversation - peerCommunicationId properties: conversation: description: conversation ID. $ref: '#/definitions/AddressableEntityRef' communicationId: type: string description: The internal communication ID. peerCommunicationId: type: string description: The peer internal communication ID. commandId: type: string description: Command ID for a given request. SupportedContent: type: object required: - id - name properties: id: type: string description: A unique supported content Id. readOnly: true name: type: string description: The name of the supported content profile dateCreated: type: string format: date-time description: 'Date this supported content profile was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Date this supported content profile was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: User reference that created this supported content profile readOnly: true $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that modified this supported content profile readOnly: true $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number readOnly: true mediaTypes: description: "Defines the allowable media that may be accepted for an inbound message or to be sent in an outbound message. The following is an example of allowing all inbound media, and for outbound all images and only mpeg video: {\n \"mediaTypes\": {\n \"allow\": {\n \"inbound\": [{\"type\": \"*/*\"}],\n \"outbound\": [{\"type\": \"image/*\"}, {\"type\": \"video/mpeg\"}]\n }\n }\n}" $ref: '#/definitions/MediaTypes' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Supported content profile for inbound and outbound messages MergeOperation: type: object properties: sourceContact: description: The source contact for the merge operation readOnly: true $ref: '#/definitions/AddressableEntityRef' targetContact: description: The target contact for the merge operation readOnly: true $ref: '#/definitions/AddressableEntityRef' resultingContact: description: The contact created as a result of the merge operation readOnly: true $ref: '#/definitions/AddressableEntityRef' ApplePay: type: object required: - domainName - merchantId - paymentCapabilities - paymentCertificateCredentialId - paymentGatewayUrl - storeName - supportedPaymentNetworks properties: storeName: type: string description: The name of the store. merchantId: type: string description: The stores merchant identifier. domainName: type: string description: The domain name associated with the merchant account. paymentCapabilities: type: array description: The payment capabilities supported by the merchant. items: type: string enum: - 3DS - creditCard - debitCard supportedPaymentNetworks: type: array description: The payment networks supported by the merchant. items: type: string enum: - amex - discover - jcb - masterCard - privateLabel - visa paymentCertificateCredentialId: type: string description: The Genesys credentialId the payment certificates are stored under. paymentGatewayUrl: type: string description: The url used to process payments. fallbackUrl: type: string description: The url opened in a web browser if the customers device is unable to make payments using Apple Pay. shippingMethodUpdateUrl: type: string description: The url called when the customer changes the shipping method. shippingContactUpdateUrl: type: string description: The url called when the customer changes their shipping address information. paymentMethodUpdateUrl: type: string description: The url called when the customer changes their payment method. orderTrackingUrl: type: string description: The url called after completing the order to update the order information in your system BulkCallbackDisconnectRequest: type: object required: - callbackDisconnectIdentifiers properties: callbackDisconnectIdentifiers: type: array description: The list of requests to disconnect callbacks in bulk items: $ref: '#/definitions/CallbackDisconnectIdentifier' EmailAddress: type: object properties: email: type: string name: type: string MeetingIdRecord: type: object required: - ephemeral properties: id: type: string description: The globally unique identifier for the object. readOnly: true ephemeral: type: boolean description: Boolean flag for ephemeral status of the created record conferenceId: type: string description: The conferenceId used to generate a meetingId dateExpired: type: string format: date-time description: 'Instant at which the meetingId record will no longer be considered active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true SendMessagingTemplateRequest: type: object properties: responseId: type: string description: Unique identifier for a Response Management response to fetch and apply pre-configured message content when sending outbound responses. parameters: type: array description: A list of Response Management response substitutions for the response's messaging template. (Deprecated) use bodyParameters instead. items: $ref: '#/definitions/TemplateParameter' headerParameters: type: array description: A list of Response Management header parameter substitutions for the response's messaging template items: $ref: '#/definitions/TemplateParameter' bodyParameters: type: array description: A list of Response Management body parameter substitutions for the response's messaging template items: $ref: '#/definitions/TemplateParameter' buttonUrlParameters: type: array description: A list of Response Management button url parameter substitutions for the response's messaging template items: $ref: '#/definitions/TemplateParameter' carouselParameters: description: Template parameters for carousel card components $ref: '#/definitions/CarouselParameters' EvaluationQuestionScore: type: object properties: questionId: type: string answerId: type: string score: type: integer format: int32 description: Unweighted score of the question markedNA: type: boolean description: True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system systemMarkedNA: type: boolean description: If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false. assistedAnswerId: type: string description: AnswerId found with evaluation assistance conditions failedKillQuestion: type: boolean description: Applicable only on fatal questions. Indicates that the answer selected was not the highest score available for the question comments: type: string description: Comments from the evaluator specific to this question aiAnswer: description: Suggested AI answer readOnly: true $ref: '#/definitions/AiAnswer' multipleSelectQuestionOptionScores: type: array description: Only applicable to Multiple Select questions. Scores corresponding to the options of Multiple Select questions. items: $ref: '#/definitions/EvaluationQuestionScore' TransferToExternalRequest: type: object properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. address: type: string description: The address (like phone number) of the external contact. EvaluationVersion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true BulkResult: type: object properties: error: description: Error details if the operation failed. $ref: '#/definitions/BulkError' entity: type: object description: The result of the operation if it succeeded. InactivityTimeoutSettings: type: object properties: timeoutSeconds: type: integer format: int32 description: Timeout in seconds for inactivity on the interaction actionType: type: string description: Action to take when timeout occurs enum: - DISCONNECT - SEND_TO_ARCHITECT_FLOW flowId: description: Flow ID for architect flow action $ref: '#/definitions/DomainEntityRef' DomainRole: type: object properties: id: type: string description: The ID of the role name: type: string description: The name of the role ChecklistInferenceJobCreationResponse: type: object properties: jobId: type: string description: ID of the inference job. message: type: string description: Message with reason in case an inference job is not created. EvaluationDetailQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/EvaluationDetailQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/EvaluationDetailQueryPredicate' CachedMediaItemEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CachedMediaItem' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 UploadAttachmentRequest: type: object required: - contentLengthBytes - name properties: name: type: string description: 'Name of the attachment file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' contentLengthBytes: type: integer format: int32 description: The length of the file to upload in bytes contentMd5: type: string description: Content MD5 of the file to upload inlineImage: type: boolean description: Whether or not the attachment should be attached inline EmailMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' subject: type: string description: The subject of the email. messagesSent: type: integer format: int32 description: The number of messages that have been sent in this email conversation. autoGenerated: type: boolean description: Indicates that the email was auto-generated like an Out of Office reply. draftAttachments: type: array description: A list of uploaded attachments on the email draft. items: $ref: '#/definitions/Attachment' spam: type: boolean description: Indicates if the inbound email was marked as spam. messageId: type: string description: A globally unique identifier for the stored content of this communication. OpenIntegrationUpdateRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Open messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' outboundNotificationWebhookUrl: type: string description: The outbound notification webhook URL for the Open messaging integration. outboundNotificationWebhookSignatureSecretToken: type: string description: The outbound notification webhook signature secret token. webhookHeaders: type: object description: The user specified headers for the Open messaging integration. additionalProperties: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ContentSetting: type: object properties: story: description: Settings relating to facebook and instagram stories feature $ref: '#/definitions/StorySetting' PresenceDefinition: type: object properties: id: type: string description: description systemPresence: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationRoutingData: type: object properties: queue: description: The queue to use for routing decisions $ref: '#/definitions/AddressableEntityRef' language: description: The language to use for routing decisions $ref: '#/definitions/AddressableEntityRef' priority: type: integer format: int32 description: The priority of the conversation to use for routing decisions skills: type: array description: The skills to use for routing decisions items: $ref: '#/definitions/AddressableEntityRef' skillExpression: type: string description: The string with skill expression requested by the caller for routing decisions skillExpressionId: type: string description: The internal id of the skill expression, if any, that is currently in use for routing decisions scoredAgents: type: array description: A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents items: $ref: '#/definitions/ScoredAgent' label: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level ConversationContentLocation: type: object properties: url: type: string description: URL of the Location. address: type: string description: Location postal address. text: type: string description: Location name. latitude: type: number format: double description: Latitude of the location. longitude: type: number format: double description: Longitude of the location. description: Location object. WhatsAppIntegrationRequest: type: object required: - name - phoneNumber - wabaCertificate properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the WhatsApp Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' phoneNumber: type: string description: The phone number associated to the whatsApp integration wabaCertificate: type: string description: The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number selfUri: type: string format: uri description: The URI for this object readOnly: true CobrowseWebMessagingSession: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string joinCode: type: string description: Cobrowse session join code readOnly: true websocketUrl: type: string description: WebSocket URL for the JS client readOnly: true dateOfferEnds: type: string format: date-time description: 'Date when Cobrowse Offer Expires. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true communicationType: type: string description: CommunicationType for Cobrowse Session readOnly: true enum: - Call - Message - Unknown selfUri: type: string format: uri description: The URI for this object readOnly: true ValidationLimits: type: object properties: minLength: $ref: '#/definitions/MinLength' maxLength: $ref: '#/definitions/MaxLength' minItems: $ref: '#/definitions/MinLength' maxItems: $ref: '#/definitions/MaxLength' minimum: $ref: '#/definitions/MinLength' maximum: $ref: '#/definitions/MaxLength' CreateCallResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true Entity: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true CoverSheet: type: object properties: notes: type: string description: Text to be added to the coversheet locale: type: string description: Locale, e.g. = en-US MessageMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' toAddress: description: Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended. $ref: '#/definitions/Address' fromAddress: description: Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended. $ref: '#/definitions/Address' messages: type: array description: Message instance details on the communication. items: $ref: '#/definitions/MessageDetails' type: type: string description: Indicates the type of message platform from which the message originated. enum: - apple - facebook - instagram - kakao - line - open - sms - telegram - twitter - webmessaging - whatsapp - unknown recipientCountry: type: string description: Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. recipientType: type: string description: 'The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.' authenticated: type: boolean description: If true, the participant member is authenticated. monitoredParticipantId: type: string description: The ID of the participant being monitored when performing a message monitor. monitoredParticipant: description: The participant being monitored when performing a message monitor. $ref: '#/definitions/AddressableEntityRef' SuggestionListing: type: object properties: entities: type: array items: $ref: '#/definitions/Suggestion' nextUri: type: string selfUri: type: string previousUri: type: string ConversationFormResponseContent: type: object properties: contentType: type: string description: Type of this content element. enum: - ButtonResponse buttonResponse: description: Button response content. $ref: '#/definitions/ConversationContentButtonResponse' description: Message content element for form responses Attachment: type: object properties: attachmentId: type: string description: The unique identifier for the attachment. name: type: string description: The name of the attachment. contentUri: type: string description: The content uri of the attachment. If set, this is commonly a public api download location. contentType: type: string description: The type of file the attachment is. contentLength: type: integer format: int32 description: The length of the attachment file. inlineImage: type: boolean description: Whether or not the attachment was attached inline., PhoneNumberColumn: type: object properties: columnName: type: string type: type: string callableTimeColumnName: type: string MaxParticipants: type: object properties: maxParticipants: type: integer format: int32 description: The maximum number of participants that are allowed on a conversation. Suggestion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true conversation: description: The conversation that the suggestions correspond to. readOnly: true $ref: '#/definitions/AddressableEntityRef' assistant: description: The assistant that was used to provide the suggestions. readOnly: true $ref: '#/definitions/AddressableEntityRef' type: type: string description: The type of the documents for which the suggestion is. readOnly: true enum: - Faq - Article - KnowledgeArticle - KnowledgeSearch - CannedResponse - Script - SuggestedKnowledgeAnswer - ThirdPartySuggestion faq: description: The Faq from the knowledgebase that was provided as the suggestion. readOnly: true $ref: '#/definitions/Faq' article: description: The article from the knowledgebase that was provided as the suggestion. readOnly: true $ref: '#/definitions/Article' dateCreated: type: string format: date-time example: '2020-09-25T11:57:02Z' description: 'Date when the suggestion was created. For example: yyyy-MM-ddTHH:mm:ss.SSZ. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true answerRecordId: type: string description: The ID of the knowledge search that provided the suggestion. readOnly: true triggerType: type: string description: The trigger type of the suggestion. readOnly: true enum: - Unknown - Fallback - ConversationStart - ConversationTransfer - ConversationEnd - Intent context: description: The conversation context in which the suggestion was raised. readOnly: true $ref: '#/definitions/SuggestionContext' state: type: string description: The state of the suggestion. readOnly: true enum: - Suggested - Accepted - Dismissed - Failed - Rated knowledgeSearch: description: The suggested knowledge search result that was provided as the suggestion. readOnly: true $ref: '#/definitions/SuggestionKnowledgeSearch' knowledgeArticle: description: The suggested knowledge article that was provided as the suggestion. readOnly: true $ref: '#/definitions/SuggestionKnowledgeArticle' cannedResponse: description: The suggested canned response that was provided as the suggestion. readOnly: true $ref: '#/definitions/SuggestionCannedResponse' script: description: The suggested script that was provided as the suggestion. readOnly: true $ref: '#/definitions/SuggestionScript' selfUri: type: string format: uri description: The URI for this object readOnly: true OpenInboundMessagingReceiptChannel: type: object required: - time - to properties: to: description: Information about the recipient the message is intended for. $ref: '#/definitions/OpenMessagingToRecipient' time: type: string format: date-time description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' description: Open Channel-specific information that describes the message and the message channel/provider. AppleIntegration: type: object required: - id - messagesForBusinessId - name properties: id: type: string description: A unique integration Id. readOnly: true name: type: string description: The name of the Apple messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' messagesForBusinessId: type: string description: The Apple Messages for Business Id for the Apple messaging integration. businessName: type: string description: The name of the business. logoUrl: type: string description: The url of the businesses logo. status: type: string description: The status of the Apple Integration recipient: description: The recipient associated to the Apple messaging Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' appleIMessageApp: description: Interactive Application (iMessage App) Settings. $ref: '#/definitions/AppleIMessageApp' appleAuthentication: description: The Apple Messages for Business authentication setting. $ref: '#/definitions/AppleAuthentication' applePay: description: Apple Pay settings. $ref: '#/definitions/ApplePay' identityResolution: description: The configuration to control identity resolution. readOnly: true $ref: '#/definitions/AppleIdentityResolutionConfig' selfUri: type: string format: uri description: The URI for this object readOnly: true SnippetRecordingRequest: type: object required: - type properties: type: type: string description: Type of recording to apply to the participant. enum: - snippet - adhoc record: type: boolean SuggestionKnowledgeAnswer: type: object properties: answer: type: string description: The most relevant answer readOnly: true startIndex: type: integer format: int32 description: The start index of the answer readOnly: true endIndex: type: integer format: int32 description: The end index of the answer readOnly: true ConsultTransferToQueue: type: object required: - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID queueId: type: string description: The id of the queue. queueName: type: string description: The name of the queue. AfterCallWorkUpdate: type: object required: - afterCallWorkRequired properties: afterCallWorkRequired: type: boolean description: Indicates whether or not after-call work must be completed for the communication. Can only be updated for connected communications. ChecklistFinalizePayload: type: object required: - exitReason properties: exitReason: type: string description: Exit reason provided at the time of finalizing the checklist. Voicemail: type: object properties: id: type: string description: The voicemail id uploadStatus: type: string description: current state of the voicemail upload enum: - pending - complete - failed - timeout - none AnalyticsFlowOutcome: type: object properties: flowOutcome: type: string description: Combination of unique flow outcome identifier and its value separated by colon flowOutcomeEndTimestamp: type: string format: date-time description: The outcome ending timestamp in ISO 8601 format. This may be null if the outcome did not succeed. flowOutcomeId: type: string description: Unique identifier of a flow outcome flowOutcomeStartTimestamp: type: string format: date-time description: The outcome starting timestamp in ISO 8601 format flowOutcomeValue: type: string description: Flow outcome value, e.g. SUCCESS ConversationContentReceivedReplyMessage: type: object properties: header: type: string description: Text to show in the header. title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the subtitle. buttonLabel: type: string description: Text to show on the button label. imageUrl: type: string description: URL of an image. description: ReceivedReplyMessage content object. OpenNormalizedMessage: type: object required: - channel - type properties: id: type: string description: Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference, as such should only be set when sending a message receipt. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenMessagingChannel' type: type: string description: Message type. enum: - Text - Receipt text: type: string description: Message text. content: type: array description: List of content elements. items: $ref: '#/definitions/OpenMessageContent' status: type: string description: Message receipt status, only used with type Receipt. enum: - Sent - Delivered - Read - Failed - Published - Removed reasons: type: array description: List of reasons for a message receipt that indicates the message has failed. Only used with Failed status. items: $ref: '#/definitions/ConversationReason' isFinalReceipt: type: boolean description: Indicates if this is the last message receipt for this message, or if another message receipt can be expected. direction: type: string description: The direction of the message. enum: - Inbound - Outbound metadata: type: object description: Additional metadata about this message. additionalProperties: type: string description: Open Messaging rich media message structure CallbackMediaSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. alertingTimeoutSeconds: type: integer format: int32 description: The alerting timeout for the media type, in seconds serviceLevel: description: The targeted service level for the media type $ref: '#/definitions/ServiceLevel' autoAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for an auto-answer interaction manualAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for a manual-answer interaction mode: type: string description: The mode callbacks will use on this queue. enum: - AgentFirst - CustomerFirst enableAutoDialAndEnd: type: boolean description: Flag to enable Auto-Dial and Auto-End automation for callbacks on this queue. autoDialDelaySeconds: type: integer format: int32 description: Time in seconds after agent connects to callback before outgoing call is auto-dialed. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds. autoEndDelaySeconds: type: integer format: int32 description: Time in seconds after agent disconnects from the outgoing call before the encasing callback is auto-ended. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds. pacingModifier: type: number format: double description: Controls the maximum number of outbound calls at one time when mode is CustomerFirst. maxRetryCount: type: integer format: int32 description: Maximum number of retries that should be attempted to try and connect a customer first callback to a customer when the initial callback attempt did not connect. retryDelaySeconds: type: integer format: int32 description: Delay in seconds between each retry of a customer first callback. liveVoiceReactionType: type: string description: The action to take if a live voice is detected during the outbound call of a customer first callback. enum: - HangUp - TransferToQueue - TransferToFlow liveVoiceFlow: description: The inbound flow to transfer to if a live voice is detected during the outbound call of a customer first callback. $ref: '#/definitions/DomainEntityRef' answeringMachineReactionType: type: string description: The action to take if an answering machine is detected during the outbound call of a customer first callback. enum: - HangUp - TransferToQueue - TransferToFlow answeringMachineFlow: description: The inbound flow to transfer to if an answering machine is detected during the outbound call of a customer first callback when answeringMachineReactionType is set to TransferToFlow. $ref: '#/definitions/DomainEntityRef' edgeGroup: description: The identifier of the edge group that will place the calls. Can be set to specify custom edge group instead of default one. $ref: '#/definitions/DomainEntityRef' site: description: The identifier of the site to be used for dialing; can be set in place of an edge group. $ref: '#/definitions/DomainEntityRef' TransferDestination: type: object properties: userId: type: string description: The id of the user if the command destination is a user. address: type: string description: The destination address if the command destination is an endpoint. ConversationContentQuickReply: type: object required: - payload - text properties: text: type: string description: Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply. payload: type: string description: Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response. image: type: string description: URL of an image associated with the quick reply. action: type: string description: Specifies the type of action that is triggered upon clicking the quick reply. enum: - Message summaryText: type: string description: Summary of what the quick reply relates to. description: Quick reply object. AnalyticsResolution: type: object properties: eventTime: type: string format: date-time description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' queueId: type: string description: The ID of the last queue on which the conversation was handled. userId: type: string description: The ID of the last user who handled the conversation. nNextContactAvoided: type: integer format: int64 SuggestionFeedback: type: object required: - rating properties: rating: type: string description: The rating value of the suggestion feedback. enum: - Negative - Positive ConversationMessagingChannel: type: object properties: id: type: string description: The integration ID. readOnly: true platform: type: string description: The provider type. readOnly: true enum: - Twitter - Facebook - Instagram - Line - Whatsapp - WebMessaging - Open - Apple - Sms type: type: string description: Specifies if this message is part of a private or public conversation. enum: - Public - Private messageId: type: string description: Unique provider ID of the message such as a Facebook message ID. readOnly: true to: description: Information about the recipient the message is sent to. readOnly: true $ref: '#/definitions/ConversationMessagingToRecipient' from: description: Information about the recipient the message is received from. readOnly: true $ref: '#/definitions/ConversationMessagingFromRecipient' time: type: string format: date-time description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Time the message was edited. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateDeleted: type: string format: date-time description: 'Time the message was deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true publicMetadata: description: Information about a public message. $ref: '#/definitions/ConversationPublicMetadata' description: Channel-specific information that describes the message and the message channel/provider. CreateCallbackCommand: type: object required: - callbackNumbers properties: scriptId: type: string description: The identifier of the script to be used for the callback queueId: type: string description: The identifier of the queue to be used for the callback. Either queueId or routingData is required. routingData: description: The routing data to be used for the callback. Either queueId or routingData is required. $ref: '#/definitions/RoutingData' customerFirstCallbackDeliveryMode: type: string description: How customer-first callback agent reservation is applied for this callback. useAgentReservation forces reservation on; noAgentReservation forces it off; useQueueSetting uses the queue configuration. enum: - UseQueueSetting - UseAgentReservation - NoAgentReservation callbackUserName: type: string description: The name of the party to be called back. callbackNumbers: type: array description: A list of phone numbers for the callback. items: type: string callbackScheduledTime: type: string format: date-time example: '2015-01-02T16:59:59.000Z' description: 'The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' countryCode: type: string description: The country code to be associated with the callback numbers. validateCallbackNumbers: type: boolean description: Whether or not to validate the callback numbers for phone number format. data: type: object description: 'A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { "notes": "ready to close the deal!", "customerPreferredName": "Doc" }' additionalProperties: type: string callerId: type: string description: The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for "callerId" varies. callerIdName: type: string description: The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for "callerIdName" varies. GroupContact: type: object required: - address - mediaType - type properties: address: type: string description: Phone number for this contact type extension: type: string description: Extension is set if the number is e164 valid display: type: string description: Formatted version of the address property readOnly: true type: type: string description: Contact type of the address enum: - GROUPRING - GROUPPHONE mediaType: type: string description: Media type of the address enum: - PHONE InstagramIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities selfUri: type: string format: uri description: The URI for this object readOnly: true FacebookId: type: object required: - ids properties: ids: type: array description: 'The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with. Max: 1 Id' uniqueItems: true items: $ref: '#/definitions/FacebookScopedId' displayName: type: string description: 'The displayName of this person''s Facebook account. Roughly translates to user.first_name + '' '' + user.last_name in the Facebook API. Max: 100 characters.' description: User information for a Facebook user interacting with a page or app LocationDefinition: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string contactUser: description: Site contact for the location entity $ref: '#/definitions/AddressableEntityRef' emergencyNumber: description: Emergency number for the location entity $ref: '#/definitions/LocationEmergencyNumber' address: $ref: '#/definitions/LocationAddress' state: type: string description: Current state of the location entity enum: - active - deleted notes: type: string description: Notes for the location entity version: type: integer format: int32 description: Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response path: type: array description: A list of ancestor IDs in order readOnly: true items: type: string profileImage: type: array description: Profile image of the location entity, retrieved with ?expand=images query parameter readOnly: true items: $ref: '#/definitions/LocationImage' floorplanImage: type: array description: Floorplan images of the location entity, retrieved with ?expand=images query parameter readOnly: true items: $ref: '#/definitions/LocationImage' addressVerificationDetails: description: Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter readOnly: true $ref: '#/definitions/LocationAddressVerificationDetails' addressVerified: type: boolean description: Boolean field which states if the address has been verified as an actual address readOnly: true addressStored: type: boolean description: Boolean field which states if the address has been stored for E911 readOnly: true images: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationNotificationTemplateParameter: type: object required: - text properties: name: type: string description: Parameter name. text: type: string description: Parameter text value. description: Template parameters for placeholders in template. ConversationEventCoBrowse: type: object required: - type properties: type: type: string description: Describes the type of CoBrowse event. enum: - Offering - OfferingExpired - OfferingAccepted - OfferingRejected sessionId: type: string description: The CoBrowse session ID. sessionJoinToken: type: string description: The CoBrowse session join token. description: A CoBrowse event. Image: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string CallHistoryParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound ani: type: string description: The call ANI. dnis: type: string description: The call DNIS. user: description: The PureCloud user for this participant. $ref: '#/definitions/User' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/Queue' group: description: The group involved in the group ring call. $ref: '#/definitions/Group' disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover externalContact: description: The PureCloud external contact $ref: '#/definitions/ExternalContact' externalOrganization: description: The PureCloud external organization $ref: '#/definitions/ExternalOrganization' didInteract: type: boolean description: Indicates whether the contact ever connected sipResponseCodes: type: array description: Indicates SIP Response codes associated with the participant items: type: integer format: int64 flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general outboundCampaign: description: The outbound campaign associated with the participant $ref: '#/definitions/Campaign' EvaluationForm: type: object required: - name - questionGroups properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The evaluation form name modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' published: type: boolean contextId: type: string questionGroups: type: array description: A list of question groups items: $ref: '#/definitions/EvaluationQuestionGroup' publishedVersions: description: A list of the published versions of this form. Not populated by default, its availability depends on the endpoint. Use the 'expand=publishHistory' query parameter to retrieve this data where applicable (refer to the endpoint description to see if it is applicable). $ref: '#/definitions/DomainEntityListingEvaluationForm' evaluationSettings: description: Settings for evaluations associated with this form $ref: '#/definitions/EvaluationSettings' latestVersionFormName: type: string description: The name of the form's most recently published version aiScoring: description: AI scoring settings for the evaluation form. readOnly: true $ref: '#/definitions/AiScoringSettings' dialect: type: string description: 'The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW' selfUri: type: string format: uri description: The URI for this object readOnly: true TransferInitiator: type: object properties: userId: type: string description: The id of the user who initiated the command if it was initiated by a user. WrapupInput: type: object properties: code: type: string description: The user configured wrap up code id. name: type: string description: The user configured wrap up code name. notes: type: string description: Text entered by the agent to describe the call or disposition. tags: type: array description: List of tags selected by the agent to describe the call or disposition. items: type: string durationSeconds: type: integer format: int32 description: The length of time in seconds that the agent spent doing after call work. endTime: type: string format: date-time description: 'The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provisional: type: boolean description: Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later. disableEndTimeUpdates: type: boolean description: Prevent updates to wrapup end time when set to true. WebChatMessageEntityList: type: object properties: pageSize: type: integer format: int32 entities: type: array items: $ref: '#/definitions/WebChatMessage' previousPage: type: string next: type: string selfUri: type: string format: uri DivisionEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri dateDivisionUpdated: type: string format: date-time description: 'The time the entity division was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AnalyticsMediaEndpointStat: type: object properties: codecs: type: array description: The MIME type(s) of the audio encodings used by the audio streams belonging to this endpoint items: type: string discardedPackets: type: integer format: int64 description: The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint duplicatePackets: type: integer format: int64 description: The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint eventTime: type: string format: date-time description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' invalidPackets: type: integer format: int64 description: The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint maxLatencyMs: type: integer format: int64 description: The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds minMos: type: number format: double description: The lowest estimated average MOS among all the audio streams belonging to this endpoint minRFactor: type: number format: double description: The lowest R-factor value among all of the audio streams belonging to this endpoint overrunPackets: type: integer format: int64 description: The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded) receivedPackets: type: integer format: int64 description: The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets) underrunPackets: type: integer format: int64 description: The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded) ConversationContentReaction: type: object required: - count properties: reactionType: type: string description: Type of reaction. enum: - None - Like - Love - Wow - Haha - Sad - Angry - Thankful - Pride - Care - Share - Comment - View - Rating count: type: integer format: int32 description: Number of users that reacted this way to the message. description: User reaction to public message. AssistanceCondition: type: object properties: operator: type: string description: The operator for the assistance condition. The operator defines whether the listed topicIds should EXIST or NOTEXIST for the condition to be evaluated as true. enum: - EXISTS - NOTEXISTS topicIds: type: array description: List of topicIds within the assistance condition which would be combined together using logical OR operator. Eg ( topicId_1 || topicId_2 ) . items: type: string OpenInboundMessageMessagingChannel: type: object required: - from - time properties: from: description: Information about the recipient the message is received from. $ref: '#/definitions/OpenMessagingFromRecipient' time: type: string format: date-time description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' messageId: type: string description: Unique provider ID of the message. metadata: description: Additional Custom Information about the channel. $ref: '#/definitions/ConversationChannelMetadata' description: Open Channel-specific information that describes the message and the message channel/provider, with additional message information UploadMediaRequest: type: object required: - contentLengthBytes - fileName properties: fileName: type: string description: 'Name of the media file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' contentLengthBytes: type: integer format: int32 description: The length of the file to upload in bytes contentMd5: type: string description: Content MD5 of the file to upload Bullseye: type: object properties: rings: type: array description: The bullseye rings configured for this queue. items: $ref: '#/definitions/Ring' DisconnectReason: type: object properties: type: type: string description: Disconnect reason protocol type. enum: - q850 - sip code: type: integer format: int32 description: Protocol specific reason code. See the Q.850 and SIP specs. phrase: type: string description: Human readable English description of the disconnect reason. reason: type: string description: Final disconnect reason code that triggered the disposition result. ConversationSummaryFollowup: type: object properties: confidence: type: number format: float description: The AI confidence value. text: type: string description: The text of the followup. description: type: string description: The description. OpenInboundMessageContent: type: object properties: attachment: description: Attachment content. $ref: '#/definitions/OpenContentAttachment' description: Message content element. CustomAttributesBulkUpdateResponseMap: type: object properties: results: type: object description: The map of Custom Attributes record ids to their results after updating. additionalProperties: $ref: '#/definitions/CustomAttributesBulkUpdateResponse' PagingSpec: type: object required: - pageNumber - pageSize properties: pageSize: type: integer format: int32 description: How many results per page pageNumber: type: integer format: int32 description: How many pages in SetUuiDataRequest: type: object properties: uuiData: type: string description: The value of the uuiData to set. AnalyticsEvaluation: type: object properties: assigneeApplicable: type: boolean description: Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable assigneeId: type: string description: UserId of the assignee calibrationId: type: string description: The calibration ID used for the purpose of training evaluators contextId: type: string description: A unique identifier for an evaluation form, regardless of version deleted: type: boolean description: Whether the evaluation has been deleted evaluationId: type: string description: Unique identifier for the evaluation evaluationStatus: type: string description: Status of evaluation enum: - Finished - InProgress - InReview - Pending - Retracted evaluatorId: type: string description: A unique identifier of the user who evaluated the interaction eventTime: type: string format: date-time description: 'Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' formId: type: string description: ID of the evaluation form used formName: type: string description: Name of the evaluation form used queueId: type: string description: The ID of the associated queue released: type: boolean description: Whether the evaluation has been released rescored: type: boolean description: Whether the evaluation has been rescored at least once systemSubmitted: type: boolean description: Whether the evaluation was auto submitted by the system userId: type: string description: ID of the agent the evaluation was performed against oTotalCriticalScore: type: integer format: int64 oTotalScore: type: integer format: int64 AggregationResultEntry: type: object properties: count: type: integer format: int64 value: type: string description: For termFrequency aggregations gte: type: number description: For numericRange aggregations lt: type: number description: For numericRange aggregations ConversationMessageContent: type: object required: - contentType properties: contentType: type: string description: Type of this content element. enum: - Reactions - Attachment - Location - QuickReply - Notification - ButtonResponse - Story - Mention - Card - Carousel - Text - QuickReplyV2 - DatePicker - InteractiveApplication - ListPicker - PaymentRequest - PaymentResponse - Push - Form - RoadsideAssistance - RichLink - NotificationResponse - Unknown location: description: Location content. $ref: '#/definitions/ConversationContentLocation' attachment: description: Attachment content. $ref: '#/definitions/ConversationContentAttachment' quickReply: description: Quick reply content. $ref: '#/definitions/ConversationContentQuickReply' buttonResponse: description: Button response content. $ref: '#/definitions/ConversationContentButtonResponse' template: description: Template notification content. $ref: '#/definitions/ConversationContentNotificationTemplate' story: description: Ephemeral story content. $ref: '#/definitions/ConversationContentStory' card: description: Card content $ref: '#/definitions/ConversationContentCard' carousel: description: Carousel content $ref: '#/definitions/ConversationContentCarousel' text: description: Text content. $ref: '#/definitions/ConversationContentText' quickReplyV2: description: Quick reply V2 content. $ref: '#/definitions/ConversationContentQuickReplyV2' reactions: type: array description: A set of reactions to a message. items: $ref: '#/definitions/ConversationContentReaction' datePicker: description: Date picker content. $ref: '#/definitions/ConversationContentDatePicker' interactiveApplication: description: InteractiveApplication content. $ref: '#/definitions/ConversationContentInteractiveApplication' listPicker: description: List picker content. $ref: '#/definitions/ConversationContentListPicker' paymentRequest: description: Payment request content. $ref: '#/definitions/ConversationContentPaymentRequest' paymentResponse: description: Payment response content. $ref: '#/definitions/ConversationContentPaymentResponse' push: description: Push content. $ref: '#/definitions/ConversationContentPush' form: description: Form content. $ref: '#/definitions/ConversationContentForm' notificationResponse: description: Notification response content, e.g. an Apple Invitation acceptance. $ref: '#/definitions/ConversationContentNotificationResponse' description: Message content element. If contentType = "Attachment" only one item is allowed. SendAgentlessOutboundMessageResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true conversationId: type: string description: The identifier of the conversation. fromAddress: type: string description: The sender of the message. toAddress: type: string description: The recipient of the message. messengerType: type: string description: Type of messenger. enum: - sms - whatsapp - open - webmessaging - apple textBody: type: string description: The body of the text message. (Deprecated - Instead use message.normalizedMessage.text) messagingTemplate: description: The messaging template sent. (Deprecated - Instead use message.normalizedMessage.content[#].template) $ref: '#/definitions/SendMessagingTemplateRequest' useExistingActiveConversation: type: boolean description: 'Use an existing active conversation to send the agentless outbound message. Set this parameter to ''true'' to use active conversation. Default value: false' message: description: Sent agentless outbound message in normalized format $ref: '#/definitions/MessageData' timestamp: type: string format: date-time description: 'The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' user: description: Details of the user created the job readOnly: true $ref: '#/definitions/AddressableEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true AppleIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities selfUri: type: string format: uri description: The URI for this object readOnly: true IdentityResolutionExternalSource: type: object properties: id: type: string description: The globally unique identifier for the object. selfUri: type: string format: uri description: The URI for this object readOnly: true ExternalOrganization: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. name: type: string description: 'The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped.' division: description: The division to which this entity belongs. $ref: '#/definitions/WritableStarrableDivision' companyType: type: string industry: type: string address: $ref: '#/definitions/ContactAddress' phoneNumber: $ref: '#/definitions/PhoneNumber' faxNumber: $ref: '#/definitions/PhoneNumber' employeeCount: type: integer format: int64 revenue: type: integer format: int64 tags: type: array items: type: string websites: type: array items: type: string tickers: type: array items: $ref: '#/definitions/Ticker' twitterId: $ref: '#/definitions/TwitterId' externalSystemUrl: type: string description: A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. modifyDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' trustor: $ref: '#/definitions/Trustor' schema: description: The schema defining custom fields for this contact $ref: '#/definitions/DataSchema' customFields: type: object description: Custom fields defined in the schema referenced by schemaId and schemaVersion. additionalProperties: type: object identifiers: type: array description: Identifiers claimed by this external org items: $ref: '#/definitions/ExternalOrganizationIdentifier' externalIds: type: array description: A list of external identifiers that identify this External Organization in an external system. Max 10 items. uniqueItems: true items: $ref: '#/definitions/ExternalId' externalDataSources: type: array description: Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. readOnly: true items: $ref: '#/definitions/ExternalDataSource' selfUri: type: string format: uri description: The URI for this object readOnly: true ExternalContact: type: object properties: id: type: string description: The globally unique identifier for the object. division: description: The division to which this entity belongs. $ref: '#/definitions/WritableStarrableDivision' firstName: type: string description: 'The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.' middleName: type: string description: 'The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.' lastName: type: string description: 'The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.' salutation: type: string description: 'The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.' title: type: string description: 'The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.' workPhone: $ref: '#/definitions/PhoneNumber' cellPhone: $ref: '#/definitions/PhoneNumber' homePhone: $ref: '#/definitions/PhoneNumber' otherPhone: $ref: '#/definitions/PhoneNumber' workEmail: type: string description: 'The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format' personalEmail: type: string description: 'The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format' otherEmail: type: string description: 'The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format' address: $ref: '#/definitions/ContactAddress' twitterId: description: User information for a Twitter account $ref: '#/definitions/TwitterId' lineId: $ref: '#/definitions/LineId' whatsAppId: description: User information for a WhatsApp account $ref: '#/definitions/WhatsAppId' facebookId: description: User information for a Facebook account $ref: '#/definitions/FacebookId' instagramId: description: User information for an Instagram account $ref: '#/definitions/InstagramId' appleOpaqueIds: type: array description: 'User information for an Apple account. Max: 10 ids' uniqueItems: true items: $ref: '#/definitions/AppleOpaqueId' externalIds: type: array description: 'A list of external identifiers that identify this contact in an external system. Max: 10 ids' uniqueItems: true items: $ref: '#/definitions/ExternalId' identifiers: type: array description: Identifiers claimed by this contact items: $ref: '#/definitions/ContactIdentifier' modifyDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' externalOrganization: $ref: '#/definitions/ExternalOrganization' surveyOptOut: type: boolean externalSystemUrl: type: string description: A string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters. schema: description: The schema defining custom fields for this contact $ref: '#/definitions/DataSchema' customFields: type: object description: Custom fields defined in the schema referenced by schemaId and schemaVersion. additionalProperties: type: object externalDataSources: type: array description: Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. readOnly: true items: $ref: '#/definitions/ExternalDataSource' type: type: string description: The type of contact readOnly: true enum: - Ephemeral - Identified - Curated canonicalContact: description: The contact at the head of the merge tree. If null, this contact is not a part of any merge. readOnly: true $ref: '#/definitions/ContactAddressableEntityRef' mergeSet: type: array description: The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge. readOnly: true items: $ref: '#/definitions/ContactAddressableEntityRef' mergedFrom: type: array description: The input contacts from the merge operation. readOnly: true items: $ref: '#/definitions/ContactAddressableEntityRef' mergedTo: description: The output contact from the merge operation. readOnly: true $ref: '#/definitions/ContactAddressableEntityRef' mergeOperation: description: '(Deprecated: use mergedTo and mergedFrom instead) Information about the merge history of this contact. If null, this contact is not a part of any merge.' readOnly: true $ref: '#/definitions/MergeOperation' selfUri: type: string format: uri description: The URI for this object readOnly: true ParkingStateRequest: type: object required: - state properties: state: type: string description: State to set the participant. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none resumeTime: type: string format: date-time description: 'Timestamp for resume parked conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' MediaType: type: object properties: type: type: string description: The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types. description: Media type definition Message: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - parked - disconnected initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - parked - disconnected id: type: string description: A globally unique identifier for this communication. held: type: boolean description: True if this call is held and the person on this side hears silence. segments: type: array description: The time line of the participant's message, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the message. enum: - inbound - outbound recordingId: type: string description: A globally unique identifier for the recording associated with this message. errorInfo: $ref: '#/definitions/ErrorBody' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable - inactivity - session.expired - takeover startHoldTime: type: string format: date-time description: 'The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the message. authenticated: type: boolean description: If true, the participant member is authenticated. type: type: string description: Indicates the type of message platform from which the message originated. enum: - apple - facebook - instagram - kakao - line - open - sms - telegram - twitter - webmessaging - whatsapp - unknown recipientCountry: type: string description: Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. recipientType: type: string description: 'The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.' scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. toAddress: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' fromAddress: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' messages: type: array description: The messages sent on this communication channel. items: $ref: '#/definitions/MessageDetails' journeyContext: description: A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). $ref: '#/definitions/JourneyContext' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. agentAssistantId: type: string description: UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. byoSmsIntegrationId: type: string description: The internal id representing the customer supplied sms integration message. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' engagementSource: type: string enum: - AppleMessagesForBusiness - Discord - Email - Facebook - FacebookMessenger - Glassdoor - GoogleBusinessProfile - Instagram - KakaoTalk - Line - LinkedIn - MicrosoftTeams - MobileChat - Other - QQ - Reddit - ServiceNow - SFDC - SMS - Snapchat - Telegram - Threads - Trustpilot - Unspecified - Viber - WebChat - WeChat - Weibo - WhatsApp - X - Yelp - YouTube - Zendesk - OpenMessaging resumeTime: type: string format: date-time description: 'Represents the time when a parked message will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'Represents the time when an message was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationEncryptionConfiguration: type: object required: - keyConfigurationType - url properties: id: type: string description: The globally unique identifier for the object. readOnly: true url: type: string description: keyConfigurationType is always KmsSymmetric, and should be the arn to the key alias for the master key keyConfigurationType: type: string description: Type should be 'KmsSymmetric' when create or update Key configurations, 'None' to disable configuration. enum: - KmsSymmetric - LocalKeyManager - Native - None lastError: description: The error message related to the configuration $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true EmailMessageReply: type: object required: - from - textBody - to properties: to: type: array description: The recipients of the email message. items: $ref: '#/definitions/EmailAddress' cc: type: array description: The recipients that were copied on the email message. items: $ref: '#/definitions/EmailAddress' bcc: type: array description: The recipients that were blind copied on the email message. items: $ref: '#/definitions/EmailAddress' from: description: The sender of the email message. $ref: '#/definitions/EmailAddress' replyTo: description: The receiver of the reply email message. $ref: '#/definitions/EmailAddress' subject: type: string description: The subject of the email message. attachments: type: array description: The attachments of the email message. items: $ref: '#/definitions/Attachment' textBody: type: string description: The text body of the email message. htmlBody: type: string description: The html body of the email message. time: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' historyIncluded: type: boolean description: Indicates whether the history of previous emails of the conversation is included within the email bodies of this message. emailSizeBytes: type: integer format: int32 description: Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form. readOnly: true maxEmailSizeBytes: type: integer format: int32 description: Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration readOnly: true FacebookAppCredentials: type: object required: - id properties: id: type: string description: Genesys Cloud Facebook App Id readOnly: true ChatConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/ChatMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationTagsUpdate: type: object required: - externalTag properties: externalTag: type: string description: The external tag associated with the conversation. DataAvailabilityResponse: type: object properties: dataAvailabilityDate: type: string format: date-time description: 'Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Schema: type: object properties: title: type: string description: A core type's title readOnly: true description: type: string description: A core type's description readOnly: true type: type: array example: '["string"] for a text-based core type, ["integer"] for a numeric core type, or ["boolean", "null"] for the checkbox core type' description: An array of fundamental JSON Schema primitive types on which the core type is based readOnly: true items: type: string items: example: '{ type": "string", "pattern": "^[\\S]+$" }' description: Denotes the type and pattern of the items in an enum core type readOnly: true $ref: '#/definitions/Items' pattern: type: string description: For the "date" and "datetime" core types, denotes the regex prescribing the allowable date/datetime format readOnly: true WhatsAppIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities selfUri: type: string format: uri description: The URI for this object readOnly: true CannedResponseLibraries: type: object properties: libraryIds: type: array description: Set of canned response library IDs associated with the queue only when mode is SelectedOnly. uniqueItems: true items: type: string mode: type: string description: The association mode of canned response libraries to queue enum: - All - SelectedOnly - None ResolutionDetailQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/ResolutionDetailQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ResolutionDetailQueryPredicate' ResolutionDetailQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric metric: type: string description: Left hand side for metric predicates enum: - nNextContactAvoided operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for metric predicates range: description: Right hand side for metric predicates $ref: '#/definitions/NumericRange' LocationAddress: type: object properties: city: type: string country: type: string countryName: type: string state: type: string street1: type: string street2: type: string zipcode: type: string ItemValidationLimits: type: object required: - maxLength - minLength properties: minLength: example: '"minLength": {"min": 0, "max": 100}' description: A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/MinLength' maxLength: example: '"validationLimits": { "minLength": {"min": 0, "max": 100}, "maxLength": {"min": 1, "max": 100} }' description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/MaxLength' SurveyDetailQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/SurveyDetailQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/SurveyDetailQueryPredicate' Team: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The team name division: description: The division to which this entity belongs. $ref: '#/definitions/WritableDivision' description: type: string description: Team information. dateCreated: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members in a team readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true WorkPlanBidRanks: type: object properties: id: type: string description: The globally unique identifier for the user. workPlanBiddingPerformance: type: integer format: int32 description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999. biddingTieBreaker: type: string description: Custom agent ranking metric that some customers can use. selfUri: type: string format: uri description: The URI for this object readOnly: true AddressableEntityRef: type: object properties: id: type: string selfUri: type: string format: uri OAuthAppleAuthorizationResponse: type: object required: - redirectUrl properties: redirectUrl: type: string description: The redirected url error: description: The error object $ref: '#/definitions/OAuthAppleAuthorizationResponseError' AsyncQueryStatus: type: object properties: state: type: string description: The current state of the asynchronous query enum: - QUEUED - PENDING - FAILED - CANCELLED - FULFILLED - EXPIRED errorMessage: type: string description: The error associated with the current query, if the state is FAILED expirationDate: type: string format: date-time description: 'The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' submissionDate: type: string format: date-time description: 'The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' completionDate: type: string format: date-time description: 'The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' SegmentDetailQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/SegmentDetailQueryPredicate' ScreenMonitoring: type: object properties: id: type: string description: A globally unique identifier for this communication. initialState: type: string description: The initial connection state of this communication. enum: - none - connected - disconnected state: type: string description: The connection state of this communication. enum: - none - connected - disconnected segments: type: array description: The time line of the participant's Screen Monitoring media, divided into activity segments. items: $ref: '#/definitions/Segment' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - system provider: type: string description: The source provider of Screen Monitoring media. targetUser: description: The user participant who is being screen monitored. $ref: '#/definitions/AddressableEntityRef' screenMonitoring: description: Screen Monitoring identifier unique to the sourceUserId-targetUserId pair. $ref: '#/definitions/AddressableEntityRef' monitoringType: type: string description: The screen monitoring type. enum: - Unknown - AgentLevel - ConversationLevel count: type: integer format: int64 description: Number of Screen Monitoring sessions the targetUserId is involved in. connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationContentQuickReplyV2: type: object required: - actions - title properties: title: type: string description: Text to show as the title of the quick reply. actions: type: array description: An array of quick reply objects. items: $ref: '#/definitions/ConversationContentQuickReply' description: Quick reply object V2. WhatsAppIntegrationUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: WhatsApp Integration name supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationActivityQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - activeRouting - addressFrom - addressTo - agentScore - ani - conversationId - convertedFrom - convertedTo - direction - dnis - mediaType - participantName - queueId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - routingPriority - scoredAgentId - sessionId - teamId - usedRouting - userId x-genesys-entity-type: value: DIMENSION_TYPE operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension predicates x-genesys-entity-type: value: DIMENSION_SELECTOR ContactSort: type: object properties: fieldName: type: string direction: type: string description: The direction in which to sort contacts. enum: - ASC - DESC numeric: type: boolean description: Whether or not the column contains numeric data. Ring: type: object properties: expansionCriteria: type: array description: The conditions that will trigger conversations to move to the next bullseye ring. items: $ref: '#/definitions/ExpansionCriterium' actions: description: The actions that will be performed just before moving conversations to the next bullseye ring. $ref: '#/definitions/Actions' memberGroups: type: array description: The groups of agents associated with the ring, if any. Ring membership will update to match group membership changes. uniqueItems: true items: $ref: '#/definitions/MemberGroup' TransferRequest: type: object properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. userId: type: string description: The user ID of the transfer target. address: type: string description: The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication. userName: type: string description: The user name of the transfer target. queueId: type: string description: The queue ID of the transfer target. voicemail: type: boolean description: If true, transfer to the voicemail inbox of the participant that is being replaced. Wrapup: type: object properties: code: type: string description: The user configured wrap up code id. name: type: string description: The user configured wrap up code name. notes: type: string description: Text entered by the agent to describe the call or disposition. tags: type: array description: List of tags selected by the agent to describe the call or disposition. items: type: string durationSeconds: type: integer format: int32 description: The length of time in seconds that the agent spent doing after call work. endTime: type: string format: date-time description: 'The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provisional: type: boolean description: Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later. ConversationEnrichmentSentimentV2: type: object required: - tag properties: tag: type: string description: Detected Sentiment tag enum: - Unknown - Positive - Negative - Neutral description: Sentiment analysis of this message. CoretypeListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/Coretype' selfUri: type: string format: uri ConversationContentCarousel: type: object required: - cards properties: cards: type: array description: An array of card objects. items: $ref: '#/definitions/ConversationContentCard' description: Carousel content object. LocationAddressVerificationDetails: type: object properties: status: type: string description: Status of address verification process enum: - Pending - InProgress - Retry - Complete - Failed dateFinished: type: string format: date-time description: 'Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateStarted: type: string format: date-time description: 'Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' service: type: string example: smartystreets-us description: Third party service used for address verification WhatsAppEmbeddedSignupIntegrationRequest: type: object required: - embeddedSignupAccessToken - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the WhatsApp Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' embeddedSignupAccessToken: type: string description: The access token returned from the embedded signup flow selfUri: type: string format: uri description: The URI for this object readOnly: true MediaTypes: type: object properties: allow: description: Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked. $ref: '#/definitions/MediaTypeAccess' description: Media types OpenMessageNormalizedMessage: type: object required: - channel - type properties: id: type: string description: Unique ID of the message generated by Messaging Platform. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenMessagingChannel' type: type: string description: Message type. enum: - Text text: type: string description: Message text. content: type: array description: List of content elements. items: $ref: '#/definitions/OpenMessageContent' metadata: type: object description: Additional metadata about this message. additionalProperties: type: string conversationId: type: string description: The conversationId context for the message description: Open Messaging rich media message structure HistoryHeadersTranslation: type: object required: - cc - forwardPrefix - from - language - replyPrefix - sent - subject - to properties: from: type: string description: A translation for the word "from", for the expected language to: type: string description: A translation for the word "to", for the expected language cc: type: string description: A translation for the word "cc", for the expected language subject: type: string description: A translation for the word "subject", for the expected language replyPrefix: type: string description: A translation for the subject prefix "Reply", for the expected language forwardPrefix: type: string description: A translation for the subject prefix "Forward", for the expected language sent: type: string description: A translation for the word "sent", for the expected language language: type: string description: The code of the expected language timeZone: type: string description: 'Timezone used by the agent, used to format the sent email date and time. If not defined, will default to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' ConversationContentStory: type: object properties: type: type: string description: Type of ephemeral story attachment. enum: - Mention - Reply url: type: string description: URL to the ephemeral story. replyToId: type: string description: ID of the ephemeral story being replied to. description: An ephemeral story. Screenshare: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. context: type: string description: The room id context (xmpp jid) for the conference session. sharing: type: boolean description: Indicates whether this participant is sharing their screen. peerCount: type: integer format: int32 description: The number of peer participants from the perspective of the participant in the conference. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the screen share. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. ConversationNotificationTemplateBody: type: object required: - parameters properties: text: type: string description: Body text. For WhatsApp, ignored. parameters: type: array description: Template parameters for placeholders in template. items: $ref: '#/definitions/ConversationNotificationTemplateParameter' description: Template body object. ExpansionCriterium: type: object properties: type: type: string enum: - TIMEOUT_SECONDS threshold: type: number format: double MaxLength: type: object required: - max - min properties: min: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance. max: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance. FacebookScopedId: type: object required: - scopedId properties: scopedId: type: string description: 'The unique page/app-specific scopedId for the user. Max: 255 characters.' description: Scoped ID for a Facebook user interacting with a page or app ExternalSource: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. name: type: string description: 'The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped.' active: type: boolean linkConfiguration: $ref: '#/definitions/LinkConfiguration' selfUri: type: string format: uri description: The URI for this object readOnly: true AnalyticsProposedAgent: type: object properties: agentRank: type: integer format: int32 description: Proposed agent rank for this conversation from predictive routing (lower is better) proposedAgentId: type: string description: Unique identifier for the agent that was proposed by predictive routing MessagingSettingReference: type: object required: - id properties: id: type: string description: The messaging Setting unique identifier associated with this integration name: type: string description: The messaging Setting profile name readOnly: true selfUri: type: string format: uri description: The messaging Setting profile URI readOnly: true dateCreated: type: string format: date-time description: 'Date this messaging Setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Date this messaging Setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: string description: Version number createdBy: description: User reference that created this Setting readOnly: true $ref: '#/definitions/DomainEntityRef' updatedBy: description: User reference that modified this Setting readOnly: true $ref: '#/definitions/DomainEntityRef' content: description: Settings relating to message contents $ref: '#/definitions/ContentSetting' event: description: Settings relating to events which may occur $ref: '#/definitions/EventSetting' description: Messaging Setting for messaging platform integrations FacebookIntegrationRequest: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Facebook Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' pageAccessToken: type: string description: "The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required." userAccessToken: type: string description: "The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required." pageId: type: string description: The page Id of Facebook page. The pageId is required when userAccessToken is provided. appId: type: string description: The app Id of Facebook app. The appId is required when a customer wants to use their own approved Facebook app. appSecret: type: string description: The app Secret of Facebook app. The appSecret is required when appId is provided. selfUri: type: string format: uri description: The URI for this object readOnly: true EmailMessagePreviewListing: type: object properties: entities: type: array items: $ref: '#/definitions/EmailMessagePreview' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 Page: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string versionId: type: string createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' rootContainer: type: object additionalProperties: type: object properties: type: object additionalProperties: type: object selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationAggregateQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/ConversationAggregateQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationAggregateQueryPredicate' ConversationAggregationQuery: type: object required: - interval - metrics properties: interval: type: string format: interval description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' x-genesys-entity-type: value: INTERVAL granularity: type: string description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H' timeZone: type: string description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' groupBy: type: array description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. items: type: string enum: - activeRouting - activeSkillId - addressFrom - addressTo - agentAssistantId - agentBullseyeRing - agentOwned - agentRank - agentScore - ani - assignerId - authenticated - conversationId - conversationInitiator - convertedFrom - convertedTo - customerParticipation - deliveryStatus - destinationAddress - direction - disconnectType - divisionId - dnis - edgeId - eligibleAgentCount - errorCode - extendedDeliveryStatus - externalContactId - externalMediaCount - externalOrganizationId - externalTag - firstQueue - flaggedReason - flowInType - flowOutType - groupId - interactionType - journeyActionId - journeyActionMapId - journeyActionMapVersion - journeyCustomerId - journeyCustomerIdType - journeyCustomerSessionId - journeyCustomerSessionIdType - knowledgeBaseId - mediaCount - mediaType - messageType - originatingDirection - originatingSocialMediaPublic - outboundCampaignId - outboundContactId - outboundContactListId - participantName - peerId - proposedAgentId - provider - purpose - queueId - remote - removedSkillId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - roomId - routingPriority - routingRing - routingRule - routingRuleType - scoredAgentId - selectedAgentId - selectedAgentRank - selfServed - sessionDnis - sessionId - skillExpressionId - stationId - teamId - usedRouting - userId - videoPresent - waitingInteractionCount - wrapUpCode filter: description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters $ref: '#/definitions/ConversationAggregateQueryFilter' metrics: type: array description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved. items: type: string enum: - nBlindTransferred - nBotInteractions - nCallbackAttempts - nCallbackOverSla - nCallbackScheduled - nCfcOffered - nCobrowseSessions - nConnected - nConsult - nConsultTransferred - nConversations - nError - nOffered - nOutbound - nOutboundAbandoned - nOutboundAttempted - nOutboundConnected - nOverSla - nStateTransitionError - nTakeover - nTransferred - oAudioMessageCount - oCallbackServiceLevel - oExternalAudioMessageCount - oExternalMediaCount - oMediaCount - oMessageCount - oMessageSegmentCount - oMessageTurn - oServiceLevel - oServiceTarget - oSkillExpressionApplications - tAbandon - tAcd - tActiveCallback - tActiveCallbackComplete - tAcw - tAgentResponseTime - tAgentVideoConnected - tAlert - tAnswered - tAverageAgentResponseTime - tAverageCustomerResponseTime - tBarging - tCallbackAbandon - tCallbackConnect - tCallbackNotReached - tCallbackVirtualWait - tCfcAbandon - tCfcAcd - tCfcAnswered - tCfcFlowOut - tCoaching - tCoachingComplete - tConnected - tContacting - tDialing - tFirstConnect - tFirstDial - tFirstEngagement - tFirstResponse - tFlowOut - tHandle - tHeld - tHeldComplete - tIvr - tMonitoring - tMonitoringComplete - tNotResponding - tPark - tParkComplete - tScreenMonitoring - tShortAbandon - tSnippetRecord - tTalk - tTalkComplete - tTransmitting - tUserResponseTime - tVoicemail - tWait flattenMultivaluedDimensions: type: boolean description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') views: type: array description: Custom derived metric views items: $ref: '#/definitions/ConversationAggregationView' alternateTimeDimension: type: string description: Dimension to use as the alternative timestamp for data in the aggregate. Choosing "eventTime" uses the actual time of the data event. enum: - eventTime queryType: type: string description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy. enum: - bottomN - groupBy - topN sortMetric: description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type. $ref: '#/definitions/ConversationAggregationSort' limit: type: integer format: int32 description: How many results you want in an ordered list. Only applicable for topN/bottomN query type. OpenIntegrationRequest: type: object required: - name - outboundNotificationWebhookSignatureSecretToken - outboundNotificationWebhookUrl properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Open messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' outboundNotificationWebhookUrl: type: string description: The outbound notification webhook URL for the Open messaging integration. outboundNotificationWebhookSignatureSecretToken: type: string description: The outbound notification webhook signature secret token. This token must be longer than 15 characters. webhookHeaders: type: object description: The user specified headers for the Open messaging integration. additionalProperties: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationFormResponseComponent: type: object required: - component - id properties: id: type: string description: The id of the component in the original message. component: description: The content object capturing component response from the original message. $ref: '#/definitions/ConversationFormResponseContent' description: A response component from a form ParticipantAttributes: type: object properties: attributes: type: object description: The map of attribute keys to values. additionalProperties: type: string ConversationActivityResponse: type: object properties: results: type: array description: Query results items: $ref: '#/definitions/ConversationActivityData' entityIdDimension: type: string description: Dimension that is used as an entityId enum: - activeRouting - addressFrom - addressTo - agentScore - ani - conversationId - convertedFrom - convertedTo - direction - dnis - mediaType - participantName - queueId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - routingPriority - scoredAgentId - sessionId - teamId - usedRouting - userId FacebookIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/FacebookIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 BulkCallbackPatchResponse: type: object properties: results: type: array description: A list of the results from the bulk operation. items: $ref: '#/definitions/BulkResult' errorCount: type: integer format: int32 description: The number of errors from the bulk operation. errorIndexes: type: array description: An index of where the errors are in the listing. items: type: integer format: int32 ConversationJsonSchemaRequest: type: object required: - $schema - properties - title properties: $schema: type: string description: The JSON Schema specification link. The only value currently supported is "http://json-schema.org/draft-04/schema#". title: type: string description: The title of the schema. Must be unique across all enabled Custom Attributes schemas. description: type: string description: The schema description. required: type: array description: The list of required schema properties. All fields are optional unless listed. New fields added after initial schema creation must be optional before being able to update to required. items: type: string properties: type: object description: The map of schema properties and their limits. additionalProperties: type: object description: A JSON Schema for create/update requests. ChatConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ChatConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 CallbackDisconnectIdentifier: type: object required: - callbackId - conversationId properties: conversationId: type: string description: The Conversation Id. callbackId: type: string description: The callback id. LineId: type: object required: - ids properties: ids: type: array description: The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with. Max 1 Id. uniqueItems: true items: $ref: '#/definitions/LineUserId' displayName: type: string description: 'The displayName of this person''s account in Line. Max: 100 characters.' description: User information for a Line account TypingSetting: type: object properties: 'on': description: Should typing indication Events be sent $ref: '#/definitions/SettingDirection' AnswerOption: type: object properties: id: type: string contextId: type: string description: An identifier for this answer that stays the same across versions of the form. readOnly: true builtInType: type: string description: 'The built-in type of this answer option. Only used for built-in answer options such as selection states for Multiple Select answer options. Possible values include: Selected, Unselected' enum: - Selected - Unselected text: type: string value: type: integer format: int32 assistanceConditions: type: array description: List of assistance conditions which are combined together with a logical AND operator. Eg ( assistanceCondtion1 && assistanceCondition2 ) wherein assistanceCondition could be ( EXISTS topic1 || topic2 || ... ) or (NOTEXISTS topic3 || topic4 || ...). items: $ref: '#/definitions/AssistanceCondition' InstagramIntegrationUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Instagram Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' pageAccessToken: type: string description: "The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided." userAccessToken: type: string description: "The short-lived User Access Token of the Instagram user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided." selfUri: type: string format: uri description: The URI for this object readOnly: true ConditionalGroupActivation: type: object properties: pilotRule: description: The pilot rule for this queue, which executes periodically to determine queue health $ref: '#/definitions/ConditionalGroupActivationPilotRule' rules: type: array description: The set of rules to be periodically executed on the queue (if the pilot rule evaluates as true or there is no pilot rule) items: $ref: '#/definitions/ConditionalGroupActivationRule' OpenInboundNormalizedEvent: type: object required: - channel - events properties: channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenInboundMessagingChannel' events: type: array description: List of event elements. items: $ref: '#/definitions/OpenEvent' description: Open Event Messaging rich media message structure NumericRange: type: object properties: gt: type: number description: Greater than gte: type: number description: Greater than or equal to lt: type: number description: Less than lte: type: number description: Less than or equal to OpenMessagingToRecipient: type: object required: - id properties: nickname: type: string description: Nickname or display name of the recipient. readOnly: true id: type: string description: The recipient ID specific to the provider. idType: type: string description: The recipient ID type. This is used to indicate the format used for the ID. readOnly: true enum: - Email - Phone - Opaque firstName: type: string description: First name of the recipient. readOnly: true lastName: type: string description: Last name of the recipient. readOnly: true image: type: string description: URL of an image that represents the recipient. readOnly: true email: type: string description: E-mail address of the recipient. description: Information about the recipient the message is sent to. MinLength: type: object required: - max - min properties: min: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance. max: type: integer format: int64 description: A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance. TwitterSignupOAuthSettings: type: object properties: clientId: type: string description: The client id of the twitter app the requesting org will use to signup scopes: type: array description: The scopes/permissions requested during the signup process during the signup process to allow their future integrations to direct message items: type: string appId: type: string description: The app id of the twitter app the requesting org will use to signup DomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri ConversationMessagingToRecipient: type: object required: - id properties: nickname: type: string description: Nickname or display name of the recipient. readOnly: true id: type: string description: The recipient ID specific to the provider. idType: type: string description: The recipient ID type. This is used to indicate the format used for the ID. readOnly: true enum: - Email - Phone - Opaque - Topic image: type: string description: URL of an image that represents the recipient. readOnly: true firstName: type: string description: First name of the recipient. readOnly: true lastName: type: string description: Last name of the recipient. readOnly: true email: type: string description: E-mail address of the recipient. readOnly: true externalContactId: type: string description: The identifier of the external contact. additionalIds: type: array description: List of recipient additional identifiers readOnly: true items: $ref: '#/definitions/ConversationRecipientAdditionalIdentifier' description: Information about the recipient the message is sent to. AgentActionPayload: type: object required: - checklistItems properties: afterCallWork: type: boolean description: Boolean flag to indicate if the agent action is in ACW stage. checklistItems: type: array description: The list of checklist items and the agent action taken on each one of them. items: $ref: '#/definitions/AgentAction' ConversationContentWheelPickerItem: type: object required: - id - title properties: id: type: string description: Unique identifier for the wheel picker item title: type: string description: The main text displayed for the item. value: type: string description: The value of the item. description: Represents a selectable item in a Wheel Picker ResolutionDetailQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ResolutionDetailQueryPredicate' DynamicLineBalancingSettings: type: object properties: enabled: type: boolean description: Indicates that this campaign is subject of dynamic line balancing relativeWeight: type: integer format: int32 description: Relative weight of this campaign in dynamic line balancing ConversationMessageEvent: type: object required: - eventType properties: eventType: type: string description: Type of this event element enum: - CoBrowse - Typing - Presence - Video - Unknown coBrowse: description: CoBrowse event. $ref: '#/definitions/ConversationEventCoBrowse' typing: description: Typing event. $ref: '#/definitions/ConversationEventTyping' presence: description: Presence event. $ref: '#/definitions/ConversationEventPresence' video: description: Video event. $ref: '#/definitions/ConversationEventVideo' description: 'Message event element. Examples include: system messages, typing indicators, cobrowse offerings.' EmailMessage: type: object required: - from - textBody - to properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string to: type: array description: The recipients of the email message. items: $ref: '#/definitions/EmailAddress' cc: type: array description: The recipients that were copied on the email message. items: $ref: '#/definitions/EmailAddress' bcc: type: array description: The recipients that were blind copied on the email message. items: $ref: '#/definitions/EmailAddress' from: description: The sender of the email message. $ref: '#/definitions/EmailAddress' replyTo: description: The receiver of the reply email message. $ref: '#/definitions/EmailAddress' subject: type: string description: The subject of the email message. attachments: type: array description: The attachments of the email message. items: $ref: '#/definitions/Attachment' textBody: type: string description: The text body of the email message. htmlBody: type: string description: The html body of the email message. time: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' historyIncluded: type: boolean description: Indicates whether the history of previous emails of the conversation is included within the email bodies of this message. state: type: string description: The state of the current draft. enum: - Created - Ready - Edited draftType: type: string description: The type of draft that need to be treated. enum: - Reply - ReplyAll - Forward emailSizeBytes: type: integer format: int32 description: Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form. readOnly: true maxEmailSizeBytes: type: integer format: int32 description: Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationSchemaUpdateRequest: type: object required: - enabled - jsonSchema - version properties: version: type: integer format: int32 description: The schema's version, a positive integer. enabled: type: boolean description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. jsonSchema: description: A JSON schema defining the extension to the built-in entity type. $ref: '#/definitions/ConversationJsonSchemaRequest' description: Schema update request. Campaign: type: object required: - callerAddress - callerName - contactList - dialingMode - name - phoneColumns properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Campaign. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactList: description: The ContactList for this Campaign to dial. $ref: '#/definitions/DomainEntityRef' queue: description: The Queue for this Campaign to route calls to. Required for all dialing modes except agentless. $ref: '#/definitions/DomainEntityRef' dialingMode: type: string description: The strategy this Campaign will use for dialing. enum: - agentless - preview - power - predictive - progressive - external script: description: The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless. $ref: '#/definitions/DomainEntityRef' edgeGroup: description: The EdgeGroup that will place the calls. Required for all dialing modes except preview. $ref: '#/definitions/DomainEntityRef' site: description: The identifier of the site to be used for dialing; can be set in place of an edge group. $ref: '#/definitions/DomainEntityRef' campaignStatus: type: string description: The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates. enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping phoneColumns: type: array description: The ContactPhoneNumberColumns on the ContactList that this Campaign should dial. items: $ref: '#/definitions/PhoneColumn' abandonRate: type: number format: double description: The targeted compliance abandon rate percentage. Required for power and predictive campaigns. dncLists: type: array description: DncLists for this Campaign to check before placing a call. items: $ref: '#/definitions/DomainEntityRef' callableTimeSet: description: The callable time set for this campaign to check before placing a call. $ref: '#/definitions/DomainEntityRef' callAnalysisResponseSet: description: The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview. $ref: '#/definitions/DomainEntityRef' errors: type: array description: A list of current error conditions associated with the campaign. readOnly: true items: $ref: '#/definitions/RestErrorDetail' callerName: type: string description: The caller id name to be displayed on the outbound call. callerAddress: type: string example: (555) 555-5555 description: The caller id phone number to be displayed on the outbound call. outboundLineCount: type: integer format: int32 description: The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. ruleSets: type: array description: Rule sets to be applied while this campaign is dialing. items: $ref: '#/definitions/DomainEntityRef' skipPreviewDisabled: type: boolean description: Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. previewTimeOutSeconds: type: integer format: int64 description: The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns. alwaysRunning: type: boolean description: Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually. contactSort: description: The order in which to sort contacts for dialing, based on a column. $ref: '#/definitions/ContactSort' contactSorts: type: array description: The order in which to sort contacts for dialing, based on up to four columns. items: $ref: '#/definitions/ContactSort' noAnswerTimeout: type: integer format: int32 description: How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns. callAnalysisLanguage: type: string description: The language the edge will use to analyze the call. priority: type: integer format: int32 description: The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. contactListFilters: type: array description: Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. items: $ref: '#/definitions/DomainEntityRef' division: description: The division this campaign belongs to. $ref: '#/definitions/DomainEntityRef' agentOwnedColumn: type: string description: Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns. dynamicContactQueueingSettings: description: Settings for dynamic queueing of contacts. $ref: '#/definitions/DynamicContactQueueingSettings' skillColumns: type: array description: The skill columns on the ContactList that this Campaign should take into account when dialing items: type: string previewAutoEnd: type: boolean description: Option to enable preview auto end maxCallsPerAgent: type: integer format: int32 description: The maximum number of calls that can be placed per agent on this campaign maxCallsPerAgentDecimal: type: number format: double description: The maximum number of calls that can be placed per agent on this campaign with decimal precision callbackAutoAnswer: type: boolean description: The option manages the auto-answer callback calls dynamicLineBalancingSettings: description: Dynamic line balancing settings $ref: '#/definitions/DynamicLineBalancingSettings' diagnosticsSettings: description: Campaign diagnostics settings $ref: '#/definitions/DiagnosticsSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true MessageData: type: object required: - status - textBody - timestamp properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string providerMessageId: type: string description: The unique identifier of the message from provider timestamp: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' fromAddress: type: string description: The sender of the text message. toAddress: type: string description: The recipient of the text message. direction: type: string description: The direction of the message. enum: - inbound - outbound messengerType: type: string description: Type of text messenger. enum: - sms - facebook - twitter - whatsapp - webmessaging - instagram - open - apple textBody: type: string description: The body of the text message. (Deprecated - Instead use normalizedMessage.text) status: type: string description: The status of the message. enum: - queued - sent - failed - received - delivery-success - delivery-failed - read - removed - published media: type: array description: The media details associated to a message. (Deprecated - Instead use normalizedMessage.content[index].attachment) items: $ref: '#/definitions/MessageMedia' normalizedMessage: description: The message into normalized format readOnly: true $ref: '#/definitions/ConversationNormalizedMessage' normalizedReceipts: type: array description: The delivery event associated with this message in normalized format, if the message direction was outbound readOnly: true items: $ref: '#/definitions/ConversationNormalizedMessage' createdBy: description: User who sent this message. $ref: '#/definitions/User' conversationId: type: string description: The id of the conversation of this message. selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationEventTyping: type: object required: - type properties: type: type: string description: Describes the type of Typing event. enum: - 'On' duration: type: integer format: int64 description: The duration of the Typing event in milliseconds. description: A Typing event. Article: type: object properties: title: type: string description: The article title. readOnly: true uri: type: string description: The URI for the article. readOnly: true snippets: type: array description: This contains snippets of text from the article matching the query. readOnly: true items: type: string confidence: type: number format: float description: Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all. readOnly: true metadata: type: object description: A map that contains custom metadata about the article answer. readOnly: true additionalProperties: $ref: '#/definitions/MetadataAttribute' version: description: The version of the Article. readOnly: true $ref: '#/definitions/AddressableEntityRef' variations: type: array description: Variations of the Article. readOnly: true items: $ref: '#/definitions/AddressableEntityRef' Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string UserAuthorization: type: object properties: roles: type: array items: $ref: '#/definitions/DomainRole' unusedRoles: type: array description: A collection of the roles the user is not using readOnly: true items: $ref: '#/definitions/DomainRole' permissions: type: array description: A collection of the permissions granted by all assigned roles readOnly: true items: type: string permissionPolicies: type: array description: The policies configured for assigned permissions. readOnly: true items: $ref: '#/definitions/ResourcePermissionPolicy' EvaluationScoringSet: type: object properties: totalScore: type: number format: float description: Score of all questions totalCriticalScore: type: number format: float description: Score of only the critical questions maxTotalRawCriticalScore: type: number format: float description: Maximum total raw score for the critical questions. Raw score is the actual point values before applying weights or percentages. maxTotalRawScore: type: number format: float description: Maximum total raw score for all questions. Raw score is the actual point values before applying weights or percentages. totalNonCriticalScore: type: number format: float description: Score of only the non-critical questions questionGroupScores: type: array items: $ref: '#/definitions/EvaluationQuestionGroupScore' anyFailedKillQuestions: type: boolean description: Indicates that at least one fatal question was answered without having the highest score available for the question comments: type: string description: Overall comments from the evaluator privateComments: type: string description: Overall private comments from the evaluator agentComments: type: string description: Comments from the agent while reviewing evaluation results transcriptTopics: type: array description: List of topics found within the conversation's transcripts items: $ref: '#/definitions/TranscriptTopic' MetadataAttribute: type: object properties: value: type: string description: The value of the metadata attribute. readOnly: true Address: type: object properties: name: type: string description: This will be nameRaw if present, or a locality lookup of the address field otherwise. nameRaw: type: string description: The name as close to the bits on the wire as possible. addressNormalized: type: string description: The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. addressRaw: type: string description: The address as close to the bits on the wire as possible. addressDisplayable: type: string description: The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. OpenInboundStructuredResponseMessage: type: object required: - buttonResponse - channel - originatingMessageId properties: channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenInboundMessageMessagingChannel' buttonResponse: description: Button response element. $ref: '#/definitions/ContentButtonResponse' originatingMessageId: type: string description: Id of original structured message that this messages responds to. ExternalOrganizationIdentifier: type: object required: - type - value properties: division: description: The division to which this entity belongs. $ref: '#/definitions/WritableStarrableDivision' type: type: string description: The type of this identifier enum: - ExternalId value: type: string description: 'The string value of the identifier. Will vary in syntax by type. Max: 255 characters.' dateCreated: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' externalSource: description: The External Source ID of the identifier $ref: '#/definitions/ExternalSource' UserPresence: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string source: type: string description: Deprecated - The sourceID field should be used as a replacement. sourceId: type: string description: Represents the ID of a registered source primary: type: boolean description: A boolean used to tell whether or not to set this presence source as the primary on a PATCH presenceDefinition: $ref: '#/definitions/PresenceDefinition' futurePresenceDefinition: description: The definition of the user's desired future presence readOnly: true $ref: '#/definitions/PresenceDefinition' message: type: string modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true TransferToQueueRequest: type: object properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. queueId: type: string description: The id of the queue. queueName: type: string description: The name of the queue. AgentChecklistResponse: type: object required: - checklistItems - id - language - name - status properties: id: type: string description: ID of the checklist. name: type: string description: Name of the checklist. checklistItems: type: array description: List of individual Checklist Items. items: $ref: '#/definitions/ChecklistItem' activationTriggers: type: array description: List of triggers that activated this checklist. items: $ref: '#/definitions/ActivationTrigger' status: type: string description: The evaluation status of the checklist. enum: - EvaluationStarted - EvaluationInProgress - EvaluationFinalized - EvaluationFinalizedWithAcw exitReason: type: string description: Exit reason provided at the time of finalizing the checklist. language: type: string description: Language associated with the checklist. agentId: type: string description: Agent ID. participantId: type: string description: Participant ID. queueId: type: string description: Queue ID. assistantId: type: string description: Assistant ID. mediaType: type: string description: Media type. enum: - Voice - Message - Email direction: type: string description: Direction of the conversation. enum: - Inbound - Outbound evaluationStartDate: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist evaluation began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' evaluationLastModifiedDate: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' evaluationFinalizedDate: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist was finalized. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' evaluationFinalizedWithAcwDate: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist was finalized with ACW. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' success: type: boolean description: Whether activation succeeded for this checklist (bulk activation). Omitted for non-bulk responses. errorCode: type: string description: Error code when success is false. errorMessage: type: string description: Error message when success is false. selfUri: type: string format: uri description: The URI for this object readOnly: true CreateCallbackResponse: type: object required: - callbackIdentifiers - conversation properties: conversation: description: The conversation associated with the callback $ref: '#/definitions/DomainEntityRef' callbackIdentifiers: type: array description: The list of communication identifiers for the callback participants items: $ref: '#/definitions/CallbackIdentifier' DirectRouting: type: object properties: callMediaSettings: description: Direct Routing Settings specific to Call media. $ref: '#/definitions/DirectRoutingMediaSettings' emailMediaSettings: description: Direct Routing Settings specific to Email media. $ref: '#/definitions/DirectRoutingMediaSettings' messageMediaSettings: description: Direct Routing Settings specific to Message media. $ref: '#/definitions/DirectRoutingMediaSettings' backupQueueId: type: string description: ID of another queue to be used as the default backup if an agent does not have their Backup Settings configured. If not set, the current queue will be used as backup, but with Direct Routing criteria removed from the conversation. waitForAgent: type: boolean description: Flag indicating if Direct Routing interactions should wait for Direct Routing agent or go immediately to selected backup. agentWaitSeconds: type: integer format: int32 description: Time (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000]. ConversationContentLineItem: type: object required: - name - price properties: name: type: string description: The display name for the item. price: type: number format: double description: The price of the item. description: type: string description: Additional details about the item (e.g. the length of time to deliver for shipping options). identifier: type: string description: A client defined value used to identify the item. description: Item included in an order. ConversationUser: type: object required: - id properties: id: type: string description: The globally unique identifier for this user. ConversationJsonSchemaDocument: type: object properties: $schema: type: string description: The JSON Schema specification link. The only value currently supported is "http://json-schema.org/draft-04/schema#". title: type: string description: The title of the schema. Must be unique across all enabled Custom Attributes Schemas. description: type: string description: The schema description. required: type: array description: The list of required schema properties. All fields are optional unless listed. New fields added after initial schema creation must be optional before being able to update to required. items: type: string properties: type: object description: The map of schema properties and their limits. additionalProperties: type: object description: A Conversation Custom Attributes JSON Schema PhoneColumn: type: object required: - columnName - type properties: columnName: type: string description: The name of the phone column. type: type: string description: The type of the phone column. For example, 'cell' or 'home'. Cobrowsesession: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none id: type: string description: A globally unique identifier for this communication. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transport.failure - error - peer - other - spam - uncallable self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' cobrowseSessionId: type: string description: The co-browse session ID. cobrowseRole: type: string description: This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). controlling: type: array description: ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). items: type: string viewerUrl: type: string description: The URL that can be used to open co-browse session in web browser. providerEventTime: type: string format: date-time description: 'The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the co-browse session. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. ConversationDetailQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/ConversationDetailQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationDetailQueryPredicate' SkillsToRemove: type: object properties: name: type: string id: type: string selfUri: type: string format: uri OpenIntegration: type: object required: - id - name - outboundNotificationWebhookSignatureSecretToken - outboundNotificationWebhookUrl properties: id: type: string description: A unique Integration Id. readOnly: true name: type: string description: The name of the Open messaging integration. supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' outboundNotificationWebhookUrl: type: string description: The outbound notification webhook URL for the Open messaging integration. outboundNotificationWebhookSignatureSecretToken: type: string description: The outbound notification webhook signature secret token. webhookHeaders: type: object description: The user specified headers for the Open messaging integration. additionalProperties: type: string status: type: string description: The status of the Open Integration recipient: description: The recipient associated to the Open messaging Integration. This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true SuggestionScript: type: object properties: script: description: The suggested script. readOnly: true $ref: '#/definitions/AddressableEntityRef' page: description: The page of the script. readOnly: true $ref: '#/definitions/AddressableEntityRef' data: type: object description: The payload for the script. readOnly: true additionalProperties: type: string ConversationContentListPicker: type: object properties: id: type: string description: Optional unique identifier to help map component replies to form messages where multiple ListPickers can be present. sections: type: array description: An array of sections in the List Picker. items: $ref: '#/definitions/ConversationContentListPickerSection' replyMessage: description: The reply message after the user has selected the options from the List Picker. $ref: '#/definitions/ConversationContentReceivedReplyMessage' receivedMessage: description: The message prompt to select options in the List Picker sections. $ref: '#/definitions/ConversationContentReceivedReplyMessage' description: List Picker object for presenting multiple sections of selectable items. Limit: type: object properties: key: type: string namespace: type: string enum: - web.deployments - web.messaging - agent.assistant - agentic.virtual.agents - analytics.agents - analytics.alerting - analytics.data.extraction - analytics - analytics.realtime - analytics.reporting.settings - anomaly.detection - architect - audiohook - audiohook.monitor - audit - auth.api - authorization - automation.testing - bots - bots.voice - business.rules - callback - case.management - cobrowse - content.management - conversation - copilot - dataactions - datatables - directory - dsar - email - employee.engagement - event.orchestration - external.contacts - external.events.data.ingestion - gamification - gcv - gdpr - groups - guides - historical.adherence - infrastructureascode - integrations - intent.miner - internal.messaging - journey - knowledge - language.understanding - learning - limit.registry - marketplace - mcp.analytics.aggregates - mcp - media.communications - messaging - micro.frontend - multi.org - notifications - onboarding - outbound - platform.api - predictive.routing - presence - quality - recording - response.management - routing - scim - screen.monitoring - search - secondary.automation.testing - skills - social.media - speech.and.text.analytics - speech.integration - supportability - task.management - telephony.configuration - usage - users - users.rules - voice.transcription - webchat - webhooks - workforce.management.adherence - workforce.management.agent.availability - workforce.management.forecast - workforce.management - workforce.management.scheduling.preferences - workforce.management.self.schedule - workforce.management.shift.trading - system value: type: integer format: int64 BulkCallbackPatchRequest: type: object required: - patchCallbackRequests properties: patchCallbackRequests: type: array description: The list of requests to update callbacks in bulk items: $ref: '#/definitions/PatchCallbackRequest' ConversationSummaryResolution: type: object properties: confidence: type: number format: float description: The AI confidence value. text: type: string description: The text of the resolution. description: type: string description: The description. outcome: type: string description: The outcome of the conversation's resolution. WhatsAppAvailablePhoneNumberDetails: type: object required: - name - status properties: name: type: string description: The verified name associated with this phone number. readOnly: true phoneNumber: type: string description: The display name associated with this phone number. It's typically the E.164 representation of the number. readOnly: true status: type: string description: The status of this phone number. readOnly: true ConversationMessageMetadata: type: object properties: type: type: string description: Message type. enum: - Text - Structured - Receipt - Event - Message - Unknown events: type: array description: List of events metadata items: $ref: '#/definitions/ConversationMessageMetadataEvent' content: type: array description: List of message content items: $ref: '#/definitions/ConversationMessageMetadataContent' description: Metadata information about a message. ConversationPublicMetadata: type: object properties: rootId: type: string description: The id of the root public message. replyToId: type: string description: The id of the message this public message is replying to. url: type: string description: The URL of the social post on the native platform. description: Information about a public message. ChecklistItem: type: object required: - id - name properties: id: type: string description: ID of the checklist item. name: type: string description: Name of the checklist item. description: type: string description: Description of the checklist item. automatedCheckEnabled: type: boolean description: Flag to indicate whether automated check is enabled for this checklist item. exactPhraseMatch: type: boolean description: Flag to indicate whether exact phrase matching is applicable for this checklist item. important: type: boolean description: Flag to indicate whether this checklist item is marked as important. stateFromModel: type: string description: Checklist state as evaluated by the model. enum: - Ticked - Unticked stateFromAgent: type: string description: Checklist state as evaluated by the agent. enum: - Ticked - Unticked dateLastModifiedByModel: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist item was last modified by the model. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateLastModifiedByAgent: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the checklist item was last modified by the agent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' lastModifiedInAcw: type: boolean description: Flag to indicate whether this checklist item was modified in ACW. selfUri: type: string format: uri description: The URI for this object readOnly: true WhatsAppAvailablePhoneNumberDetailsListing: type: object properties: entities: type: array items: $ref: '#/definitions/WhatsAppAvailablePhoneNumberDetails' FacebookPermission: type: object properties: name: type: string description: Facebook permission name readOnly: true type: type: string description: Facebook permission type readOnly: true enum: - FacebookPrivate - FacebookPublic - InstagramPrivate - InstagramPublic - WhatsAppPrivate description: Facebook Permissions Model ConversationContentAttachment: type: object required: - mediaType properties: id: type: string description: Provider specific ID for attachment. mediaType: type: string description: The type of attachment this instance represents. enum: - Image - Video - Audio - File - Link url: type: string description: URL of the attachment. mime: type: string description: Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml). text: type: string description: Text associated with attachment such as an image caption. sha256: type: string description: Secure hash of the attachment content. filename: type: string description: Suggested file name for attachment. contentSizeBytes: type: integer format: int64 description: Size in bytes of the attachment content. description: Attachment object. Contact: type: object properties: address: type: string description: Email address or phone number for this contact type display: type: string description: Formatted version of the address property readOnly: true mediaType: type: string enum: - PHONE - EMAIL - SMS type: type: string enum: - PRIMARY - WORK - WORK2 - WORK3 - WORK4 - HOME - MOBILE - MAIN - OTHER extension: type: string description: Use internal extension instead of address. Mutually exclusive with the address field. countryCode: type: string integration: type: string example: microsoftteams description: Integration tag value if this number is associated with an external integration. ConversationRecipientAdditionalIdentifier: type: object required: - type - value properties: type: type: string description: Type of the Identifier readOnly: true enum: - Deployment - Subject - Unknown - Topic - IngestionRule - IngestionRuleVersion - PhoneNumber - Bsuid - ParentBsuid - Username value: type: string description: The Identifier value. readOnly: true description: Additional identifiers for describing messaging recipient. ConversationActivityQueryMetric: type: object required: - metric properties: metric: type: string description: The requested metric enum: - oAlerting - oInteracting - oLongestInteracting - oLongestWaiting - oWaiting details: type: boolean description: Flag for including observation details for this metric in the response CallMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' muted: type: boolean description: Value is true when the call is muted. confined: type: boolean description: Value is true when the call is confined. recording: type: boolean description: Value is true when the call is being recorded. recordingState: type: string description: The state of the call recording. enum: - none - active - paused recordersState: description: Contains the states of different recorders. $ref: '#/definitions/RecordersState' group: description: The group involved in the group ring call. $ref: '#/definitions/DomainEntityRef' ani: type: string description: The call ANI. dnis: type: string description: The call DNIS. documentId: type: string description: The ID of the Content Management document if the call is a fax. faxStatus: description: Extra fax information if the call is a fax. $ref: '#/definitions/FaxStatus' monitoredParticipantId: type: string description: The ID of the participant being monitored when performing a call monitor. coachedParticipantId: type: string description: The ID of the participant being coached when performing a call coach. bargedParticipantId: type: string description: If this participant barged in a participant's call, then this will be the id of the targeted participant. consultParticipantId: type: string description: The ID of the consult transfer target participant when performing a consult transfer. uuiData: type: string description: User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567. bargedTime: type: string format: date-time description: 'The timestamp when this participant was connected to the barge conference in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' securePause: type: boolean description: True when the recording of this call is in secure pause status. disposition: description: Call resolution data for Dialer bulk make calls commands. $ref: '#/definitions/Disposition' transferSource: type: string description: Indicates how call reaches the agent. SurveyDetailQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/SurveyDetailQueryPredicate' AfterCallWork: type: object properties: startTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' state: type: string enum: - unknown - notApplicable - skipped - pending - complete ConsultTransferToAgent: type: object required: - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID userId: type: string description: The id of the internal user. userDisplayName: type: string description: The name of the internal user. ConversationPushFailedMessageReferences: type: object required: - id properties: id: type: string description: Unique ID of the message. description: References of failed messages requiring a push. CreateOutboundMessagingConversationRequest: type: object required: - queueId - toAddress - toAddressMessengerType properties: queueId: type: string description: The ID of the queue to be associated with the message. This will determine the fromAddress of the message, unless useUserFromAddress is true and the queue is configured to use the agent's Direct Routing address as the fromAddress. toAddress: type: string description: The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. For whatsapp messenger type, use a Whatsapp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a Whatsapp ID would be 13175555555 toAddressMessengerType: type: string description: The messaging address messenger type. enum: - sms - open - whatsapp useExistingConversation: type: boolean description: "An override to use an existing conversation. \nIf set to true, an existing conversation will be used if there is one within the conversation window. \nIf set to false, create request fails if there is a conversation within the conversation window." externalContactId: type: string description: The external contact with which the message will be associated. useUserFromAddress: type: boolean description: "An override to attempt to use the user's configured direct routing address as the fromAddress. \nIf set to true, users configured address with 'directrouting' integration will be used as fromAddress. \nIf set to false or not set, the queueId will be used for determining fromAddress." ConditionalGroupRoutingRule: type: object properties: queue: description: The queue being evaluated for this rule. If null, the current queue will be used. $ref: '#/definitions/DomainEntityRef' metric: type: string description: The queue metric being evaluated enum: - EstimatedWaitTime - ServiceLevel operator: type: string description: The operator that compares the actual value against the condition value enum: - GreaterThan - GreaterThanOrEqualTo - LessThan - LessThanOrEqualTo conditionValue: type: number format: double description: The limit value, beyond which a rule evaluates as true groups: type: array description: The group(s) to activate if the rule evaluates as true uniqueItems: true items: $ref: '#/definitions/MemberGroup' waitSeconds: type: integer format: int32 description: The number of seconds to wait in this rule, if it evaluates as true, before evaluating the next rule. For the final rule, this is ignored, so need not be specified. ConversationNotificationTemplateHeader: type: object required: - type properties: type: type: string description: Template header type. enum: - Text - Media text: type: string description: Header text. For WhatsApp, ignored. media: description: Media template header image. $ref: '#/definitions/ConversationContentAttachment' parameters: type: array description: Template parameters for placeholders in template. items: $ref: '#/definitions/ConversationNotificationTemplateParameter' description: Template header object. Faq: type: object properties: question: type: string description: Question from the knowledge base that was matched to user request. readOnly: true answer: type: string description: Answer from the knowledge base corresponding to the identified question. readOnly: true sourceUri: type: string description: A URI uniquely identifying the document, e.g. projects/acme-inc/knowledgeBases/MTAyNjgxNDU1Nzc3NTM1NzU0MjQ/documents/MTI5ODc3NzQzOTQ5MTc5NzgxMTI. readOnly: true documentUrl: type: string description: URL pointing to a web page if document was sourced from a URL. readOnly: true documentDisplayName: type: string description: A human-readable description of the document, e.g. 'Sample store FAQ' readOnly: true confidence: type: number format: float description: Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all readOnly: true AgentAction: type: object required: - agentAction - id - name properties: id: type: string description: ID of the checklist item. name: type: string description: Name of the checklist item. agentAction: type: string description: The agent action taken on a checklist item. enum: - Ticked - Unticked selfUri: type: string format: uri description: The URI for this object readOnly: true SetRecordingState: type: object properties: recordingState: type: string description: On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings. enum: - ACTIVE - PAUSED - NONE ConversationContentListPickerItem: type: object properties: id: type: string description: Unique identifier for the list picker item title: type: string description: The main text displayed for the item. subtitle: type: string description: Additional text providing more details about the item. imageUrl: type: string description: URL of an image to be displayed alongside the item. description: Represents a selectable item in a list picker. Division: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationReference: type: object properties: id: type: string selfUri: type: string format: uri ConversationMessageMetadataEvent: type: object properties: eventType: type: string description: Type of this event element enum: - CoBrowse - Typing - Presence - Video - Unknown subType: type: string description: Event subtype enum: - 'On' - Join - Offering - OfferingExpired - OfferingAccepted - OfferingRejected - Disconnect - Clear - SignIn - SessionExpired - Authenticate - AuthenticateFailure - AuthenticateCancel - Unknown description: Metadata information about a message event. SocialExpression: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. socialMediaId: type: string description: A globally unique identifier for the social media. socialMediaHub: type: string description: The social network of the communication socialUserName: type: string description: The user name for the communication. previewText: type: string description: The text preview of the communication contents recordingId: type: string description: A globally unique identifier for the recording associated with this chat. segments: type: array description: The time line of the participant's chat, divided into activity segments. items: $ref: '#/definitions/Segment' held: type: boolean description: True if this call is held and the person on this side hears silence. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the social expression. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. JourneyCustomerSession: type: object required: - id - type properties: id: type: string description: An ID of a Customer/User's session within the Journey System at a point-in-time type: type: string description: The type of the Customer/User's session within the Journey System (e.g. web, app) MessagingSetting: type: object required: - id properties: id: type: string description: The messaging Setting unique identifier associated with this integration readOnly: true name: type: string description: The messaging Setting profile name dateCreated: type: string format: date-time description: 'Date this messaging setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Date this messaging setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: string description: Version number readOnly: true createdBy: description: User reference that created this Setting readOnly: true $ref: '#/definitions/DomainEntityRef' updatedBy: description: User reference that modified this Setting readOnly: true $ref: '#/definitions/DomainEntityRef' content: description: Configuration relating to message contents $ref: '#/definitions/ContentSetting' event: description: Configuration relating to events which may occur $ref: '#/definitions/EventSetting' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Messaging setting for messaging platform integrations InternalMessageConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/InternalMessageConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 CallbackMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' outboundPreview: description: The outbound preview associated with this callback. $ref: '#/definitions/DialerPreview' voicemail: description: The voicemail associated with this callback. $ref: '#/definitions/Voicemail' callbackNumbers: type: array description: The list of phone number to use for this callback. items: type: string callbackUserName: type: string description: The name of the callback target. externalCampaign: type: boolean description: True if the call for the callback uses external dialing. skipEnabled: type: boolean description: If true, the callback can be skipped. timeoutSeconds: type: integer format: int32 description: Duration in seconds before the callback will be auto-dialed. automatedCallbackConfigId: type: string description: The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal. callbackScheduledTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' DefaultAnswer: type: object properties: id: type: string description: Selected default answer id for the question. notApplicable: type: boolean description: Is true if the selected default answer for the question is N/A readOnly: true ConversationDataSchemaListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/ConversationDataSchema' selfUri: type: string format: uri EvaluationSource: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: Type of the evaluation source. enum: - Policy - User - Unknown - Program selfUri: type: string format: uri description: The URI for this object readOnly: true PatchCallbackResponse: type: object required: - callbackIdentifiers - conversation properties: conversation: description: The conversation associated with the callback $ref: '#/definitions/DomainEntityRef' callbackIdentifiers: type: array description: The list of communication identifiers for the callback participants items: $ref: '#/definitions/CallbackIdentifier' QueueMediaSettings: type: object properties: call: description: The queue media settings for call interactions. $ref: '#/definitions/MediaSettings' callback: description: The queue media settings for callback interactions. $ref: '#/definitions/CallbackMediaSettings' chat: description: The queue media settings for chat interactions. $ref: '#/definitions/MediaSettings' email: description: The queue media settings for email interactions. $ref: '#/definitions/EmailMediaSettings' message: description: The queue media settings for message interactions. $ref: '#/definitions/MessageMediaSettings' SuggestionKnowledgeArticle: type: object properties: title: type: string description: The article title. readOnly: true snippets: type: array description: Snippets of text from the article matching the query. readOnly: true items: type: string document: description: The article. readOnly: true $ref: '#/definitions/AddressableEntityRef' version: description: The version of the article. readOnly: true $ref: '#/definitions/AddressableEntityRef' knowledgeAnswer: description: The most relevant answer within the suggested article. readOnly: true $ref: '#/definitions/SuggestionKnowledgeAnswer' variations: type: array description: The variations of the article. readOnly: true items: $ref: '#/definitions/AddressableEntityRef' MessagingConfigListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessagingSetting' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 ConversationDataSchema: type: object properties: id: type: string description: The globally unique identifier for the schema. version: type: integer format: int32 description: The schema's version, a positive integer. enabled: type: boolean description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. dateCreated: type: string format: date-time description: 'The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: The URI of the user that created this schema. readOnly: true $ref: '#/definitions/DomainEntityRef' jsonSchema: description: A JSON schema defining the extension to the built-in entity type. $ref: '#/definitions/ConversationJsonSchemaDocument' selfUri: type: string format: uri description: The URI for this object readOnly: true ErrorInfo: type: object properties: message: type: string code: type: string CreateEmailRequest: type: object required: - provider properties: queueId: type: string description: The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId flowId: type: string description: The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId provider: type: string description: The name of the provider that is sourcing the emails. The Provider "PureCloud Email" is reserved for native emails. skillIds: type: array description: The list of skill ID's to use for routing. items: type: string skillExpression: type: string description: The skill expression to use for routing the email conversation (when using queueId). languageId: type: string description: The ID of the language to use for routing. priority: type: integer format: int64 description: The priority to assign to the conversation for routing. attributes: type: object description: The list of attributes to associate with the customer participant. additionalProperties: type: string toAddress: type: string description: The email address of the recipient of the email. toName: type: string description: The name of the recipient of the email. fromAddress: type: string description: The email address of the sender of the email. fromName: type: string description: The name of the sender of the email. subject: type: string description: The subject of the email direction: type: string description: Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based. enum: - OUTBOUND - INBOUND htmlBody: type: string description: An HTML body content of the email. textBody: type: string description: A text body content of the email. externalContactId: type: string description: The external contact with which the email should be associated. This field is only valid for OUTBOUND email. utilizationLabel: type: string description: Optional. The ID of the label to controls the number of agent interactions for INBOUND communications minLength: 0 maxLength: 36 Video: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. context: type: string description: The room id context (xmpp jid) for the conference session. audioMuted: type: boolean description: Indicates whether this participant has muted their outgoing audio. videoMuted: type: boolean description: Indicates whether this participant has muted/paused their outgoing video. sharingScreen: type: boolean description: Indicates whether this participant is sharing their screen to the session. peerCount: type: integer format: int32 description: The number of peer participants from the perspective of the participant in the conference. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the video. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. msids: type: array description: List of media stream ids items: type: string self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. CustomAttributesPatchRequest: type: object required: - customAttributes - id properties: id: type: string description: Unique identifier for the Custom Attributes record. IDs are created by users. divisions: type: array description: The list of division ids. Use [] if divisions aren't used (Unassigned Division). Omitting or setting to [] clears existing values on update. items: type: string version: type: integer format: int32 description: The latest version of the Custom Attributes record. Optional for concurrency check. customAttributes: type: object description: The map of attribute values. additionalProperties: type: object InternalMessageMediaParticipant: type: object properties: id: type: string description: The unique participant ID. name: type: string description: The display friendly name of the participant. address: type: string description: The participant address. startTime: type: string format: date-time description: 'The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startHoldTime: type: string format: date-time description: 'The time when this participant''s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' purpose: type: string description: 'The participant''s purpose. Values can be: ''agent'', ''user'', ''customer'', ''external'', ''acd'', ''ivr' state: type: string description: 'The participant''s state. Values can be: ''alerting'', ''connected'', ''disconnected'', ''dialing'', ''contacting' enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none direction: type: string description: 'The participant''s direction. Values can be: ''inbound'' or ''outbound''' enum: - inbound - outbound disconnectType: type: string description: The reason the participant was disconnected from the conversation. enum: - endpoint - endpoint.donotdisturb - client - system - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - inactivity - session.expired - takeover held: type: boolean description: Value is true when the participant is on hold. wrapupRequired: type: boolean description: Value is true when the participant requires wrap-up. wrapupPrompt: type: string description: The wrap-up prompt indicating the type of wrap-up to be performed. mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc items: type: string user: description: The PureCloud user for this participant. $ref: '#/definitions/DomainEntityRef' queue: description: The PureCloud queue for this participant. $ref: '#/definitions/DomainEntityRef' team: description: The PureCloud team for this participant. $ref: '#/definitions/DomainEntityRef' attributes: type: object description: A list of ad-hoc attributes for the participant. additionalProperties: type: string errorInfo: description: If the conversation ends in error, contains additional error details. $ref: '#/definitions/ErrorInfo' script: description: The Engage script that should be used by this participant. $ref: '#/definitions/DomainEntityRef' wrapupTimeoutMs: type: integer format: int32 description: The amount of time the participant has to complete wrap-up. wrapupSkipped: type: boolean description: Value is true when the participant has skipped wrap-up. alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. provider: type: string description: The source provider for the communication. externalContact: description: If this participant represents an external contact, then this will be the reference for the external contact. $ref: '#/definitions/DomainEntityRef' externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganization: description: If this participant represents an external org, then this will be the reference for the external org. $ref: '#/definitions/DomainEntityRef' wrapup: description: Wrapup for this participant, if it has been applied. $ref: '#/definitions/Wrapup' peer: type: string description: The peer communication corresponding to a matching leg for this communication. flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general journeyContext: description: Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. $ref: '#/definitions/JourneyContext' conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'The time when this participant''s communication was last parked. Does not reset on resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resumeTime: type: string format: date-time description: 'The time when this participant''s communications will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' internalMessageId: type: string description: The internal message communication ID. targetUser: description: The user participant on receiving side of the internal message conversation. $ref: '#/definitions/AddressableEntityRef' sourceUser: description: The user participant on sending side of the internal message conversation. $ref: '#/definitions/AddressableEntityRef' toAddress: description: Address for the participant on receiving side of the internal message communication. $ref: '#/definitions/Address' fromAddress: description: Address for the participant on the sending side of the internal message communication. $ref: '#/definitions/Address' messages: type: array description: Message instance details on the communication. items: $ref: '#/definitions/InternalMessageDetails' ConversationEditedInput: type: object properties: text: type: string description: The text of the edited input. dateModified: type: string format: date-time description: 'The modification date of the edited input. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' WebChatMemberInfo: type: object required: - role properties: id: type: string description: The communicationId of this member. displayName: type: string description: The display name of the member. firstName: type: string description: The first name of the member. lastName: type: string description: The last name of the member. email: type: string description: The email address of the member. phoneNumber: type: string description: The phone number of the member. avatarImageUrl: type: string format: uri description: The url to the avatar image of the member. role: type: string description: The role of the member, one of [agent, customer, acd, workflow] enum: - AGENT - CUSTOMER - WORKFLOW - ACD joinDate: type: string format: date-time description: 'The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' leaveDate: type: string format: date-time description: 'The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' authenticatedGuest: type: boolean description: If true, the guest member is an authenticated guest. customFields: type: object description: Any custom fields of information pertaining to this member. additionalProperties: type: string state: type: string description: The connection state of this member. enum: - CONNECTED - DISCONNECTED - ALERTING MessageConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessageConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 OpenIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/OpenIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 AnalyticsConversationQueryResponse: type: object properties: conversations: type: array items: $ref: '#/definitions/AnalyticsConversationWithoutAttributes' aggregations: type: array items: $ref: '#/definitions/AggregationResult' totalHits: type: integer format: int32 Trustor: type: object required: - enabled properties: id: type: string description: Organization Id for this trust. readOnly: true enabled: type: boolean description: If disabled no trustee user will have access, even if they were previously added. dateCreated: type: string format: date-time description: 'Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true createdBy: description: User that created trust. readOnly: true $ref: '#/definitions/OrgUser' organization: description: Organization associated with this trust. readOnly: true $ref: '#/definitions/Organization' authorization: description: Authorization for the trustee user has in this trustor organization readOnly: true $ref: '#/definitions/TrusteeAuthorization' selfUri: type: string format: uri description: The URI for this object readOnly: true CallCommand: type: object required: - callNumber properties: callNumber: type: string description: The phone number to dial for this call. phoneColumn: type: string description: For a dialer preview or scheduled callback, the phone column associated with the phone number SuggestionContext: type: object properties: queue: description: The queue used to assign the interaction to the user, if any. readOnly: true $ref: '#/definitions/AddressableEntityRef' mediaType: type: string description: The media type of the conversation in which the suggestion event was raised. readOnly: true enum: - Message - Voice - Unknown user: description: The agent participant who received the raised suggestion, if any. readOnly: true $ref: '#/definitions/UserReference' externalContact: description: The external contact of the end-user participant, if any. readOnly: true $ref: '#/definitions/AddressableEntityRef' utterance: description: The utterance in the voice conversation, after which the suggestion was raised, if any. readOnly: true $ref: '#/definitions/Entity' message: description: The message in the digital conversation, after which the suggestion was raised, if any. readOnly: true $ref: '#/definitions/AddressableEntityRef' queryStatement: type: string description: The query statement used when generating the suggestion, if any. readOnly: true ConversationNormalizedMessage: type: object required: - type properties: id: type: string description: Unique ID of the message. Message receipts will have the same ID as the message they reference. readOnly: true channel: description: Channel-specific information that describes the message and the message channel/provider. readOnly: true $ref: '#/definitions/ConversationMessagingChannel' type: type: string description: Message type. enum: - Text - Structured - Receipt - Event - Message - Unknown text: type: string description: Message text. content: type: array description: List of content elements. items: $ref: '#/definitions/ConversationMessageContent' events: type: array description: List of event elements. items: $ref: '#/definitions/ConversationMessageEvent' status: type: string description: Message receipt status, only used with type Receipt. readOnly: true enum: - Sent - Delivered - Read - Failed - Published - Removed reasons: type: array description: List of reasons for a message receipt that indicates the message has failed. Only used with Failed status. readOnly: true items: $ref: '#/definitions/ConversationReason' originatingEntity: type: string description: Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies. enum: - Human - Bot isFinalReceipt: type: boolean description: Indicates if this is the last message receipt for this message, or if another message receipt can be expected. readOnly: true direction: type: string description: The direction of the message. readOnly: true enum: - Inbound - Outbound relatedMessages: type: array description: A list of messages related to this one. items: $ref: '#/definitions/ConversationNormalizedMessage' metadata: type: object description: Additional metadata about this message. additionalProperties: type: string enrichment: description: Metadata enrichments provided by the platform. $ref: '#/definitions/ConversationEnrichment' byoSmsIntegrationId: type: string description: The internal id representing the customer supplied sms integration message. description: General rich media message structure with normalized feature support across many messaging channels. ConversationAggregateQueryResponse: type: object properties: results: type: array items: $ref: '#/definitions/ConversationAggregateDataContainer' FacebookIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationDetailQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - accessAttribute - conversationEnd - conversationId - conversationInitiator - conversationStart - customerParticipation - divisionId - externalTag - mediaStatsMinConversationMos - originatingDirection - originatingSocialMediaPublic x-genesys-entity-type: value: DIMENSION_TYPE metric: type: string description: Left hand side for metric predicates enum: - nBlindTransferred - nBotInteractions - nCallbackAttempts - nCallbackOverSla - nCallbackScheduled - nCfcOffered - nCobrowseSessions - nConnected - nConsult - nConsultTransferred - nConversations - nError - nFlow - nFlowMilestone - nFlowOutcome - nFlowOutcomeFailed - nOffered - nOutbound - nOutboundAbandoned - nOutboundAttempted - nOutboundConnected - nOverSla - nStateTransitionError - nTakeover - nTransferred - oAudioMessageCount - oExternalAudioMessageCount - oExternalMediaCount - oFlowMilestone - oMediaCount - oMessageCount - oMessageSegmentCount - oMessageTurn - oSkillExpressionApplications - tAbandon - tAcd - tActiveCallback - tActiveCallbackComplete - tAcw - tAgentResponseTime - tAgentVideoConnected - tAlert - tAnswered - tAverageAgentResponseTime - tAverageCustomerResponseTime - tBarging - tCallbackAbandon - tCallbackConnect - tCallbackNotReached - tCallbackVirtualWait - tCfcAbandon - tCfcAcd - tCfcAnswered - tCfcFlowOut - tCoaching - tCoachingComplete - tConnected - tContacting - tConversationDuration - tDialing - tFirstConnect - tFirstDial - tFirstEngagement - tFirstResponse - tFlow - tFlowDisconnect - tFlowExit - tFlowOut - tFlowOutcome - tHandle - tHeld - tHeldComplete - tIvr - tMonitoring - tMonitoringComplete - tNotResponding - tPark - tParkComplete - tScreenMonitoring - tShortAbandon - tSnippetRecord - tTalk - tTalkComplete - tTransmitting - tUserResponseTime - tVoicemail operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension or metric predicates x-genesys-entity-type: value: DIMENSION_SELECTOR range: description: Right hand side for dimension or metric predicates $ref: '#/definitions/NumericRange' StatisticalResponse: type: object properties: interval: type: string metrics: type: array items: $ref: '#/definitions/AggregateMetricData' views: type: array items: $ref: '#/definitions/AggregateViewData' ConversationAsyncAggregateQueryResponse: type: object properties: results: type: array items: $ref: '#/definitions/ConversationAggregateDataContainer' cursor: type: string description: Cursor token to retrieve next page AggregateViewData: type: object properties: name: type: string stats: $ref: '#/definitions/StatisticalSummary' UserStations: type: object properties: associatedStation: description: Current associated station for this user. readOnly: true $ref: '#/definitions/UserStation' effectiveStation: description: The station where the user can be reached based on their default and associated station. readOnly: true $ref: '#/definitions/UserStation' defaultStation: description: Default station to be used if not associated with a station. readOnly: true $ref: '#/definitions/UserStation' lastAssociatedStation: description: Last associated station for this user. readOnly: true $ref: '#/definitions/UserStation' OAuthLastTokenIssued: type: object properties: dateIssued: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationMessageMetadataContent: type: object properties: contentType: type: string description: Type of this content element. enum: - Reactions - Attachment - Location - QuickReply - Notification - ButtonResponse - Story - Mention - Card - Carousel - Text - QuickReplyV2 - DatePicker - InteractiveApplication - ListPicker - PaymentRequest - PaymentResponse - Push - Form - RoadsideAssistance - RichLink - NotificationResponse - Unknown subType: type: string description: Content subtype enum: - Image - Video - Audio - File - Link - Mention - Reply - Button - QuickReply - Postback - Unknown description: Metadata information about a message content. ConversationContentCardAction: type: object properties: type: type: string description: Describes the type of action. enum: - Link - Postback - Unknown text: type: string description: The response text from the button click. payload: type: string description: Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel. url: type: string description: A URL of a web page to direct the user to. description: A card action that a user can take. Queue: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: The queue description. dateCreated: type: string format: date-time description: 'The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: type: string description: The ID of the user that last modified the queue. createdBy: type: string description: The ID of the user that created the queue. memberCount: type: integer format: int32 description: The total number of members in the queue. readOnly: true userMemberCount: type: integer format: int32 description: The number of user members (i.e., non-group members) in the queue. readOnly: true joinedMemberCount: type: integer format: int32 description: The number of joined members in the queue. readOnly: true mediaSettings: description: The media settings for the queue. $ref: '#/definitions/QueueMediaSettings' routingRules: type: array description: The routing rules for the queue, used for Preferred Agent Routing. items: $ref: '#/definitions/RoutingRule' conditionalGroupRouting: description: The Conditional Group Routing settings for the queue. $ref: '#/definitions/ConditionalGroupRouting' conditionalGroupActivation: description: The Conditional Group Activation settings for the queue. $ref: '#/definitions/ConditionalGroupActivation' bullseye: description: The bullseye settings for the queue. $ref: '#/definitions/Bullseye' scoringMethod: type: string description: The Scoring Method for the queue. enum: - TimestampAndPriority - PriorityOnly lastAgentRoutingMode: type: string description: The Last Agent Routing Mode for the queue. enum: - Disabled - QueueMembersOnly - AnyAgent acwSettings: description: The ACW settings for the queue. $ref: '#/definitions/AcwSettings' skillEvaluationMethod: type: string description: The skill evaluation method to use when routing conversations. enum: - NONE - BEST - ALL memberGroups: type: array description: The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes. uniqueItems: true items: $ref: '#/definitions/MemberGroup' queueFlow: description: The in-queue flow to use for call conversations waiting in queue. $ref: '#/definitions/DomainEntityRef' emailInQueueFlow: description: The in-queue flow to use for email conversations waiting in queue. $ref: '#/definitions/DomainEntityRef' messageInQueueFlow: description: The in-queue flow to use for message conversations waiting in queue. $ref: '#/definitions/DomainEntityRef' whisperPrompt: description: The prompt used for whisper on the queue, if configured. $ref: '#/definitions/DomainEntityRef' onHoldPrompt: description: The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play. $ref: '#/definitions/DomainEntityRef' autoAnswerOnly: type: boolean description: Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. cannedResponseLibraries: description: Canned response library IDs and mode with which they are associated with the queue $ref: '#/definitions/CannedResponseLibraries' enableTranscription: type: boolean description: Indicates whether voice transcription is enabled for this queue. enableAudioMonitoring: type: boolean description: Indicates whether audio monitoring is enabled for this queue. enableManualAssignment: type: boolean description: Indicates whether manual assignment is enabled for this queue. agentOwnedRouting: description: The Agent Owned Routing settings for the queue $ref: '#/definitions/AgentOwnedRouting' directRouting: description: The Direct Routing settings for the queue $ref: '#/definitions/DirectRouting' callingPartyName: type: string description: The name to use for caller identification for outbound calls from this queue. callingPartyNumber: type: string description: The phone number to use for caller identification for outbound calls from this queue. defaultScripts: type: object description: The default script Ids for the communication types. additionalProperties: $ref: '#/definitions/Script' outboundMessagingAddresses: description: The messaging addresses for the queue. $ref: '#/definitions/QueueMessagingAddresses' outboundEmailAddress: description: The default email address to use for outbound email from this queue. $ref: '#/definitions/QueueEmailAddress' peerId: type: string description: The ID of an associated external queue. suppressInQueueCallRecording: type: boolean description: Indicates whether recording in-queue calls is suppressed for this queue. selfUri: type: string format: uri description: The URI for this object readOnly: true SocialMediaMessageData: type: object required: - status - timestamp properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string providerMessageId: type: string description: The unique identifier of the message from provider timestamp: type: string format: date-time description: 'The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' fromAddress: type: string description: The sender of the text message. toAddress: type: string description: The recipient of the text message. direction: type: string description: The direction of the message. enum: - inbound - outbound messengerType: type: string description: Type of text messenger. enum: - sms - facebook - twitter - whatsapp - webmessaging - instagram - open - apple status: type: string description: The status of the message. enum: - queued - sent - failed - received - delivery-success - delivery-failed - read - removed - published normalizedMessage: description: The message into normalized format readOnly: true $ref: '#/definitions/ConversationNormalizedMessage' normalizedReceipts: type: array description: The delivery event associated with this message in normalized format, if the message direction was outbound readOnly: true items: $ref: '#/definitions/ConversationNormalizedMessage' createdBy: description: User who sent this message. $ref: '#/definitions/User' conversationId: type: string description: The id of the conversation of this message. selfUri: type: string format: uri description: The URI for this object readOnly: true AnalyticsConversationSegment: type: object properties: audioMuted: type: boolean description: Flag indicating if audio is muted or not (true/false) conference: type: boolean description: Indicates whether the segment was a conference destinationConversationId: type: string description: The unique identifier of a new conversation when a conversation is ended for a conference destinationSessionId: type: string description: The unique identifier of a new session when a session is ended for a conference disconnectType: type: string description: The session disconnect type enum: - client - conferenceTransfer - consultTransfer - dndEndpoint - dndTransfer - endpoint - error - forwardTransfer - inactivity - noAnswerTransfer - notAvailableTransfer - other - peer - sessionExpired - spam - system - takeover - timeout - transfer - transportFailure - uncallable errorCode: type: string description: A code corresponding to the error that occurred groupId: type: string description: Unique identifier for a Genesys Cloud group q850ResponseCodes: type: array description: Q.850 response code(s) items: type: integer format: int64 queueId: type: string description: Queue identifier requestedLanguageId: type: string description: Unique identifier for the language requested for an interaction requestedRoutingSkillIds: type: array description: Unique identifier(s) for skill(s) requested for an interaction items: type: string requestedRoutingUserIds: type: array description: Unique identifier(s) for agent(s) requested for an interaction items: type: string segmentEnd: type: string format: date-time description: 'The end time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' segmentStart: type: string format: date-time description: 'The start time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' segmentType: type: string description: The activity that takes place in the segment, such as hold or interact enum: - alert - barging - callback - coaching - contacting - converting - delay - dialing - hold - interact - ivr - monitoring - parked - scheduled - screenmonitoring - sharing - system - transmitting - unknown - uploading - voicemail - wrapup sipResponseCodes: type: array description: SIP response code(s) items: type: integer format: int64 sourceConversationId: type: string description: The unique identifier of the previous conversation when a new conversation is created for a conference sourceSessionId: type: string description: The unique identifier of the previous session when a new session is created for a conference subject: type: string description: The subject for the initial email that started this conversation videoMuted: type: boolean description: Flag indicating if video is muted/paused or not (true/false) wrapUpCode: type: string description: Wrap up code wrapUpNote: type: string description: Note entered by an agent during after-call work wrapUpTags: type: array description: Tag(s) assigned during after-call work items: type: string scoredAgents: type: array description: Scored agents items: $ref: '#/definitions/AnalyticsScoredAgent' properties: type: array description: Additional segment properties items: $ref: '#/definitions/AnalyticsProperty' TransferToExternalContactRequest: type: object required: - contactId - phoneType properties: transferType: type: string description: The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended. enum: - Attended - Unattended keepInternalMessageAlive: type: boolean description: If true, the digital internal message will NOT be terminated. contactId: type: string description: The external contact id. phoneType: type: string description: The external contact phone type. enum: - WorkPhone - CellPhone - HomePhone - OtherPhone AgentChecklistInfo: type: object required: - checklistItems - id - name properties: id: type: string description: ID of the checklist. name: type: string description: Name of the checklist. checklistItems: type: array description: List of individual Checklist Items. items: $ref: '#/definitions/ChecklistItem' selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationContentIntroduction: type: object required: - buttonText - title properties: title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the subtitle. imageUrl: type: string description: URL of an image. buttonText: type: string description: Text to show on the button. description: Introduction content object. UploadAttachmentResponse: type: object properties: attachmentId: type: string description: The attachment ID name: type: string description: The name of the attachment file url: type: string description: Pre-signed URL to upload the file headers: type: object description: Required headers when uploading a file through PUT request to the URL additionalProperties: type: string conversationId: type: string description: The conversation ID ConversationActivityQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/ConversationActivityQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationActivityQueryPredicate' MessagingSettingPatchRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The messaging Setting profile name content: description: Settings relating to message contents $ref: '#/definitions/ContentSetting' event: description: Settings relating to events which may occur $ref: '#/definitions/EventSetting' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Messaging setting for messaging platform integrations ConversationContentPaymentResponse: type: object required: - originatingMessageId - paymentStatus properties: originatingMessageId: type: string description: Reference to the ID of the original payment request message this response is for. paymentStatus: type: string description: The status of the payment transaction. enum: - Completed - Failed failureReason: type: string description: The reason the payment request failed. description: Payment response object representing the status of a payment transaction. ConversationNotificationTemplateButton: type: object required: - index - type properties: type: type: string description: Specifies the type of the button. enum: - QuickReply - PhoneNumber - Url text: type: string description: Button text message. index: type: integer format: int64 description: index of the button in the list. phoneNumber: type: string description: Button phone number. url: type: string description: Button URL link. payload: type: string description: Content of the payload to be included in the quick reply response when the button is pressed. parameters: type: array description: Template parameters for placeholders in the button. items: $ref: '#/definitions/ConversationNotificationTemplateParameter' description: Template button object ConversationUtilizationLabelUpdate: type: object properties: utilizationLabelId: type: string description: The utilization label associated with the conversation. ConversationAggregateQueryClause: type: object required: - predicates - type properties: type: type: string description: Boolean operation to apply to the provided predicates enum: - and - or predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/ConversationAggregateQueryPredicate' DispositionSilentCallTimeout: type: object properties: timeoutMs: type: integer format: int32 description: Configured silent call timeout value. timerStartTime: type: string format: date-time description: 'Timer start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' timerEndTime: type: string format: date-time description: 'Timer end time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationParticipantSearchCriteria: type: object required: - type properties: endValue: type: string description: The end value of the range. This field is used for range search types. values: type: array description: A list of values for the search to match against items: type: string startValue: type: string description: The start value of the range. This field is used for range search types. value: type: string description: A value for the search to match against operator: type: string description: How to apply this search criteria against other criteria enum: - AND - OR - NOT group: type: array description: Groups multiple conditions items: $ref: '#/definitions/ConversationParticipantSearchCriteria' dateFormat: type: string description: Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. type: type: string description: Search Type enum: - EXACT - DATE_RANGE fields: type: array description: Field names to search against items: type: string PagelessDomainEntityListingEvaluationVersion: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/EvaluationVersion' selfUri: type: string format: uri CachedMediaItem: type: object properties: id: type: string description: The unique identifier for the cached media. readOnly: true url: type: string description: The URL that represents the external media that has been cached readOnly: true downloadUrl: type: string description: A URL to fetch the cached media readOnly: true mediaType: type: string description: The media type for the URL readOnly: true contentLengthBytes: type: integer format: int32 description: The content length of the media represented by the URL, in bytes. readOnly: true dateCreated: type: string format: date-time description: 'The date the cached item was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateExpires: type: string format: date-time description: 'The date the cached item expires and will be removed from the cache. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Defines an external media that has been ingested and cached by Genesys Cloud for conversation messaging User: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' chat: $ref: '#/definitions/Chat' department: type: string email: type: string primaryContactInfo: type: array description: Auto populated from addresses. readOnly: true items: $ref: '#/definitions/Contact' addresses: type: array description: Email addresses and phone numbers for this user items: $ref: '#/definitions/Contact' state: type: string description: The current state for this user. readOnly: true enum: - active - inactive - deleted title: type: string username: type: string manager: $ref: '#/definitions/User' images: type: array items: $ref: '#/definitions/Image' version: type: integer format: int32 description: Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. certifications: type: array items: type: string biography: $ref: '#/definitions/Biography' employerInfo: $ref: '#/definitions/EmployerInfo' preferredName: type: string description: Preferred full name of the agent routingStatus: description: ACD routing status readOnly: true $ref: '#/definitions/RoutingStatus' presence: description: Active presence readOnly: true $ref: '#/definitions/UserPresence' integrationPresence: description: Integration presence readOnly: true $ref: '#/definitions/UserPresence' conversationSummary: description: Summary of conversion statistics for conversation types. readOnly: true $ref: '#/definitions/UserConversationSummary' outOfOffice: description: Determine if out of office is enabled readOnly: true $ref: '#/definitions/OutOfOffice' geolocation: description: Current geolocation position readOnly: true $ref: '#/definitions/Geolocation' station: description: Effective, default, and last station information readOnly: true $ref: '#/definitions/UserStations' authorization: description: Roles and permissions assigned to the user readOnly: true $ref: '#/definitions/UserAuthorization' profileSkills: type: array description: Profile skills possessed by the user readOnly: true items: type: string locations: type: array description: The user placement at each site location. readOnly: true items: $ref: '#/definitions/Location' groups: type: array description: The groups the user is a member of readOnly: true items: $ref: '#/definitions/Group' team: description: The team the user is a member of readOnly: true $ref: '#/definitions/Team' workPlanBidRanks: description: The WFM work plan bid rank settings for the user readOnly: true $ref: '#/definitions/WorkPlanBidRanks' skills: type: array description: Routing (ACD) skills possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingSkill' languages: type: array description: Routing (ACD) languages possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingLanguage' acdAutoAnswer: type: boolean description: acd auto answer languagePreference: type: string description: preferred language by the user readOnly: true lastTokenIssued: $ref: '#/definitions/OAuthLastTokenIssued' dateLastLogin: type: string format: date-time description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateWelcomeSent: type: string format: date-time description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true InternalMessageDetails: type: object properties: messageId: type: string description: UUID identifying the internal message media. messageTime: type: string format: date-time description: 'The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AnalyticsFlow: type: object properties: endingLanguage: type: string description: Flow ending language, e.g. en-us entryReason: type: string description: The particular entry reason for this flow, e.g. an address, userId, or flowId entryType: type: string description: The entry type for this flow, e.g. dnis, dialer, agent, flow, or direct enum: - agent - direct - dnis - flow - outbound exitReason: type: string description: The exit reason for this flow, e.g. DISCONNECT flowId: type: string description: The unique identifier of this flow flowName: type: string description: The name of this flow at the time of flow execution flowType: type: string description: The type of this flow enum: - BOT - COMMONMODULE - DIGITALBOT - EMAILSEND - INBOUNDCALL - INBOUNDCHAT - INBOUNDEMAIL - INBOUNDSHORTMESSAGE - INQUEUECALL - INQUEUEEMAIL - INQUEUESHORTMESSAGE - OUTBOUNDCALL - SECURECALL - SPEECH - SURVEYINVITE - VOICE - VOICEMAIL - VOICESURVEY - WORKFLOW - WORKITEM flowVersion: type: string description: The version of this flow issuedCallback: type: boolean description: Flag indicating whether the flow issued a callback recognitionFailureReason: type: string description: The recognition failure reason causing to exit/disconnect startingLanguage: type: string description: Flow starting language, e.g. en-us transferTargetAddress: type: string description: The address of a flow transfer target, e.g. a phone number, an email address, or a queueId transferTargetName: type: string description: The name of a flow transfer target transferType: type: string description: The type of transfer for flows that ended with a transfer outcomes: type: array description: Flow outcomes items: $ref: '#/definitions/AnalyticsFlowOutcome' TwitterIntegrationRequest: type: object required: - appId - codeChallenge - name - redirectUri - signupCode properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Twitter Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' signupCode: type: string description: The authorization code returned from the signup flow to request access tokens later on appId: type: string description: The appId of the Twitter app to register the integration on codeChallenge: type: string description: The codeChallenge used during the signup flow redirectUri: type: string description: The redirectUri used during the signup flow selfUri: type: string format: uri description: The URI for this object readOnly: true CallConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CallConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 ConsultTransferUpdate: type: object required: - speakTo properties: speakTo: type: string description: Determines to whom the initiating participant is speaking. enum: - DESTINATION - OBJECT - BOTH - CONFERENCE consultingUserId: type: string description: The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID TwitterOAuthSettings: type: object properties: clientId: type: string description: The client id of the twitter app the requesting org will use to signup scopes: type: array description: The scopes/permissions requested during the signup process during the signup process to allow their future integrations to direct message items: type: string EmailMediaSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. alertingTimeoutSeconds: type: integer format: int32 description: The alerting timeout for the media type, in seconds serviceLevel: description: The targeted service level for the media type $ref: '#/definitions/ServiceLevel' autoAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for an auto-answer interaction manualAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for a manual-answer interaction FaxSendResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string uploadDestinationUri: type: string format: uri uploadMethodType: type: string enum: - SINGLE_PUT - MULTIPART_POST headers: type: object additionalProperties: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true InternalMessageConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/InternalMessageMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true OpenEvent: type: object required: - eventType properties: eventType: type: string description: Type of this event element enum: - Typing description: Message event element. ConversationQuery: type: object required: - interval properties: conversationFilters: type: array description: Filters that target conversation-level data items: $ref: '#/definitions/ConversationDetailQueryFilter' segmentFilters: type: array description: Filters that target individual segments within a conversation items: $ref: '#/definitions/SegmentDetailQueryFilter' evaluationFilters: type: array description: Filters that target evaluations items: $ref: '#/definitions/EvaluationDetailQueryFilter' surveyFilters: type: array description: Filters that target surveys items: $ref: '#/definitions/SurveyDetailQueryFilter' resolutionFilters: type: array description: Filters that target resolutions items: $ref: '#/definitions/ResolutionDetailQueryFilter' order: type: string description: Sort the result set in ascending/descending order. Default is ascending enum: - asc - desc - unordered orderBy: type: string description: 'Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart' enum: - conversationStart - conversationEnd - segmentStart - segmentEnd interval: type: string format: interval description: 'Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' aggregations: type: array description: Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters items: $ref: '#/definitions/AnalyticsQueryAggregation' paging: description: Page size and number to control iterating through large result sets. Default page size is 25 $ref: '#/definitions/PagingSpec' ContactAddressableEntityRef: type: object properties: id: type: string selfUri: type: string format: uri ResourceConditionNode: type: object properties: variableName: type: string conjunction: type: string enum: - AND - OR operator: type: string enum: - EQ - IN - GE - GT - LE - LT operands: type: array items: $ref: '#/definitions/ResourceConditionValue' terms: type: array items: $ref: '#/definitions/ResourceConditionNode' AnalyticsSession: type: object properties: activeSkillIds: type: array description: ID(s) of Skill(s) that are active on the conversation items: type: string acwSkipped: type: boolean description: Marker for an agent that skipped after call work addressFrom: type: string description: The address that initiated an action addressOther: type: string description: The email address for the participant on the other side of the email conversation addressSelf: type: string description: The email address for the participant on this side of the email conversation addressTo: type: string description: The address receiving an action agentAssistantId: type: string description: Unique identifier of the active virtual agent assistant agentBullseyeRing: type: integer format: int32 description: Bullseye ring of the targeted agent agentOwned: type: boolean description: Flag indicating an agent-owned callback ani: type: string description: Automatic Number Identification (caller's number) assignerId: type: string description: ID of the user that manually assigned a conversation authenticated: type: boolean description: Flag that indicates that the identity of the customer has been asserted as verified by the provider. bargedParticipantId: type: string description: The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation) bcc: type: array description: Blind carbon copy email address(es) items: type: string callbackNumbers: type: array description: Callback phone number(s) items: type: string callbackScheduledTime: type: string format: date-time description: 'Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' callbackUserName: type: string description: The name of the user requesting a call back cc: type: array description: Carbon copy email address(es) items: type: string cleared: type: boolean description: Flag that indicates that the conversation has been cleared by the customer coachedParticipantId: type: string description: The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation) cobrowseRole: type: string description: Describes side of the cobrowse (sharer or viewer) cobrowseRoomId: type: string description: A unique identifier for a Genesys Cloud cobrowse room deliveryPushed: type: boolean description: Flag that indicates that the push delivery mechanism was used deliveryStatus: type: string description: The email or SMS delivery status enum: - DeliveryFailed - DeliveryPushed - DeliverySuccess - Failed - Published - Queued - Read - Received - Sent deliveryStatusChangeDate: type: string format: date-time description: 'Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' destinationAddresses: type: array description: Destination address(es) of transfers or consults items: type: string detectedSpeechEnd: type: string format: date-time description: 'Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' detectedSpeechStart: type: string format: date-time description: 'Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' direction: type: string description: The direction of the communication enum: - inbound - outbound dispositionAnalyzer: type: string description: (Dialer) Analyzer (for example speech.person) dispositionName: type: string description: (Dialer) Result of the analysis (for example disposition.classification.callable.machine) dnis: type: string description: Dialed number identification service (number dialed by the calling party) edgeId: type: string description: Unique identifier of the edge device eligibleAgentCounts: type: array description: Number of eligible agents for each predictive routing attempt items: type: integer format: int32 engagementSource: type: string description: Open Messaging engagement source type enum: - AppleMessagesForBusiness - Discord - Email - Facebook - FacebookMessenger - Glassdoor - GoogleBusinessProfile - Instagram - KakaoTalk - Line - LinkedIn - MicrosoftTeams - MobileChat - Other - QQ - Reddit - ServiceNow - SFDC - SMS - Snapchat - Telegram - Threads - Trustpilot - Unspecified - Viber - WebChat - WeChat - Weibo - WhatsApp - X - Yelp - YouTube - Zendesk - OpenMessaging errorCodeDescription: type: string description: Error code description extracted from the first disconnectReason extendedDeliveryStatus: type: string description: Extended delivery status flowInType: type: string description: Type of flow in that occurred when entering ACD. flowOutType: type: string description: Type of flow out that occurred when emitting tFlowOut. journeyActionId: type: string description: Identifier of the journey action. journeyActionMapId: type: string description: Identifier of the journey action map that triggered the action. journeyActionMapVersion: type: integer format: int32 description: Version of the journey action map that triggered the action. journeyCustomerId: type: string description: Primary identifier of the journey customer in the source where the activities originate from. journeyCustomerIdType: type: string description: Type of primary identifier of the journey customer (e.g. cookie). journeyCustomerSessionId: type: string description: Unique identifier of the journey session. journeyCustomerSessionIdType: type: string description: Type or category of journey sessions (e.g. web, ticket, delivery, atm). mediaBridgeId: type: string description: Media bridge ID for the conference session consistent across all participants mediaCount: type: integer format: int32 description: Count of any media (images, files, etc) included in this session mediaType: type: string description: The session media type enum: - callback - chat - cobrowse - email - internalmessage - message - screenmonitoring - screenshare - unknown - video - voice messageType: type: string description: 'Message type for messaging services. E.g.: sms, facebook, twitter, line' monitoredParticipantId: type: string description: The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation) outboundCampaignId: type: string description: (Dialer) Unique identifier of the outbound campaign outboundContactId: type: string description: (Dialer) Unique identifier of the contact outboundContactListId: type: string description: (Dialer) Unique identifier of the contact list that this contact belongs to peerId: type: string description: This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session. protocolCallId: type: string description: The original voice protocol call ID, e.g. a SIP call ID provider: type: string description: The source provider for the communication. recording: type: boolean description: Flag determining if an audio recording was started or not remote: type: string description: Name, phone number, or email address of the remote party. remoteNameDisplayable: type: string description: Unique identifier for the remote party removedSkillIds: type: array description: ID(s) of Skill(s) that have been removed by bullseye routing items: type: string requestedRoutings: type: array description: Routing type(s) for requested/attempted routing methods. items: type: string enum: - Bullseye - Conditional - Direct - Last - Manual - Predictive - Preferred - Standard - Vip roomId: type: string description: Unique identifier for the room routingRing: type: integer format: int32 description: Routing ring for bullseye or preferred agent routing routingRule: type: string description: Routing rule for preferred, conditional and predictive routing type routingRuleType: type: string description: Routing rule type enum: - Bullseye - Conditional - Predictive - Preferred screenMonitoredUserId: type: string description: The user ID for the participant who is being screen monitored. screenShareAddressSelf: type: string description: Direct screen share address screenShareRoomId: type: string description: A unique identifier for a Genesys Cloud screen share room scriptId: type: string description: A unique identifier for a script selectedAgentId: type: string description: Selected agent ID selectedAgentRank: type: integer format: int32 description: Selected agent GPR rank sessionDnis: type: string description: Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred sessionId: type: string description: The unique identifier of this session sharingScreen: type: boolean description: Flag determining if screen share is started or not (true/false) skillExpressionId: type: string description: Unique identifier for the skill requested for an interaction skipEnabled: type: boolean description: (Dialer) Whether the agent can skip the dialer contact snippetRecording: type: boolean description: Whether or not the conversation included a snippet being recorded. timeoutSeconds: type: integer format: int32 description: The number of seconds before Genesys Cloud begins the call for a call back (0 disables automatic calling) usedRouting: type: string description: Complete routing method enum: - Bullseye - Conditional - Direct - Last - Manual - Predictive - Preferred - Standard - Vip videoAddressSelf: type: string description: Direct Video address videoRoomId: type: string description: A unique identifier for a Genesys Cloud video room waitingInteractionCounts: type: array description: Number of waiting interactions for each predictive routing attempt items: type: integer format: int32 agentGroups: type: array description: Conditional group routing agent groups items: $ref: '#/definitions/AnalyticsAgentGroup' proposedAgents: type: array description: Proposed agents items: $ref: '#/definitions/AnalyticsProposedAgent' mediaEndpointStats: type: array description: MediaEndpointStats associated with this session items: $ref: '#/definitions/AnalyticsMediaEndpointStat' flow: description: IVR flow execution associated with this session $ref: '#/definitions/AnalyticsFlow' metrics: type: array description: List of metrics for this session items: $ref: '#/definitions/AnalyticsSessionMetric' segments: type: array description: List of segments for this session items: $ref: '#/definitions/AnalyticsConversationSegment' SecureSessionEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/SecureSession' EvaluationQuestion: type: object properties: id: type: string contextId: type: string description: An identifier for this question that stays the same across versions of the form. readOnly: true text: type: string helpText: type: string type: type: string enum: - multipleChoiceQuestion - multipleSelectQuestion - freeTextQuestion - npsQuestion - readOnlyTextBlockQuestion naEnabled: type: boolean commentsRequired: type: boolean visibilityCondition: $ref: '#/definitions/VisibilityCondition' answerOptions: type: array description: Options from which to choose an answer for this question. Only used by Multiple Choice type questions. items: $ref: '#/definitions/AnswerOption' multipleSelectOptionQuestions: type: array description: Only used by Multiple Select type questions. A list of multiple choice questions representing selectable options. items: $ref: '#/definitions/EvaluationQuestion' defaultAnswer: description: The default selected answer for the question $ref: '#/definitions/DefaultAnswer' automatedScoringFocus: type: string description: Focus setting for automated scoring enum: - FullInteraction - EvaluatedAgent isKill: type: boolean isCritical: type: boolean ConversationContentNotificationResponse: type: object required: - notificationStatus - originatingMessageId properties: originatingMessageId: type: string description: Reference to the ID of the original outbound notification message this response is for (e.g. the Apple requestIdentifier). referenceId: type: string description: The business context reference associated with the notification (e.g. order ID, case ID). May be empty if the provider does not return it. notificationStatus: type: string description: The status of the notification response. enum: - Accepted - Declined notificationText: type: string description: The localized display text of the user's response (e.g. "Yes"). description: Inbound response to a notification, such as an Apple Invitations acceptance. ConversationEventVideo: type: object required: - type properties: type: type: string description: Describes the type of Video event. enum: - Offering - OfferingExpired - OfferingAccepted - OfferingRejected offeringId: type: string description: The Video offering ID. jwt: type: string description: The Video offering JWT token. description: A Video event. AppleAuthentication: type: object properties: oauthClientId: type: string description: The Apple Messages for Business OAuth client id. oauthClientSecret: type: string description: The Apple Messages for Business OAuth client secret. oauthTokenUrl: type: string description: The Apple Messages for Business token URL. oauthScope: type: string description: The Apple Messages for Business OAuth scope. ArrayNode: type: object OpenMessagingIdentityResolutionConfig: type: object required: - resolveIdentities properties: division: description: The division to use when performing identity resolution. $ref: '#/definitions/WritableStarrableDivision' resolveIdentities: type: boolean description: Whether the channel should resolve identities externalSource: description: The external source used for stitching this channel. $ref: '#/definitions/IdentityResolutionExternalSource' selfUri: type: string format: uri description: The URI for this object readOnly: true Empty: type: object AiAnswer: type: object properties: answerId: type: string description: The unique identifier of the suggested AI answer. explanation: type: string description: An explanation providing the reasoning behind the suggested answer. failureType: type: string description: Describes the type of error associated with the AI answer. enum: - LowConfidenceError - ParsingError - ServiceError - LowHistoricalAccuracyError AppleIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/AppleIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 EventSetting: type: object properties: typing: description: Settings regarding typing events $ref: '#/definitions/TypingSetting' SuggestionKnowledgeSearch: type: object properties: title: type: string description: The article title. readOnly: true snippets: type: array description: Snippets of text from the article matching the query. readOnly: true items: type: string confidence: type: number format: float description: Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all. readOnly: true searchId: type: string description: The search id. readOnly: true document: description: The article matching the query. readOnly: true $ref: '#/definitions/AddressableEntityRef' version: description: The version of the article. readOnly: true $ref: '#/definitions/AddressableEntityRef' knowledgeAnswer: description: The most relevant answer within a searched article for the searched query readOnly: true $ref: '#/definitions/SuggestionKnowledgeAnswer' variations: type: array description: Variations of the article. readOnly: true items: $ref: '#/definitions/AddressableEntityRef' QueueMessagingAddresses: type: object properties: smsAddress: $ref: '#/definitions/DomainEntityRef' openMessagingRecipient: $ref: '#/definitions/DomainEntityRef' whatsAppRecipient: $ref: '#/definitions/DomainEntityRef' InboundMessageRequest: type: object required: - provider properties: queueId: type: string description: The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId flowId: type: string description: The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId provider: type: string description: The name of the provider that is sourcing the email such as Oracle, Salesforce, etc. skillIds: type: array description: The list of skill ID's to use for routing. items: type: string languageId: type: string description: The ID of the language to use for routing. priority: type: integer format: int32 description: The priority to assign to the conversation for routing. attributes: type: object description: The list of attributes to associate with the customer participant. additionalProperties: type: string toAddress: type: string description: The email address of the recipient of the email. toName: type: string description: The name of the recipient of the email. fromAddress: type: string description: The email address of the sender of the email. fromName: type: string description: The name of the sender of the email. subject: type: string description: The subject of the email WrapupCode: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The wrap-up code name. division: description: The division to which this entity belongs. $ref: '#/definitions/StarrableDivision' description: type: string description: The wrap-up code description. dateCreated: type: string format: date-time description: 'Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: type: string description: The ID of the user that created the wrap-up code. modifiedBy: type: string description: The ID of the user that modified the wrap-up code. selfUri: type: string format: uri description: The URI for this object readOnly: true CardParameters: type: object properties: index: type: integer format: int32 description: Index of the card in the carousel template bodyParameters: type: array description: A list of Response Management carousel card body parameter substitutions for the response's messaging template items: $ref: '#/definitions/TemplateParameter' buttonUrlParameters: type: array description: A list of Response Management carousel card button URL parameter substitutions for the response's messaging template items: $ref: '#/definitions/TemplateParameter' description: Template parameters for a single carousel card UserRoutingSkill: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When "Best available skills" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. state: type: string description: Activate or deactivate this routing skill. enum: - active - inactive - deleted skillUri: type: string format: uri description: URI to the organization skill used by this user skill. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id. ConversationSummariesGetResponse: type: object properties: conversation: description: The conversation object. $ref: '#/definitions/AddressableEntityRef' summary: description: The summary of the conversation. $ref: '#/definitions/ConversationSummary' sessionSummaries: type: array description: All the summaries of the session. items: $ref: '#/definitions/ConversationSessionSummary' description: Defines the summaries of a conversation. Signature: type: object properties: enabled: type: boolean description: A toggle to enable the signature on email send. cannedResponseId: type: string description: The identifier referring to an email signature canned response. alwaysIncluded: type: boolean description: A toggle that defines if a signature is always included or only set on the first email in an email chain. inclusionType: type: string description: The configuration to indicate when the signature of a conversation has to be included enum: - Draft - Send - SendOnce AnalyticsAgentGroup: type: object properties: agentGroupId: type: string description: Conditional group routing agent group identifier agentGroupType: type: string description: Conditional group routing agent group type enum: - Group - SkillGroup - Team WhatsAppIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/WhatsAppIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 MemberGroup: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/WritableDivision' type: type: string description: The group type enum: - TEAM - GROUP - SKILLGROUP memberCount: type: integer format: int32 description: The number of members in this group readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true CustomAttributesUpdateRequest: type: object required: - customAttributes - id properties: id: type: string description: Unique identifier for the Custom Attributes record. IDs are created by users. divisions: type: array description: The list of division ids. Use [] if divisions aren't used (Unassigned Division). Omitting or setting to [] clears existing values on update. items: type: string schemaId: type: string description: The id of the schema that dictates which attributes can be included. Required for create, cannot be updated. version: type: integer format: int32 description: The latest version of the Custom Attributes record. Optional for concurrency check on update. customAttributes: type: object description: The map of attribute values. additionalProperties: type: object CallbackConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CallbackConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 FacebookIntegrationUpdateRequest: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Facebook Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: description: Defines the message settings to be applied for this integration $ref: '#/definitions/MessagingSettingRequestReference' pageAccessToken: type: string description: "The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided." userAccessToken: type: string description: "The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided." selfUri: type: string format: uri description: The URI for this object readOnly: true Organization: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string defaultLanguage: type: string description: 'The default language for this organization. Example: ''en''' defaultCountryCode: type: string description: 'The default country code for this organization. Example: ''US''' thirdPartyOrgName: type: string description: The short name for the organization. This field is globally unique and cannot be changed. readOnly: true thirdPartyURI: type: string format: uri domain: type: string features: type: object description: The state of features available for the organization. readOnly: true additionalProperties: type: boolean version: type: integer format: int32 description: The current version of the organization. state: type: string description: The current state. Examples are active, inactive, deleted. enum: - active - inactive - deleted defaultSiteId: type: string supportURI: type: string description: Email address where support tickets are sent to. voicemailEnabled: type: boolean productPlatform: type: string description: Organizations Originating Platform. readOnly: true enum: - GenesysCloud - PureCloud - PureEngage - PureEngageCloud - PureConnect - PureConnectCloud - Unknown selfUri: type: string format: uri description: The URI for this object readOnly: true DataSchema: type: object required: - jsonSchema - version properties: id: type: string description: The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates. name: type: string version: type: integer format: int32 description: The schema's version, a positive integer. Required for updates. appliesTo: type: array description: Indicates the built-in entity type to which this schema applies. readOnly: true items: type: string enum: - CONTACT - CONVERSATION - EXTERNAL_ORGANIZATION - OPEN_ACTION - WORKITEM - DECISION_TABLE - USER_CUSTOM_ATTRIBUTES - EXTERNAL_EVENTS enabled: type: boolean description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. createdBy: description: The URI of the user that created this schema. readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true jsonSchema: example: "{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}" description: A JSON schema defining the extension to the built-in entity type. $ref: '#/definitions/JsonSchemaDocument' selfUri: type: string format: uri description: The URI for this object readOnly: true InstagramId: type: object required: - ids properties: ids: type: array description: The set of scopedIds that this person has. Each scopedId is specific to an Instagram page or app that the user interacts with. Max 1 id. uniqueItems: true items: $ref: '#/definitions/InstagramScopedId' displayName: type: string description: 'The displayName of the person who owns this Instagram account. Max: 100 characters.' handle: type: string description: 'The handle of the person who owns this Instagram account. Max: 100 characters.' description: User information for an Instagram account ConversationContentInput: type: object required: - isMultipleLine - isRequired properties: id: type: string description: Unique identifier for the input title: type: string description: The main text displayed for the input field(s). subtitle: type: string description: Additional text providing more details about the input field(s). placeholderText: type: string description: Placeholder text for input field(s). isRequired: type: boolean description: Whether the input field(s) are required to be filled in. isMultipleLine: type: boolean description: Whether the input should allow multiple lines of text. keyboardType: type: string description: Type of keyboard to be shown. enum: - Default - NumberPunctuation - Number - Phone - Email - Decimal - Websearch - URL autoCompleteType: type: string description: A string value representing the keyboard and system information about the expected semantic meaning for the content that users enter. enum: - Prefix - Name - GivenName - MiddleName - FamilyName - Suffix - Nickname - Title - Organization - Location - StreetAddress - Addressline1 - Addressline2 - City - State - Country - PostalCode - Username - OneTimeCode - Email - Phone - PaymentCardNumber - PaymentCardExpiration - PaymentCardExpirationMonth - PaymentCardExpirationYear - PaymentCardSecurityCode - PaymentCardType - PaymentCardName - PaymentCardGivenName - PaymentCardMiddleName - PaymentCardFamilyName - Birthdate - BirthdateDay - BirthdateMonth - BirthdateYear - DateTime - FlightNumber - Url description: Single or multiline text input component. TwitterIntegrationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/TwitterIntegration' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 QuestionGroupSettings: type: object properties: questionGroupContextId: type: string description: The context id of the question group in the form. questionSettings: type: array items: $ref: '#/definitions/QuestionSettings' JsonSearchResponse: type: object required: - pageCount - pageNumber - pageSize - results - total - types properties: total: type: integer format: int64 description: The total number of results found pageCount: type: integer format: int32 description: The total number of pages pageSize: type: integer format: int32 description: The current page size pageNumber: type: integer format: int32 description: The current page number types: type: array description: Resource types the search was performed against items: type: string results: description: Search results $ref: '#/definitions/ArrayNode' aggregations: $ref: '#/definitions/ArrayNode' StarrableDivision: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true MessageConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/MessageMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true LocationEmergencyNumber: type: object properties: e164: type: string number: type: string type: type: string description: The type of emergency number. enum: - default - elin LineUserId: type: object required: - userId properties: userId: type: string description: 'The unique channel-specific userId for the user. Max: 255 characters.' description: Channel-specific User ID for Line accounts WhatsAppEmbeddedSignupIntegrationActivationRequest: type: object required: - phoneNumber - pin properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: WhatsApp Integration name readOnly: true phoneNumber: type: string description: Phone number to associate with the WhatsApp integration pin: type: string description: Specify the two-step verification PIN for that phone number selfUri: type: string format: uri description: The URI for this object readOnly: true SurveyDetailQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - eventTime - queueId - surveyCompletedDate - surveyFormContextId - surveyFormId - surveyId - surveyPartialResponse - surveyPromoterScore - surveyStatus - surveyType - userId x-genesys-entity-type: value: DIMENSION_TYPE metric: type: string description: Left hand side for metric predicates enum: - oSurveyTotalScore operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension or metric predicates x-genesys-entity-type: value: DIMENSION_SELECTOR range: description: Right hand side for dimension or metric predicates $ref: '#/definitions/NumericRange' EmployerInfo: type: object properties: officialName: type: string employeeId: type: string employeeType: type: string dateHire: type: string SendAgentlessOutboundMessageRequest: type: object required: - fromAddress - toAddressMessengerType properties: fromAddress: type: string description: The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp, Open and Apple messenger types use the provisioned integration’s ID. For WebMessaging use the DeploymentId toAddress: type: string description: The messaging address of the recipient of the message. For an Apple Invitation and SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555. For WebMessaging this cannot be used, instead use externalContactId toAddressMessengerType: type: string description: The recipient messaging address messenger type. enum: - sms - whatsapp - open - webmessaging - apple textBody: type: string description: 'The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters.' messagingTemplate: description: The messaging template to use in the case of WhatsApp messenger type. This field is required when using WhatsApp messenger type $ref: '#/definitions/SendMessagingTemplateRequest' useExistingActiveConversation: type: boolean description: 'Use an existing active conversation to send the agentless outbound message. Set this parameter to ''true'' to use active conversation. Default value: false' ContactIdentifier: type: object required: - type - value properties: division: description: The division to which this entity belongs. $ref: '#/definitions/WritableStarrableDivision' type: type: string description: The type of this identifier enum: - SocialLine - SocialFacebook - SocialTwitter - SocialWhatsapp - SocialInstagram - SocialWhatsappBsuid - AppleOpaqueId - Email - Phone - Cookie - ExternalId value: type: string description: 'The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped.' dateCreated: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' externalSource: description: The External Source ID of the identifier $ref: '#/definitions/ExternalSource' AggregateMetricData: type: object properties: metric: type: string qualifier: type: string stats: $ref: '#/definitions/StatisticalSummary' Ticker: type: object required: - exchange - symbol properties: symbol: type: string description: 'The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc.' exchange: type: string description: 'The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc.' TwitterIntegration: type: object required: - id - name - version properties: id: type: string description: A unique Integration ID readOnly: true name: type: string description: The name of the Twitter Integration supportedContent: description: Defines the SupportedContent profile configured for an integration $ref: '#/definitions/SupportedContentReference' messagingSetting: $ref: '#/definitions/MessagingSettingReference' status: type: string description: The status of the Twitter Integration recipient: description: The recipient reference associated with the Twitter Integration This recipient is used to associate a flow to an integration readOnly: true $ref: '#/definitions/DomainEntityRef' dateCreated: type: string format: date-time description: 'Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateModified: type: string format: date-time description: 'Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User reference that created this Integration $ref: '#/definitions/DomainEntityRef' modifiedBy: description: User reference that last modified this Integration $ref: '#/definitions/DomainEntityRef' version: type: integer format: int32 description: Version number required for updates createStatus: type: string description: Status of asynchronous create operation readOnly: true enum: - Initiated - Completed - Error createError: description: Error information returned, if createStatus is set to Error readOnly: true $ref: '#/definitions/ErrorBody' selfUri: type: string format: uri description: The URI for this object readOnly: true RoutingRule: type: object properties: operator: type: string description: matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score. enum: - MEETS_THRESHOLD - ANY threshold: type: integer format: int32 description: threshold required for routing attempt (generally an agent score). may be null for operator ANY. waitSeconds: type: number format: double description: seconds to wait in this rule before moving to the next CreateCallbackOnConversationCommand: type: object required: - callbackNumbers properties: scriptId: type: string description: The identifier of the script to be used for the callback queueId: type: string description: The identifier of the queue to be used for the callback. Either queueId or routingData is required. routingData: description: The routing data to be used for the callback. Either queueId or routingData is required. $ref: '#/definitions/RoutingData' customerFirstCallbackDeliveryMode: type: string description: How customer-first callback agent reservation is applied for this callback. useAgentReservation forces reservation on; noAgentReservation forces it off; useQueueSetting uses the queue configuration. enum: - UseQueueSetting - UseAgentReservation - NoAgentReservation callbackUserName: type: string description: The name of the party to be called back. callbackNumbers: type: array description: A list of phone numbers for the callback. items: type: string callbackScheduledTime: type: string format: date-time example: '2015-01-02T16:59:59.000Z' description: 'The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' countryCode: type: string description: The country code to be associated with the callback numbers. validateCallbackNumbers: type: boolean description: Whether or not to validate the callback numbers for phone number format. data: type: object description: 'A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { "notes": "ready to close the deal!", "customerPreferredName": "Doc" }' additionalProperties: type: string callerId: type: string description: The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for "callerId" varies. callerIdName: type: string description: The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for "callerIdName" varies. AnalyticsQueryAggregation: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - termFrequency - numericRange dimension: type: string description: For use with termFrequency aggregations metric: type: string description: For use with numericRange aggregations size: type: integer format: int32 description: For use with termFrequency aggregations ranges: type: array description: For use with numericRange aggregations items: $ref: '#/definitions/AggregationRange' InboundRoute: type: object required: - fromName - pattern properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string pattern: type: string description: The search pattern that the mailbox name should match. queue: description: The queue to route the emails to. $ref: '#/definitions/DomainEntityRef' priority: type: integer format: int32 description: The priority to use for routing. skills: type: array description: The skills to use for routing. items: $ref: '#/definitions/DomainEntityRef' language: description: The language to use for routing. $ref: '#/definitions/DomainEntityRef' fromName: type: string description: The sender name to use for outgoing replies. fromEmail: type: string description: The sender email to use for outgoing replies. flow: description: The flow to use for processing the email. $ref: '#/definitions/DomainEntityRef' replyEmailAddress: description: The route to use for email replies. $ref: '#/definitions/QueueEmailAddress' autoBcc: type: array description: The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute. items: $ref: '#/definitions/EmailAddress' spamFlow: description: The flow to use for processing inbound emails that have been marked as spam. $ref: '#/definitions/DomainEntityRef' signature: description: The configuration for the canned response signature that will be appended to outbound emails sent via this route $ref: '#/definitions/Signature' historyInclusion: type: string description: The configuration to indicate how the history of a conversation has to be included in a draft enum: - Include - Exclude - Optional allowMultipleActions: type: boolean description: Control if multiple actions are allowed on this route. When true the disconnect has to be done manually. When false a conversation will be disconnected by the system after every action mailboxFolders: type: array description: Integration Folder routed to this route items: type: string status: type: string description: The status of the route. readOnly: true enum: - Pending - Active - Removing - Error selfUri: type: string format: uri description: The URI for this object readOnly: true ChecklistInferenceJobResponse: type: object required: - id - status properties: id: type: string description: ID of the inference job. status: type: string description: Status of the checklist inference job. enum: - Processing - Error - Complete error: description: Error information associated with a job in case of any errors. $ref: '#/definitions/ErrorInfo' agentChecklistInfo: description: Agent checklist info. $ref: '#/definitions/AgentChecklistInfo' jobStartTime: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the inference job started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' jobEndTime: type: string format: date-time example: '2025-08-06T03:52:10.150Z' description: 'Date when the inference job finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' language: type: string description: Language associated with the checklist. agentId: type: string description: Agent ID. participantId: type: string description: Participant ID. queueId: type: string description: Queue ID. assistantId: type: string description: Assistant ID. mediaType: type: string description: Media type. enum: - Voice - Message - Email direction: type: string description: Direction of the conversation. enum: - Inbound - Outbound selfUri: type: string format: uri description: The URI for this object readOnly: true CallbackConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/CallbackMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true UserParam: type: object properties: key: type: string value: type: string OpenStructuredResponseNormalizedMessage: type: object required: - channel - type properties: id: type: string description: Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference, as such should only be set when sending a message receipt. channel: description: Channel-specific information that describes the message and the message channel/provider. $ref: '#/definitions/OpenMessagingChannel' type: type: string description: Message type. enum: - Structured direction: type: string description: The direction of the message. enum: - Inbound content: type: array description: List of content elements. items: $ref: '#/definitions/OpenInboundStructuredResponseNormalizedMessageContent' metadata: type: object description: Additional metadata about this message. additionalProperties: type: string description: Open Messaging rich media response normalized message structure Settings: type: object properties: communicationBasedACW: type: boolean description: Communication Based ACW includeNonAgentConversationSummary: type: boolean description: Display communication summary allowCallbackQueueSelection: type: boolean description: Allow Callback Queue Selection callbacksInheritRoutingFromInboundCall: type: boolean description: Inherit callback routing data from inbound calls completeAcwWhenAgentTransitionsOffline: type: boolean description: Complete ACW When Agent Transitions Offline totalActiveCallback: type: boolean description: Exclude the 'interacting' duration from the handle calculations of callbacks Chat: type: object properties: jabberId: type: string CobrowseConversation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string participants: type: array description: The list of participants involved in the conversation. items: $ref: '#/definitions/CobrowseMediaParticipant' otherMediaUris: type: array description: The list of other media channels involved in the conversation. items: type: string format: uri recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' divisions: type: array description: Identifiers of divisions associated with this conversation. items: $ref: '#/definitions/ConversationDivisionMembership' selfUri: type: string format: uri description: The URI for this object readOnly: true EmailConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/EmailConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 JourneyContext: type: object required: - customer properties: customer: description: A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomer' customerSession: description: A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomerSession' triggeringAction: description: A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) $ref: '#/definitions/JourneyAction' QueueEmailAddress: type: object properties: domain: $ref: '#/definitions/DomainEntityRef' route: $ref: '#/definitions/InboundRoute' WorkspaceSummary: type: object properties: totalDocumentCount: type: integer format: int64 totalDocumentByteCount: type: integer format: int64 JsonCursorSearchResponse: type: object required: - results - types properties: types: type: array description: Resource types the search was performed against items: type: string results: description: Search results $ref: '#/definitions/ArrayNode' aggregations: $ref: '#/definitions/ArrayNode' cursor: type: string description: The page cursor Items: type: object properties: type: type: string pattern: type: string SchemaQuantityLimits: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string minFieldNameCharacters: type: integer format: int32 example: '"minFieldNameCharacters":1' description: The minimum number of schema field name characters allowed. readOnly: true maxFieldNameCharacters: type: integer format: int32 example: '"maxFieldNameCharacters":100' description: The maximum number of schema field name characters allowed. readOnly: true minFieldTitleCharacters: type: integer format: int32 example: '"minFieldTitleCharacters":1' description: The minimum number of schema field title characters allowed. readOnly: true maxFieldTitleCharacters: type: integer format: int32 example: '"maxFieldTitleCharacters":100' description: The maximum number of schema field title characters allowed. readOnly: true minFieldDescriptionCharacters: type: integer format: int32 example: '"minFieldDescriptionCharacters":0' description: The minimum number of schema field description characters allowed. readOnly: true maxFieldDescriptionCharacters: type: integer format: int32 example: '"maxFieldDescriptionCharacters":200' description: The maximum number of schema field description characters allowed. readOnly: true minSchemaNameCharacters: type: integer format: int32 example: '"minSchemaNameCharacters":1' description: The minimum number of schema name characters allowed. readOnly: true maxSchemaNameCharacters: type: integer format: int32 example: '"maxSchemaNameCharacters":50' description: The maximum number of schema name characters allowed. readOnly: true minSchemaDescriptionCharacters: type: integer format: int32 example: '"minSchemaDescriptionCharacters":0' description: The minimum number of schema description characters allowed. readOnly: true maxSchemaDescriptionCharacters: type: integer format: int32 example: '"maxSchemaDescriptionCharacters":200' description: The maximum number of schema description characters allowed. readOnly: true maxNumberOfSchemasPerOrg: type: integer format: int32 example: '"maxNumberOfSchemasPerOrg":20' description: The maximum number of schema allowed per org. readOnly: true maxNumberOfFieldsPerSchema: type: integer format: int32 example: '"maxNumberOfFieldsPerSchema":25' description: The maximum number of schema fields allowed per schema. readOnly: true maxNumberOfFieldsPerOrg: type: integer format: int32 example: '"maxNumberOfFieldsPerOrg":500' description: The maximum number of schema fields allowed per organization across all of their schemas. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true Actions: type: object properties: skillsToRemove: type: array uniqueItems: true items: $ref: '#/definitions/SkillsToRemove' TranscriptTopic: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the object. readOnly: true topicPhrase: type: string description: 'The phrase which detected the topic. ' readOnly: true transcriptPhrase: type: string description: The transcript phrase which detected the topic. readOnly: true confidence: type: integer format: int32 description: The detection confidence of the topic. readOnly: true startTimeMilliseconds: type: integer format: int64 description: The start time of the topic phrase. readOnly: true duration: $ref: '#/definitions/TopicDuration' offset: description: Location of the phrase readOnly: true $ref: '#/definitions/TopicOffset' recordingLocation: type: integer format: int64 description: Location of the phrase in the recording in milliseconds readOnly: true ConversationQueueMediaSettings: type: object properties: alertingTimeoutSeconds: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. autoAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for auto answered interactions. manualAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for manually answered interactions. enableAutoAnswer: type: boolean description: Flag to indicate if auto answer is enabled for the given media type or media subtype. Coretype: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string version: type: integer format: int32 description: A positive integer denoting the core type's version dateCreated: type: string format: date-time description: 'The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' schema: description: The core type's built-in schema $ref: '#/definitions/Schema' current: type: boolean description: A boolean indicating if the core type's version is the current one in use by the system validationFields: type: array description: An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type. items: type: string validationLimits: example: '"validationLimits": { "minLength": {"min": 0, "max": 100}, "maxLength": {"min": 1, "max": 100} }' description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. $ref: '#/definitions/ValidationLimits' itemValidationFields: type: array description: Specific to the "tag" core type, this is an array of strings naming the tag item fields of the core type subject to validation items: type: string itemValidationLimits: example: "\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}" description: A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as "tag" and "enum". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags. $ref: '#/definitions/ItemValidationLimits' selfUri: type: string format: uri description: The URI for this object readOnly: true UserReference: type: object properties: id: type: string description: The globally unique identifier for the object. selfUri: type: string format: uri description: The URI for this object readOnly: true DispositionAmdTimeout: type: object properties: timeoutMs: type: integer format: int32 description: Configured AMD timeout value. timerStartEvent: type: string description: Configured option for when to start the AMD timer, such as on line connect or speech start. timerStartTime: type: string format: date-time description: 'Timer start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' timerEndTime: type: string format: date-time description: 'Timer end time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationReason: type: object required: - message properties: code: type: string description: The reason code for the failed message receipt. enum: - MessageExpired - RateLimited - MessageNotAllowed - GeneralError - UnsupportedMessage - UnknownMessage - InvalidMessageStructure - InvalidDestination - ServerError - MediaTypeNotAllowed - InvalidMediaContentLength - RecipientOptedOut - DataFiltered message: type: string description: Description of the reason for the failed message receipt. description: Reasons for a failed message receipt. SegmentDetailQueryFilter: type: object required: - type properties: type: type: string description: Boolean operation to apply to the provided predicates and clauses enum: - and - or clauses: type: array description: Boolean 'and/or' logic with up to two-levels of nesting items: $ref: '#/definitions/SegmentDetailQueryClause' predicates: type: array description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).' items: $ref: '#/definitions/SegmentDetailQueryPredicate' DraftManipulationRequest: type: object properties: translate: description: A set of definitions to translate email attributes and correctly display date and time, for a given language $ref: '#/definitions/HistoryHeadersTranslation' draftType: type: string description: The kind of draft that as to be treated. Used to prefix response subject or auto-include information enum: - Reply - ReplyAll - Forward CustomAttributesListing: type: object properties: results: type: array items: $ref: '#/definitions/CustomAttributes' ConversationContentPush: type: object required: - deviceToken - deviceTokenId - deviceType - expiration - failedMessages - notificationMessage - pushProviderIntegration properties: deviceType: type: string description: The device type used to send the push notification enum: - Android - IOS deviceTokenId: type: string description: Unique Id of the device token deviceToken: type: string description: device token from the notification provider failedMessages: type: array description: MessageIds failed to be sent which trigger the push event items: $ref: '#/definitions/ConversationPushFailedMessageReferences' notificationMessage: description: Title and body localized according to deployment $ref: '#/definitions/ConversationPushNotificationMessageLabel' pushProviderIntegration: description: Push provider integrations details configured on the deployment $ref: '#/definitions/ConversationPushProviderIntegration' expiration: type: integer format: int64 description: The time to live of the pushed message description: A Push object EngagementRequest: type: object properties: visibility: type: string description: Represents the visibility of summary enum: - Presented - NotPresented - Unknown status: type: string description: Represents the engagements made by the agent in response to the generated summary enum: - Copied - NotCopied - Unknown VisibilityCondition: type: object properties: combiningOperation: type: string enum: - AND - OR predicates: type: array description: 'A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of "/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}" or, to assume the current question group, "../question/{questionIndex}/answer/{answerIndex}". Note: Indexes are zero-based' items: type: object TopicOffset: type: object properties: wordCount: type: integer format: int64 description: 'Count of words before the topic ' readOnly: true characterCount: type: integer format: int64 description: 'Count of characters before the topic ' readOnly: true Digits: type: object properties: digits: type: string description: A string representing the digits pressed on phone. WritableStarrableDivision: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true EvaluationDetailQueryPredicate: type: object properties: type: type: string description: Optional type, can usually be inferred enum: - dimension - property - metric dimension: type: string description: Left hand side for dimension predicates enum: - assigneeApplicable - assigneeId - calibrationId - contextId - deleted - evaluationId - evaluationStatus - evaluatorId - eventTime - formId - formName - queueId - released - rescored - systemSubmitted - userId x-genesys-entity-type: value: DIMENSION_TYPE metric: type: string description: Left hand side for metric predicates enum: - oTotalCriticalScore - oTotalScore operator: type: string description: Optional operator, default is matches enum: - matches - exists - notExists value: type: string description: Right hand side for dimension or metric predicates x-genesys-entity-type: value: DIMENSION_SELECTOR range: description: Right hand side for dimension or metric predicates $ref: '#/definitions/NumericRange' SecureSession: type: object required: - flow - state properties: id: type: string description: The globally unique identifier for the object. readOnly: true flow: description: The flow to execute securely $ref: '#/definitions/DomainEntityRef' userData: type: string description: Customer-provided data state: type: string description: The current state of a secure session enum: - PENDING - COMPLETED - FAILED sourceParticipantId: type: string description: Unique identifier for the participant initiating the secure session. disconnect: type: boolean description: If true, disconnect the agent after creating the session selfUri: type: string format: uri description: The URI for this object readOnly: true AgentChecklistResponseList: type: object properties: entities: type: array items: $ref: '#/definitions/AgentChecklistResponse' nextUri: type: string selfUri: type: string previousUri: type: string OpenInboundMessagingChannel: type: object required: - from - time properties: from: description: Information about the recipient the message is received from. $ref: '#/definitions/OpenMessagingFromRecipient' time: type: string format: date-time description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' description: Open Channel-specific information that describes the message and the message channel/provider. WebChatMessage: type: object required: - body - bodyType - conversation - sender - timestamp properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversation: description: The identifier of the conversation $ref: '#/definitions/WebChatConversation' sender: description: The member who sent the message $ref: '#/definitions/WebChatMemberInfo' body: type: string description: The message body. bodyType: type: string description: The purpose of the message within the conversation, such as a standard text entry versus a greeting. enum: - standard - notice - member-join - member-leave - media-request timestamp: type: string format: date-time description: The timestamp of the message, in ISO-8601 format selfUri: type: string format: uri description: The URI for this object readOnly: true Group: type: object required: - name - rulesVisible - type - visibility properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The group name. description: type: string dateModified: type: string format: date-time description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members. readOnly: true state: type: string description: Active, inactive, or deleted state. readOnly: true enum: - active - inactive - deleted version: type: integer format: int32 description: Current version for this resource. readOnly: true type: type: string description: Type of group. enum: - official - social images: type: array items: $ref: '#/definitions/Image' addresses: type: array items: $ref: '#/definitions/GroupContact' rulesVisible: type: boolean description: Are membership rules visible to the person requesting to view the group visibility: type: string description: Who can view this group enum: - public - owners - members rolesEnabled: type: boolean description: Allow roles to be assigned to this group includeOwners: type: boolean description: Allow owners to be included as members of the group callsEnabled: type: boolean description: Allow calls to be placed to this group. owners: type: array description: Owners of the group items: $ref: '#/definitions/User' selfUri: type: string format: uri description: The URI for this object readOnly: true Evaluation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversation: $ref: '#/definitions/ConversationReference' evaluationForm: description: Evaluation form used for evaluation. $ref: '#/definitions/EvaluationForm' evaluator: $ref: '#/definitions/User' agent: $ref: '#/definitions/User' calibration: $ref: '#/definitions/Calibration' status: type: string enum: - PENDING - INPROGRESS - FINISHED - INREVIEW - RETRACTED answers: $ref: '#/definitions/EvaluationScoringSet' agentHasRead: type: boolean assignee: $ref: '#/definitions/User' assigneeApplicable: type: boolean description: Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable. releaseDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' assignedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' changedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' submittedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' revisionCreatedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' queue: $ref: '#/definitions/Queue' mediaType: type: array description: List of different communication types used in conversation. items: type: string enum: - CALL - CALLBACK - CHAT - COBROWSE - EMAIL - MESSAGE - INTERNAL_MESSAGE - SCREEN_MONITORING - SOCIAL_EXPRESSION - VIDEO - SCREENSHARE divisionIds: type: array description: Evaluation is assigned in the following division(s). items: type: string rescore: type: boolean description: Is only true when evaluation is re-scored. conversationDate: type: string format: date-time description: 'Creation date of the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' conversationEndDate: type: string format: date-time description: 'End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' neverRelease: type: boolean description: Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. assigned: type: boolean description: Set to false to unassign the evaluation. This cannot be set to false when assignee is also set. dateAssigneeChanged: type: string format: date-time description: 'Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resourceId: type: string description: Only used for email evaluations. Will be null for all other evaluations. resourceType: type: string description: The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. enum: - EMAIL redacted: type: boolean description: Is only true when the user making the request does not have sufficient permissions to see evaluation agentTeam: description: Team of the evaluation agent $ref: '#/definitions/Team' isScoringIndex: type: boolean authorizedActions: type: array description: 'List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit' items: type: string hasAssistanceFailed: type: boolean description: Is true when evaluation assistance didn't execute successfully evaluationSource: description: The source that created the evaluation. readOnly: true $ref: '#/definitions/EvaluationSource' disputeCount: type: integer format: int32 description: The number of times this evaluation has been disputed readOnly: true version: type: integer format: int32 description: The evaluation version number readOnly: true versionHistory: description: List of all versions of the evaluation readOnly: true $ref: '#/definitions/PagelessDomainEntityListingEvaluationVersion' declinedReview: type: boolean description: Is true when the evaluation review was declined evaluationContextId: type: string description: The shared id for different versions of an evaluation retractedEvaluation: description: The previous evaluation version $ref: '#/definitions/EvaluationReference' aiScoring: description: AI scoring details for the evaluation. readOnly: true $ref: '#/definitions/AiScoring' selfUri: type: string format: uri description: The URI for this object readOnly: true DynamicContactQueueingSettings: type: object properties: sort: type: boolean description: Whether to sort contacts dynamically filter: type: boolean description: Whether to filter contacts dynamically Location: type: object properties: id: type: string description: Unique identifier for the location floorplanId: type: string description: Unique identifier for the location floorplan image readOnly: true coordinates: type: object description: Users coordinates on the floorplan. Only used when floorplanImage is set additionalProperties: type: number format: double notes: type: string description: Optional description on the users location locationDefinition: $ref: '#/definitions/LocationDefinition' EmailsSettings: type: object properties: sendingSizeLimit: type: integer format: int32 ConversationAsyncAggregationQuery: type: object required: - interval - metrics properties: interval: type: string format: interval description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' granularity: type: string description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H' timeZone: type: string description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' groupBy: type: array description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. items: type: string enum: - activeRouting - activeSkillId - addressFrom - addressTo - agentAssistantId - agentBullseyeRing - agentOwned - agentRank - agentScore - ani - assignerId - authenticated - conversationId - conversationInitiator - convertedFrom - convertedTo - customerParticipation - deliveryStatus - destinationAddress - direction - disconnectType - divisionId - dnis - edgeId - eligibleAgentCount - errorCode - extendedDeliveryStatus - externalContactId - externalMediaCount - externalOrganizationId - externalTag - firstQueue - flaggedReason - flowInType - flowOutType - groupId - interactionType - journeyActionId - journeyActionMapId - journeyActionMapVersion - journeyCustomerId - journeyCustomerIdType - journeyCustomerSessionId - journeyCustomerSessionIdType - knowledgeBaseId - mediaCount - mediaType - messageType - originatingDirection - originatingSocialMediaPublic - outboundCampaignId - outboundContactId - outboundContactListId - participantName - peerId - proposedAgentId - provider - purpose - queueId - remote - removedSkillId - requestedLanguageId - requestedRouting - requestedRoutingSkillId - roomId - routingPriority - routingRing - routingRule - routingRuleType - scoredAgentId - selectedAgentId - selectedAgentRank - selfServed - sessionDnis - sessionId - skillExpressionId - stationId - teamId - usedRouting - userId - videoPresent - waitingInteractionCount - wrapUpCode filter: description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters $ref: '#/definitions/ConversationAggregateQueryFilter' metrics: type: array description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved. items: type: string enum: - nBlindTransferred - nBotInteractions - nCallbackAttempts - nCallbackOverSla - nCallbackScheduled - nCfcOffered - nCobrowseSessions - nConnected - nConsult - nConsultTransferred - nConversations - nError - nOffered - nOutbound - nOutboundAbandoned - nOutboundAttempted - nOutboundConnected - nOverSla - nStateTransitionError - nTakeover - nTransferred - oAudioMessageCount - oCallbackServiceLevel - oExternalAudioMessageCount - oExternalMediaCount - oMediaCount - oMessageCount - oMessageSegmentCount - oMessageTurn - oServiceLevel - oServiceTarget - oSkillExpressionApplications - tAbandon - tAcd - tActiveCallback - tActiveCallbackComplete - tAcw - tAgentResponseTime - tAgentVideoConnected - tAlert - tAnswered - tAverageAgentResponseTime - tAverageCustomerResponseTime - tBarging - tCallbackAbandon - tCallbackConnect - tCallbackNotReached - tCallbackVirtualWait - tCfcAbandon - tCfcAcd - tCfcAnswered - tCfcFlowOut - tCoaching - tCoachingComplete - tConnected - tContacting - tDialing - tFirstConnect - tFirstDial - tFirstEngagement - tFirstResponse - tFlowOut - tHandle - tHeld - tHeldComplete - tIvr - tMonitoring - tMonitoringComplete - tNotResponding - tPark - tParkComplete - tScreenMonitoring - tShortAbandon - tSnippetRecord - tTalk - tTalkComplete - tTransmitting - tUserResponseTime - tVoicemail - tWait flattenMultivaluedDimensions: type: boolean description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') views: type: array description: Custom derived metric views items: $ref: '#/definitions/ConversationAggregationView' alternateTimeDimension: type: string description: Dimension to use as the alternative timestamp for data in the aggregate. Choosing "eventTime" uses the actual time of the data event. enum: - eventTime queryType: type: string description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy. enum: - bottomN - groupBy - topN sortMetric: description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type. $ref: '#/definitions/ConversationAggregationSort' limit: type: integer format: int32 description: How many results you want in an ordered list. Only applicable for topN/bottomN query type. pageSize: type: integer format: int32 description: The number of results per page Segment: type: object required: - endTime - startTime properties: startTime: type: string format: date-time description: 'The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' type: type: string description: The activity taking place for the participant in the segment. howEnded: type: string description: A description of the event that ended the segment. disconnectType: type: string description: A description of the event that disconnected the segment CobrowseConversationEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CobrowseConversation' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 ChecklistInferenceJobPayload: type: object required: - conversationContext properties: conversationContext: type: array description: List of conversations on which checklist evaluation is to be done. items: $ref: '#/definitions/ConversationContext' LinkConfiguration: type: object required: - uriTemplate properties: uriTemplate: type: string description: Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 400 characters. AggregationRange: type: object properties: gte: type: number description: Greater than or equal to lt: type: number description: Less than BulkError: type: object properties: message: type: string description: Error message of the bulk operation result. code: type: string description: Error code of the bulk operation result. ConversationMessagingFromRecipient: type: object required: - id properties: nickname: type: string description: Nickname or display name of the recipient. readOnly: true id: type: string description: The recipient ID specific to the provider. idType: type: string description: The recipient ID type. This is used to indicate the format used for the ID. readOnly: true enum: - Email - Phone - Opaque image: type: string description: URL of an image that represents the recipient. firstName: type: string description: First name of the recipient. lastName: type: string description: Last name of the recipient. email: type: string description: E-mail address of the recipient. readOnly: true externalContactId: type: string description: The identifier of the external contact. additionalIds: type: array description: List of recipient additional identifiers readOnly: true items: $ref: '#/definitions/ConversationRecipientAdditionalIdentifier' description: Information about the recipient the message is received from. securityDefinitions: PureCloud OAuth: type: oauth2 authorizationUrl: https://login.mypurecloud.com/authorize flow: implicit scopes: all: All the scopes Guest Chat JWT: type: apiKey name: Authorization in: header externalDocs: description: PureCloud API Documentation url: https://developer.genesys.cloud/