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 Recording 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: Recording description: Recordings, policies, annotations, orphans externalDocs: description: Recording Documentation url: https://developer.genesys.cloud/analyticsdatamanagement/recording/ paths: /api/v2/recording/crossplatform/mediaretentionpolicies: get: tags: - Recording summary: Gets media retention policy list with query options to filter on name and enabled. description: for a less verbose response, add summary=true to this endpoint operationId: getRecordingCrossplatformMediaretentionpolicies produces: - application/json parameters: - name: pageSize in: query description: The total page size requested required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: The page number requested required: false type: integer default: 1 format: int32 - name: sortBy in: query description: variable name requested to sort by required: false type: string - name: expand in: query description: variable name requested by expand list required: false type: array items: type: string collectionFormat: multi - name: nextPage in: query description: next page token required: false type: string - name: previousPage in: query description: Previous page token required: false type: string - name: name in: query description: the policy name - used for filtering results in searches. required: false type: string - name: enabled in: query description: checks to see if policy is enabled - use enabled = true or enabled = false required: false type: boolean - name: summary in: query description: provides a less verbose response of policy lists. required: false type: boolean default: false - name: hasErrors in: query description: provides a way to fetch all policies with errors or policies that do not have errors required: false type: boolean - name: deleteDaysThreshold in: query description: provides a way to fetch all policies with any actions having deleteDays exceeding the provided value required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/PolicyEntityListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:view x-purecloud-method-name: getRecordingCrossplatformMediaretentionpolicies post: tags: - Recording summary: Create media retention policy description: Policy does not work retroactively operationId: postRecordingCrossplatformMediaretentionpolicies produces: - application/json parameters: - in: body name: body description: Policy required: true schema: $ref: '#/definitions/CrossPlatformPolicyCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/CrossPlatformPolicy' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.media.policy.invalid: One of the configured actions or conditions was invalid. bad.request: The request could not be understood by the server due to malformed syntax. recording.policy.assign.evaluation.evaluator.permission.check.failed: evaluator permission failure for evaluation recording.policy.assign.calibration.evaluator.permission.check.failed: Calibrator permission failure invalid.property: Value [%s] is not a valid property for object [%s] recording.policy.export.integration.invalid: The specified export integration is not a valid integration. constraint.validation: '%s' recording.policy.assign.metered.evaluation.evaluator.permission.check.failed: evaluator permission failure for metered evaluation recording.policy.calibrator.permission.fail: General calibrator permission failure recording.policy.export.integration.disabled: The specified export integration is not in active state. recording.policy.invalid.queue: The specified queues was invalid. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:add x-purecloud-method-name: postRecordingCrossplatformMediaretentionpolicies delete: tags: - Recording summary: Delete media retention policies description: Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. operationId: deleteRecordingCrossplatformMediaretentionpolicies produces: - application/json parameters: - name: ids in: query 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 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:delete x-purecloud-method-name: deleteRecordingCrossplatformMediaretentionpolicies /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}: get: tags: - Recording summary: Get a media retention policy description: '' operationId: getRecordingCrossplatformMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CrossPlatformPolicy' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:view x-purecloud-method-name: getRecordingCrossplatformMediaretentionpolicy put: tags: - Recording summary: Update a media retention policy description: Policy does not work retroactively operationId: putRecordingCrossplatformMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string - in: body name: body description: Policy required: true schema: $ref: '#/definitions/CrossPlatformPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/CrossPlatformPolicy' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.media.policy.invalid: One of the configured actions or conditions was invalid. bad.request: The request could not be understood by the server due to malformed syntax. recording.policy.assign.evaluation.evaluator.permission.check.failed: evaluator permission failure for evaluation recording.policy.assign.calibration.evaluator.permission.check.failed: Calibrator permission failure invalid.property: Value [%s] is not a valid property for object [%s] recording.policy.export.integration.invalid: The specified export integration is not a valid integration. constraint.validation: '%s' recording.policy.assign.metered.evaluation.evaluator.permission.check.failed: evaluator permission failure for metered evaluation recording.policy.calibrator.permission.fail: General calibrator permission failure recording.policy.export.integration.disabled: The specified export integration is not in active state. recording.policy.invalid.queue: The specified queues was invalid. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:edit x-purecloud-method-name: putRecordingCrossplatformMediaretentionpolicy delete: tags: - Recording summary: Delete a media retention policy description: '' operationId: deleteRecordingCrossplatformMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID 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 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.policy.not.found: The supplied policy was not found or is invalid not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:delete x-purecloud-method-name: deleteRecordingCrossplatformMediaretentionpolicy patch: tags: - Recording summary: Patch a media retention policy description: '' operationId: patchRecordingCrossplatformMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string - in: body name: body description: Policy required: true schema: $ref: '#/definitions/CrossPlatformPolicyUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/CrossPlatformPolicy' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:crossPlatformRetentionPolicy:edit x-purecloud-method-name: patchRecordingCrossplatformMediaretentionpolicy /api/v2/recording/mediaretentionpolicies: get: tags: - Recording summary: Gets media retention policy list with query options to filter on name and enabled. description: for a less verbose response, add summary=true to this endpoint operationId: getRecordingMediaretentionpolicies produces: - application/json parameters: - name: pageSize in: query description: The total page size requested required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: The page number requested required: false type: integer default: 1 format: int32 - name: sortBy in: query description: variable name requested to sort by required: false type: string - name: expand in: query description: variable name requested by expand list required: false type: array items: type: string collectionFormat: multi - name: nextPage in: query description: next page token required: false type: string - name: previousPage in: query description: Previous page token required: false type: string - name: name in: query description: the policy name - used for filtering results in searches. required: false type: string - name: enabled in: query description: checks to see if policy is enabled - use enabled = true or enabled = false required: false type: boolean - name: summary in: query description: provides a less verbose response of policy lists. required: false type: boolean default: false - name: hasErrors in: query description: provides a way to fetch all policies with errors or policies that do not have errors required: false type: boolean - name: deleteDaysThreshold in: query description: provides a way to fetch all policies with any actions having deleteDays exceeding the provided value required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/PolicyEntityListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:view x-purecloud-method-name: getRecordingMediaretentionpolicies post: tags: - Recording summary: Create media retention policy description: Policy does not work retroactively operationId: postRecordingMediaretentionpolicies produces: - application/json parameters: - in: body name: body description: Policy required: true schema: $ref: '#/definitions/PolicyCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/Policy' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.policy.invalid: The recording policy is invalid. recording.media.policy.invalid: One of the configured actions or conditions was invalid. bad.request: The request could not be understood by the server due to malformed syntax. recording.policy.assign.evaluation.evaluator.permission.check.failed: evaluator permission failure for evaluation recording.policy.assign.calibration.evaluator.permission.check.failed: Calibrator permission failure invalid.property: Value [%s] is not a valid property for object [%s] recording.policy.export.integration.invalid: The specified export integration is not a valid integration. constraint.validation: '%s' recording.policy.assign.metered.evaluation.evaluator.permission.check.failed: evaluator permission failure for metered evaluation recording.policy.assign.metered.assignment.by.agent.evaluator.permission.check.failed: evaluator permission failure for metered assignment by agent recording.policy.calibrator.permission.fail: General calibrator permission failure recording.policy.export.integration.disabled: The specified export integration is not in active state. recording.policy.invalid.queue: The specified queues was invalid. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. recording.policy.name.duplicate.name: Policy name already exists, cannot duplicate. recording.policy.description.exceeds.limit: Policy description exceeds size limit. recording.policy.analytics.retention.violation: Policy retention was violated. recording.policy.assign.survey.sending.domain.does.not.exist: Sending domain does not exist in the organization recording.policy.name.exceeds.limit: Policy named exceeds size limit. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:add x-purecloud-method-name: postRecordingMediaretentionpolicies delete: tags: - Recording summary: Delete media retention policies description: Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. operationId: deleteRecordingMediaretentionpolicies produces: - application/json parameters: - name: ids in: query 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 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:delete x-purecloud-method-name: deleteRecordingMediaretentionpolicies /api/v2/recording/mediaretentionpolicies/{policyId}: get: tags: - Recording summary: Get a media retention policy description: '' operationId: getRecordingMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Policy' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:view x-purecloud-method-name: getRecordingMediaretentionpolicy put: tags: - Recording summary: Update a media retention policy description: 'Policy does not work retroactively. In the conditions.forUsers section, each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' operationId: putRecordingMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string - in: body name: body description: Policy required: true schema: $ref: '#/definitions/Policy' responses: '200': description: successful operation schema: $ref: '#/definitions/Policy' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.media.policy.invalid: One of the configured actions or conditions was invalid. bad.request: The request could not be understood by the server due to malformed syntax. recording.policy.assign.evaluation.evaluator.permission.check.failed: evaluator permission failure for evaluation recording.policy.assign.calibration.evaluator.permission.check.failed: Calibrator permission failure invalid.property: Value [%s] is not a valid property for object [%s] recording.policy.export.integration.invalid: The specified export integration is not a valid integration. constraint.validation: '%s' recording.policy.assign.metered.evaluation.evaluator.permission.check.failed: evaluator permission failure for metered evaluation recording.policy.assign.metered.assignment.by.agent.evaluator.permission.check.failed: evaluator permission failure for metered assignment by agent recording.policy.calibrator.permission.fail: General calibrator permission failure recording.policy.export.integration.disabled: The specified export integration is not in active state. recording.policy.invalid.queue: The specified queues was invalid. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. recording.policy.name.required: Recording policy named required. recording.policy.assign.survey.sending.domain.does.not.exist: Sending domain does not exist in the 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: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.internal.server.error: Internal server error updating policy. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:edit x-purecloud-method-name: putRecordingMediaretentionpolicy delete: tags: - Recording summary: Delete a media retention policy description: '' operationId: deleteRecordingMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID 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 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.policy.not.found: The supplied policy was not found or is invalid not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:delete x-purecloud-method-name: deleteRecordingMediaretentionpolicy patch: tags: - Recording summary: Patch a media retention policy description: '' operationId: patchRecordingMediaretentionpolicy produces: - application/json parameters: - name: policyId in: path description: Policy ID required: true type: string - in: body name: body description: Policy required: true schema: $ref: '#/definitions/PolicyUpdate' responses: '200': description: successful operation schema: $ref: '#/definitions/Policy' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:retentionPolicy:edit x-purecloud-method-name: patchRecordingMediaretentionpolicy /api/v2/recording/recordingkeys: get: tags: - Recording summary: Get encryption key list description: '' operationId: getRecordingRecordingkeys 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/EncryptionKeyEntityListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:view x-purecloud-method-name: getRecordingRecordingkeys post: tags: - Recording summary: Create encryption key description: '' operationId: postRecordingRecordingkeys produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/EncryptionKey' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: postRecordingRecordingkeys /api/v2/recording/recordingkeys/rotationschedule: get: tags: - Recording summary: Get key rotation schedule description: '' operationId: getRecordingRecordingkeysRotationschedule produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/KeyRotationSchedule' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:view x-purecloud-method-name: getRecordingRecordingkeysRotationschedule put: tags: - Recording summary: Update key rotation schedule description: '' operationId: putRecordingRecordingkeysRotationschedule produces: - application/json parameters: - in: body name: body description: KeyRotationSchedule required: true schema: $ref: '#/definitions/KeyRotationSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/KeyRotationSchedule' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: putRecordingRecordingkeysRotationschedule /api/v2/recording/localkeys: post: tags: - Recording summary: create a local key management recording key description: '' operationId: postRecordingLocalkeys produces: - application/json parameters: - in: body name: body description: Local Encryption body required: true schema: $ref: '#/definitions/LocalEncryptionKeyRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/EncryptionKey' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: postRecordingLocalkeys /api/v2/recording/keyconfigurations/{keyConfigurationId}: get: tags: - Recording summary: Get the encryption key configurations description: '' operationId: getRecordingKeyconfiguration produces: - application/json parameters: - name: keyConfigurationId in: path description: Key Configurations Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingEncryptionConfiguration' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:view x-purecloud-method-name: getRecordingKeyconfiguration put: tags: - Recording summary: Update the encryption key configurations description: '' operationId: putRecordingKeyconfiguration produces: - application/json parameters: - name: keyConfigurationId in: path description: Key Configurations Id required: true type: string - in: body name: body description: Encryption key configuration metadata required: true schema: $ref: '#/definitions/RecordingEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingEncryptionConfiguration' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: putRecordingKeyconfiguration /api/v2/recording/keyconfigurations: get: tags: - Recording summary: Get a list of key configurations data description: '' operationId: getRecordingKeyconfigurations produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingEncryptionConfigurationListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:view x-purecloud-method-name: getRecordingKeyconfigurations post: tags: - Recording summary: Setup configurations for encryption key creation description: '' operationId: postRecordingKeyconfigurations produces: - application/json parameters: - in: body name: body description: Encryption Configuration required: true schema: $ref: '#/definitions/RecordingEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingEncryptionConfiguration' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: postRecordingKeyconfigurations /api/v2/recording/keyconfigurations/validate: post: tags: - Recording summary: Validate encryption key configurations without saving it description: '' operationId: postRecordingKeyconfigurationsValidate produces: - application/json parameters: - in: body name: body description: Encryption Configuration required: true schema: $ref: '#/definitions/RecordingEncryptionConfiguration' responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingEncryptionConfiguration' '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:encryptionKey:edit x-purecloud-method-name: postRecordingKeyconfigurationsValidate /api/v2/recording/batchrequests/{jobId}: get: tags: - Recording summary: Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results. description: '' operationId: getRecordingBatchrequest produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/BatchDownloadJobStatusResult' '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). batch.download.permission.denied: Only user that initiated the job can request results app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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. batch.download.job.not.found: The requested job is unknown '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - quality - quality:readonly x-purecloud-method-name: getRecordingBatchrequest /api/v2/recording/batchrequests: post: tags: - Recording summary: Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download. description: '' operationId: postRecordingBatchrequests produces: - application/json parameters: - in: body name: body description: Job submission criteria required: true schema: $ref: '#/definitions/BatchDownloadJobSubmission' responses: '200': description: successful operation schema: $ref: '#/definitions/BatchDownloadJobSubmissionResult' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: batch.download.too.many.items: Too many items requested, max 100 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] batch.download.bad.request: Request list is required and must not be empty 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: - quality - quality:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: postRecordingBatchrequests /api/v2/recordings/deletionprotection: post: tags: - Recording summary: Get a list of conversations with protected recordings description: '' operationId: postRecordingsDeletionprotection produces: - application/json parameters: - in: body name: body description: conversationIds required: true schema: $ref: '#/definitions/ConversationDeletionProtectionQuery' responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/AddressableEntityRef' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.conversation.id.not.uuid: Request needs recording conversation ID not UUID. bad.request: The request could not be understood by the server due to 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: recording.conversation.not.found: Recording conversation 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: - recordings - recordings:readonly x-purecloud-method-name: postRecordingsDeletionprotection put: tags: - Recording summary: Apply or revoke recording protection for conversations description: '' operationId: putRecordingsDeletionprotection produces: - application/json parameters: - name: protect in: query description: Check for apply, uncheck for revoke (each action requires the respective permission) required: false type: boolean default: true - in: body name: body required: false schema: $ref: '#/definitions/ConversationDeletionProtectionQuery' 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. recording.empty.payload: Recording payload was 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' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.conversation.not.found: Recording conversation 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:deletionProtection:apply - recording:deletionProtection:revoke x-purecloud-method-name: putRecordingsDeletionprotection /api/v2/orphanrecordings/{orphanId}/media: get: tags: - Recording summary: Gets the media of a single orphan recording description: A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body. operationId: getOrphanrecordingMedia produces: - application/json parameters: - name: orphanId in: path description: Orphan ID required: true type: string - name: formatId in: query description: The desired media format. required: false type: string default: WEBM enum: - WAV - WEBM - WAV_ULAW - OGG_VORBIS - OGG_OPUS - MP3 - NONE - name: emailFormatId in: query description: The desired media format when downloading an email recording. required: false type: string default: EML enum: - EML - NONE - name: chatFormatId in: query description: The desired media format when downloading a chat recording. required: false type: string default: ZIP enum: - ZIP - NONE - name: messageFormatId in: query description: The desired media format when downloading a message recording. required: false type: string default: ZIP enum: - ZIP - NONE - name: download in: query description: requesting a download format of the recording required: false type: boolean default: false enum: - 'true' - 'false' - name: fileName in: query description: the name of the downloaded fileName required: false type: string - name: locale in: query description: The locale for the requested file when downloading, as an ISO 639-1 code required: false type: string - name: mediaFormats in: query description: All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/Recording' '202': description: Accepted - Transcoding orphan media '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: - quality - quality:readonly x-inin-requires-permissions: type: ANY permissions: - recording:orphan:view x-purecloud-method-name: getOrphanrecordingMedia /api/v2/orphanrecordings/{orphanId}: get: tags: - Recording summary: Gets a single orphan recording description: '' operationId: getOrphanrecording produces: - application/json parameters: - name: orphanId in: path description: Orphan ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OrphanRecording' '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: - quality - quality:readonly x-inin-requires-permissions: type: ANY permissions: - recording:orphan:view x-purecloud-method-name: getOrphanrecording put: tags: - Recording summary: Updates an orphan recording to a regular recording with retention values description: If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api. operationId: putOrphanrecording produces: - application/json parameters: - name: orphanId in: path description: Orphan ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/OrphanUpdateRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/Recording' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.orphan.retention.data.invalid: The provided dates in the payload were invalid. recording.orphan.unknown.conversation: The provided conversation in the payload doesn't 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. recording.recording.analytics.retention.violation: The provided delete date exceeds the limit imposed by the analytics retention settings. 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' recording.orphan.edit.permission.check.failed: Requesting user lacks permission to perform this api operation. '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: - quality x-inin-requires-permissions: type: ANY permissions: - recording:orphan:edit x-purecloud-method-name: putOrphanrecording delete: tags: - Recording summary: Deletes a single orphan recording description: '' operationId: deleteOrphanrecording produces: - application/json parameters: - name: orphanId in: path description: Orphan ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/OrphanRecording' '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: - quality x-inin-requires-permissions: type: ANY permissions: - recording:orphan:delete x-purecloud-method-name: deleteOrphanrecording /api/v2/orphanrecordings: get: tags: - Recording summary: Gets all orphan recordings description: '' operationId: getOrphanrecordings produces: - application/json parameters: - name: pageSize in: query description: The total page size requested required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: The page number requested required: false type: integer default: 1 format: int32 - name: sortBy in: query description: variable name requested to sort by required: false type: string - name: expand in: query description: variable name requested by expand list required: false type: array items: type: string collectionFormat: multi - name: nextPage in: query description: next page token required: false type: string - name: previousPage in: query description: Previous page token required: false type: string - name: hasConversation in: query description: Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. required: false type: boolean default: false - name: media in: query description: Filter resulting orphans based on their media type required: false type: string enum: - Call - Screen responses: '200': description: successful operation schema: $ref: '#/definitions/OrphanRecordingListing' '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' recording.orphan.view.permission.check.failed: Failed to verify recording view permission. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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: general.internal.server.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - quality - quality:readonly x-inin-requires-permissions: type: ANY permissions: - recording:orphan:view x-purecloud-method-name: getOrphanrecordings /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}: get: tags: - Recording summary: Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing. description: '' operationId: getConversationRecordingmetadataRecordingId produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingMetadata' '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: recording.recording.view.permission.check.failed: Failed to verify recording view permission. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recordingsegment.view.permission.check.failed: Failed to verify recording segment view permission. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. recording.recording.not.found: Recording with recordingId was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecordingmetadataRecordingId /api/v2/conversations/{conversationId}/recordings/{recordingId}: get: tags: - Recording summary: Gets a specific recording. description: Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted. operationId: getConversationRecording produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - name: formatId in: query description: The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE required: false type: string default: WEBM enum: - WAV - WEBM - WAV_ULAW - OGG_VORBIS - OGG_OPUS - MP3 - NONE - name: emailFormatId in: query description: The desired media format when downloading an email recording. Valid values:EML,NONE required: false type: string default: EML enum: - EML - NONE - name: chatFormatId in: query description: 'The desired media format when downloading a chat recording. Valid values:ZIP,NONE ' required: false type: string default: ZIP enum: - ZIP - NONE - name: messageFormatId in: query description: The desired media format when downloading a message recording. Valid values:ZIP,NONE required: false type: string default: ZIP enum: - ZIP - NONE - name: download in: query description: requesting a download format of the recording. Valid values:true,false required: false type: boolean default: false enum: - 'true' - 'false' - name: fileName in: query description: the name of the downloaded fileName required: false type: string - name: locale in: query description: The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code required: false type: string - name: mediaFormats in: query description: All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/Recording' '202': description: Success - recording is transcoding schema: $ref: '#/definitions/Recording' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: quality.query.invalid.conversation: The conversation query was invalid. bad.request: The request could not be understood by the server due to 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: recording.recording.view.permission.check.failed: Failed to verify recording view permission. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recordingsegment.view.permission.check.failed: Failed to verify recording segment view permission. '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: general.internal.server.error: An internal server error has occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecording put: tags: - Recording summary: Updates the retention records on a recording. description: 'Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.' operationId: putConversationRecording produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - in: body name: body description: recording required: true schema: $ref: '#/definitions/Recording' - name: clearExport in: query description: Whether to clear the pending export for the recording required: false type: boolean responses: '200': description: successful operation schema: $ref: '#/definitions/Recording' '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 recording.not.archivable: Recording has been deleted or is still uploading invalid.date: 'Dates must be specified as ISO-8601 strings. 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] recording.invalid.json: Recording request contains invalid JSON 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' recording.recording.edit.retention.permission.check.failed: Failed to verify recording edit retention permission. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recording.restore.permission.check.failed: improper permissions found when attempting to restore recordings '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.not.archivable: Recording is not achievable not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recording:editRetention - recording:recording:restore - recording:screenRecording:view - recording:screenRecording:editRetention - recording:screenRecording:restore - recording:snippetRecording:view - recording:snippetRecording:editRetention - recording:snippetRecording:restore x-purecloud-method-name: putConversationRecording /api/v2/conversations/{conversationId}/recordingmetadata: get: tags: - Recording summary: Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing. description: '' operationId: getConversationRecordingmetadata produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/RecordingMetadata' '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: recording.recording.view.permission.check.failed: Request forbidden due to recording view permissions check failing. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recordingsegment.view.permission.check.failed: Request forbidden due to recording segment view permissions check failing. '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.not.found: Conversation with specified conversationId was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.internal.server.error: An internal server error has occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecordingmetadata /api/v2/conversations/{conversationId}/recordings: get: tags: - Recording summary: Get all of a Conversation's Recordings. description: Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted. operationId: getConversationRecordings produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: maxWaitMs in: query description: The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. required: false type: integer default: 5000 format: int32 - name: formatId in: query description: The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. required: false type: string default: WEBM enum: - WAV - WEBM - WAV_ULAW - OGG_VORBIS - OGG_OPUS - MP3 - NONE - name: mediaFormats in: query description: All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3. required: false type: array items: type: string collectionFormat: multi - name: locale in: query description: The locale used for redacting sensitive information in requested files, as an ISO 639-1 code required: false type: string - name: includePauseAnnotationsForScreenRecordings in: query description: Include applicable Secure Pause annotations from all audio recordings to all screen recordings required: false type: boolean default: false responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/Recording' '202': description: Success - recording is transcoding '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: quality.query.invalid.conversation: Quality query has invalid conversation. bad.request: The request could not be understood by the server due to 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: recording.recording.view.permission.check.failed: The recording:recording:view permission is required. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recordingsegment.view.permission.check.failed: The recording:recordingSegment:view permission is required. '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.not.found: A conversation for the provided conversationId was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.internal.server.error: An internal server error has occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is 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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecordings /api/v2/recordings/retention/query: get: tags: - Recording summary: Query for recording retention data description: '' operationId: getRecordingsRetentionQuery produces: - application/json parameters: - name: retentionThresholdDays in: query description: Fetch retention data for recordings retained for more days than the provided value. required: true type: integer format: int32 - 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: Page size. Maximum is 500. required: false type: integer default: 25 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingRetentionCursorEntityListing' '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: recording.recording.view.permission.check.failed: The recording:recording:view permission is required. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:recording:view x-purecloud-method-name: getRecordingsRetentionQuery /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}: get: tags: - Recording summary: Get annotation description: '' operationId: getConversationRecordingAnnotation produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - name: annotationId in: path description: Annotation ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Annotation' '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]' recording.annotation.view.permission.check.failed: Failed to verify view annotation permission missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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. recording.annotation.not.found: The recording annotation was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:annotation:view - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecordingAnnotation put: tags: - Recording summary: Update annotation description: If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates. operationId: putConversationRecordingAnnotation produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - name: annotationId in: path description: Annotation ID required: true type: string - in: body name: body description: annotation required: true schema: $ref: '#/definitions/Annotation' responses: '200': description: successful operation schema: $ref: '#/definitions/Annotation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.annotation.description.too.long: Annotation description too long. bad.request: The request could not be understood by the server due to 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] recording.invalid.json: Request contains invalid JSON. 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: recording.recording.view.permission.check.failed: Failed to verify recording view permission. missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' recording.annotation.update.permission.check.failed: Failed to verify recording update permission. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.recordingsegment.view.permission.check.failed: Failed to verify recording segment view permission. '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:annotation:edit - recording:annotation:add - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: putConversationRecordingAnnotation delete: tags: - Recording summary: Delete annotation description: '' operationId: deleteConversationRecordingAnnotation produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - name: annotationId in: path description: Annotation ID 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). recording.annotation.cant.delete.for.another.user: Can't delete a recording annotation for another user. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' recording.annotation.delete.permission.check.failed: Failed to verify recording delete permission. '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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:annotation:delete - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: deleteConversationRecordingAnnotation /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations: get: tags: - Recording summary: Get annotations for recording description: '' operationId: getConversationRecordingAnnotations produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/Annotation' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:annotation:view - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: getConversationRecordingAnnotations post: tags: - Recording summary: Create annotation description: If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates. operationId: postConversationRecordingAnnotations produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string - name: recordingId in: path description: Recording ID required: true type: string - in: body name: body description: annotation required: true schema: $ref: '#/definitions/Annotation' responses: '200': description: successful operation schema: $ref: '#/definitions/Annotation' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: recording.annotation.description.too.long: Annotation description too long. bad.request: The request could not be understood by the server due to 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] recording.invalid.json: Request contains invalid JSON. 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:annotation:add - recording:annotation:edit - recording:recording:view - recording:recordingSegment:view - recording:snippetRecording:view - recording:screenRecording:view x-purecloud-method-name: postConversationRecordingAnnotations /api/v2/recording/jobs/{jobId}/failedrecordings: get: tags: - Recording summary: Get IDs of recordings that the bulk job failed for description: '' operationId: getRecordingJobFailedrecordings produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string - name: pageSize in: query description: Page size. Maximum is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: includeTotal in: query description: If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. required: false type: boolean - name: cursor in: query description: Indicates where to resume query results (not required for first page) required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/FailedRecordingEntityListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ALL permissions: - recording:job:view x-purecloud-method-name: getRecordingJobFailedrecordings /api/v2/recording/jobs/{jobId}: get: tags: - Recording summary: Get the status of the job associated with the job id. description: '' operationId: getRecordingJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingJob' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ALL permissions: - recording:job:view x-purecloud-method-name: getRecordingJob put: tags: - Recording summary: Execute the recording bulk job. description: Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention. operationId: putRecordingJob produces: - application/json parameters: - name: jobId in: path description: jobId required: true type: string - in: body name: body description: query required: true schema: $ref: '#/definitions/ExecuteRecordingJobsQuery' responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingJob' '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: - recordings x-inin-requires-permissions: type: ALL permissions: - recording:job:edit - recording:recording:editRetention - recording:screenRecording:editRetention - recording:snippetRecording:editRetention x-purecloud-method-name: putRecordingJob delete: tags: - Recording summary: Delete the recording bulk job description: '' operationId: deleteRecordingJob produces: - application/json parameters: - name: jobId in: path description: jobId 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: - recordings x-inin-requires-permissions: type: ALL permissions: - recording:job:delete x-purecloud-method-name: deleteRecordingJob /api/v2/recording/jobs: get: tags: - Recording summary: Get the status of all jobs within the user's organization description: '' operationId: getRecordingJobs 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: sortBy in: query description: Sort by required: false type: string default: userId enum: - userId - dateCreated - name: state in: query description: Filter by state required: false type: string enum: - FULFILLED - PENDING - READY - PROCESSING - CANCELLED - FAILED - name: showOnlyMyJobs in: query description: Show only my jobs required: false type: boolean - name: jobType in: query description: Job Type (Can be left empty for both) required: false type: string enum: - ARCHIVE - DELETE - EXPORT - name: includeTotal in: query description: If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. required: false type: boolean - name: cursor in: query description: Indicates where to resume query results (not required for first page) required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingJobEntityListing' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ALL permissions: - recording:job:view x-purecloud-method-name: getRecordingJobs post: tags: - Recording summary: Create a recording bulk job. description: Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out. operationId: postRecordingJobs produces: - application/json parameters: - in: body name: body description: query required: true schema: $ref: '#/definitions/RecordingJobsQuery' responses: '202': description: Accepted - Running query asynchronously schema: $ref: '#/definitions/RecordingJob' '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. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled for actionAge and screen recording parameters security: - PureCloud OAuth: - recordings x-inin-requires-permissions: type: ALL permissions: - recording:job:add x-purecloud-method-name: postRecordingJobs /api/v2/recording/settings: get: tags: - Recording summary: Get the Recording Settings for the Organization description: '' operationId: getRecordingSettings produces: - application/json parameters: - name: createDefault in: query description: If no settings are found, a new one is created with default values required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingSettings' '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: general.internal.server.error: Internal server error getting recording settings internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - recordings - recordings:readonly x-purecloud-method-name: getRecordingSettings put: tags: - Recording summary: Update the Recording Settings for the Organization description: '' operationId: putRecordingSettings produces: - application/json parameters: - in: body name: body description: Recording settings required: true schema: $ref: '#/definitions/RecordingSettings' responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingSettings' '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] recording.org.settings.request.invalid: invalid recording setting 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: - recordings x-inin-requires-permissions: type: ANY permissions: - recording:settings:editScreenRecordings - recording:settings:editRegionalStorage - recording:settings:editUrlExpiration - recording:settings:editConferenceRecording - recording:settings:editHierarchyAccessControl x-purecloud-method-name: putRecordingSettings /api/v2/recording/uploads/reports/{reportId}: get: tags: - Recording summary: Get the status of a recording upload status report description: '' operationId: getRecordingUploadsReport produces: - application/json parameters: - name: reportId in: path description: reportId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RecordingUploadReport' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ALL permissions: - recording:uploadReport:view x-purecloud-method-name: getRecordingUploadsReport /api/v2/recording/uploads/reports: post: tags: - Recording summary: Creates a recording upload status report description: '' operationId: postRecordingUploadsReports produces: - application/json parameters: - in: body name: body description: Report parameters required: true schema: $ref: '#/definitions/RecordingUploadReportRequest' responses: '202': description: Accepted - preparing report. schema: $ref: '#/definitions/RecordingUploadReport' '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: - recordings x-inin-requires-permissions: type: ALL permissions: - recording:uploadReport:add x-purecloud-method-name: postRecordingUploadsReports /api/v2/recordings/screensessions/details: get: tags: - Recording summary: Retrieves an object containing the total number of concurrent active screen recordings description: '' operationId: getRecordingsScreensessionsDetails produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ScreenRecordingActiveSessions' '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: - recordings - recordings:readonly x-inin-requires-permissions: type: ANY permissions: - recording:screenRecording:view x-purecloud-method-name: getRecordingsScreensessionsDetails /api/v2/recordings/screensessions/acknowledge: post: tags: - Recording summary: Acknowledge a screen recording. description: '' operationId: postRecordingsScreensessionsAcknowledge produces: - application/json parameters: - in: body name: body description: AcknowledgeScreenRecordingRequest required: true schema: $ref: '#/definitions/AcknowledgeScreenRecordingRequest' responses: '204': description: Recording acknowledged '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: postRecordingsScreensessionsAcknowledge /api/v2/recordings/screensessions/metadata: post: tags: - Recording summary: Provide meta-data a screen recording. description: '' operationId: postRecordingsScreensessionsMetadata produces: - application/json parameters: - in: body name: body description: ScreenRecordingMetaDataRequest required: true schema: $ref: '#/definitions/ScreenRecordingMetaDataRequest' responses: '204': description: Meta-data supplied to screen recording. '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: postRecordingsScreensessionsMetadata definitions: 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 RecordingUploadReportRequest: type: object required: - dateSince properties: dateSince: type: string format: date-time description: 'Report will include uploads since this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' uploadStatus: type: string description: Report will include uploads with this status enum: - Pending - Success - Failure - WaitForConversation 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 TimeInterval: type: object properties: months: type: integer format: int32 weeks: type: integer format: int32 days: type: integer format: int32 hours: type: integer format: int32 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. 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 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.' RecordingJobEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/RecordingJob' 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 PolicyUpdate: type: object properties: enabled: type: boolean CrossPlatformPolicy: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: 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' 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' order: type: integer format: int32 description: type: string enabled: type: boolean mediaPolicies: description: Conditions and actions per media type $ref: '#/definitions/CrossPlatformMediaPolicies' conditions: description: Conditions $ref: '#/definitions/PolicyConditions' actions: description: Actions $ref: '#/definitions/CrossPlatformPolicyActions' policyErrors: $ref: '#/definitions/PolicyErrors' selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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 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 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' 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' Annotation: type: object properties: id: type: string description: Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request). name: type: string type: type: string location: type: integer format: int64 description: Offset of annotation in milliseconds. durationMs: type: integer format: int64 description: Duration of annotation in milliseconds. absoluteLocation: type: integer format: int64 description: Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses). absoluteDurationMs: type: integer format: int64 description: Duration of annotation (milliseconds). recordingLocation: type: integer format: int64 description: Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts recordingDurationMs: type: integer format: int64 description: Duration of annotation (milliseconds), adjusted for any recording cuts. user: description: User that created this annotation (if any). $ref: '#/definitions/User' description: type: string description: Text of annotation. Maximum character limit is 500. reason: type: string description: 'Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause' readOnly: true enum: - Hold - SecurePause - FlowOrQueue - Pause annotations: type: array description: List of annotations readOnly: true items: $ref: '#/definitions/Annotation' realtimeLocation: type: integer format: int64 description: Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true RecordingJobsQuery: type: object required: - action properties: action: type: string description: Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. enum: - ARCHIVE - DELETE - EXPORT actionDate: type: string format: date-time description: 'The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' actionAge: type: integer format: int32 description: The number of days after each recording's creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. screenRecordingActionDate: type: string format: date-time description: 'The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' screenRecordingActionAge: type: integer format: int32 description: The number of days after each screen recording's creation date when the action will be performed. If this is provided then includeScreenRecordings must be true. integrationId: type: string description: IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action. includeRecordingsWithSensitiveData: type: boolean description: 'Whether to include recordings with PCI DSS and/or PII data, default value = false ' includeScreenRecordings: type: boolean description: 'Whether to include Screen recordings for the action, default value = true ' includePolicyBasedRecordings: type: boolean description: Whether to include policy-based recordings for the action, default value = true includeSnippetRecordings: type: boolean description: Whether to include snippet recordings for the action, default value = true clearExport: type: boolean description: For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false conversationQuery: description: 'Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. This result depends on the analytics data lake job completion. See also: https://developer.genesys.cloud/analyticsdatamanagement/analytics/jobs/conversation-details-job#data-availability.' $ref: '#/definitions/AsyncConversationQuery' agedConversationInterval: type: string format: interval description: 'As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss' 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 ScreenRecordingMetaData: type: object properties: trackId: type: string mediaId: type: string screenId: type: string originX: type: integer format: int32 originY: type: integer format: int32 primary: type: boolean main: type: boolean 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' AcknowledgeScreenRecordingRequest: type: object properties: participantJid: type: string roomId: type: string conversationId: type: string 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 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' ListPicker: type: object required: - sections properties: id: type: string description: Optional unique identifier to help map component replies to form messages where multiple List Pickers can be present. title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the description. header: type: string description: Text to show in the header. sections: type: array description: An array of sections in the List Picker. items: $ref: '#/definitions/ListPickerSection' PaymentResponse: type: object 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. QuestionSettings: type: object properties: questionContextId: type: string description: The context id of the question in the group settings: $ref: '#/definitions/AiScoringSetting' DeleteRetention: type: object properties: days: type: integer format: int32 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 MediaSummary: type: object properties: contactCenter: $ref: '#/definitions/MediaSummaryDetail' enterprise: $ref: '#/definitions/MediaSummaryDetail' 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 ListPickerSection: type: object required: - items - multipleSelection - title properties: items: type: array description: List of items to choose from in the section items: $ref: '#/definitions/ListPickerItem' multipleSelection: type: boolean description: Whether multiple items can be selected in this section. title: type: string description: Required title for the section. 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 OrphanRecordingListing: type: object properties: entities: type: array items: $ref: '#/definitions/OrphanRecording' 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 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.' PolicyUser: type: object required: - version properties: id: type: string description: User ID 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 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.' CrossPlatformMessageMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/CrossPlatformPolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/MessageMediaPolicyConditions' RetentionDuration: type: object properties: archiveRetention: $ref: '#/definitions/ArchiveRetention' deleteRetention: $ref: '#/definitions/DeleteRetention' ExpansionCriterium: type: object properties: type: type: string enum: - TIMEOUT_SECONDS threshold: type: number format: double ChatMediaPolicyConditions: type: object properties: forUsers: type: array description: 'List of users to apply this policy to. Each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' items: $ref: '#/definitions/PolicyUser' dateRanges: type: array items: type: string forQueues: type: array items: $ref: '#/definitions/Queue' wrapupCodes: type: array items: $ref: '#/definitions/WrapupCode' languages: type: array items: $ref: '#/definitions/Language' timeAllowed: $ref: '#/definitions/TimeAllowed' teams: type: array description: Teams to match conversations against items: $ref: '#/definitions/Team' duration: $ref: '#/definitions/DurationCondition' 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. BatchDownloadJobSubmission: type: object required: - batchDownloadRequestList properties: batchDownloadRequestList: type: array description: List of up to 100 items requested items: $ref: '#/definitions/BatchDownloadRequest' 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 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 Recording: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversationId: type: string path: type: string startTime: type: string description: The start time of the recording. Null when there is no playable media. endTime: type: string description: The end time of the recording. Null when there is no playable media. media: type: string description: The media type of the recording. This could be audio, chat, messaging, email, or screen. mediaSubtype: type: string description: The media subtype of the recording. enum: - Trunk - Station - Consult - Screen - Snippet mediaSubject: type: string description: The media subject of the recording. annotations: type: array description: Annotations that belong to the recording. items: $ref: '#/definitions/Annotation' transcript: type: array description: Represents a chat transcript items: $ref: '#/definitions/ChatMessage' emailTranscript: type: array description: Represents an email transcript items: $ref: '#/definitions/RecordingEmailMessage' messagingTranscript: type: array description: Represents a messaging transcript items: $ref: '#/definitions/RecordingMessagingMessage' fileState: type: string description: 'Represents the current file state for a recording. Examples: Uploading, Archived, etc' enum: - ARCHIVED - AVAILABLE - DELETED - RESTORED - RESTORING - UPLOADING - ERROR restoreExpirationTime: type: string format: date-time description: 'The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' mediaUris: type: object description: The different mediaUris for the recording. Null when there is no playable media. additionalProperties: $ref: '#/definitions/MediaResult' estimatedTranscodeTimeMs: type: integer format: int64 actualTranscodeTimeMs: type: integer format: int64 archiveDate: type: string format: date-time description: 'The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' archiveMedium: type: string description: 'The type of archive medium used. Example: CloudArchive' enum: - CLOUDARCHIVE deleteDate: type: string format: date-time description: 'The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportDate: type: string format: date-time description: 'The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportedDate: type: string format: date-time description: 'The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' outputDurationMs: type: integer format: int32 description: Duration of transcoded media in milliseconds outputSizeInBytes: type: integer format: int32 description: Size of transcoded media in bytes. 0 if there is no transcoded media. maxAllowedRestorationsForOrg: type: integer format: int32 description: How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced. remainingRestorationsAllowedForOrg: type: integer format: int32 description: The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced. sessionId: type: string description: The session id represents an external resource id, such as email, call, chat, etc users: type: array description: The users participating in the conversation items: $ref: '#/definitions/User' recordingFileRole: type: string description: Role of the file recording. It can be either customer_experience or adhoc. enum: - CUSTOMER_EXPERIENCE - ADHOC recordingErrorStatus: type: string description: Status of a recording that cannot be returned because of an error enum: - EMAIL_TRANSCRIPT_TOO_LARGE originalRecordingStartTime: type: string format: date-time description: 'The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' creationTime: type: string format: date-time description: 'The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' associatedConversationIds: type: array description: List of associated conversation IDs items: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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 ConversationDeletionProtectionQuery: type: object required: - conversationIds properties: conversationIds: type: array description: This is a list of ConversationIds. The list cannot exceed 100 conversationids. items: type: string PaymentLineItem: type: object properties: name: type: string description: The display name for the item. price: type: number format: double description: The price of the item. PublishedSurveyFormReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string contextId: type: string description: The context id of this form. selfUri: type: string format: uri description: The URI for this object readOnly: true 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. InitiateScreenRecording: type: object properties: recordACW: type: boolean archiveRetention: $ref: '#/definitions/ArchiveRetention' deleteRetention: $ref: '#/definitions/DeleteRetention' Card: type: object properties: title: type: string description: Text to show in the title. description: type: string description: Text to show in the description. url: type: string description: URL of an image. defaultAction: description: The default action to be taken. $ref: '#/definitions/CardAction' actions: type: array description: List of possible action objects. items: $ref: '#/definitions/CardAction' 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 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 RichLink: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true header: description: Header for the Rich Link. $ref: '#/definitions/RichLinkHeader' footer: type: string description: Footer text for the Rich Link. text: type: string description: Text for the body of the Rich Link. url: type: string description: Url for the Rich Link. urlLabel: type: string description: Label for the URL of the Rich link. MeteredAssignmentByAgent: type: object properties: evaluationContextId: type: string evaluators: type: array items: $ref: '#/definitions/User' maxNumberEvaluations: type: integer format: int32 evaluationForm: $ref: '#/definitions/EvaluationForm' timeInterval: $ref: '#/definitions/TimeInterval' timeZone: type: string CrossPlatformEmailMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/CrossPlatformPolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/EmailMediaPolicyConditions' DatePicker: type: object required: - datePickerAvailableDateTimes 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. datePickerAvailableDateTimes: type: array description: An array of available times objects. items: $ref: '#/definitions/DatePickerAvailableDateTime' dateSelected: type: string format: date-time description: 'Selected date response from end customer. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' RecordingUploadReport: type: object properties: id: type: string description: The report id. name: type: string state: type: string description: The current status of the upload report. enum: - InProgress - Completed - Failed signedUrl: type: string description: For COMPLETED tasks, the signed url to download the report. selfUri: type: string format: uri description: The URI for this object readOnly: true DurationCondition: type: object properties: durationTarget: type: string enum: - DURATION - DURATION_RANGE durationOperator: type: string durationRange: type: string durationMode: type: string enum: - Between - Over - Under RecordingTemplateCarousel: type: object properties: cards: type: array description: An array of template card objects. items: $ref: '#/definitions/RecordingTemplateCard' 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 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' 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' TimeSlot: type: object properties: startTime: type: string description: start time in xx:xx:xx.xxx format stopTime: type: string description: stop time in xx:xx:xx.xxx format day: type: integer format: int32 description: Day for this time slot, Monday = 1 ... Sunday = 7 MediaTranscription: type: object properties: displayName: type: string transcriptionProvider: type: string enum: - VOCI - CALLJOURNEY integrationId: type: string 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 RecordingWheelPicker: type: object 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: An array of options in the Wheel Picker. items: $ref: '#/definitions/RecordingWheelPickerItem' TrusteeAuthorization: type: object properties: permissions: type: array description: Permissions that the trustee user has in the trustor organization readOnly: true items: type: string PolicyActions: type: object properties: retainRecording: type: boolean description: true to retain the recording associated with the conversation. Default = true deleteRecording: type: boolean description: true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false alwaysDelete: type: boolean description: true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false assignEvaluations: type: array items: $ref: '#/definitions/EvaluationAssignment' assignMeteredEvaluations: type: array items: $ref: '#/definitions/MeteredEvaluationAssignment' assignMeteredAssignmentByAgent: type: array items: $ref: '#/definitions/MeteredAssignmentByAgent' assignCalibrations: type: array items: $ref: '#/definitions/CalibrationAssignment' assignSurveys: type: array items: $ref: '#/definitions/SurveyAssignment' retentionDuration: $ref: '#/definitions/RetentionDuration' initiateScreenRecording: $ref: '#/definitions/InitiateScreenRecording' mediaTranscriptions: type: array description: Deprecated. The Voci and Call Journey transcription integrations are no longer supported. items: $ref: '#/definitions/MediaTranscription' integrationExport: description: Policy action for exporting recordings using an integration to 3rd party s3. $ref: '#/definitions/IntegrationExport' 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 RecordingTemplateButton: type: object 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. isSelected: type: boolean description: Indicates if the button is selected by end customer. Endpoint: type: object required: - name - schema properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: Name division: description: The division to which this entity belongs. $ref: '#/definitions/Division' description: type: string description: The resource's description. version: type: integer format: int32 description: The current version of the resource. dateCreated: type: string format: date-time description: 'The date the resource 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: 'The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true modifiedBy: type: string description: The ID of the user that last modified the resource. readOnly: true createdBy: type: string description: The ID of the user that created the resource. readOnly: true state: type: string description: Indicates if the resource is active, inactive, or deleted. readOnly: true enum: - active - inactive - deleted modifiedByApp: type: string description: The application that last modified the resource. readOnly: true createdByApp: type: string description: The application that created the resource. readOnly: true count: type: integer format: int32 properties: type: object additionalProperties: type: object schema: description: Schema $ref: '#/definitions/DomainEntityRef' enabled: type: boolean site: $ref: '#/definitions/DomainEntityRef' dids: type: array items: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true 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 Policy: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: 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' 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' order: type: integer format: int32 description: type: string enabled: type: boolean mediaPolicies: description: Conditions and actions per media type $ref: '#/definitions/MediaPolicies' conditions: description: Conditions $ref: '#/definitions/PolicyConditions' actions: description: Actions $ref: '#/definitions/PolicyActions' policyErrors: $ref: '#/definitions/PolicyErrors' selfUri: type: string format: uri description: The URI for this object readOnly: true CrossPlatformPolicyCreate: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The policy 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' 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' order: type: integer format: int32 description: type: string enabled: type: boolean mediaPolicies: description: Conditions and actions per media type $ref: '#/definitions/CrossPlatformMediaPolicies' conditions: description: Conditions $ref: '#/definitions/PolicyConditions' actions: description: Actions $ref: '#/definitions/CrossPlatformPolicyActions' policyErrors: $ref: '#/definitions/PolicyErrors' selfUri: type: string format: uri description: The URI for this object readOnly: true MessageMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/PolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/MessageMediaPolicyConditions' 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' 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' 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' TimeAllowed: type: object properties: timeSlots: type: array items: $ref: '#/definitions/TimeSlot' timeZoneId: type: string empty: type: boolean RecordingWheelPickerItem: type: object 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 isSelected: type: boolean description: Indicates if the item is selected by end customer. 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 RecordingEmailMessage: type: object properties: htmlBody: type: string textBody: type: string id: type: string to: type: array items: $ref: '#/definitions/EmailAddress' cc: type: array items: $ref: '#/definitions/EmailAddress' bcc: type: array items: $ref: '#/definitions/EmailAddress' from: $ref: '#/definitions/EmailAddress' replyTo: description: Indicates the address to which the author of the message suggests that replies be sent $ref: '#/definitions/EmailAddress' subject: type: string attachments: type: array items: $ref: '#/definitions/EmailAttachment' time: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ReceivedReplyMessage: type: object properties: title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the subtitle. ExecuteRecordingJobsQuery: type: object required: - state properties: state: type: string description: The desired state for the job to be set to. enum: - PROCESSING RecordingIntroduction: type: object properties: title: type: string description: Text to show in the title. subtitle: type: string description: Text to show in the subtitle. 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 RecordingTemplateHeader: type: object properties: type: type: string description: Template header type. enum: - Text - Media text: type: string description: Header text. media: description: Media template header image. $ref: '#/definitions/RecordingAttachment' PolicyErrors: type: object properties: policyErrorMessages: type: array items: $ref: '#/definitions/PolicyErrorMessage' RecordingForm: type: object properties: introduction: description: The introduction component, used to give an intro into what the form entails. $ref: '#/definitions/RecordingIntroduction' formPages: type: array description: Form pages. items: $ref: '#/definitions/RecordingFormPage' receivedMessage: description: Defines the initial prompt message structure containing title and subtitle fields that are displayed to the end user when a form requires completion. $ref: '#/definitions/ReceivedReplyMessage' replyMessage: description: The reply message after the user has filled out the form received. $ref: '#/definitions/ReceivedReplyMessage' response: type: array description: Content of the payload included in the Form response. items: $ref: '#/definitions/RecordingFormResponseComponent' 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. EncryptionKeyEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/EncryptionKey' 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 RecordingNotificationTemplate: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true language: type: string description: Template language. header: description: The template header. $ref: '#/definitions/RecordingTemplateHeader' body: description: The template body. $ref: '#/definitions/RecordingTemplateBody' buttons: type: array description: Template buttons items: $ref: '#/definitions/RecordingTemplateButton' carousel: description: The template carousel $ref: '#/definitions/RecordingTemplateCarousel' footer: description: The template footer. $ref: '#/definitions/RecordingTemplateFooter' 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. 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' 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. LocalEncryptionKeyRequest: type: object required: - configId - keypairId - publicKey properties: configId: type: string description: The local configuration id that contains metadata on private local service publicKey: type: string description: Base 64 encoded public key, generated by the local service. keypairId: type: string description: The key pair id from the local service. 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' EmailAddress: type: object properties: email: type: string name: type: string DomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri KeyRotationSchedule: type: object required: - period properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string period: type: string description: Value to set schedule to enum: - DISABLED - DAILY - WEEKLY - MONTHLY - YEARLY selfUri: type: string format: uri description: The URI for this object readOnly: true 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' CrossPlatformCallMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/CrossPlatformPolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/CallMediaPolicyConditions' 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 QueueMessagingAddresses: type: object properties: smsAddress: $ref: '#/definitions/DomainEntityRef' openMessagingRecipient: $ref: '#/definitions/DomainEntityRef' whatsAppRecipient: $ref: '#/definitions/DomainEntityRef' 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.' RecordingLocation: 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. CalibrationAssignment: type: object properties: calibrator: $ref: '#/definitions/User' evaluators: type: array items: $ref: '#/definitions/User' evaluationForm: $ref: '#/definitions/EvaluationForm' expertEvaluator: $ref: '#/definitions/User' RecordingMetadata: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversationId: type: string path: type: string startTime: type: string description: The start time of the recording for screen recordings. Null for other types. endTime: type: string media: type: string description: The type of media that the recording is. At the moment that could be audio, chat, email, or message. mediaSubtype: type: string description: The recording media subtype. enum: - Trunk - Station - Consult - Screen - Snippet mediaSubject: type: string description: The recording media subject. annotations: type: array description: Annotations that belong to the recording. Populated when recording filestate is AVAILABLE. items: $ref: '#/definitions/Annotation' fileState: type: string description: 'Represents the current file state for a recording. Examples: Uploading, Archived, etc' enum: - ARCHIVED - AVAILABLE - DELETED - RESTORED - RESTORING - UPLOADING - ERROR restoreExpirationTime: type: string format: date-time description: 'The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' archiveDate: type: string format: date-time description: 'The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' archiveMedium: type: string description: 'The type of archive medium used. Example: CloudArchive' enum: - CLOUDARCHIVE deleteDate: type: string format: date-time description: 'The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportDate: type: string format: date-time description: 'The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportedDate: type: string format: date-time description: 'The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' maxAllowedRestorationsForOrg: type: integer format: int32 description: How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced. remainingRestorationsAllowedForOrg: type: integer format: int32 description: The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced. sessionId: type: string description: The session id represents an external resource id, such as email, call, chat, etc region: type: string description: The region the source recording is stored in enum: - af-south-1 - ap-east-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - me-central-1 - mx-central-1 - sa-east-1 - us-east-1 - us-west-2 selfUri: type: string format: uri description: The URI for this object readOnly: true 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 MessageMediaPolicyConditions: type: object properties: forUsers: type: array description: 'List of users to apply this policy to. Each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' items: $ref: '#/definitions/PolicyUser' dateRanges: type: array items: type: string forQueues: type: array items: $ref: '#/definitions/Queue' wrapupCodes: type: array items: $ref: '#/definitions/WrapupCode' languages: type: array items: $ref: '#/definitions/Language' timeAllowed: $ref: '#/definitions/TimeAllowed' teams: type: array description: Teams to match conversations against items: $ref: '#/definitions/Team' customerParticipation: type: string enum: - 'YES' - 'NO' 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 OrphanRecording: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string createdTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' recoveredTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' providerType: type: string enum: - EDGE - CHAT - EMAIL - SCREEN_RECORDING - PUREENGAGE - PURECONNECT mediaSizeBytes: type: integer format: int64 mediaType: type: string enum: - CALL - CHAT - EMAIL - SCREEN mediaSubtype: type: string enum: - Trunk - Station - Consult - Screen - Snippet mediaSubject: type: string fileState: type: string enum: - ARCHIVED - AVAILABLE - DELETED - RESTORED - RESTORING - UPLOADING providerEndpoint: $ref: '#/definitions/Endpoint' recording: $ref: '#/definitions/Recording' orphanStatus: type: string description: The status of the orphaned recording's conversation. enum: - NO_CONVERSATION - UNKNOWN_CONVERSATION - CONVERSATION_NOT_COMPLETE - CONVERSATION_NOT_EVALUATED - EVALUATED sourceOrphaningId: type: string description: An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with region: type: string enum: - af-south-1 - ap-east-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - me-central-1 - mx-central-1 - sa-east-1 - us-east-1 - us-west-2 selfUri: type: string format: uri description: The URI for this object readOnly: true QuickReply: type: object 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 textback payload after clicking a quick reply url: type: string description: The location of the image file associated with quick reply action: type: string description: Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is "Message" which sends a message using the quick reply text. enum: - Message isSelected: type: boolean description: Indicates if the quick reply option is selected by end customer 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' CrossPlatformMediaPolicies: type: object properties: callPolicy: description: Conditions and actions for calls $ref: '#/definitions/CrossPlatformCallMediaPolicy' chatPolicy: description: Conditions and actions for chats $ref: '#/definitions/CrossPlatformChatMediaPolicy' emailPolicy: description: Conditions and actions for emails $ref: '#/definitions/CrossPlatformEmailMediaPolicy' messagePolicy: description: Conditions and actions for messages $ref: '#/definitions/CrossPlatformMessageMediaPolicy' LocalEncryptionConfiguration: type: object required: - apiId - apiKey - url properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string url: type: string description: The url for decryption. This must specify the path to where Purecloud can requests decryption apiId: type: string description: The api id for Hawk Authentication. apiKey: type: string description: The api shared symmetric key used for hawk authentication selfUri: type: string format: uri description: The URI for this object readOnly: true 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. 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. CrossPlatformPolicyUpdate: type: object properties: enabled: type: boolean 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' EvaluationAssignment: type: object properties: evaluationForm: $ref: '#/definitions/EvaluationForm' user: $ref: '#/definitions/User' 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 PolicyCreate: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The policy 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' 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' order: type: integer format: int32 description: type: string enabled: type: boolean mediaPolicies: description: Conditions and actions per media type $ref: '#/definitions/MediaPolicies' conditions: description: Conditions $ref: '#/definitions/PolicyConditions' actions: description: Actions $ref: '#/definitions/PolicyActions' policyErrors: $ref: '#/definitions/PolicyErrors' selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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. 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 CallMediaPolicyConditions: type: object properties: forUsers: type: array description: 'List of users to apply this policy to. Each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' items: $ref: '#/definitions/PolicyUser' dateRanges: type: array items: type: string forQueues: type: array items: $ref: '#/definitions/Queue' wrapupCodes: type: array items: $ref: '#/definitions/WrapupCode' languages: type: array items: $ref: '#/definitions/Language' timeAllowed: $ref: '#/definitions/TimeAllowed' teams: type: array description: Teams to match conversations against items: $ref: '#/definitions/Team' directions: type: array items: type: string enum: - INBOUND - OUTBOUND duration: $ref: '#/definitions/DurationCondition' Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string RecordingRetention: type: object properties: conversationId: type: string recordingId: type: string archiveDate: type: string format: date-time description: 'The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' archiveMedium: type: string description: 'The type of archive medium used. Example: CloudArchive' enum: - CLOUDARCHIVE deleteDate: type: string format: date-time description: 'The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportDate: type: string format: date-time description: 'The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportedDate: type: string format: date-time description: 'The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' creationTime: type: string format: date-time description: 'The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' 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 BatchDownloadJobSubmissionResult: 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 CallMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/PolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/CallMediaPolicyConditions' 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 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' 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' Language: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The language name. 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' state: type: string enum: - active - inactive - deleted version: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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 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' RecordingFormResponseContent: type: object properties: contentType: type: string description: Type of this content element. enum: - ButtonResponse buttonResponse: description: Button response content. $ref: '#/definitions/ButtonResponse' 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 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. 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 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 LocationEmergencyNumber: type: object properties: e164: type: string number: type: string type: type: string description: The type of emergency number. enum: - default - elin AiScoringSetting: type: object properties: enabled: type: boolean description: True if AI Scoring feature is configured. 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]. EmailMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/PolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/EmailMediaPolicyConditions' RecordingTemplateFooter: type: object properties: text: type: string description: Footer text. ScreenRecordingActiveSessions: type: object properties: count: type: integer format: int32 description: Current concurrent active screen recordings count for organization RecordingMessagingMessage: type: object properties: from: type: string description: The message sender session id. fromUser: description: The user who sent this message. $ref: '#/definitions/User' fromExternalContact: description: The PureCloud external contact sender details. $ref: '#/definitions/ExternalContact' to: type: string description: The message recipient. 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' id: type: string description: A globally unique identifier for this communication. status: type: string description: Status of the message purpose: type: string description: A well known string that specifies the purpose or type of the participant on this communication. participantId: type: string description: A globally unique identifier for the participant on this communication. queue: description: A globally unique identifier for the queue involved in this communication. $ref: '#/definitions/AddressableEntityRef' workflow: description: A globally unique identifier for the workflow involved in this communication. $ref: '#/definitions/AddressableEntityRef' messageText: type: string description: The content of this message. messageMediaAttachments: type: array description: List of media objects attached with this message. items: $ref: '#/definitions/MessageMediaAttachment' messageStickerAttachments: type: array description: List of message stickers attached with this message. items: $ref: '#/definitions/MessageStickerAttachment' quickReplies: type: array description: List of quick reply options offered with this message. items: $ref: '#/definitions/QuickReply' buttonResponse: description: Button Response selected by user for this message. $ref: '#/definitions/ButtonResponse' buttonResponses: type: array description: List of Button Response selected by user for this message. items: $ref: '#/definitions/ButtonResponse' story: description: Ephemeral story content. $ref: '#/definitions/RecordingContentStory' cards: type: array description: List of cards offered for this message items: $ref: '#/definitions/Card' notificationTemplate: description: Template notification content. $ref: '#/definitions/RecordingNotificationTemplate' datePicker: description: DatePicker content object. $ref: '#/definitions/DatePicker' listPicker: description: ListPicker content object. $ref: '#/definitions/ListPicker' contentType: type: string description: Indicates the content type for this message enum: - QuickReply - Story - Card - Carousel - Attachment - Location - Notification - GenericTemplate - ListTemplate - Postback - Reactions - Mention - ButtonResponse - DatePicker - ListPicker - InteractiveApplication - PaymentRequest - PaymentResponse - Form - RichLink - RoadsideAssistance - NotificationResponse socialVisibility: type: string description: For social media messages, the visibility of the message in the originating social platform enum: - Public - Private events: type: array description: List of event elements items: $ref: '#/definitions/ConversationMessageEvent' interactiveApplication: description: InteractiveApplication content. $ref: '#/definitions/InteractiveApplication' paymentRequest: description: Payment request content. $ref: '#/definitions/PaymentRequest' paymentResponse: description: Payment response content. $ref: '#/definitions/PaymentResponse' form: description: Form content. $ref: '#/definitions/RecordingForm' roadsideAssistance: description: Roadside Assistance content. $ref: '#/definitions/RecordingRoadsideAssistance' richLink: description: Rich Link content. $ref: '#/definitions/RichLink' messageReceipts: type: array description: List of message receipts items: $ref: '#/definitions/RecordingMessageReceipt' 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' 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' EmployerInfo: type: object properties: officialName: type: string employeeId: type: string employeeType: type: string dateHire: type: string SkillsToRemove: type: object properties: name: type: string id: type: string selfUri: type: string format: uri RecordingContentStory: 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: Story object. ListPickerItem: type: object required: - id - selected - title properties: id: type: string description: Unique identifier for the list picker item subtitle: type: string description: Additional text providing more details about the item. title: type: string description: The main text displayed for the item. selected: type: boolean description: Whether the item is selected. 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' ScreenRecordingMetaDataRequest: type: object properties: participantJid: type: string roomId: type: string metaData: type: array items: $ref: '#/definitions/ScreenRecordingMetaData' MessageStickerAttachment: type: object properties: url: type: string description: The location of the media, useful for retrieving it id: type: string description: A globally unique identifier for the media object. 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.' InteractiveApplication: 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. ButtonResponse: type: object properties: type: type: string description: Button response type that captures Button and QuickReply type responses enum: - Button - QuickReply - DatePicker - ListPicker - Form text: type: string description: Text to show inside the Button reply. This is also used as the response text after clicking on the Button. payload: type: string description: Content of the textback payload after clicking a button messageType: type: string description: Button response message type that captures QuickReply , Cards and Carousel.This is used as label for Card selection enum: - QuickReply - Card - Carousel originatingMessageId: type: string description: Reference to the ID of the original message (e.g., list picker) this button response is replying to. RecordingJobFailedRecording: type: object properties: conversation: description: Conversation readOnly: true $ref: '#/definitions/AddressableEntityRef' recording: description: Recording readOnly: true $ref: '#/definitions/AddressableEntityRef' SurveyAssignment: type: object required: - sendingDomain properties: surveyForm: description: The survey form used for this survey. $ref: '#/definitions/PublishedSurveyFormReference' flow: description: The URI reference to the flow associated with this survey. $ref: '#/definitions/DomainEntityRef' inviteTimeInterval: type: string description: An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days. sendingUser: type: string description: User together with sendingDomain used to send email, null to use no-reply sendingDomain: type: string description: Validated email domain, required 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' 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 MessageMediaAttachment: 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. enum: - image/png - image/jpeg - image/gif contentLength: type: integer format: int64 description: The optional content length of the the media object, in bytes. name: type: string description: The name of the media object. id: type: string description: A globally unique identifier for the media object. ResourceConditionValue: type: object properties: type: type: string enum: - SCALAR - VARIABLE - USER - QUEUE - TEAM value: type: string ChatMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/PolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/ChatMediaPolicyConditions' CrossPlatformPolicyActions: type: object properties: retainRecording: type: boolean description: true to retain the recording associated with the conversation. Default = true deleteRecording: type: boolean description: true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false alwaysDelete: type: boolean description: true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false assignEvaluations: type: array items: $ref: '#/definitions/EvaluationAssignment' assignMeteredEvaluations: type: array items: $ref: '#/definitions/MeteredEvaluationAssignment' assignMeteredAssignmentByAgent: type: array items: $ref: '#/definitions/MeteredAssignmentByAgent' assignCalibrations: type: array items: $ref: '#/definitions/CalibrationAssignment' retentionDuration: $ref: '#/definitions/RetentionDuration' mediaTranscriptions: type: array items: $ref: '#/definitions/MediaTranscription' integrationExport: description: Policy action for exporting recordings using an integration to 3rd party s3. $ref: '#/definitions/IntegrationExport' ChatMessage: type: object properties: body: type: string description: The message body id: type: string to: type: string description: The message recipient from: type: string description: The message sender utc: type: string chat: type: string description: The interaction id (if available) message: type: string description: The message id type: type: string bodyType: type: string description: Type of the message body (v2 chats only) enum: - STANDARD - ACTIVITY - TYPING - NOTICE - MEMBERJOIN - MEMBERLEAVE - MEDIAREQUEST senderCommunicationId: type: string description: Communication of sender (v2 chats only) participantPurpose: type: string description: Participant purpose of sender (v2 chats only) user: description: The user information for the sender (if available) $ref: '#/definitions/ChatMessageUser' 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 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 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' 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. RecordingEncryptionConfigurationListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/RecordingEncryptionConfiguration' selfUri: type: string format: uri MediaResult: type: object properties: mediaUri: type: string waveformData: type: array items: type: number format: float UserParam: type: object properties: key: type: string value: type: string RecordingMessageReceiptReason: type: object 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 RichLinkHeader: type: object properties: type: type: string description: Describes the Rich Link header type. enum: - Text - Image - File - Video value: type: string description: Rich Link header text value. url: type: string description: Rich Link header URL. BatchDownloadRequest: type: object properties: conversationId: type: string description: Conversation id requested recordingId: type: string description: Recording id requested, optional. Leave null for all recordings on the conversation RecordingSettings: type: object properties: maxSimultaneousStreams: type: integer format: int32 description: Maximum number of simultaneous screen recording streams maxConfigurableScreenRecordingStreams: type: integer format: int32 description: Upper limit that maxSimultaneousStreams can be configured regionalRecordingStorageEnabled: type: boolean description: Store call recordings in the region where they are intended to be recorded, otherwise in the organization's home region recordingPlaybackUrlTtl: type: integer format: int32 description: The duration in minutes for which the generated URL for recording playback remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes. recordingBatchDownloadUrlTtl: type: integer format: int32 description: The duration in minutes for which the generated URL for recording batch download remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes. stopRecordingWhenOnlyExternalParticipants: type: boolean description: Whether to stop recording in conference when only external participants remain Chat: type: object properties: jabberId: type: string RecordingEncryptionConfiguration: type: object required: - keyConfigurationType - url properties: id: type: string description: The globally unique identifier for the object. readOnly: true url: type: string description: When keyConfigurationType is LocalKeyManager, this should be the url for decryption and must specify the path to where GenesysCloud can requests decryption. When keyConfigurationType is KmsSymmetric, this should be the arn to the key alias for the master key apiId: type: string description: The api id for Hawk Authentication. Null if keyConfigurationType is KmsSymmetric apiKey: type: string description: The api shared symmetric key used for hawk authentication. Null if keyConfigurationType is KmsSymmetric keyConfigurationType: type: string description: Type should be LocalKeyManager or KmsSymmetric when create or update Key configurations; 'Native' for disabling 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 CardAction: type: object properties: type: type: string description: Describes the type of action. enum: - Link - Postback text: type: string description: The response text from the button click. payload: type: string description: Content of the textback payload after clicking a button. url: type: string description: The location of the image file associated with action. isSelected: type: boolean description: Indicates if the card option is selected by end customer. description: A card action that a user can take. ChatMessageUser: type: object properties: id: type: string name: type: string displayName: type: string username: type: string images: type: array items: $ref: '#/definitions/Image' 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 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 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' RecordingAttachment: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true 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. text: type: string description: Text associated with attachment such as an image caption. fileName: type: string description: Suggested file name for attachment. 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. 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 QueueEmailAddress: type: object properties: domain: $ref: '#/definitions/DomainEntityRef' route: $ref: '#/definitions/InboundRoute' 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' BatchDownloadJobResult: type: object properties: conversationId: type: string description: Conversation id of the result recordingId: type: string description: Recording id of the result resultUrl: type: string description: URL of results... HTTP GET from this location to download results for this item contentType: type: string description: Content type of this result errorMsg: type: string description: An error message, in case of failed processing will indicate the cause of the failure 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' Actions: type: object properties: skillsToRemove: type: array uniqueItems: true items: $ref: '#/definitions/SkillsToRemove' Image: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string DatePickerAvailableDateTime: 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 times of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' 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. ArchiveRetention: type: object properties: days: type: integer format: int32 storageMedium: type: string enum: - CLOUDARCHIVE 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' 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 PolicyErrorMessage: type: object properties: statusCode: type: integer format: int32 userMessage: type: object userParamsMessage: type: string errorCode: type: string correlationId: type: string userParams: type: array items: $ref: '#/definitions/UserParam' insertDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' EmailMediaPolicyConditions: type: object properties: forUsers: type: array description: 'List of users to apply this policy to. Each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' items: $ref: '#/definitions/PolicyUser' dateRanges: type: array items: type: string forQueues: type: array items: $ref: '#/definitions/Queue' wrapupCodes: type: array items: $ref: '#/definitions/WrapupCode' languages: type: array items: $ref: '#/definitions/Language' timeAllowed: $ref: '#/definitions/TimeAllowed' teams: type: array description: Teams to match conversations against items: $ref: '#/definitions/Team' customerParticipation: type: string enum: - 'YES' - 'NO' 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. BatchDownloadJobStatusResult: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true jobId: type: string description: JobId returned when job was initially submitted. expectedResultCount: type: integer format: int32 description: Number of results expected when job is completed, this includes both success and error results. This number could change as recordings are being discovered and processed. resultCount: type: integer format: int32 description: Current number of results available, this includes both success and error results. errorCount: type: integer format: int32 description: Current number of error results. status: type: string description: Current status of the job. A job is considered completed when all the submitted requests have been processed and fulfilled. enum: - InProgress - Completed results: type: array description: Current set of results for the job. items: $ref: '#/definitions/BatchDownloadJobResult' selfUri: type: string format: uri description: The URI for this object readOnly: true 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 PaymentRequest: type: object required: - orderTotal properties: paymentPlatform: type: string description: The payment platform being used (e.g. Apple Pay) 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/PaymentLineItem' shippingOptions: type: array description: The available shipping options. items: $ref: '#/definitions/PaymentLineItem' RecordingJob: type: object required: - state properties: id: type: string description: The globally unique identifier for the object. readOnly: true user: description: Details of the user created the job readOnly: true $ref: '#/definitions/AddressableEntityRef' state: type: string description: The current state of the job. enum: - FULFILLED - PENDING - READY - PROCESSING - CANCELLED - FAILED recordingJobsQuery: description: Original query of the job. readOnly: true $ref: '#/definitions/RecordingJobsQuery' dateCreated: type: string format: date-time description: 'Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true totalConversations: type: integer format: int32 description: Total number of conversations affected. readOnly: true totalRecordings: type: integer format: int32 description: Total number of recordings affected. readOnly: true totalSkippedRecordings: type: integer format: int32 description: Total number of recordings that have been skipped. readOnly: true totalFailedRecordings: type: integer format: int32 description: Total number of recordings that the bulk job failed to process. readOnly: true totalProcessedRecordings: type: integer format: int32 description: Total number of recordings have been processed. readOnly: true percentProgress: type: integer format: int32 description: Progress in percentage based on the number of recordings readOnly: true errorMessage: type: string description: Error occurred during the job execution readOnly: true failedRecordings: type: string description: Get IDs of recordings that the bulk job failed for readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true 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' 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 RecordingInput: type: object 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). responseText: type: string description: Text response from end customer. Bullseye: type: object properties: rings: type: array description: The bullseye rings configured for this queue. items: $ref: '#/definitions/Ring' PolicyConditions: type: object properties: forUsers: type: array description: 'List of users to apply this policy to. Each user object can include the ''id'' field containing the user''s unique identifier. Example: [{"id":""}].' items: $ref: '#/definitions/PolicyUser' directions: type: array items: type: string enum: - INBOUND - OUTBOUND dateRanges: type: array items: type: string mediaTypes: type: array items: type: string enum: - CALL - CHAT forQueues: type: array items: $ref: '#/definitions/Queue' duration: $ref: '#/definitions/DurationCondition' wrapupCodes: type: array items: $ref: '#/definitions/WrapupCode' timeAllowed: $ref: '#/definitions/TimeAllowed' teams: type: array description: Teams to match conversations against items: $ref: '#/definitions/Team' customerParticipation: type: string description: This condition is to filter out conversation with and without customer participation. enum: - 'YES' - 'NO' 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' LocationImage: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string 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 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 MeteredEvaluationAssignment: type: object properties: evaluationContextId: type: string evaluators: type: array items: $ref: '#/definitions/User' maxNumberEvaluations: type: integer format: int32 evaluationForm: $ref: '#/definitions/EvaluationForm' assignToActiveUser: type: boolean timeInterval: $ref: '#/definitions/TimeInterval' 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' 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 RecordingRetentionCursorEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/RecordingRetention' nextUri: type: string selfUri: type: string previousUri: type: string EncryptionKey: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string createDate: type: string format: date-time description: 'create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' keydataSummary: type: string description: key data summary (base 64 encoded public key) user: description: user that requested generation of public key $ref: '#/definitions/User' localEncryptionConfiguration: description: Local configuration $ref: '#/definitions/LocalEncryptionConfiguration' keyConfigurationType: type: string description: Key type used in this configuration enum: - KmsSymmetric - LocalKeyManager - Native - None kmsKeyArn: type: string description: ARN of internal key to be wrapped by AWS KMS Symmetric key selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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' 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' 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' EmailAttachment: type: object properties: name: type: string contentPath: type: string contentType: type: string attachmentId: type: string contentLength: type: integer format: int32 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 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 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 RecordingRoadsideAssistance: type: object properties: text: type: string description: The Roadside Assistance message text. phoneNumber: type: string description: Phone number the user provided. isDevicePhoneNumber: type: boolean description: If the user provided their own phone number. location: description: User Location object. $ref: '#/definitions/RecordingLocation' messageNumber: type: integer format: int64 description: The counter of the message. 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' 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 RecordingTemplateBody: type: object properties: text: type: string description: Template parameters for placeholders in template. OrphanUpdateRequest: type: object properties: archiveDate: type: string format: date-time description: 'The orphan recording''s archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' deleteDate: type: string format: date-time description: 'The orphan recording''s delete date. Must be greater than archiveDate and exportDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' exportDate: type: string format: date-time description: 'The orphan recording''s export date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' integrationId: type: string description: IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set. conversationId: type: string description: A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media. FailedRecordingEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/RecordingJobFailedRecording' 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 PolicyEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Policy' 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 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) 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' RecordingFormPageComponent: 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/DatePicker' wheelPicker: description: Wheel Picker content. $ref: '#/definitions/RecordingWheelPicker' listPicker: description: List Picker content. $ref: '#/definitions/ListPicker' input: description: Input content. $ref: '#/definitions/RecordingInput' CrossPlatformChatMediaPolicy: type: object properties: actions: description: Actions applied when specified conditions are met $ref: '#/definitions/CrossPlatformPolicyActions' conditions: description: Conditions for when actions should be applied $ref: '#/definitions/ChatMediaPolicyConditions' MediaPolicies: type: object properties: callPolicy: description: Conditions and actions for calls $ref: '#/definitions/CallMediaPolicy' chatPolicy: description: Conditions and actions for chats $ref: '#/definitions/ChatMediaPolicy' emailPolicy: description: Conditions and actions for emails $ref: '#/definitions/EmailMediaPolicy' messagePolicy: description: Conditions and actions for messages $ref: '#/definitions/MessageMediaPolicy' RecordingFormResponseComponent: type: object 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/RecordingFormResponseContent' 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. RecordingFormPage: type: object 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/RecordingFormPageComponent' RecordingMessageReceipt: type: object properties: id: type: string description: The id of the message receipt. Message receipts will have the same ID as the message they reference. receiptTime: type: string format: date-time description: 'Original time of the event (receipt). Example: delivery receipt time, read receipt time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' status: type: string description: The message receipt status 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/RecordingMessageReceiptReason' 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' 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 IntegrationExport: type: object required: - integration properties: integration: description: The aws-s3-recording-bulk-actions-integration that the policy uses for exports. $ref: '#/definitions/DomainEntityRef' shouldExportScreenRecordings: type: boolean description: True if the policy should export screen recordings in addition to the other conversation media. Default = true AppleOpaqueId: type: object properties: value: type: string description: 'Max: 255 characters. Leading and trailing whitespace stripped.' 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' 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.' 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 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' RecordingTemplateCard: type: object properties: header: description: The template header. $ref: '#/definitions/RecordingTemplateHeader' body: description: The template body. $ref: '#/definitions/RecordingTemplateBody' buttons: type: array description: Template buttons. items: $ref: '#/definitions/RecordingTemplateButton' 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 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/