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 Voicemail 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: Voicemail description: Mailbox, messages, policy externalDocs: description: Voicemail Documentation url: https://developer.genesys.cloud/commdigital/voicemail/ paths: /api/v2/voicemail/groups/{groupId}/messages: get: tags: - Voicemail summary: List voicemail messages description: '' operationId: getVoicemailGroupMessages produces: - application/json parameters: - name: groupId in: path description: Group ID required: true type: string - 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/VoicemailMessageEntityListing' '400': description: The request could not be understood by the server due to malformed 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' voicemail.not.authorized.voicemail.message: Not authorized to access voicemail messages not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailGroupMessages /api/v2/voicemail/queues/{queueId}/messages: get: tags: - Voicemail summary: List voicemail messages description: '' operationId: getVoicemailQueueMessages produces: - application/json parameters: - name: queueId in: path description: Queue ID required: true type: string - 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/VoicemailMessageEntityListing' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ANY permissions: - voicemail:acdvoicemail:view x-purecloud-method-name: getVoicemailQueueMessages /api/v2/voicemail/users/{userId}/messages: get: tags: - Voicemail summary: List voicemail messages description: '' operationId: getVoicemailUserMessages produces: - application/json parameters: - name: userId in: path description: User ID required: true type: string - 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/VoicemailMessageEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ANY permissions: - voicemail:voicemail:viewOther x-purecloud-method-name: getVoicemailUserMessages /api/v2/voicemail/groups/{groupId}/policy: get: tags: - Voicemail summary: Get a group's voicemail policy description: '' operationId: getVoicemailGroupPolicy produces: - application/json parameters: - name: groupId in: path description: Group ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailGroupPolicy' '400': description: The request could not be understood by the server due to malformed 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: voicemailservice.groupnotfound: The voicemail policy was not found general.resource.not.found: The voicemail policy was not found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ANY permissions: - voicemail:groupPolicy:view x-purecloud-method-name: getVoicemailGroupPolicy patch: tags: - Voicemail summary: Update a group's voicemail policy description: '' operationId: patchVoicemailGroupPolicy produces: - application/json parameters: - name: groupId in: path description: Group ID required: true type: string - in: body name: body description: The group's voicemail policy required: true schema: $ref: '#/definitions/VoicemailGroupPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailGroupPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail x-inin-requires-permissions: type: ANY permissions: - voicemail:groupPolicy:edit x-purecloud-method-name: patchVoicemailGroupPolicy /api/v2/voicemail/mailbox: get: tags: - Voicemail summary: Get the current user's mailbox information description: '' operationId: getVoicemailMailbox produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMailboxInfo' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMailbox /api/v2/voicemail/me/mailbox: get: tags: - Voicemail summary: Get the current user's mailbox information description: '' operationId: getVoicemailMeMailbox produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMailboxInfo' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '502': description: Bad Gateway schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: externalservice.error: External service error. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMeMailbox /api/v2/voicemail/groups/{groupId}/mailbox: get: tags: - Voicemail summary: Get the group's mailbox information description: '' operationId: getVoicemailGroupMailbox produces: - application/json parameters: - name: groupId in: path description: groupId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMailboxInfo' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailGroupMailbox /api/v2/voicemail/users/{userId}/mailbox: get: tags: - Voicemail summary: Get a user's mailbox information description: '' operationId: getVoicemailUserMailbox produces: - application/json parameters: - name: userId in: path description: userId required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMailboxInfo' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ANY permissions: - voicemail:mailbox:viewOther x-purecloud-method-name: getVoicemailUserMailbox /api/v2/voicemail/me/messages: get: tags: - Voicemail summary: List voicemail messages description: '' operationId: getVoicemailMeMessages 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/VoicemailMessageEntityListing' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMeMessages /api/v2/voicemail/me/policy: get: tags: - Voicemail summary: Get the current user's voicemail policy description: '' operationId: getVoicemailMePolicy produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailUserPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMePolicy patch: tags: - Voicemail summary: Update the current user's voicemail policy description: '' operationId: patchVoicemailMePolicy produces: - application/json parameters: - in: body name: body description: The user's voicemail policy required: true schema: $ref: '#/definitions/VoicemailUserPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailUserPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail x-purecloud-method-name: patchVoicemailMePolicy /api/v2/voicemail/messages/{messageId}: get: tags: - Voicemail summary: Get a voicemail message description: '' operationId: getVoicemailMessage produces: - application/json parameters: - name: messageId in: path description: Message ID required: true type: string - name: expand in: query description: If the caller is a known user, which fields, if any, to expand required: false type: array items: type: string enum: - callerUser.routingStatus - callerUser.primaryPresence - callerUser.conversationSummary - callerUser.outOfOffice - callerUser.geolocation - conversations - transcription collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMessage put: tags: - Voicemail summary: Update a voicemail message description: A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. operationId: putVoicemailMessage produces: - application/json parameters: - name: messageId in: path description: Message ID required: true type: string - in: body name: body description: VoicemailMessage required: true schema: $ref: '#/definitions/VoicemailMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] voicemail.retention.policy.type.required: The voicemail retention policy type is required constraint.validation: '%s' voicemail.retention.policy.number.of.days.too.small: The retention policy's number of days is too small voicemail.retention.policy.type.unknown: The voicemail retention policy type is invalid not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable voicemail.retention.policy.number.of.days.required: The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL invalid.date: 'Dates must be specified as ISO-8601 strings. 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. voicemail.retention.policy.number.of.days.too.large: The retention policy's number of days is too large invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' voicemail.not.authorized.voicemail.delete: You are not authorized to delete the voicemail message. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. voicemail.notes.length.exceeded: The voicemail message's note length was exceeded. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail x-purecloud-method-name: putVoicemailMessage delete: tags: - Voicemail summary: Delete a voicemail message. description: A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission. operationId: deleteVoicemailMessage produces: - application/json parameters: - name: messageId in: path description: Message 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: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail x-purecloud-method-name: deleteVoicemailMessage patch: tags: - Voicemail summary: Update a voicemail message description: A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. operationId: patchVoicemailMessage produces: - application/json parameters: - name: messageId in: path description: Message ID required: true type: string - in: body name: body description: VoicemailMessage required: true schema: $ref: '#/definitions/VoicemailMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. invalid.property: Value [%s] is not a valid property for object [%s] voicemail.retention.policy.type.required: The voicemail retention policy type is required constraint.validation: '%s' voicemail.retention.policy.number.of.days.too.small: The retention policy's number of days is too small voicemail.retention.policy.type.unknown: The voicemail retention policy type is invalid not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable voicemail.retention.policy.number.of.days.required: The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL invalid.date: 'Dates must be specified as ISO-8601 strings. 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. voicemail.retention.policy.number.of.days.too.large: The retention policy's number of days is too large invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' voicemail.not.authorized.voicemail.delete: You are not authorized to delete the voicemail message. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. voicemailservice.toomanyrequests: Too many requests have been made in the given time voicemail.notes.length.exceeded: The voicemail message's note length was exceeded. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail x-purecloud-method-name: patchVoicemailMessage /api/v2/voicemail/messages/{messageId}/media: get: tags: - Voicemail summary: Get media playback URI for this voicemail message description: API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads operationId: getVoicemailMessageMedia produces: - application/json parameters: - name: messageId in: path description: Message 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 responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMediaInfo' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMessageMedia /api/v2/voicemail/messages: get: tags: - Voicemail summary: List voicemail messages description: '' operationId: getVoicemailMessages produces: - application/json parameters: - name: ids in: query description: An optional comma separated list of VoicemailMessage ids required: false type: string - name: expand in: query description: If the caller is a known user, which fields, if any, to expand required: false type: array items: type: string enum: - callerUser.routingStatus - callerUser.primaryPresence - callerUser.conversationSummary - callerUser.outOfOffice - callerUser.geolocation - conversations - transcription collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMessageEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access a voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailMessages post: tags: - Voicemail summary: Copy a voicemail message to a user or group description: '' operationId: postVoicemailMessages produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/CopyVoicemailMessage' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailMessage' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. voicemail.copy.missing.voicemail.message.id: The request requires a voicemailMessageId bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] voicemail.copy.missing.target: The request requires a userId or groupId constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' voicemail.not.authorized.voicemail.message: You are not authorized to access the voicemail message. not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. voicemail.copy.group.does.not.have.voicemail.enabled: Cannot copy the voicemail to the group because they do not have voicemail enabled voicemail.copy.user.does.not.have.voicemail.enabled: Cannot copy the voicemail to the user because they do not have voicemail enabled '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail x-purecloud-method-name: postVoicemailMessages delete: tags: - Voicemail summary: Delete all voicemail messages description: '' operationId: deleteVoicemailMessages produces: - application/json parameters: [] responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.a.user: This request requires a user context. Client credentials cannot be used for requests to this resource. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - voicemail x-purecloud-method-name: deleteVoicemailMessages /api/v2/voicemail/policy: get: tags: - Voicemail summary: Get a policy description: '' operationId: getVoicemailPolicy produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailOrganizationPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ALL permissions: - telephony:plugin:all x-purecloud-method-name: getVoicemailPolicy put: tags: - Voicemail summary: Update a policy description: '' operationId: putVoicemailPolicy produces: - application/json parameters: - in: body name: body description: Policy required: true schema: $ref: '#/definitions/VoicemailOrganizationPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailOrganizationPolicy' '400': description: The request could not be understood by the server due to malformed 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: voicemailservice.orgvoicemailconfig.alerttimeouttoolarge: AlertTimeoutTooLarge voicemailservice.orgvoicemailconfig.maxpinlengthtoosmall: MaxPinLengthTooSmall voicemailservice.orgvoicemailconfig.iterationstoolarge: IterationsTooLarge voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaysmissing: UserVoicemailRetentionPolicyNumberOfDaysMissing voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypemissing: GroupVoicemailRetentionPolicyTypeMissing voicemailservice.orgvoicemailconfig.minrecordingtimegreaterthanmax: MinRecordingTimeGreaterThanMax voicemailservice.orgvoicemailconfig.organizationnotfound: OrganizationNotFound voicemailservice.orgvoicemailconfig.saltlengthtoolarge: SaltLengthTooLarge voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaysmissing: GroupVoicemailRetentionPolicyNumberOfDaysMissing voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoolarge: GroupVoicemailRetentionPolicyNumberOfDaysTooLarge voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypemissing: UserVoicemailRetentionPolicyTypeMissing voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypeunknown: QueueVoicemailRetentionPolicyTypeUnknown voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoosmall: GroupVoicemailRetentionPolicyNumberOfDaysTooSmall voicemailservice.orgvoicemailconfig.minpinlengthtoosmall: MinPinLengthTooSmall voicemailservice.orgvoicemailconfig.maxrecordingtimetoolarge: MaxRecordingTimeTooLarge voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoolarge: QueueVoicemailRetentionPolicyNumberOfDaysTooLarge voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypeunknown: UserVoicemailRetentionPolicyTypeUnknown voicemailservice.orgvoicemailconfig.alerttimeouttoosmall: AlertTimeoutTooSmall voicemailservice.orgvoicemailconfig.iterationstoosmall: IterationsTooSmall voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoolarge: UserVoicemailRetentionPolicyNumberOfDaysTooLarge voicemailservice.orgvoicemailconfig.invalidalgorithm: InvalidAlgorithm voicemailservice.orgvoicemailconfig.keylengthtoosmall: KeyLengthTooSmall voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoosmall: QueueVoicemailRetentionPolicyNumberOfDaysTooSmall request.conflict: The request conflicts with the current state of the target resource. voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypemissing: QueueVoicemailRetentionPolicyTypeMissing voicemailservice.orgvoicemailconfig.minrecordingtimetoosmall: MinRecordingTimeTooSmall voicemailservice.orgvoicemailconfig.hipaaenabledorganizationcannotsendemailnotifications: HipaaEnabledOrganizationCannotSendEmailNotifications voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaysmissing: QueueVoicemailRetentionPolicyNumberOfDaysMissing voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypeunknown: GroupVoicemailRetentionPolicyTypeUnknown voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoosmall: UserVoicemailRetentionPolicyNumberOfDaysTooSmall voicemailservice.orgvoicemailconfig.keylengthtoolarge: KeyLengthTooLarge voicemailservice.orgvoicemailconfig.saltlengthtoosmall: SaltLengthTooSmall voicemailservice.orgvoicemailconfig.minpinlengthgreaterthanmax: MinPinLengthGreaterThanMax '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '424': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: voicemailservice.orgvoicemailconfig.unabletoverifyorganizationhipaaenabledflag: UnableToVerifyOrganizationHipaaEnabledFlag security: - PureCloud OAuth: - voicemail x-inin-requires-permissions: type: ALL permissions: - telephony:plugin:all x-purecloud-method-name: putVoicemailPolicy /api/v2/voicemail/userpolicies/{userId}: get: tags: - Voicemail summary: Get a user's voicemail policy description: '' operationId: getVoicemailUserpolicy produces: - application/json parameters: - name: userId in: path description: User ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailUserPolicy' '400': description: The request could not be understood by the server due to malformed 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: voicemailservice.user.usernotfound: The specified voicemail user 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: - voicemail - voicemail:readonly x-inin-requires-permissions: type: ANY permissions: - telephony:plugin:all - voicemail:userPolicy:viewOther x-purecloud-method-name: getVoicemailUserpolicy put: tags: - Voicemail summary: Update a user's voicemail policy description: '' operationId: putVoicemailUserpolicy produces: - application/json parameters: - name: userId in: path description: User ID required: true type: string - in: body name: body description: The user's voicemail policy required: true schema: $ref: '#/definitions/VoicemailUserPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailUserPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail x-inin-requires-permissions: type: ANY permissions: - telephony:plugin:all - voicemail:userPolicy:viewOther x-purecloud-method-name: putVoicemailUserpolicy patch: tags: - Voicemail summary: Update a user's voicemail policy description: '' operationId: patchVoicemailUserpolicy produces: - application/json parameters: - name: userId in: path description: User ID required: true type: string - in: body name: body description: The user's voicemail policy required: true schema: $ref: '#/definitions/VoicemailUserPolicy' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailUserPolicy' '400': description: The request could not be understood by the server due to malformed 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: - voicemail x-inin-requires-permissions: type: ANY permissions: - telephony:plugin:all - voicemail:userPolicy:viewOther x-purecloud-method-name: patchVoicemailUserpolicy /api/v2/voicemail/search: get: tags: - Voicemail summary: Search voicemails using the q64 value returned from a previous search description: '' operationId: getVoicemailSearch produces: - application/json parameters: - name: q64 in: query description: q64 required: true type: string - name: expand in: query description: expand required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailsSearchResponse' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-purecloud-method-name: getVoicemailSearch post: tags: - Voicemail summary: Search voicemails description: '' operationId: postVoicemailSearch produces: - application/json parameters: - in: body name: body description: Search request options required: true schema: $ref: '#/definitions/VoicemailSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/VoicemailsSearchResponse' '400': description: The request could not be understood by the server due to malformed 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: - voicemail - voicemail:readonly x-purecloud-method-name: postVoicemailSearch definitions: Team: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The team name division: description: The division to which this entity belongs. $ref: '#/definitions/WritableDivision' description: type: string description: Team information. dateCreated: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members in a team readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true WorkPlanBidRanks: type: object properties: id: type: string description: The globally unique identifier for the user. workPlanBiddingPerformance: type: integer format: int32 description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999. biddingTieBreaker: type: string description: Custom agent ranking metric that some customers can use. selfUri: type: string format: uri description: The URI for this object readOnly: true AddressableEntityRef: type: object properties: id: type: string selfUri: type: string format: uri ResourcePermissionPolicy: type: object properties: id: type: string domain: type: string entityName: type: string policyName: type: string policyDescription: type: string actionSetKey: type: string allowConditions: type: boolean resourceConditionNode: $ref: '#/definitions/ResourceConditionNode' namedResources: type: array items: type: string resourceCondition: type: string actionSet: type: array uniqueItems: true items: type: string AiScoring: type: object properties: failureType: type: string description: The type of error that occurred while processing AI scores. It is null where there is no error. readOnly: true enum: - QuotaReached - ParsingError - ServiceError - InvalidRequest - DuplicateFormSameAgent - Unauthorized - DuplicateAutomatedFormWithCopiedScore pending: type: boolean description: Indicates whether AI scoring is currently processing the evaluation. readOnly: true dateLastChanged: type: string format: date-time description: 'The date when the AI scores were last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true WritableDivision: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true FaxStatus: type: object properties: direction: type: string description: The fax direction, either "send" or "receive". expectedPages: type: integer format: int64 description: Total number of expected pages, if known. activePage: type: integer format: int64 description: Active page of the transmission. linesTransmitted: type: integer format: int64 description: Number of lines that have completed transmission. bytesTransmitted: type: integer format: int64 description: Number of bytes that have competed transmission. baudRate: type: integer format: int64 description: Current signaling rate of transmission, baud rate. pageErrors: type: integer format: int64 description: Number of page errors. lineErrors: type: integer format: int64 description: Number of line errors. VoicemailsSearchResponse: type: object required: - pageCount - pageNumber - pageSize - results - total - types properties: total: type: integer format: int64 description: The total number of results found pageCount: type: integer format: int32 description: The total number of pages pageSize: type: integer format: int32 description: The current page size pageNumber: type: integer format: int32 description: The current page number previousPage: type: string description: Q64 value for the previous page of results currentPage: type: string description: Q64 value for the current page of results nextPage: type: string description: Q64 value for the next page of results types: type: array description: Resource types the search was performed against items: type: string results: type: array description: Search results items: $ref: '#/definitions/VoicemailMessage' ScreenMonitoring: type: object properties: id: type: string description: A globally unique identifier for this communication. initialState: type: string description: The initial connection state of this communication. enum: - none - connected - disconnected state: type: string description: The connection state of this communication. enum: - none - connected - disconnected segments: type: array description: The time line of the participant's Screen Monitoring media, divided into activity segments. items: $ref: '#/definitions/Segment' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - system provider: type: string description: The source provider of Screen Monitoring media. targetUser: description: The user participant who is being screen monitored. $ref: '#/definitions/AddressableEntityRef' screenMonitoring: description: Screen Monitoring identifier unique to the sourceUserId-targetUserId pair. $ref: '#/definitions/AddressableEntityRef' monitoringType: type: string description: The screen monitoring type. enum: - Unknown - AgentLevel - ConversationLevel count: type: integer format: int64 description: Number of Screen Monitoring sessions the targetUserId is involved in. connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Conversation: type: object required: - participants - startTime properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string externalTag: type: string description: The external tag associated with the conversation. startTime: type: string format: date-time description: 'The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' address: type: string description: The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound. participants: type: array description: The list of all participants in the conversation. items: $ref: '#/definitions/Participant' conversationIds: type: array description: A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference. items: type: string maxParticipants: type: integer format: int32 description: If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. recordingState: type: string description: On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording. enum: - ACTIVE - PAUSED - NONE state: type: string description: On update, 'disconnected' will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - parked - none divisions: type: array description: Identifiers of divisions associated with this conversation items: $ref: '#/definitions/ConversationDivisionMembership' recentTransfers: type: array description: The list of the most recent 20 transfer commands applied to this conversation. items: $ref: '#/definitions/TransferResponse' securePause: type: boolean description: True when the recording of this conversation is in secure pause status. utilizationLabelId: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level inactivityTimeout: type: string format: date-time description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true AdjustableLiveSpeakerDetection: type: object properties: mode: type: string description: Modes to tune between speed to live speaker detection vs accuracy. enum: - unknown - disabled - low - medium - high preconnectDuration: type: string description: ISO 8601 formatted relative duration (e.g., PT30.8427419S for 30.8 seconds), calculated on line connect. eventName: type: string description: The name of the event that triggered the ALSD evaluation (e.g., line.connect, speech.generic). isPersonLikely: type: boolean description: The output of the ALSD detector, evaluating whether there is likely a person on the call based on the above inputs, and if so, a person is detected early (person disposition name and speech.person analyzer result) and the associated action taken (e.g., speech.person postconnect entry in the disposition table has the action to transfer to a queue). totalRingbacks: type: integer format: int32 description: Number of tone.ring.* analyzer events detected during the call (expected mostly during pre-connect but the last ringback tone detection could potentially complete after line connect, which will increment totalRingbacks still). lineConnected: type: boolean description: Protocol line connect received (answered by a person, machine, busy, fax). 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' 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 Wrapup: type: object properties: code: type: string description: The user configured wrap up code id. name: type: string description: The user configured wrap up code name. notes: type: string description: Text entered by the agent to describe the call or disposition. tags: type: array description: List of tags selected by the agent to describe the call or disposition. items: type: string durationSeconds: type: integer format: int32 description: The length of time in seconds that the agent spent doing after call work. endTime: type: string format: date-time description: 'The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provisional: type: boolean description: Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later. OAuthLastTokenIssued: type: object properties: dateIssued: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationMessageMetadataContent: type: object properties: contentType: type: string description: Type of this content element. enum: - Reactions - Attachment - Location - QuickReply - Notification - ButtonResponse - Story - Mention - Card - Carousel - Text - QuickReplyV2 - DatePicker - InteractiveApplication - ListPicker - PaymentRequest - PaymentResponse - Push - Form - RoadsideAssistance - RichLink - NotificationResponse - Unknown subType: type: string description: Content subtype enum: - Image - Video - Audio - File - Link - Mention - Reply - Button - QuickReply - Postback - Unknown description: Metadata information about a message content. Disposition: type: object required: - name properties: name: type: string description: Name of the disposition. Either a platform predefined value, or the name of the disposition in the disposition table.. analyzer: type: string description: The final media analyzer result that triggered the disposition result, if any. dispositionParameters: description: Contains various parameters related to call analysis. $ref: '#/definitions/DispositionParameters' detectedSpeechStart: type: string format: date-time description: 'Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' detectedSpeechEnd: type: string format: date-time description: 'Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' amdTimeout: description: Answering Machine Detection timeout configuration. $ref: '#/definitions/DispositionAmdTimeout' silentCallTimeout: description: Silent Call timeout configuration. $ref: '#/definitions/DispositionSilentCallTimeout' QuestionSettings: type: object properties: questionContextId: type: string description: The context id of the question in the group settings: $ref: '#/definitions/AiScoringSetting' 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 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 MediaSummary: type: object properties: contactCenter: $ref: '#/definitions/MediaSummaryDetail' enterprise: $ref: '#/definitions/MediaSummaryDetail' 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 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.' Screenshare: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. context: type: string description: The room id context (xmpp jid) for the conference session. sharing: type: boolean description: Indicates whether this participant is sharing their screen. peerCount: type: integer format: int32 description: The number of peer participants from the perspective of the participant in the conference. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the screen share. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. ExpansionCriterium: type: object properties: type: type: string enum: - TIMEOUT_SECONDS threshold: type: number format: double 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. VoicemailUserPolicy: type: object properties: enabled: type: boolean description: Whether the user has voicemail enabled readOnly: true alertTimeoutSeconds: type: integer format: int32 description: The number of seconds to ring the user's phone before a call is transfered to voicemail pin: type: string description: The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security modifiedDate: type: string format: date-time description: 'The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true sendEmailNotifications: type: boolean description: Whether email notifications are sent to the user when a new voicemail is received 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 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 VoicemailMailboxInfo: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true ownerType: type: string description: The owner type of the voicemail mailbox readOnly: true enum: - User - Group - Queue usageSizeBytes: type: integer format: int64 description: The total number of bytes for all voicemail message audio recordings readOnly: true totalCount: type: integer format: int32 description: The total number of voicemail messages readOnly: true unreadCount: type: integer format: int32 description: The total number of voicemail messages marked as unread readOnly: true deletedCount: type: integer format: int32 description: The total number of voicemail messages marked as deleted readOnly: true createdDate: type: string format: date-time description: 'The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true modifiedDate: type: string format: date-time description: 'The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true newestUnreadDate: type: string format: date-time description: 'The date of the most recent unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true oldestUnreadDate: type: string format: date-time description: 'The date of the most oldest unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true newestReadDate: type: string format: date-time description: 'The date of the most recent read voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true oldestReadDate: type: string format: date-time description: 'The date of the most oldest read voicemail message. 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 UserRoutingLanguage: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. state: type: string description: Activate or deactivate this routing language. enum: - active - inactive - deleted languageUri: type: string format: uri description: URI to the organization language used by this user language. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id. ConditionalGroupActivationCondition: type: object properties: simpleMetric: description: Instructs this condition to evaluate a simple queue-level metric $ref: '#/definitions/ConditionalGroupActivationSimpleMetric' operator: type: string description: The operator used to compare the actual value against the threshold value enum: - GreaterThan - GreaterThanOrEqualTo - LessThan - LessThanOrEqualTo - EqualTo - NotEqualTo value: type: number format: double description: The threshold value, beyond which a rule evaluates as true 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 VoicemailMessage: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true conversation: description: The conversation that the voicemail message is associated with readOnly: true $ref: '#/definitions/Conversation' read: type: boolean description: Whether the voicemail message is marked as read audioRecordingDurationSeconds: type: integer format: int32 description: The voicemail message's audio recording duration in seconds readOnly: true audioRecordingSizeBytes: type: integer format: int64 description: The voicemail message's audio recording size in bytes readOnly: true transcription: type: string description: The transcription of the voicemail's audio readOnly: true createdDate: type: string format: date-time description: 'The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true modifiedDate: type: string format: date-time description: 'The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true deletedDate: type: string format: date-time description: 'The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true callerAddress: type: string description: The caller address readOnly: true callerName: type: string description: Optionally the name of the caller that left the voicemail message if the caller was a known user readOnly: true callerUser: description: Optionally the user that left the voicemail message if the caller was a known user readOnly: true $ref: '#/definitions/User' deleted: type: boolean description: Whether the voicemail message has been marked as deleted note: type: string description: An optional note user: description: The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue readOnly: true $ref: '#/definitions/User' group: description: The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue readOnly: true $ref: '#/definitions/Group' queue: description: The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group readOnly: true $ref: '#/definitions/Queue' copiedFrom: description: Represents where this voicemail message was copied from readOnly: true $ref: '#/definitions/VoicemailCopyRecord' copiedTo: type: array description: Represents where this voicemail has been copied to readOnly: true items: $ref: '#/definitions/VoicemailCopyRecord' deleteRetentionPolicy: description: The retention policy for this voicemail when deleted is set to true $ref: '#/definitions/VoicemailRetentionPolicy' selfUri: type: string format: uri description: The URI for this object readOnly: true EvaluationReference: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true TopicDuration: type: object properties: totalMilliseconds: type: integer format: int64 description: The total duration of the topic phrase within the conversation readOnly: true DispositionSilentCallTimeout: type: object properties: timeoutMs: type: integer format: int32 description: Configured silent call timeout value. timerStartTime: type: string format: date-time description: 'Timer start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' timerEndTime: type: string format: date-time description: 'Timer end time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' PagelessDomainEntityListingEvaluationVersion: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/EvaluationVersion' selfUri: type: string format: uri VoicemailMediaInfo: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true mediaFileUri: type: string format: uri mediaImageUri: type: string format: uri waveformData: type: array items: type: number format: float 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 InternalMessageDetails: type: object properties: messageId: type: string description: UUID identifying the internal message media. messageTime: type: string format: date-time description: 'The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' VoicemailCopyRecord: type: object properties: user: description: The user that the voicemail message was copied to/from readOnly: true $ref: '#/definitions/User' group: description: The group that the voicemail message was copied to/from readOnly: true $ref: '#/definitions/Group' date: type: string format: date-time description: 'The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true 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' 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 Email: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - disconnected - none - parked - transmitting initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - disconnected - none - parked - transmitting id: type: string description: A globally unique identifier for this communication. held: type: boolean description: True if this call is held and the person on this side hears silence. subject: type: string description: The subject for the initial email that started this conversation. messagesSent: type: integer format: int32 description: The number of email messages sent by this participant. segments: type: array description: The time line of the participant's email, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the email enum: - inbound - outbound recordingId: type: string description: A globally unique identifier for the recording associated with this call. errorInfo: $ref: '#/definitions/ErrorBody' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' autoGenerated: type: boolean description: Indicates that the email was auto-generated like an Out of Office reply. provider: type: string description: The source provider for the email. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. messageId: type: string description: A globally unique identifier for the stored content of this communication. draftAttachments: type: array description: A list of uploaded attachments on the email draft. items: $ref: '#/definitions/Attachment' spam: type: boolean description: Indicates if the inbound email was marked as spam. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' parkTime: type: string format: date-time description: 'Represents the time when an email was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Participant: type: object properties: id: type: string description: A globally unique identifier for this conversation. startTime: type: string format: date-time description: 'The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' name: type: string description: A human readable name identifying the participant. userUri: type: string description: If this participant represents a user, then this will be an URI that can be used to fetch the user. userId: type: string description: If this participant represents a user, then this will be the globally unique identifier for the user. externalContactId: type: string description: If this participant represents an external contact, then this will be the globally unique identifier for the external contact. externalContactInitialDivisionId: type: string description: If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned. externalOrganizationId: type: string description: If this participant represents an external org, then this will be the globally unique identifier for the external org. queueId: type: string description: If present, the queue id that the communication channel came in on. groupId: type: string description: If present, group of users the participant represents. teamId: type: string description: The team id that this participant is a member of when added to the conversation. queueName: type: string description: If present, the queue name that the communication channel came in on. purpose: type: string description: A well known string that specifies the purpose of this participant. participantType: type: string description: A well known string that specifies the type of this participant. consultParticipantId: type: string description: If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred. address: type: string description: The address for the this participant. For a phone call this will be the ANI. ani: type: string description: The address for the this participant. For a phone call this will be the ANI. aniName: type: string description: The ani-based name for this participant. dnis: type: string description: The address for the this participant. For a phone call this will be the ANI. locale: type: string description: An ISO 639 language code specifying the locale for this participant wrapupRequired: type: boolean description: True iff this participant is required to enter wrapup for this conversation. wrapupPrompt: type: string description: This field controls how the UI prompts the agent for a wrapup. enum: - mandatory - optional - agentRequested - timeout - forcedTimeout wrapupTimeoutMs: type: integer format: int32 description: Specifies how long a timed ACW session will last. wrapupSkipped: type: boolean description: The UI sets this field when the agent chooses to skip entering a wrapup for this participant. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' mediaRoles: type: array description: List of roles this participant's media has had on the conversation, ie monitor, coach, etc. items: type: string conversationRoutingData: description: Information on how a communication should be routed to an agent. $ref: '#/definitions/ConversationRoutingData' alertingTimeoutMs: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. monitoredParticipantId: type: string description: If this participant is a monitor, then this will be the id of the participant that is being monitored. coachedParticipantId: type: string description: If this participant is a coach, then this will be the id of the participant that is being coached. attributes: type: object description: Additional participant attributes additionalProperties: type: string calls: type: array items: $ref: '#/definitions/Call' callbacks: type: array items: $ref: '#/definitions/Callback' chats: type: array items: $ref: '#/definitions/ConversationChat' cobrowsesessions: type: array items: $ref: '#/definitions/Cobrowsesession' emails: type: array items: $ref: '#/definitions/Email' messages: type: array items: $ref: '#/definitions/Message' internalMessages: type: array items: $ref: '#/definitions/InternalMessage' screenMonitorings: type: array items: $ref: '#/definitions/ScreenMonitoring' screenshares: type: array items: $ref: '#/definitions/Screenshare' socialExpressions: type: array items: $ref: '#/definitions/SocialExpression' videos: type: array items: $ref: '#/definitions/Video' evaluations: type: array items: $ref: '#/definitions/Evaluation' screenRecordingState: type: string description: The current screen recording state for this participant. enum: - requested - active - paused - stopped - error - timeout flaggedReason: type: string description: The reason specifying why participant flagged the conversation. enum: - general startAcwTime: type: string format: date-time description: 'The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endAcwTime: type: string format: date-time description: 'The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' bargedParticipantId: type: string description: If this participant barged in a participant's call, then this will be the id of the targeted participant. ConversationDivisionMembership: type: object properties: division: description: A division the conversation belongs to. $ref: '#/definitions/DomainEntityRef' entities: type: array description: The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions. items: $ref: '#/definitions/DivisionEntityRef' 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' 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' 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 EvaluationQuestionGroupScore: type: object properties: questionGroupId: type: string totalScore: type: number format: float description: Score of all questions in the group maxTotalScore: type: number format: float description: Maximum possible score of all questions in the group markedNA: type: boolean description: True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system systemMarkedNA: type: boolean description: If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false. totalCriticalScore: type: number format: float description: Score of only the critical questions in the group maxTotalCriticalScore: type: number format: float description: Maximum possible score of only the critical questions in the group totalNonCriticalScore: type: number format: float description: Score of only the non critical questions in the group maxTotalNonCriticalScore: type: number format: float description: Maximum possible score of only the non critical questions in the group totalScoreUnweighted: type: number format: float description: Unweighted score of all questions in the group maxTotalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of all questions in the group totalCriticalScoreUnweighted: type: number format: float description: Unweighted score of only the critical questions in the group maxTotalCriticalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of only the critical questions in the group totalNonCriticalScoreUnweighted: type: number format: float description: Unweighted score of only the non critical questions in the group maxTotalNonCriticalScoreUnweighted: type: number format: float description: Maximum possible unweighted score of only the non critical questions in the group questionScores: type: array items: $ref: '#/definitions/EvaluationQuestionScore' JourneyAction: type: object required: - actionMap - id properties: id: type: string description: The ID of an action from the Journey System (an action is spawned from an actionMap) actionMap: description: Details about the action map from the Journey System which triggered this action $ref: '#/definitions/JourneyActionMap' DispositionParameters: type: object properties: adjustableLiveSpeakerDetection: description: ALSD evaluation inputs and output (isPersonalLikely) of the ALSD detector the last time it ran on the call (could be multiple times) $ref: '#/definitions/AdjustableLiveSpeakerDetection' MessageSubtypeSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. enableInactivityTimeout: type: boolean description: Indicates if inactivity timeout is enabled for the given subtype. 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 EvaluationQuestionScore: type: object properties: questionId: type: string answerId: type: string score: type: integer format: int32 description: Unweighted score of the question markedNA: type: boolean description: True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system systemMarkedNA: type: boolean description: If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false. assistedAnswerId: type: string description: AnswerId found with evaluation assistance conditions failedKillQuestion: type: boolean description: Applicable only on fatal questions. Indicates that the answer selected was not the highest score available for the question comments: type: string description: Comments from the evaluator specific to this question aiAnswer: description: Suggested AI answer readOnly: true $ref: '#/definitions/AiAnswer' multipleSelectQuestionOptionScores: type: array description: Only applicable to Multiple Select questions. Scores corresponding to the options of Multiple Select questions. items: $ref: '#/definitions/EvaluationQuestionScore' EvaluationVersion: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true AiAnswer: type: object properties: answerId: type: string description: The unique identifier of the suggested AI answer. explanation: type: string description: An explanation providing the reasoning behind the suggested answer. failureType: type: string description: Describes the type of error associated with the AI answer. enum: - LowConfidenceError - ParsingError - ServiceError - LowHistoricalAccuracyError TransferResponseModifiedBy: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true EvaluationSettingsAssignee: type: object properties: user: description: The user the dispute should be assigned to $ref: '#/definitions/UserReferenceWithName' type: type: string description: 'The assignee type. Valid values: Original, Individual, None' enum: - Original - Individual - None QueueMessagingAddresses: type: object properties: smsAddress: $ref: '#/definitions/DomainEntityRef' openMessagingRecipient: $ref: '#/definitions/DomainEntityRef' whatsAppRecipient: $ref: '#/definitions/DomainEntityRef' 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 Calibration: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string calibrator: $ref: '#/definitions/User' agent: $ref: '#/definitions/User' conversation: $ref: '#/definitions/ConversationReference' evaluationForm: $ref: '#/definitions/EvaluationForm' contextId: type: string averageScore: type: integer format: int32 highScore: type: integer format: int32 lowScore: type: integer format: int32 createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' evaluations: type: array items: $ref: '#/definitions/Evaluation' evaluators: type: array items: $ref: '#/definitions/User' scoringIndex: $ref: '#/definitions/Evaluation' expertEvaluator: $ref: '#/definitions/User' selfUri: type: string format: uri description: The URI for this object readOnly: true JourneyCustomer: type: object required: - id - idType properties: id: type: string description: An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable. idType: type: string description: The type of the customerId within the Journey System (e.g. cookie). SearchSort: type: object properties: sortOrder: type: string description: The sort order for results enum: - ASC - DESC - SCORE sortBy: type: string description: The field in the resource that you want to sort the results by ServiceLevel: type: object properties: percentage: type: number format: double description: The desired Service Level. A value between 0 and 1. durationMs: type: integer format: int64 description: Service Level target in milliseconds. 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. 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 PresenceDefinition: type: object properties: id: type: string description: description systemPresence: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationRoutingData: type: object properties: queue: description: The queue to use for routing decisions $ref: '#/definitions/AddressableEntityRef' language: description: The language to use for routing decisions $ref: '#/definitions/AddressableEntityRef' priority: type: integer format: int32 description: The priority of the conversation to use for routing decisions skills: type: array description: The skills to use for routing decisions items: $ref: '#/definitions/AddressableEntityRef' skillExpression: type: string description: The string with skill expression requested by the caller for routing decisions skillExpressionId: type: string description: The internal id of the skill expression, if any, that is currently in use for routing decisions scoredAgents: type: array description: A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents items: $ref: '#/definitions/ScoredAgent' label: type: string description: An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level 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 Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string RecordersState: type: object properties: adhocState: type: string description: Indicates the state of the adhoc recorder. enum: - ACTIVE - PAUSED - NONE customerExperienceState: type: string description: Indicates the state of the customer experience recorder. enum: - ACTIVE - PAUSED - NONE agentExperienceState: type: string description: Indicates the state of the agent experience recorder. enum: - ACTIVE - PAUSED - NONE snippetState: type: string description: Indicates the state of the snippet recording. enum: - ACTIVE - PAUSED - NONE UserAuthorization: type: object properties: roles: type: array items: $ref: '#/definitions/DomainRole' unusedRoles: type: array description: A collection of the roles the user is not using readOnly: true items: $ref: '#/definitions/DomainRole' permissions: type: array description: A collection of the permissions granted by all assigned roles readOnly: true items: type: string permissionPolicies: type: array description: The policies configured for assigned permissions. readOnly: true items: $ref: '#/definitions/ResourcePermissionPolicy' EvaluationScoringSet: type: object properties: totalScore: type: number format: float description: Score of all questions totalCriticalScore: type: number format: float description: Score of only the critical questions maxTotalRawCriticalScore: type: number format: float description: Maximum total raw score for the critical questions. Raw score is the actual point values before applying weights or percentages. maxTotalRawScore: type: number format: float description: Maximum total raw score for all questions. Raw score is the actual point values before applying weights or percentages. totalNonCriticalScore: type: number format: float description: Score of only the non-critical questions questionGroupScores: type: array items: $ref: '#/definitions/EvaluationQuestionGroupScore' anyFailedKillQuestions: type: boolean description: Indicates that at least one fatal question was answered without having the highest score available for the question comments: type: string description: Overall comments from the evaluator privateComments: type: string description: Overall private comments from the evaluator agentComments: type: string description: Comments from the agent while reviewing evaluation results transcriptTopics: type: array description: List of topics found within the conversation's transcripts items: $ref: '#/definitions/TranscriptTopic' 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' VoicemailSearchRequest: type: object properties: sortOrder: type: string description: The sort order for results enum: - ASC - DESC - SCORE sortBy: type: string description: The field in the resource that you want to sort the results by pageSize: type: integer format: int32 description: The number of results per page pageNumber: type: integer format: int32 description: The page of resources you want to retrieve sort: type: array description: Multi-value sort order, list of multiple sort values items: $ref: '#/definitions/SearchSort' expand: type: array description: Provides more details about a specified resource items: type: string query: type: array items: $ref: '#/definitions/VoicemailSearchCriteria' Address: type: object properties: name: type: string description: This will be nameRaw if present, or a locality lookup of the address field otherwise. nameRaw: type: string description: The name as close to the bits on the wire as possible. addressNormalized: type: string description: The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. addressRaw: type: string description: The address as close to the bits on the wire as possible. addressDisplayable: type: string description: The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. 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 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 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 ScoredAgent: type: object properties: agent: description: The agent $ref: '#/definitions/DomainEntityRef' score: type: integer format: int32 description: Agent's score for the current conversation, from 0 - 100, higher being better LocationEmergencyNumber: type: object properties: e164: type: string number: type: string type: type: string description: The type of emergency number. enum: - default - elin 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]. AiScoringSetting: type: object properties: enabled: type: boolean description: True if AI Scoring feature is configured. MessageDetails: type: object properties: messageId: type: string description: UUID identifying the message media. messageURI: type: string format: uri description: A URI for this message entity. messageStatus: type: string description: Indicates the delivery status of the message. enum: - queued - sent - failed - received - delivery-success - delivery-failed - read - removed - published messageSegmentCount: type: integer format: int32 description: The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. messageTime: type: string format: date-time description: 'The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' media: type: array description: 'Deprecated: Use the API /api/v2/conversations/messages/{conversationId}/messages/{messageId} to get the associated media.' items: $ref: '#/definitions/MessageMedia' stickers: type: array description: 'Deprecated: This attribute is no longer used. Messages have not included associated stickers for a long time.' items: $ref: '#/definitions/MessageSticker' messageMetadata: description: Information that describes the content of the message, if any $ref: '#/definitions/ConversationMessageMetadata' socialVisibility: type: string description: For social media messages, the visibility of the message in the originating social platform enum: - private - public errorInfo: description: Provider specific error information for a communication. $ref: '#/definitions/ErrorBody' Call: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - converting - uploading - transmitting - none id: type: string description: A globally unique identifier for this communication. direction: type: string description: The direction of the call enum: - inbound - outbound recording: type: boolean description: True if this call is being recorded. recordingState: type: string description: State of recording on this call. enum: - none - active - paused recordersState: description: Contains the states of different recorders. $ref: '#/definitions/RecordersState' muted: type: boolean description: True if this call is muted so that remote participants can't hear any audio from this end. confined: type: boolean description: True if this call is held and the person on this side hears hold music. held: type: boolean description: True if this call is held and the person on this side hears silence. securePause: type: boolean description: True when the recording of this call is in secure pause status. recordingId: type: string description: A globally unique identifier for the recording associated with this call. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' errorInfo: $ref: '#/definitions/ErrorInfo' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - endpoint.donotdisturb - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.donotdisturb - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' documentId: type: string description: If call is an outbound fax of a document from content management, then this is the id in content management. startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectReasons: type: array description: List of reasons that this call was disconnected. This will be set once the call disconnects. items: $ref: '#/definitions/DisconnectReason' faxStatus: description: Extra information on fax transmission. $ref: '#/definitions/FaxStatus' provider: type: string description: The source provider for the call. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. uuiData: type: string description: User to User Information (UUI) data managed by SIP session application. self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' other: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. agentAssistantId: type: string description: UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. transferSource: type: string description: Indicates how call reaches the agent. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' disposition: description: Call resolution data for Dialer bulk make calls commands. $ref: '#/definitions/Disposition' Cobrowsesession: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none id: type: string description: A globally unique identifier for this communication. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transport.failure - error - peer - other - spam - uncallable self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' cobrowseSessionId: type: string description: The co-browse session ID. cobrowseRole: type: string description: This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). controlling: type: array description: ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). items: type: string viewerUrl: type: string description: The URL that can be used to open co-browse session in web browser. providerEventTime: type: string format: date-time description: 'The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the co-browse session. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. SkillsToRemove: type: object properties: name: type: string id: type: string selfUri: type: string format: uri EmployerInfo: type: object properties: officialName: type: string employeeId: type: string employeeType: type: string dateHire: type: string ConversationChat: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. roomId: type: string description: The room id for the chat. recordingId: type: string description: A globally unique identifier for the recording associated with this chat. segments: type: array description: The time line of the participant's chat, divided into activity segments. items: $ref: '#/definitions/Segment' held: type: boolean description: True if this call is held and the person on this side hears silence. direction: type: string description: The direction of the chat enum: - inbound - outbound disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - transfer - transfer.conference - transfer.consult - transfer.forward - error - peer - other - uncallable - timeout startHoldTime: type: string format: date-time description: 'The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the email. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. avatarImageUrl: type: string description: If available, the URI to the avatar image of this communication. journeyContext: description: A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). $ref: '#/definitions/JourneyContext' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' VoicemailSearchCriteria: type: object required: - type properties: endValue: type: string description: The end value of the range. This field is used for range search types. values: type: array description: A list of values for the search to match against items: type: string startValue: type: string description: The start value of the range. This field is used for range search types. value: type: string description: A value for the search to match against operator: type: string description: How to apply this search criteria against other criteria enum: - AND - OR - NOT group: type: array description: Groups multiple conditions items: $ref: '#/definitions/VoicemailSearchCriteria' dateFormat: type: string description: Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. fields: type: array description: Field names to search against items: type: string x-genesys-search-fields: value: - voicemailId - ownerId - ownerType - deleted - read - callerAddress - callerUser - createdDate - modifiedDate type: type: string description: Search Type enum: - EXACT - STARTS_WITH - CONTAINS - REGEX - TERM - TERMS - REQUIRED_FIELDS - MATCH_ALL - DATE_RANGE Attachment: type: object properties: attachmentId: type: string description: The unique identifier for the attachment. name: type: string description: The name of the attachment. contentUri: type: string description: The content uri of the attachment. If set, this is commonly a public api download location. contentType: type: string description: The type of file the attachment is. contentLength: type: integer format: int32 description: The length of the attachment file. inlineImage: type: boolean description: Whether or not the attachment was attached inline., 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 RoutingStatus: type: object properties: userId: type: string description: The userId of the agent status: type: string description: Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist. enum: - OFF_QUEUE - IDLE - INTERACTING - NOT_RESPONDING - COMMUNICATING startTime: type: string format: date-time description: 'The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ResourceConditionValue: type: object properties: type: type: string enum: - SCALAR - VARIABLE - USER - QUEUE - TEAM value: type: string PhoneNumberColumn: type: object properties: columnName: type: string type: type: string callableTimeColumnName: type: string 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 PINConfiguration: type: object properties: minimumLength: type: integer format: int32 maximumLength: type: integer format: int32 Voicemail: type: object properties: id: type: string description: The voicemail id uploadStatus: type: string description: current state of the voicemail upload enum: - pending - complete - failed - timeout - none 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' TransferDestination: type: object properties: userId: type: string description: The id of the user if the command destination is a user. address: type: string description: The destination address if the command destination is an endpoint. ConversationMessageMetadata: type: object properties: type: type: string description: Message type. enum: - Text - Structured - Receipt - Event - Message - Unknown events: type: array description: List of events metadata items: $ref: '#/definitions/ConversationMessageMetadataEvent' content: type: array description: List of message content items: $ref: '#/definitions/ConversationMessageMetadataContent' description: Metadata information about a message. DialerPreview: type: object properties: id: type: string contactId: type: string description: The contact associated with this preview data pop contactListId: type: string description: The contactList associated with this preview data pop. campaignId: type: string description: The campaignId associated with this preview data pop. phoneNumberColumns: type: array description: The phone number columns associated with this campaign items: $ref: '#/definitions/PhoneNumberColumn' callbackAutoAnswer: type: boolean description: Whether or not to auto answer the callback InternalMessage: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - disconnected initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - disconnected id: type: string description: A globally unique identifier for this communication. segments: type: array description: The time line of the participant's internal message, divided into activity segments. items: $ref: '#/definitions/Segment' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - client - system - peer - transfer startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the message. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. targetUserId: type: string description: The user ID for the participant on receiving side of the internal message conversation. sourceUserId: type: string description: The user ID for the participant on sending side of the internal message conversation. toAddress: description: Address for the participant on receiving side of the internal message communication. $ref: '#/definitions/Address' fromAddress: description: Address for the participant on the sending side of the internal message communication. $ref: '#/definitions/Address' messages: type: array description: The messages sent on this communication channel. items: $ref: '#/definitions/InternalMessageDetails' CopyVoicemailMessage: type: object required: - voicemailMessageId properties: voicemailMessageId: type: string description: The id of the VoicemailMessage to copy userId: type: string description: The id of the User to copy the VoicemailMessage to groupId: type: string description: The id of the Group to copy the VoicemailMessage to description: Used to copy a VoicemailMessage to either a User or a Group Chat: type: object properties: jabberId: type: string 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 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' JourneyContext: type: object required: - customer properties: customer: description: A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomer' customerSession: description: A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomerSession' triggeringAction: description: A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) $ref: '#/definitions/JourneyAction' 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. QueueEmailAddress: type: object properties: domain: $ref: '#/definitions/DomainEntityRef' route: $ref: '#/definitions/InboundRoute' 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 AfterCallWork: type: object properties: startTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' state: type: string enum: - unknown - notApplicable - skipped - pending - complete 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 TranscriptTopic: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the object. readOnly: true topicPhrase: type: string description: 'The phrase which detected the topic. ' readOnly: true transcriptPhrase: type: string description: The transcript phrase which detected the topic. readOnly: true confidence: type: integer format: int32 description: The detection confidence of the topic. readOnly: true startTimeMilliseconds: type: integer format: int64 description: The start time of the topic phrase. readOnly: true duration: $ref: '#/definitions/TopicDuration' offset: description: Location of the phrase readOnly: true $ref: '#/definitions/TopicOffset' recordingLocation: type: integer format: int64 description: Location of the phrase in the recording in milliseconds readOnly: true ConversationQueueMediaSettings: type: object properties: alertingTimeoutSeconds: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. autoAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for auto answered interactions. manualAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for manually answered interactions. enableAutoAnswer: type: boolean description: Flag to indicate if auto answer is enabled for the given media type or media subtype. 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 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. TransferInitiator: type: object properties: userId: type: string description: The id of the user who initiated the command if it was initiated by a user. Callback: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none id: type: string description: A globally unique identifier for this communication. segments: type: array description: The time line of the participant's callback, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the call enum: - inbound - outbound held: type: boolean description: True if this call is held and the person on this side hears silence. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dialerPreview: description: The preview data to be used when this callback is a Preview. $ref: '#/definitions/DialerPreview' voicemail: description: The voicemail data to be used when this callback is an ACD voicemail. $ref: '#/definitions/Voicemail' callbackNumbers: type: array description: The phone number(s) to use to place the callback. items: type: string callbackUserName: type: string description: The name of the user requesting a callback. scriptId: type: string description: The UUID of the script to use. externalCampaign: type: boolean description: True if the call for the callback uses external dialing. skipEnabled: type: boolean description: True if the ability to skip a callback should be enabled. timeoutSeconds: type: integer format: int32 description: The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' callbackScheduledTime: type: string format: date-time description: 'The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' automatedCallbackConfigId: type: string description: The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. provider: type: string description: The source provider for the callback. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. callerId: type: string description: The phone number displayed to recipients of the phone call. The value should conform to the E164 format. callerIdName: type: string description: The name displayed to recipients of the phone call. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' DispositionAmdTimeout: type: object properties: timeoutMs: type: integer format: int32 description: Configured AMD timeout value. timerStartEvent: type: string description: Configured option for when to start the AMD timer, such as on line connect or speech start. timerStartTime: type: string format: date-time description: 'Timer start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' timerEndTime: type: string format: date-time description: 'Timer end time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' MessageMedia: type: object properties: url: type: string description: The location of the media, useful for retrieving it mediaType: type: string description: The optional internet media type of the the media object. If null then the media type should be dictated by the url contentLengthBytes: type: integer format: int32 description: The optional content length of the the media object, in bytes. name: type: string description: The optional name of the the media object. id: type: string description: The optional id of the the media object. UserReferenceWithName: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true DivisionEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri dateDivisionUpdated: type: string format: date-time description: 'The time the entity division was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' 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 Bullseye: type: object properties: rings: type: array description: The bullseye rings configured for this queue. items: $ref: '#/definitions/Ring' DisconnectReason: type: object properties: type: type: string description: Disconnect reason protocol type. enum: - q850 - sip code: type: integer format: int32 description: Protocol specific reason code. See the Q.850 and SIP specs. phrase: type: string description: Human readable English description of the disconnect reason. reason: type: string description: Final disconnect reason code that triggered the disposition result. 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 VoicemailMessageEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/VoicemailMessage' 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 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 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' TopicOffset: type: object properties: wordCount: type: integer format: int64 description: 'Count of words before the topic ' readOnly: true characterCount: type: integer format: int64 description: 'Count of characters before the topic ' readOnly: true ConversationReference: type: object properties: id: type: string selfUri: type: string format: uri ConversationMessageMetadataEvent: type: object properties: eventType: type: string description: Type of this event element enum: - CoBrowse - Typing - Presence - Video - Unknown subType: type: string description: Event subtype enum: - 'On' - Join - Offering - OfferingExpired - OfferingAccepted - OfferingRejected - Disconnect - Clear - SignIn - SessionExpired - Authenticate - AuthenticateFailure - AuthenticateCancel - Unknown description: Metadata information about a message event. GroupEmailPolicy: type: object properties: emailMembers: type: boolean emailGroup: type: boolean 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' SocialExpression: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. socialMediaId: type: string description: A globally unique identifier for the social media. socialMediaHub: type: string description: The social network of the communication socialUserName: type: string description: The user name for the communication. previewText: type: string description: The text preview of the communication contents recordingId: type: string description: A globally unique identifier for the recording associated with this chat. segments: type: array description: The time line of the participant's chat, divided into activity segments. items: $ref: '#/definitions/Segment' held: type: boolean description: True if this call is held and the person on this side hears silence. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the social expression. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. 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 JourneyCustomerSession: type: object required: - id - type properties: id: type: string description: An ID of a Customer/User's session within the Journey System at a point-in-time type: type: string description: The type of the Customer/User's session within the Journey System (e.g. web, app) JourneyActionMap: type: object required: - id - version properties: id: type: string description: The ID of the actionMap in the Journey System which triggered this action version: type: integer format: int32 description: The version number of the actionMap in the Journey System at the time this action was triggered UserStation: type: object properties: id: type: string description: A globally unique identifier for this station readOnly: true name: type: string type: type: string associatedUser: $ref: '#/definitions/User' associatedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' defaultUser: $ref: '#/definitions/User' providerInfo: type: object description: 'Provider-specific info for this station, e.g. { "edgeGroupId": "ffe7b15c-a9cc-4f4c-88f5-781327819a49" }' additionalProperties: type: string webRtcCallAppearances: type: integer format: int32 description: The number of call appearances on the station. readOnly: true ConditionalGroupActivationRule: type: object properties: conditions: type: array description: The list of conditions used in this rule items: $ref: '#/definitions/ConditionalGroupActivationCondition' conditionExpression: type: string description: A string expression that defines the relationships of conditions in this rule groups: type: array description: The group(s) that this rule activates (if rule evaluates as true) or deactivates (if rule evaluates as false) uniqueItems: true items: $ref: '#/definitions/MemberGroup' 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' VoicemailGroupPolicy: type: object properties: name: type: string group: description: The group associated with the policy readOnly: true $ref: '#/definitions/Group' enabled: type: boolean description: Whether voicemail is enabled for the group sendEmailNotifications: type: boolean description: Whether email notifications are sent to group members when a new voicemail is received disableEmailPii: type: boolean description: Removes any PII from group emails. This is overridden by the analogous organization configuration value. This is always true if HIPAA is enabled or unknown for an organization. includeEmailTranscriptions: type: boolean description: Whether to include the voicemail transcription in a group notification email languagePreference: type: string description: The language preference for the group. Used for group voicemail transcription emailPolicy: description: The email policy for the group $ref: '#/definitions/GroupEmailPolicy' rotateCallsSecs: type: integer format: int32 description: How many seconds to ring before rotating to the next member in the group stopRingingAfterRotations: type: integer format: int32 description: How many rotations to go through overflowGroupId: type: string description: A fallback group to contact when all of the members in this group did not answer the call. groupAlertType: type: string description: Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin. enum: - RANDOM - ROUND_ROBIN - SEQUENTIAL interactiveResponsePromptId: type: string description: The prompt to use when connecting a user to a Group Ring call interactiveResponseRequired: type: boolean description: Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call includeGroupNumberInUserCallerIdLists: type: boolean description: Whether the group phone number should be included in users' caller id lists Group: type: object required: - name - rulesVisible - type - visibility properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The group name. description: type: string dateModified: type: string format: date-time description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members. readOnly: true state: type: string description: Active, inactive, or deleted state. readOnly: true enum: - active - inactive - deleted version: type: integer format: int32 description: Current version for this resource. readOnly: true type: type: string description: Type of group. enum: - official - social images: type: array items: $ref: '#/definitions/Image' addresses: type: array items: $ref: '#/definitions/GroupContact' rulesVisible: type: boolean description: Are membership rules visible to the person requesting to view the group visibility: type: string description: Who can view this group enum: - public - owners - members rolesEnabled: type: boolean description: Allow roles to be assigned to this group includeOwners: type: boolean description: Allow owners to be included as members of the group callsEnabled: type: boolean description: Allow calls to be placed to this group. owners: type: array description: Owners of the group items: $ref: '#/definitions/User' selfUri: type: string format: uri description: The URI for this object readOnly: true Evaluation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string conversation: $ref: '#/definitions/ConversationReference' evaluationForm: description: Evaluation form used for evaluation. $ref: '#/definitions/EvaluationForm' evaluator: $ref: '#/definitions/User' agent: $ref: '#/definitions/User' calibration: $ref: '#/definitions/Calibration' status: type: string enum: - PENDING - INPROGRESS - FINISHED - INREVIEW - RETRACTED answers: $ref: '#/definitions/EvaluationScoringSet' agentHasRead: type: boolean assignee: $ref: '#/definitions/User' assigneeApplicable: type: boolean description: Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable. releaseDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' assignedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' changedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' submittedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' revisionCreatedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' queue: $ref: '#/definitions/Queue' mediaType: type: array description: List of different communication types used in conversation. items: type: string enum: - CALL - CALLBACK - CHAT - COBROWSE - EMAIL - MESSAGE - INTERNAL_MESSAGE - SCREEN_MONITORING - SOCIAL_EXPRESSION - VIDEO - SCREENSHARE divisionIds: type: array description: Evaluation is assigned in the following division(s). items: type: string rescore: type: boolean description: Is only true when evaluation is re-scored. conversationDate: type: string format: date-time description: 'Creation date of the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' conversationEndDate: type: string format: date-time description: 'End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' neverRelease: type: boolean description: Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. assigned: type: boolean description: Set to false to unassign the evaluation. This cannot be set to false when assignee is also set. dateAssigneeChanged: type: string format: date-time description: 'Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' resourceId: type: string description: Only used for email evaluations. Will be null for all other evaluations. resourceType: type: string description: The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. enum: - EMAIL redacted: type: boolean description: Is only true when the user making the request does not have sufficient permissions to see evaluation agentTeam: description: Team of the evaluation agent $ref: '#/definitions/Team' isScoringIndex: type: boolean authorizedActions: type: array description: 'List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit' items: type: string hasAssistanceFailed: type: boolean description: Is true when evaluation assistance didn't execute successfully evaluationSource: description: The source that created the evaluation. readOnly: true $ref: '#/definitions/EvaluationSource' disputeCount: type: integer format: int32 description: The number of times this evaluation has been disputed readOnly: true version: type: integer format: int32 description: The evaluation version number readOnly: true versionHistory: description: List of all versions of the evaluation readOnly: true $ref: '#/definitions/PagelessDomainEntityListingEvaluationVersion' declinedReview: type: boolean description: Is true when the evaluation review was declined evaluationContextId: type: string description: The shared id for different versions of an evaluation retractedEvaluation: description: The previous evaluation version $ref: '#/definitions/EvaluationReference' aiScoring: description: AI scoring details for the evaluation. readOnly: true $ref: '#/definitions/AiScoring' selfUri: type: string format: uri description: The URI for this object readOnly: true 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 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' VoicemailOrganizationPolicy: type: object properties: enabled: type: boolean description: Whether voicemail is enabled for this organization readOnly: true alertTimeoutSeconds: type: integer format: int32 description: The organization's default number of seconds to ring a user's phone before a call is transferred to voicemail pinConfiguration: description: The configuration for user PINs to access their voicemail from a phone $ref: '#/definitions/PINConfiguration' voicemailExtension: type: string description: The extension for voicemail retrieval. The default value is *86. pinRequired: type: boolean description: If this is true, a PIN is required when accessing a user's voicemail from a phone. interactiveResponseRequired: type: boolean description: Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call sendEmailNotifications: type: boolean description: Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. includeEmailTranscriptions: type: boolean description: Whether to include the voicemail transcription in the notification email disableEmailPii: type: boolean description: Removes any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization. maximumRecordingTimeSeconds: type: integer format: int32 description: Default value for the maximum length of time in seconds of a recorded voicemail modifiedDate: type: string format: date-time description: 'The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true Message: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - connected - parked - disconnected initialState: type: string description: The initial connection state of this communication. enum: - alerting - connected - parked - disconnected id: type: string description: A globally unique identifier for this communication. held: type: boolean description: True if this call is held and the person on this side hears silence. segments: type: array description: The time line of the participant's message, divided into activity segments. items: $ref: '#/definitions/Segment' direction: type: string description: The direction of the message. enum: - inbound - outbound recordingId: type: string description: A globally unique identifier for the recording associated with this message. errorInfo: $ref: '#/definitions/ErrorBody' disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable - inactivity - session.expired - takeover startHoldTime: type: string format: date-time description: 'The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the message. authenticated: type: boolean description: If true, the participant member is authenticated. type: type: string description: Indicates the type of message platform from which the message originated. enum: - apple - facebook - instagram - kakao - line - open - sms - telegram - twitter - webmessaging - whatsapp - unknown recipientCountry: type: string description: Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. recipientType: type: string description: 'The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.' scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. toAddress: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' fromAddress: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' messages: type: array description: The messages sent on this communication channel. items: $ref: '#/definitions/MessageDetails' journeyContext: description: A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). $ref: '#/definitions/JourneyContext' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. agentAssistantId: type: string description: UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. byoSmsIntegrationId: type: string description: The internal id representing the customer supplied sms integration message. queueMediaSettings: description: Represents the queue settings for this media type. $ref: '#/definitions/ConversationQueueMediaSettings' engagementSource: type: string enum: - AppleMessagesForBusiness - Discord - Email - Facebook - FacebookMessenger - Glassdoor - GoogleBusinessProfile - Instagram - KakaoTalk - Line - LinkedIn - MicrosoftTeams - MobileChat - Other - QQ - Reddit - ServiceNow - SFDC - SMS - Snapchat - Telegram - Threads - Trustpilot - Unspecified - Viber - WebChat - WeChat - Weibo - WhatsApp - X - Yelp - YouTube - Zendesk - OpenMessaging resumeTime: type: string format: date-time description: 'Represents the time when a parked message will resume. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' parkTime: type: string format: date-time description: 'Represents the time when an message was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' Segment: type: object required: - endTime - startTime properties: startTime: type: string format: date-time description: 'The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endTime: type: string format: date-time description: 'The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' type: type: string description: The activity taking place for the participant in the segment. howEnded: type: string description: A description of the event that ended the segment. disconnectType: type: string description: A description of the event that disconnected the segment EvaluationSource: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: Type of the evaluation source. enum: - Policy - User - Unknown - Program selfUri: type: string format: uri description: The URI for this object readOnly: true 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' VoicemailRetentionPolicy: type: object properties: voicemailRetentionPolicyType: type: string description: The retention policy type enum: - RETAIN_INDEFINITELY - RETAIN_WITH_TTL - IMMEDIATE_DELETE numberOfDays: type: integer format: int32 description: If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL description: Governs how the voicemail is retained MessageSticker: type: object properties: url: type: string description: The location of the sticker, useful for retrieving it id: type: string description: The unique id of the the sticker object. Video: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. context: type: string description: The room id context (xmpp jid) for the conference session. audioMuted: type: boolean description: Indicates whether this participant has muted their outgoing audio. videoMuted: type: boolean description: Indicates whether this participant has muted/paused their outgoing video. sharingScreen: type: boolean description: Indicates whether this participant is sharing their screen to the session. peerCount: type: integer format: int32 description: The number of peer participants from the perspective of the participant in the conference. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the video. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. msids: type: array description: List of media stream ids items: type: string self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. ErrorInfo: type: object properties: message: type: string code: type: string 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 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' TransferResponse: type: object properties: id: type: string description: The id of the command. state: type: string description: The state of the command. enum: - Pending - Active - Complete - Canceled - Failed - Timeout - Unknown dateIssued: type: string format: date-time description: 'The date/time that this command was issued. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' initiator: description: The initiator of the command. $ref: '#/definitions/TransferInitiator' modifiedBy: description: The user or entity that modified the command. $ref: '#/definitions/TransferResponseModifiedBy' destination: description: The destination of the command. $ref: '#/definitions/TransferDestination' transferType: type: string description: The type of transfer to perform. enum: - Attended - Unattended DomainEntityListingEvaluationForm: type: object properties: entities: type: array items: $ref: '#/definitions/EvaluationForm' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 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/