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 Outbound 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: Outbound description: '' externalDocs: description: Outbound Documentation url: https://developer.genesys.cloud/routing/outbound/ paths: /api/v2/outbound/campaigns/{campaignId}/agents/{userId}: put: tags: - Outbound summary: 'Send notification that an agent''s state changed ' description: New agent state. operationId: putOutboundCampaignAgent produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - name: userId in: path description: Agent's user ID required: true type: string - in: body name: body description: agent required: true schema: $ref: '#/definitions/Agent' responses: '200': description: successful operation schema: type: string '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.stage: No stage was provided. invalid.campaign.status: The dialer campaign was not active. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-purecloud-method-name: putOutboundCampaignAgent /api/v2/outbound/attemptlimits/{attemptLimitsId}: get: tags: - Outbound summary: Get attempt limits description: '' operationId: getOutboundAttemptlimit produces: - application/json parameters: - name: attemptLimitsId in: path description: Attempt limits ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AttemptLimits' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:attemptLimits:view x-purecloud-method-name: getOutboundAttemptlimit put: tags: - Outbound summary: Update attempt limits description: '' operationId: putOutboundAttemptlimit produces: - application/json parameters: - name: attemptLimitsId in: path description: Attempt limits ID required: true type: string - in: body name: body description: AttemptLimits required: true schema: $ref: '#/definitions/AttemptLimits' responses: '200': description: successful operation schema: $ref: '#/definitions/AttemptLimits' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: incorrect.max.value: Max values must be > 0 and one of them must be defined name.cannot.be.blank: A name must be provided. exceeded.max.attempts.per.contact: The maximum attempts allowed per contact is 100. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.time.zone: Not recognized as a valid time zone. invalid.property: Value [%s] is not a valid property for object [%s] exceeded.max.attempts.per.number: The maximum attempts allowed per number is 100. constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:attemptLimits:edit x-purecloud-method-name: putOutboundAttemptlimit delete: tags: - Outbound summary: Delete attempt limits description: '' operationId: deleteOutboundAttemptlimit produces: - application/json parameters: - name: attemptLimitsId in: path description: Attempt limits ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:attemptLimits:delete x-purecloud-method-name: deleteOutboundAttemptlimit /api/v2/outbound/attemptlimits: get: tags: - Outbound summary: Query attempt limits list description: '' operationId: getOutboundAttemptlimits produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/AttemptLimitsEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:attemptLimits:view x-purecloud-method-name: getOutboundAttemptlimits post: tags: - Outbound summary: Create attempt limits description: '' operationId: postOutboundAttemptlimits produces: - application/json parameters: - in: body name: body description: AttemptLimits required: true schema: $ref: '#/definitions/AttemptLimits' responses: '200': description: successful operation schema: $ref: '#/definitions/AttemptLimits' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: incorrect.max.value: Max values must be > 0 and one of them must be defined name.cannot.be.blank: A name must be provided. exceeded.max.attempts.per.contact: The maximum attempts per contact limit is 100. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.time.zone: Not recognized as a valid time zone. invalid.property: Value [%s] is not a valid property for object [%s] exceeded.max.attempts.per.number: The maximum attempts per number limit is 100. constraint.validation: '%s' max.entity.count.reached: The maximum attempt limits count has been reached. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Valid resetPeriod values are NEVER or TODAY until Attempt Limit Enhancements Feature Toggle is enabled. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:attemptLimits:add x-purecloud-method-name: postOutboundAttemptlimits /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}: get: tags: - Outbound summary: Get a dialer call analysis response set. description: '' operationId: getOutboundCallanalysisresponseset produces: - application/json parameters: - name: callAnalysisSetId in: path description: Call Analysis Response Set ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:responseSet:view x-purecloud-method-name: getOutboundCallanalysisresponseset put: tags: - Outbound summary: Update a dialer call analysis response set. description: '' operationId: putOutboundCallanalysisresponseset produces: - application/json parameters: - name: callAnalysisSetId in: path description: Call Analysis Response Set ID required: true type: string - in: body name: body description: ResponseSet required: true schema: $ref: '#/definitions/ResponseSet' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.property: Value [%s] is not a valid property for object [%s] invalid.call.analysis.response.set: The call analysis response set is invalid. constraint.validation: '%s' invalid.call.analysis.response.set.for.agentless.campaign: The call analysis response set is invalid for agentless campaigns. invalid.update: '' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.flow: The outbound flow could not be found. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:responseSet:edit x-purecloud-method-name: putOutboundCallanalysisresponseset delete: tags: - Outbound summary: Delete a dialer call analysis response set. description: '' operationId: deleteOutboundCallanalysisresponseset produces: - application/json parameters: - name: callAnalysisSetId in: path description: Call Analysis Response Set 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: call.analysis.response.set.in.use: The dialer call analysis response set is in use. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:responseSet:delete x-purecloud-method-name: deleteOutboundCallanalysisresponseset /api/v2/outbound/callanalysisresponsesets: get: tags: - Outbound summary: Query a list of dialer call analysis response sets. description: '' operationId: getOutboundCallanalysisresponsesets produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseSetEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:responseSet:view x-purecloud-method-name: getOutboundCallanalysisresponsesets post: tags: - Outbound summary: Create a dialer call analysis response set. description: '' operationId: postOutboundCallanalysisresponsesets produces: - application/json parameters: - in: body name: body description: ResponseSet required: true schema: $ref: '#/definitions/ResponseSet' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.create: '' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' max.entity.count.reached: The maximum call analysis response set count has been reached. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.flow: The outbound flow could not be found. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:responseSet:add x-purecloud-method-name: postOutboundCallanalysisresponsesets /api/v2/outbound/callabletimesets/{callableTimeSetId}: get: tags: - Outbound summary: Get callable time set description: '' operationId: getOutboundCallabletimeset produces: - application/json parameters: - name: callableTimeSetId in: path description: Callable Time Set ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CallableTimeSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:callableTimeSet:view x-purecloud-method-name: getOutboundCallabletimeset put: tags: - Outbound summary: Update callable time set description: '' operationId: putOutboundCallabletimeset produces: - application/json parameters: - name: callableTimeSetId in: path description: Callable Time Set ID required: true type: string - in: body name: body description: DialerCallableTimeSet required: true schema: $ref: '#/definitions/CallableTimeSet' responses: '200': description: successful operation schema: $ref: '#/definitions/CallableTimeSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. duplicate.callable.time.name: A callable time with this name already exists in the time set. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.time.zone: Not recognized as a valid time zone. missing.time.zone: Each callable time must have a time zone identifier. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.update: '' missing.callable.time.name: The callable time must have a name. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.start.time: Start time must be before stop time. invalid.day: Days must be within 1 - 7. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:callableTimeSet:edit x-purecloud-method-name: putOutboundCallabletimeset delete: tags: - Outbound summary: Delete callable time set description: '' operationId: deleteOutboundCallabletimeset produces: - application/json parameters: - name: callableTimeSetId in: path description: Callable Time Set ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. callable.time.set.in.use: The callable time set is in use. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:callableTimeSet:delete x-purecloud-method-name: deleteOutboundCallabletimeset /api/v2/outbound/callabletimesets: get: tags: - Outbound summary: Query callable time set list description: '' operationId: getOutboundCallabletimesets produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CallableTimeSetEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:callableTimeSet:view x-purecloud-method-name: getOutboundCallabletimesets post: tags: - Outbound summary: Create callable time set description: '' operationId: postOutboundCallabletimesets produces: - application/json parameters: - in: body name: body description: DialerCallableTimeSet required: true schema: $ref: '#/definitions/CallableTimeSet' responses: '200': description: successful operation schema: $ref: '#/definitions/CallableTimeSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. duplicate.callable.time.name: A callable time with this name already exists in the time set. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.create: '' invalid.time.zone: There is an unrecognized time zone. missing.time.zone: Each callable time must have a time zone identifier. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' max.entity.count.reached: The maximum callable time set count has been reached. missing.callable.time.name: The callable time must have a name. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.start.time: Start time must be before stop time. invalid.day: Days must be within 1 - 7. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:callableTimeSet:add x-purecloud-method-name: postOutboundCallabletimesets /api/v2/outbound/campaigns/{campaignId}/callback/schedule: post: tags: - Outbound summary: Schedule a Callback for a Dialer Campaign (Deprecated) description: This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead." operationId: postOutboundCampaignCallbackSchedule produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - in: body name: body description: ContactCallbackRequest required: true schema: $ref: '#/definitions/ContactCallbackRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactCallbackRequest' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. contact.cannot.be.blank: The contact cannot be blank. invalid.property: Value [%s] is not a valid property for object [%s] contact.list.cannot.be.blank: The contact list cannot be blank. constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable schedule.cannot.be.blank: The schedule cannot be blank. invalid.date: 'Dates must be specified as ISO-8601 strings. 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.contact.phone.column: The contact phone columns are invalid. invalid.schedule.format: The schedule format is invalid. callback.schedule.invalid: The callback schedule is not valid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. callback.scheduling.error: '' '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound deprecated: true x-purecloud-method-name: postOutboundCampaignCallbackSchedule /api/v2/outbound/campaigns/divisionviews/{campaignId}: get: tags: - Outbound summary: Get a basic Campaign information object description: This returns a simplified version of a Campaign, consisting of name and division. operationId: getOutboundCampaignsDivisionview produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignDivisionView' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:search x-purecloud-method-name: getOutboundCampaignsDivisionview /api/v2/outbound/campaigns/divisionviews: get: tags: - Outbound summary: Query a list of basic Campaign information objects description: This returns a simplified version of a Campaign, consisting of name and division. operationId: getOutboundCampaignsDivisionviews produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignDivisionViewListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:search x-purecloud-method-name: getOutboundCampaignsDivisionviews /api/v2/outbound/campaigns/{campaignId}/interactions: get: tags: - Outbound summary: Get dialer campaign interactions. description: '' operationId: getOutboundCampaignInteractions produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignInteractions' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The specified campaignId was not found. resource.not.found: Resource not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaignInteractions /api/v2/outbound/campaigns/{campaignId}/linedistribution: get: tags: - Outbound summary: Get line distribution information for campaigns using same Edge Group or Site as given campaign description: '' operationId: getOutboundCampaignLinedistribution produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - name: includeOnlyActiveCampaigns in: query description: If true will return only active Campaigns required: false type: boolean default: true - name: edgeGroupId in: query description: Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive. required: false type: string - name: siteId in: query description: Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive. required: false type: string - name: useWeight in: query description: Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations required: false type: boolean - name: relativeWeight in: query description: Relative weight to be used in line distribution calculations instead of current Campaign's relative weight required: false type: integer format: int32 - name: outboundLineCount in: query description: The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count required: false type: integer format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignOutboundLinesDistribution' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.campaign.outbound.line.count: The outbound line count is invalid invalid.relative.weight: Relative weight must be between values 0 and 100 inclusively bad.request: The request could not be understood by the server due to malformed syntax. invalid.campaign: The campaign is invalid site.has.no.active.edges: There are no active edges in the site invalid.property: Value [%s] is not a valid property for object [%s] edge.group.has.no.active.edges: There are no active edges in the edge group edge.group.not.found: The edge group could not be found constraint.validation: '%s' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' no.edge.group.for.site: No edge group was found for the site invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' site.and.edge.group.cannot.be.configured: A single campaign cannot have both a site and an edge group configured '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:lineDistribution:view x-purecloud-method-name: getOutboundCampaignLinedistribution /api/v2/outbound/campaigns/{campaignId}: get: tags: - Outbound summary: Get dialer campaign. description: '' operationId: getOutboundCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Campaign' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaign put: tags: - Outbound summary: Update a campaign. description: '' operationId: putOutboundCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - in: body name: body description: Campaign required: true schema: $ref: '#/definitions/Campaign' - name: useMaxCallsPerAgentDecimal in: query description: Use maxCallsPerAgent with decimal precision required: false type: boolean enum: - 'true' - 'false' responses: '200': description: successful operation schema: $ref: '#/definitions/Campaign' '409': description: Conflict. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.campaign.active: The campaign is already active. too.many.skill.queue.members: The limit for number of queue members on a campaign configured for skill records has been exceeded. See details. invalid.update.wrong.version: '' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: column.data.type.specification.not.found.for.contact.sort: A column data type specification must be defined for contact sort column invalid.priority: The priority must be between 1 and 5 (inclusive) name.length.exceeded: The name length exceeds the limit of 64 characters. invalid.column.data.type.specification.data.type: Column data type specification data type must match the contact sort column data type too.many.queue.members: The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details. duplicate.name: The name already exists. invalid.max.calls.per.agent: Max calls per agent must be inside allowed range contact.list.filter.in.use: A campaign can not be created or updated because the contact list filter is in use by another running campaign site.has.no.active.edges: There are no active edges in the site edge.group.not.found: The edge group could not be found. too.many.data.action.conditions: There can be a maximum of 1 data action condition across all rule sets referenced by this campaign missing.column.data.type.specification.in.contact.list: Column data type specifications must be defined on the campaign's contact list contact.sorts.duplicate.field.names: The same column name is used in separate contact sorts entries. invalid.update: '' more.than.one.contact.list.filter: Only one contact list filter is allowed per campaign. managed.site.cannot.be.configured: Managed Sites cannot be configured on a campaign. invalid.campaign.preview.timeout.seconds: The preview timeout seconds must be between 0 and 1200 (inclusive) invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' resources.in.use: Resources are already in use. cannot.update.dynamic.contact.queueing.settings: The dynamic contact queueing settings cannot be updated invalid.update.bad.status.transition: The status transition is invalid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' contact.list.filter.not.found: The contact list filter could not be found. dnc.list.not.found: A do not call list could not be found. missing.caller.id.address: No caller id address supplied agent.owned.column.cannot.be.changed: The agent owned column cannot be changed. rule.set.not.found: A rule set could not be found. managed.edge.group.cannot.be.configured: Managed Edge Groups cannot be configured on a campaign. property.not.allowed.for.external.calling: 'The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.' invalid.campaign.phone.columns: The campaign phone columns are invalid. contact.sorts.conflict: The contact sort and contact sorts fields have conflicting values. invalid.update.campaign.active: The campaign is already active response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable site.not.found: The site could not be found queue.not.found: The queue could not be found. dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns: Dynamic contact queueing cannot be enabled for agent owned campaigns no.edge.group.for.site: No edge group was found for the site name.cannot.be.blank: A name must be provided. invalid.campaign.outbound.line.count: '' bad.request: The request could not be understood by the server due to malformed syntax. callable.time.set.not.found: The callable time set could not be found. missing.caller.id.name: No caller id name supplied skill.columns.cannot.be.modified: Skill columns can only be modified before a campaign is turned on for the first time, after a campaign is recycled while it is off or after it completes. invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded: The column data type specification length value exceeds the max length allowed for a skill column constraint.validation: '%s' dnc.list.invalid.custom.exclusion.column: The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List contact.list.filter.does.not.match.contact.list: The contact list on the contact list filter does not match the contact list on the campaign. dynamic.queueing.campaigns.count.exceeded: The limit for dynamic queueing campaigns has been exceeded invalid.acw.queue.setting: Please change the After Call Work setting on the queue as Agent Requested is not valid 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. call.analysis.response.set.not.found: The call analysis response set could not be found. agent.owned.queue.cannot.be.changed: The queue cannot be changed on a campaign configured for agent owned records. script.not.found: The script could not be found. site.and.edge.group.cannot.be.configured: A single campaign cannot have both a site and an edge group configured contact.sort.field.not.found: The contact sort field is not a column on the contact list. invalid.campaign.agent.owned.column: The campaign agent owned column is not a valid contact list column. contact.sorts.invalid.field.name: A contact sorts field name is not a valid column name in the campaign's contact list. invalid.relative.weight: Relative weight must be between values 0 and 100 inclusively external.calling.property.not.allowed: Some properties cannot be set on an external calling campaign. See details invalid.property: Value [%s] is not a valid property for object [%s] edge.group.has.no.active.edges: There are no active edges in the edge group dynamic.queueing.active.campaigns.count.exceeded: The limit for active dynamic queueing campaigns has been exceeded invalid.call.analysis.response.set.for.agentless.campaign: The call analysis response set is invalid for agentless campaigns. invalid.ani.address: The caller id number is invalid. name.required: A name must be provided. callable.time.set.conflicts.with.automatic.time.zone.mapping: A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping. invalid.campaign.skill.column.data.type: The column data type specification that is selected as a skill column must be of Data Type text. active.campaigns.limit.exceeded: The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one. edge.group.is.empty: There are no edges in the edge group invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' missing.time.zone.in.contactlist: When using a callable time set, the contact list must have at least one time zone column defined. invalid.dialing.mode.update: Invalid dialing mode site.is.empty: There are no edges in the site contact.list.import.in.progress: The contact list on the camapign is still importing contacts. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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' all.campaigns.black.listed: This organization has been blacklisted from starting campaigns. Please contact support. authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' campaign.black.listed: This campaign has been blacklisted. Please contact support. '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:edit x-purecloud-method-name: putOutboundCampaign delete: tags: - Outbound summary: Delete a campaign. description: '' operationId: deleteOutboundCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Campaign' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. campaign.in.use: The campaign is in use. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:delete x-purecloud-method-name: deleteOutboundCampaign patch: tags: - Outbound summary: Update a campaign. description: '' operationId: patchOutboundCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - in: body name: body description: CampaignPatchRequest required: true schema: $ref: '#/definitions/CampaignPatchRequest' responses: '204': description: The campaign was updated '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.relative.weight: Relative weight must be between values 0 and 100 inclusively bad.request: The request could not be understood by the server due to malformed syntax. invalid.max.calls.per.agent: Max calls per agent must be inside allowed range invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.update: An attempt was made to update the outbound campaign in an invalid way response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. queue.not.found: The queue could not be found. resources.in.use: Resources are already in use. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: Conflict due to concurrent modification was detected '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:edit x-purecloud-method-name: patchOutboundCampaign /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results: get: tags: - Outbound summary: Get a preview of how agents will be mapped to this campaign's contact list. description: '' operationId: getOutboundCampaignAgentownedmappingpreviewResults produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/AgentOwnedMappingPreviewListing' '202': description: The preview is not yet ready '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: campaign.is.not.agent.owned: This campaign is not configured for agent-owned records. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The preview does not exist. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:view - outbound:contact:view - routing:queue:view x-purecloud-method-name: getOutboundCampaignAgentownedmappingpreviewResults /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview: post: tags: - Outbound summary: Initiate request for a preview of how agents will be mapped to this campaign's contact list. description: '' operationId: postOutboundCampaignAgentownedmappingpreview produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '202': description: Accepted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: campaign.is.not.agent.owned: This campaign is not configured for agent-owned records. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:campaign:view - outbound:contact:view - directory:user:view x-purecloud-method-name: postOutboundCampaignAgentownedmappingpreview /api/v2/outbound/campaigns/{campaignId}/diagnostics: get: tags: - Outbound summary: Get campaign diagnostics description: '' operationId: getOutboundCampaignDiagnostics produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignDiagnostics' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaignDiagnostics /api/v2/outbound/campaigns/{campaignId}/progress: get: tags: - Outbound summary: Get campaign progress description: '' operationId: getOutboundCampaignProgress produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignProgress' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaignProgress delete: tags: - Outbound summary: Reset campaign progress and recycle the campaign description: '' operationId: deleteOutboundCampaignProgress produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '202': description: Accepted - the campaign will be recycled momentarily '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:edit - outbound:campaign:recycle x-purecloud-method-name: deleteOutboundCampaignProgress /api/v2/outbound/campaigns/{campaignId}/skillcombinations: get: tags: - Outbound summary: Get the remaining and total contact count for each skill combination in a skills campaign description: '' operationId: getOutboundCampaignSkillcombinations produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 responses: '200': description: successful operation schema: $ref: '#/definitions/PagedSkillCombinationListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaignSkillcombinations /api/v2/outbound/campaigns/{campaignId}/start: post: tags: - Outbound summary: Start the campaign description: '' operationId: postOutboundCampaignStart produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '204': description: OK - The campaign is started '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:start x-purecloud-method-name: postOutboundCampaignStart /api/v2/outbound/campaigns/{campaignId}/stop: post: tags: - Outbound summary: Stop the campaign description: '' operationId: postOutboundCampaignStop produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '204': description: OK - The campaign is stopped '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:stop x-purecloud-method-name: postOutboundCampaignStop /api/v2/outbound/campaignrules/{campaignRuleId}: get: tags: - Outbound summary: Get Campaign Rule description: '' operationId: getOutboundCampaignrule produces: - application/json parameters: - name: campaignRuleId in: path description: Campaign Rule ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaignRule:view x-purecloud-method-name: getOutboundCampaignrule put: tags: - Outbound summary: Update Campaign Rule description: '' operationId: putOutboundCampaignrule produces: - application/json parameters: - name: campaignRuleId in: path description: Campaign Rule ID required: true type: string - in: body name: body description: CampaignRule required: true schema: $ref: '#/definitions/CampaignRule' responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. invalid.campaign.rule.date.time.condition.combination: Campaign rule has an invalid combination of date-time conditions. name.length.exceeded: The name length exceeds the limit of 64 characters. missing.campaign.rule.conditions: Campaign rule must have a condition. invalid.campaign.rule.action.parameter: Campaign rule action has an invalid parameter. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. missing.campaign.rule.condition.value: Campaign rule condition must have an value. missing.campaign.rule.entity: Campaign rule must have an entity for conditions. missing.campaign.rule.action.parameters: Campaign rule action must have a parameter. invalid.campaign.rule.condition.parameter: Campaign rule condition has an invalid parameter. conditions.limit.exceeded: The maximum number of conditions has been exceeded constraint.validation: '%s' missing.campaign.rule.condition.type: Campaign rule condition must have a type. 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.campaign.rule.condition.value: Campaign rule condition has an invalid value. missing.campaign.rule.actions: Campaign rule must have an action. cannot.modify.campaign.rule.property: Cannot modify a rule property invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' missing.campaign.rule.action.entity: Campaign rule must have an action entity. incorrect.max.value: Max values must be > 0 and one of them must be defined invalid.property: Value [%s] is not a valid property for object [%s] invalid.campaign.rule.condition.operator: Campaign rule condition has an invalid operator. cannot.modify.enabled.campaign.rule: Cannot modify a rule that is enabled. missing.campaign.rule.condition.parameters: Campaign rule condition must have a parameter. missing.campaign.rule.action.type: Campaign rule action must have a type. invalid.external.campaign.dialingmode.transition: Cannot change to/from external dialing mode to/from another dialing mode. invalid.campaign.rule.action.parameter.messages.per.minute: Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation) invalid.campaign.rule.condition.for.duration: Campaign rule condition has an invalid 'forDuration' parameter invalid.campaign.rule.property.value: Invalid a campaign rule property value response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.campaign.rule.date.time.condition.parameter: Campaign rule date-time condition has an invalid parameter. campaign.rule.entity.incompatible: Incompatible rule entities missing.campaign.rule.condition.operator: Campaign rule condition must have an operator. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignRule:edit x-purecloud-method-name: putOutboundCampaignrule delete: tags: - Outbound summary: Delete Campaign Rule description: '' operationId: deleteOutboundCampaignrule produces: - application/json parameters: - name: campaignRuleId in: path description: Campaign Rule ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. cannot.delete.enabled.campaign.rule: Cannot delete a rule that is enabled. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignRule:delete x-purecloud-method-name: deleteOutboundCampaignrule /api/v2/outbound/campaignrules: get: tags: - Outbound summary: Query Campaign Rule list description: '' operationId: getOutboundCampaignrules produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignRuleEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaignRule:view x-purecloud-method-name: getOutboundCampaignrules post: tags: - Outbound summary: Create Campaign Rule description: '' operationId: postOutboundCampaignrules produces: - application/json parameters: - in: body name: body description: CampaignRule required: true schema: $ref: '#/definitions/CampaignRule' responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignRule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. cannot.create.enabled.campaign.rule: Cannot create a rule that is enabled. invalid.campaign.rule.date.time.condition.combination: Campaign rule has an invalid combination of date-time conditions. name.length.exceeded: The name length exceeds the limit of 64 characters. missing.campaign.rule.conditions: Campaign rule must have a condition. invalid.campaign.rule.action.parameter: Campaign rule action has an invalid parameter. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. missing.campaign.rule.condition.value: Campaign rule condition must have an value. missing.campaign.rule.entity: Campaign rule must have an entity for conditions. missing.campaign.rule.action.parameters: Campaign rule action must have a parameter. invalid.campaign.rule.condition.parameter: Campaign rule condition has an invalid parameter. conditions.limit.exceeded: The maximum number of conditions has been exceeded constraint.validation: '%s' missing.campaign.rule.condition.type: Campaign rule condition must have a type. 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.campaign.rule.condition.value: Campaign rule condition has an invalid value. invalid.turn.on.campaign.action: Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count. missing.campaign.rule.actions: Campaign rule must have an action. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' missing.campaign.rule.action.entity: At least one rule action entity is required. incorrect.max.value: Max values must be > 0 and one of them must be defined invalid.property: Value [%s] is not a valid property for object [%s] invalid.campaign.rule.condition.operator: Campaign rule condition has an invalid operator. missing.campaign.rule.condition.parameters: Campaign rule condition must have a parameter. max.entity.count.reached: The maximum campaign rule count has been reached. missing.campaign.rule.action.type: Campaign rule action must have a type. invalid.external.campaign.dialingmode.transition: Cannot change to/from external dialing mode to/from another dialing mode. invalid.campaign.rule.action.parameter.messages.per.minute: Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation) invalid.campaign.rule.condition.for.duration: Campaign rule condition has an invalid 'forDuration' parameter invalid.campaign.rule.property.value: Invalid a campaign rule property value response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.campaign.rule.date.time.condition.parameter: Campaign rule date-time condition has an invalid parameter. invalid.dialing.mode.update: Invalid dialing mode specified. campaign.rule.entity.incompatible: Incompatible rule entities missing.campaign.rule.condition.operator: Campaign rule condition must have an operator. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignRule:add x-purecloud-method-name: postOutboundCampaignrules /api/v2/outbound/schedules/campaigns/{campaignId}: get: tags: - Outbound summary: Get a dialer campaign schedule. description: '' operationId: getOutboundSchedulesCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:view - outbound:campaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesCampaign put: tags: - Outbound summary: Update a new campaign schedule. description: '' operationId: putOutboundSchedulesCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - in: body name: body description: CampaignSchedule required: true schema: $ref: '#/definitions/CampaignSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.interval.time: '' bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create the schedule in an invalid way recurrences.exceeded.limit: The number of recurrences exceeds the limit. invalid.number.of.occurrences: The number of occurrences is a required field for numbered ranges and cannot exceed the limit. recurrence.invalid.alteration.start.time: The alteration start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.end.time: The end time of an interval must not be in the past invalid.pattern.type: The pattern type is a required field and must be a valid pattern type. recurrence.invalid.end.time: The end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" constraint.validation: '%s' future.intervals.exceeded.limit: '' invalid.update: An attempt was made to update the schedule in an invalid way invalid.alteration.type: The alteration type is a required field and must be a valid alteration type. recurrence.id.duplicate.found: Duplicate recurrence ID found. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.range.end: The range end date must be a valid future date, greater than the recurrence start date, and in the format "YYYY-MM-DDThh:mm:ss" invalid.timezone: The time zone of a schedule must be a valid timezone string like ‘America/New_York’ invalid.pattern.interval: The interval field is a required field and must be a number between 1 and the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.attributes.supplied: The schedule contains unsupported attributes invalid.days.of.week: The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week. recurrence.alterations.exceeded.limit: The number of alterations within the recurrence has exceeded the limit overlapping.interval: Each interval must not overlap with any other interval response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.start.time: The start time of an interval must not be in the past recurrence.invalid.start.time: The start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.range.type: The range type is a required field and must be a valid range type. recurrence.id.not.allowed: Recurrence ID is not allowed. recurrence.invalid.alteration.end.time: The alteration end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" invalid.associated.resource.type: The associated resource type must be 'campaigns' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:edit - outbound:campaign:editSchedule x-purecloud-method-name: putOutboundSchedulesCampaign delete: tags: - Outbound summary: Delete a dialer campaign schedule. description: '' operationId: deleteOutboundSchedulesCampaign produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:delete - outbound:campaign:deleteSchedule x-purecloud-method-name: deleteOutboundSchedulesCampaign /api/v2/outbound/schedules/campaigns: get: tags: - Outbound summary: Query for a list of dialer campaign schedules. description: '' operationId: getOutboundSchedulesCampaigns produces: - application/json parameters: [] responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/CampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:view - outbound:campaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesCampaigns /api/v2/outbound/campaigns/{campaignId}/stats: get: tags: - Outbound summary: Get statistics about a Dialer Campaign description: '' operationId: getOutboundCampaignStats produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignStats' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The dialer campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaignStats /api/v2/outbound/campaigns/performance/query: post: tags: - Outbound summary: Get performance data for a list of campaigns description: '' operationId: postOutboundCampaignsPerformanceQuery produces: - application/json parameters: - in: body name: body description: Campaign IDs. Maximum of 50 IDs allowed. required: true schema: type: array items: type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignPerformanceDataListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:performance:view - outbound:campaign:view x-purecloud-method-name: postOutboundCampaignsPerformanceQuery /api/v2/outbound/campaigns/progress: post: tags: - Outbound summary: Get progress for a list of campaigns description: '' operationId: postOutboundCampaignsProgress produces: - application/json parameters: - in: body name: body description: Campaign IDs required: true schema: type: array items: type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/CampaignProgress' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.missing.callback.numbers: Callback numbers missing callback.error.missing.queue.id: Callback missing queue ID bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: postOutboundCampaignsProgress /api/v2/outbound/campaigns: get: tags: - Outbound summary: Query a list of dialer campaigns. description: '' operationId: getOutboundCampaigns produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: contactListId in: query description: Contact List ID required: false type: string - name: dncListIds in: query description: DNC list ID required: false type: string - name: distributionQueueId in: query description: Distribution queue ID required: false type: string - name: edgeGroupId in: query description: Edge group ID required: false type: string - name: callAnalysisResponseSetId in: query description: Call analysis response set ID required: false type: string - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.bulk.retrieves: Only 100 campaigns can be retrieved by id at a time bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view x-purecloud-method-name: getOutboundCampaigns post: tags: - Outbound summary: Create a campaign. description: '' operationId: postOutboundCampaigns produces: - application/json parameters: - in: body name: body description: Campaign required: true schema: $ref: '#/definitions/Campaign' - name: useMaxCallsPerAgentDecimal in: query description: Use maxCallsPerAgent with decimal precision required: false type: boolean enum: - 'true' - 'false' responses: '200': description: successful operation schema: $ref: '#/definitions/Campaign' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: column.data.type.specification.not.found.for.contact.sort: A column data type specification must be defined for contact sort column invalid.priority: The priority must be between 1 and 5 (inclusive) name.length.exceeded: The name length exceeds the limit of 64 characters. invalid.column.data.type.specification.data.type: Column data type specification data type must match the contact sort column data type too.many.queue.members: The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details. duplicate.name: The name already exists. invalid.max.calls.per.agent: Max calls per agent must be inside allowed range contact.list.filter.in.use: A campaign can not be created because the contact list filter is in use by another running campaign site.has.no.active.edges: There are no active edges in the site edge.group.not.found: The edge group could not be found. too.many.data.action.conditions: There can be a maximum of 1 data action condition across all rule sets referenced by this campaign missing.column.data.type.specification.in.contact.list: Column data type specifications must be defined on the campaign's contact list contact.sorts.duplicate.field.names: The same column name is used in separate contact sorts entries. invalid.agent.owned.dialing.mode: Agent owned records are only available for the Preview dialing mode. more.than.one.contact.list.filter: Only one contact list filter is allowed per campaign. managed.site.cannot.be.configured: Managed Sites cannot be configured on a campaign. invalid.campaign.preview.timeout.seconds: The preview timeout seconds must be between 0 and 1200 (inclusive) invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' cannot.update.dynamic.contact.queueing.settings: Dynamic queueing cannot be changed once it's set invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' contact.list.filter.not.found: The contact list filter could not be found. dnc.list.not.found: A do not call list could not be found. missing.caller.id.address: No caller id address supplied rule.set.not.found: A rule set could not be found. managed.edge.group.cannot.be.configured: Managed Edge Groups cannot be configured on a campaign. property.not.allowed.for.external.calling: Property is not allowed for external calling max.entity.count.reached: The maximum campaign count has been reached. invalid.campaign.phone.columns: The campaign phone columns are invalid. contact.sorts.conflict: The contact sort and contact sorts fields have conflicting values. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable site.not.found: The site could not be found queue.not.found: The queue could not be found. dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns: Dynamic contact queueing cannot be enabled for agent owned campaigns no.edge.group.for.site: No edge group was found for the site name.cannot.be.blank: A name must be provided. missing.contact.list.filter: A contact list filter must be provided when dynamic filtering is enabled. invalid.campaign.outbound.line.count: '' bad.request: The request could not be understood by the server due to malformed syntax. callable.time.set.not.found: The callable time set could not be found. invalid.create: '' missing.caller.id.name: No caller id name supplied invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded: The column data type specification length value exceeds the max length allowed for a skill column constraint.validation: '%s' dnc.list.invalid.custom.exclusion.column: The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List contact.list.filter.does.not.match.contact.list: The contact list on the contact list filter does not match the contact list on the campaign. dynamic.queueing.campaigns.count.exceeded: The limit for dynamic queueing campaigns has been exceeded invalid.acw.queue.setting: Please change the After Call Work setting on the queue as Agent Requested is not valid 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. call.analysis.response.set.not.found: The call analysis response set could not be found. script.not.found: The script could not be found. site.and.edge.group.cannot.be.configured: A single campaign cannot have both a site and an edge group configured contact.sort.field.not.found: The contact sort field is not a column on the contact list. invalid.campaign.agent.owned.column: The campaign agent owned column is not a valid contact list column. contact.sorts.invalid.field.name: A contact sorts field name is not a valid column name in the campaign's contact list. invalid.relative.weight: Relative weight must be between values 0 and 100 inclusively external.calling.property.not.allowed: Some properties cannot be set on an external calling campaign. See details invalid.property: Value [%s] is not a valid property for object [%s] edge.group.has.no.active.edges: There are no active edges in the edge group dynamic.queueing.active.campaigns.count.exceeded: The limit for active dynamic queueing campaigns has been exceeded invalid.ani.address: The caller id number is invalid. callable.time.set.conflicts.with.automatic.time.zone.mapping: A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping. invalid.campaign.skill.column.data.type: The column data type specification that is selected as a skill column must be of Data Type text. edge.group.is.empty: There are no edges in the edge group invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' missing.time.zone.in.contactlist: When using a callable time set, the contact list must have at least one time zone column defined. invalid.dialing.mode.update: A campaign may not be updated to or from external dialing mode to any other dialing mode. site.is.empty: There are no edges in the site '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. too.many.skill.queue.members: The limit for number of queue members on a campaign configured for skill records has been exceeded. See details. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:add x-purecloud-method-name: postOutboundCampaigns /api/v2/outbound/campaigns/all/divisionviews: get: tags: - Outbound summary: Query across all types of campaigns description: '' operationId: getOutboundCampaignsAllDivisionviews produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: id in: query description: Campaign ID(s) required: false type: array items: type: string collectionFormat: multi - name: name in: query description: Campaign name(s) required: false type: string - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: mediaType in: query description: Media type(s) required: false type: array items: type: string enum: - email - sms - voice - whatsapp collectionFormat: multi - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CommonCampaignDivisionViewEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] invalid.filter.field: Invalid query parameter supplied for filtering. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:search - outbound:messagingCampaign:search - outbound:emailCampaign:search - outbound:whatsAppCampaign:search x-purecloud-method-name: getOutboundCampaignsAllDivisionviews /api/v2/outbound/campaigns/all: get: tags: - Outbound summary: Query across all types of campaigns by division description: '' operationId: getOutboundCampaignsAll produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: id in: query description: Campaign ID(s) required: false type: array items: type: string collectionFormat: multi - name: name in: query description: Campaign name(s) required: false type: string - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: mediaType in: query description: Media type(s) required: false type: array items: type: string enum: - email - sms - voice - whatsapp collectionFormat: multi - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CommonCampaignEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] invalid.filter.field: Invalid query parameter supplied for filtering. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaign:view - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: getOutboundCampaignsAll /api/v2/outbound/contactlists/divisionviews/{contactListId}: get: tags: - Outbound summary: Get a basic ContactList information object description: This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size. operationId: getOutboundContactlistsDivisionview produces: - application/json parameters: - name: contactListId in: path description: Contactlist ID required: true type: string - name: includeImportStatus in: query description: Include import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListDivisionView' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:contactList:search x-purecloud-method-name: getOutboundContactlistsDivisionview /api/v2/outbound/contactlists/divisionviews: get: tags: - Outbound summary: Query a list of simplified contact list objects. description: This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size. operationId: getOutboundContactlistsDivisionviews produces: - application/json parameters: - name: includeImportStatus in: query description: Include import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListDivisionViewListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.bulk.retrieves: Only 100 contact lists can be retrieved by id at a time bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:contactList:search x-purecloud-method-name: getOutboundContactlistsDivisionviews /api/v2/outbound/contactlists/{contactListId}/export: get: tags: - Outbound summary: Get the URI of a contact list export. description: '' operationId: getOutboundContactlistExport produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string - name: download in: query description: Redirect to download uri required: false type: string default: 'false' responses: '200': description: successful operation schema: $ref: '#/definitions/ExportUri' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' exports.black.listed: This organization has been prohibited from exporting contact lists. Please contact support. invalid.property: Value [%s] is not 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: contact.list.not.found: The contact list could not be found. no.available.list.export.uri: There is no available download URI for contact list at this time. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:contact:view - outbound:contactList:view x-purecloud-method-name: getOutboundContactlistExport post: tags: - Outbound summary: Initiate the export of a contact list. description: Returns 200 if received OK. operationId: postOutboundContactlistExport produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string - in: body name: body description: Export information to get required: false schema: $ref: '#/definitions/ContactsExportRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/DomainEntityRef' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. contact.list.export.in.progress: An export is already in progress for this contact list. internal.error: An internal service error occurred. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.contact.list.filter: The contact list filter provided is not valid. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. exports.black.listed: This organization has been prohibited from exporting contact lists. Please contact support. contact.list.import.in.progress: The contact list cannot be exported while it is being imported. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:contact:view - outbound:contactList:view x-purecloud-method-name: postOutboundContactlistExport /api/v2/outbound/contactlistfilters/preview: post: tags: - Outbound summary: Get a preview of the output of a contact list filter description: '' operationId: postOutboundContactlistfiltersPreview produces: - application/json parameters: - in: body name: body description: ContactListFilter required: true schema: $ref: '#/definitions/ContactListFilter' responses: '200': description: successful operation schema: $ref: '#/definitions/FilterPreviewResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contact:view x-purecloud-method-name: postOutboundContactlistfiltersPreview /api/v2/outbound/contactlistfilters/{contactListFilterId}: get: tags: - Outbound summary: Get Contact list filter description: '' operationId: getOutboundContactlistfilter produces: - application/json parameters: - name: contactListFilterId in: path description: Contact List Filter ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListFilter' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:view x-purecloud-method-name: getOutboundContactlistfilter put: tags: - Outbound summary: Update Contact List Filter description: '' operationId: putOutboundContactlistfilter produces: - application/json parameters: - name: contactListFilterId in: path description: Contact List Filter ID required: true type: string - in: body name: body description: ContactListFilter required: true schema: $ref: '#/definitions/ContactListFilter' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListFilter' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: operator.required: Could not update the contact list filter because the operator field was empty. bad.request: The request could not be understood by the server due to malformed syntax. contact.list.not.found: Could not update the contact list filter because the contact list could not be found. filter.type.required.for.multiple.predicates: Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates. constraint.validation: '%s' filter.type.required.for.multiple.clauses: Could not update the contact list filter because the filter type is required if there are multiple clauses. at.least.one.predicate.required: Could not update the contact list filter because each clause must contain at least one predicate. value.required: Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator. range.max.required: Could not update the contact list filter because the range max field is required for Between operator. filter.modification.in.progress: Could not update the contact list filter because filter modification is in progress. value.did.not.match.column.type: Could not update the contact list filter because the predicate value field did not match the column type. 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. value.exceeds.max.digits: The maximum number of digits for the value on a predicate with a numeric operator has been exceeded. max.less.than.min: Could not update the contact list filter because the predicate range max value is less than the min value. min.did.not.match.column.type: Could not update the contact list filter because the predicate range min field did not match the column type. value.exceeds.max.decimal.places: The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded. cannot.edit.contact.list.filter.source.type: Could not update the contact list filter because the source type can not be edited. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' column.does.not.match.contact.list: Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list. contact.list.template.not.found: Could not update the contact list filter because the contact list template could not be found. range.required: Could not update the contact list filter because the range field was empty and is required for Between and In operators. max.predicates.contains.exceeded: Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded. invalid.property: Value [%s] is not a valid property for object [%s] contact.list.cannot.be.blank: Could not update the contact list filter because the contact list field was blank when source type is ContactList. invalid.date.value: Could not update the contact list filter because the value field on the predicate is not a valid date. clauses.required: Could not update the contact list filter because the clauses field is required to contain at least one clause. max.did.not.match.column.type: Could not update the contact list filter because the predicate range max field did not match the column type. invalid.contact.list.filter.source.type: Could not update the contact list filter because the source type is invalid. column.required: Could not update the contact list filter because the column field was empty on a predicate. max.predicates.exceeded: Could not update the contact list filter because the maximum number of predicates has been exceeded. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' contact.list.template.required: Could not update the contact list filter because the contact list template field was blank when source type is ContactListTemplate. range.set.required: Could not update the contact list filter because the range set field is required for In operator. range.min.required: Could not update the contact list filter because the range min field is required for Between operator. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:edit x-purecloud-method-name: putOutboundContactlistfilter delete: tags: - Outbound summary: Delete Contact List Filter description: '' operationId: deleteOutboundContactlistfilter produces: - application/json parameters: - name: contactListFilterId in: path description: Contact List Filter ID required: true type: string responses: '204': description: Contact list filter deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:delete x-purecloud-method-name: deleteOutboundContactlistfilter /api/v2/outbound/contactlistfilters/bulk/retrieve: post: tags: - Outbound summary: Retrieve multiple contact list filters description: '' operationId: postOutboundContactlistfiltersBulkRetrieve produces: - application/json parameters: - in: body name: body description: The contact list filters to retrieve required: true schema: $ref: '#/definitions/ContactListFilterBulkRetrieveBody' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListFilterEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: No body with contact list filter ids was provided in request. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:view x-purecloud-method-name: postOutboundContactlistfiltersBulkRetrieve /api/v2/outbound/contactlistfilters: get: tags: - Outbound summary: Query Contact list filters description: '' operationId: getOutboundContactlistfilters produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending - name: contactListId in: query description: Contact List ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListFilterEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:view x-purecloud-method-name: getOutboundContactlistfilters post: tags: - Outbound summary: Create Contact List Filter description: '' operationId: postOutboundContactlistfilters produces: - application/json parameters: - in: body name: body description: ContactListFilter required: true schema: $ref: '#/definitions/ContactListFilter' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListFilter' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: operator.required: Could not update the contact list filter because the operator field was empty. bad.request: The request could not be understood by the server due to malformed syntax. contact.list.not.found: Could not create the contact list filter because the contact list could not be found. filter.type.required.for.multiple.predicates: Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates. constraint.validation: '%s' filter.type.required.for.multiple.clauses: Could not update the contact list filter because the filter type is required if there are multiple clauses. at.least.one.predicate.required: Could not update the contact list filter because each clause must contain at least one predicate. value.required: Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator. range.max.required: Could not update the contact list filter because the range max field is required for Between operator. value.did.not.match.column.type: Could not update the contact list filter because the predicate value field did not match the column type. 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. value.exceeds.max.digits: The maximum number of digits for the value on a predicate with a numeric operator has been exceeded. max.less.than.min: Could not update the contact list filter because the predicate range max value is less than the min value. min.did.not.match.column.type: Could not update the contact list filter because the predicate range min field did not match the column type. value.exceeds.max.decimal.places: The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' column.does.not.match.contact.list: Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list. contact.list.template.not.found: Could not create the contact list filter because the contact list template could not be found. range.required: Could not update the contact list filter because the range field was empty and is required for Between and In operators. max.predicates.contains.exceeded: Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded. invalid.property: Value [%s] is not a valid property for object [%s] contact.list.cannot.be.blank: Could not create the contact list filter because the contact list field was blank when source type is ContactList. invalid.date.value: Could not update the contact list filter because the value field on the predicate is not a valid date. clauses.required: Could not update the contact list filter because the clauses field is required to contain at least one clause. max.did.not.match.column.type: Could not update the contact list filter because the predicate range max field did not match the column type. invalid.contact.list.filter.source.type: Could not create the contact list filter because the source type is invalid. column.required: Could not update the contact list filter because the column field was empty on a predicate. max.entity.count.reached: The maximum contact list filter count has been reached. max.predicates.exceeded: Could not create the contact list filter because the maximum number of predicates has been exceeded. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' contact.list.template.required: Could not create the contact list filter because the contact list template field was blank when source type is ContactListTemplate. range.set.required: Could not update the contact list filter because the range set field is required for In operator. range.min.required: Could not update the contact list filter because the range min field is required for Between operator. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListFilter:add x-purecloud-method-name: postOutboundContactlistfilters /api/v2/outbound/contactlists/{contactListId}/importstatus: get: tags: - Outbound summary: Get dialer contactList import status. description: '' operationId: getOutboundContactlistImportstatus produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ImportStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlistImportstatus /api/v2/outbound/contactlists/{contactListId}: get: tags: - Outbound summary: Get a dialer contact list. description: '' operationId: getOutboundContactlist produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string - name: includeImportStatus in: query description: Import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/ContactList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: contact.list.not.found: The dialer contact list was not found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlist put: tags: - Outbound summary: Update a contact list. description: '' operationId: putOutboundContactlist produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string - in: body name: body description: ContactList required: true schema: $ref: '#/definitions/ContactList' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: no.phone.columns: No phone columns provided invalid.contact.whatsapp.column: At least one whatsapp column is required, and all whatsapp columns must have a columnName and type. name.length.exceeded: The name length exceeds the limit of 64 characters. system.column.phone.column: ContactList Phone column cannot be a system defined column name. duplicate.name: The name already exists. not.unique.email.columns: Email Columns contain duplicate values. contact.list.whatsapp.columns.not.supported: Contact list whatsapp columns are not supported. cannot.update.whatsapp.columns: The whatsapp columns can not be updated. missing.column.data.type.specification.in.contact.list: Column data type specifications must be provided for all columns invalid.contact.email.column: At least one email column is required, and all email columns must have a columnName and type. not.unique.whatsapp.columns: Whatsapp Columns contain duplicate values. invalid.update: '' cannot.update.email.columns: The email columns can not be updated. invalid.retention.expiration.in.past: The retention expiration date is in the past. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.contact.phone.column: At least one phone column is required, and all phone columns must have a columnName and type. invalid.zip.code.column: The zip code column must be a column of the contact list and cannot be a phone column contact.columns.do.not.contain.email.column: The contact columns do not contain one or more of the specified email addresses columns invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.retention.missing.preferred.timezone: The retention configuration is missing preferred timezone. column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed: The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed. invalid.column.data.type.specifications.max.values: The numeric column data type specifications max value is invalid. cannot.edit.automatic.time.zone.mapping.settings: Automatic time zone mapping and the zip code column cannot be changed after contact list creation not.unique.phone.columns: Phone Number Columns contain duplicate values. contact.columns.do.not.contain.whatsapp.column: The contact columns do not contain one or more of the specified whatsapp columns no.email.columns: No email columns provided phone.columns.limit.exceeded: Number of phone columns must not exceed the limit. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable cannot.update.column.data.type.specifications: The column data type specifications cannot be updated. cannot.have.zip.code.column.without.automatic.time.zone.mapping: The zip code column can only be used when automatic time zone mapping is also being used contact.list.email.columns.not.supported: Contact list email columns are not supported. missing.column.data.type.specification.max.length: The numeric column data type specifications max length value is required. name.cannot.be.blank: A name must be provided. contact.columns.do.not.contain.phone.number.column: The contact columns do not contain one or more of the specified phone number columns bad.request: The request could not be understood by the server due to malformed syntax. missing.column.data.type.specification.max: The numeric column data type specifications max value is required. invalid.retention.days: The retention days value is invalid. no.contact.columns.defined: There are no contact columns defined. constraint.validation: '%s' contact.list.both.phone.email.column.empty: Contact list phone and email columns are empty. invalid.column.data.type.specifications.max.length.values: The text column data type specifications max length value is invalid not.unique.contact.columns: Contact Columns contains duplicate values. missing.column.data.type.specification.min: The numeric column data type specifications min value is required. 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. cannot.have.callable.time.column.with.automatic.time.zone.mapping: The phone columns cannot reference callable time columns when automatic time zone mapping is being used cannot.update.phone.columns: The phone columns can not be updated. email.columns.limit.exceeded: Number of email columns must not exceed the limit. contact.columns.dont.match: Contact columns field and ordered contact columns field must match. whatsapp.columns.limit.exceeded: Number of whatsapp columns must not exceed the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.retention.configuration: The retention configuration is invalid. column.data.type.specification.column.name.not.found: Column data type specification column name is not a valid contact list column invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.contact.data.value: The contact data values are invalid. invalid.column.data.type.specifications.min.values: The numeric column data type specifications min value is invalid. cannot.update.contact.column.names: The contact column names can not be updated. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:edit x-purecloud-method-name: putOutboundContactlist delete: tags: - Outbound summary: Delete a contact list. description: '' operationId: deleteOutboundContactlist produces: - application/json parameters: - name: contactListId in: path description: ContactList 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: name.cannot.be.blank: A name must be provided. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable internal.error: An internal server error occurred. referential.integrity.error: Could not delete the resource because it is referenced by another entity. contact.list.import.in.progress: The contact list import is in progress. contact.list.in.use: The contact list is in use. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:delete x-purecloud-method-name: deleteOutboundContactlist /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview: get: tags: - Outbound summary: Preview the result of applying Automatic Time Zone Mapping to a contact list description: '' operationId: getOutboundContactlistTimezonemappingpreview produces: - application/json parameters: - name: contactListId in: path description: ContactList ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/TimeZoneMappingPreview' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.automatic.time.zone.mapping: This contact list is not set up for Automatic Time Zone Mapping bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The contact list could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlistTimezonemappingpreview /api/v2/outbound/contactlisttemplates/{contactListTemplateId}: get: tags: - Outbound summary: Get Contact List Template description: '' operationId: getOutboundContactlisttemplate produces: - application/json parameters: - name: contactListTemplateId in: path description: ContactListTemplate ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:view x-purecloud-method-name: getOutboundContactlisttemplate put: tags: - Outbound summary: Update a contact list template. description: '' operationId: putOutboundContactlisttemplate produces: - application/json parameters: - name: contactListTemplateId in: path description: ContactListTemplate ID required: true type: string - in: body name: body description: ContactListTemplate required: true schema: $ref: '#/definitions/ContactListTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: no.phone.columns: No phone columns provided invalid.contact.whatsapp.column: At least one whatsapp column is required, and all whatsapp columns must have a columnName and type. name.length.exceeded: The name length exceeds the limit of 64 characters. system.column.phone.column: ContactList Phone column cannot be a system defined column name. not.unique.email.columns: Email Columns contain duplicate values. cannot.update.whatsapp.columns: The whatsapp columns can not be updated. invalid.contact.email.column: At least one email column is required, and all email columns must have a columnName and type. not.unique.whatsapp.columns: Whatsapp Columns contain duplicate values. invalid.update: '' cannot.update.email.columns: The email columns cannot be updated. contact.column.length.limit.exceeded: The length of each contact column must not exceed the limit. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.contact.phone.column: At least one phone column is required, and all phone columns must have a columnName and type. invalid.zip.code.column: The zip code column must be a column of the contact list template and cannot be a phone column invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.retention.missing.preferred.timezone: The retention configuration is missing preferred timezone. column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed: The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed. invalid.column.data.type.specifications.max.values: The numeric column data type specifications max value is invalid. cannot.edit.automatic.time.zone.mapping.settings: Automatic time zone mapping and the zip code column cannot be changed after contact list creation not.unique.phone.columns: Phone Number Columns contain duplicate values. no.email.columns: No email columns provided contact.list.template.both.phone.email.column.empty: Contact list template phone and email columns are empty. contact.list.template.whatsapp.columns.not.supported: Contact list Template whatsapp columns are not supported. phone.columns.limit.exceeded: Number of phone columns must not exceed the limit. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable cannot.update.column.data.type.specifications: The column data type specifications cannot be updated. cannot.have.zip.code.column.without.automatic.time.zone.mapping: The zip code column can only be used when automatic time zone mapping is also being used missing.column.data.type.specification.max.length: The numeric column data type specifications max length value is required. name.cannot.be.blank: A name must be provided. missing.column.data.type.specification.in.contact.list.template: Column data type specifications must be provided for all columns bad.request: The request could not be understood by the server due to malformed syntax. missing.column.data.type.specification.max: The numeric column data type specifications max value is required. invalid.retention.days: The retention days value is invalid. no.contact.columns.defined: There are no contact columns defined. constraint.validation: '%s' invalid.column.data.type.specifications.max.length.values: The text column data type specifications max length value is invalid not.unique.contact.columns: Contact Columns contains duplicate values. contact.list.template.email.columns.not.supported: Contact list template email columns are not supported. missing.column.data.type.specification.min: The numeric column data type specifications min value is required. 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. cannot.have.callable.time.column.with.automatic.time.zone.mapping: The phone columns cannot reference callable time columns when automatic time zone mapping is being used cannot.update.phone.columns: The phone columns cannot be updated. email.columns.limit.exceeded: Number of email columns must not exceed the limit. whatsapp.columns.limit.exceeded: Number of whatsapp columns must not exceed the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.retention.configuration: The retention configuration is invalid. column.data.type.specification.column.name.not.found: Column data type specification column name is not a valid contact list template column invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' contact.columns.limit.exceeded: Number of contact columns must not exceed the limit. invalid.column.data.type.specifications.min.values: The numeric column data type specifications min value is invalid. cannot.update.contact.column.names: The contact column names cannot be updated. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:edit x-purecloud-method-name: putOutboundContactlisttemplate delete: tags: - Outbound summary: Delete Contact List Template description: '' operationId: deleteOutboundContactlisttemplate produces: - application/json parameters: - name: contactListTemplateId in: path description: ContactListTemplate ID required: true type: string responses: '204': description: Contact list template deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:delete x-purecloud-method-name: deleteOutboundContactlisttemplate /api/v2/outbound/contactlisttemplates: get: tags: - Outbound summary: Query a list of contact list templates description: '' operationId: getOutboundContactlisttemplates produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:view x-purecloud-method-name: getOutboundContactlisttemplates post: tags: - Outbound summary: Create Contact List Template description: '' operationId: postOutboundContactlisttemplates produces: - application/json parameters: - in: body name: body description: ContactListTemplate required: true schema: $ref: '#/definitions/ContactListTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. no.phone.columns: No phone columns provided name.length.exceeded: The name length exceeds the limit of 64 characters. missing.column.data.type.specification.in.contact.list.template: Column data type specifications must be provided for all columns system.column.phone.column: ContactList Phone column cannot be a system defined column name. bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: '' not.unique.email.columns: Email Columns contain duplicate values. missing.column.data.type.specification.max: The numeric column data type specifications max value is required. constraint.validation: '%s' not.unique.whatsapp.columns: Whatsapp Columns contain duplicate values. invalid.column.data.type.specifications.max.length.values: The text column data type specifications max length value is invalid. contact.list.template.email.columns.not.supported: Contact list template email columns not supported. missing.column.data.type.specification.min: The numeric column data type specifications min value is required. 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. cannot.have.callable.time.column.with.automatic.time.zone.mapping: The phone columns cannot reference callable time columns when automatic time zone mapping is being used invalid.zip.code.column: The zip code column must be a column of the contact list template and cannot be a phone column invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' email.columns.limit.exceeded: Number of email columns must not exceed the limit. column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed: The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed. whatsapp.columns.limit.exceeded: Number of whatsapp columns must not exceed the limit. invalid.column.data.type.specifications.max.values: The numeric column data type specifications max value is invalid. not.unique.phone.columns: Phone Number Columns contain duplicate values. invalid.property: Value [%s] is not a valid property for object [%s] no.email.columns: No email columns provided contact.list.template.both.phone.email.column.empty: Contact list template phone and email columns are empty. max.entity.count.reached: The maximum contact list template count has been reached. contact.list.template.whatsapp.columns.not.supported: Contact list Template whatsapp columns are not supported. phone.columns.limit.exceeded: Number of phone columns must not exceed the limit. column.data.type.specification.column.name.not.found: Column data type specification column name is not a valid contact list template column response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' cannot.have.zip.code.column.without.automatic.time.zone.mapping: The zip code column can only be used when automatic time zone mapping is also being used invalid.column.data.type.specifications.min.values: The numeric column data type specifications min value is invalid. missing.column.data.type.specification.max.length: The numeric column data type specifications max length value is required. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:add x-purecloud-method-name: postOutboundContactlisttemplates delete: tags: - Outbound summary: Delete multiple contact list templates. description: '' operationId: deleteOutboundContactlisttemplates produces: - application/json parameters: - name: id in: query description: contact list template id(s) to delete required: true type: array items: type: string collectionFormat: multi responses: '204': description: Contact list templates accepted for delete. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.deletes: There were too many contact list templates in the request. bad.request: The request could not be understood by the server due to 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: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:delete x-purecloud-method-name: deleteOutboundContactlisttemplates /api/v2/outbound/contactlisttemplates/bulk/add: post: tags: - Outbound summary: Add multiple contact list templates description: '' operationId: postOutboundContactlisttemplatesBulkAdd produces: - application/json parameters: - in: body name: body description: contact list template(s) to add required: true schema: type: array items: $ref: '#/definitions/ContactListTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.contact.list.templates.added: The number of contact list templates being added exceeds the limit bad.request: No contact list templates were provided in request. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:add x-purecloud-method-name: postOutboundContactlisttemplatesBulkAdd /api/v2/outbound/contactlisttemplates/bulk/retrieve: post: tags: - Outbound summary: Get multiple contact list templates description: '' operationId: postOutboundContactlisttemplatesBulkRetrieve produces: - application/json parameters: - in: body name: body description: contact list templates to get required: true schema: $ref: '#/definitions/ContactListTemplateBulkRetrieveBody' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: No contact list template ids were provided in request. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactListTemplate:view x-purecloud-method-name: postOutboundContactlisttemplatesBulkRetrieve /api/v2/outbound/contactlists: get: tags: - Outbound summary: Query a list of contact lists. description: 'Any ContactList field can be used as a query parameter to filter results. Multiple values can be specified for a field, and filter type prefixes can be used inline. Example: dateCreated=greaterthan:2025-01-01T00:00:00.000Z&dateCreated=lessthan:2027-01-01T00:00:00.000Z. See https://developer.genesys.cloud/routing/outbound/filter-type for available filter types.' operationId: getOutboundContactlists produces: - application/json parameters: - name: includeImportStatus in: query description: Include import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.bulk.retrieves: Only 100 contact lists can be retrieved by id at a time bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlists post: tags: - Outbound summary: Create a contact List. description: '' operationId: postOutboundContactlists produces: - application/json parameters: - in: body name: body description: ContactList required: true schema: $ref: '#/definitions/ContactList' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: no.phone.columns: No phone columns provided invalid.contact.whatsapp.column: At least one whatsapp column is required, and all whatsapp columns must have a columnName and type. name.length.exceeded: The name length exceeds the limit of 64 characters. system.column.phone.column: ContactList Phone column cannot be a system defined column name. duplicate.name: The name already exists. not.unique.email.columns: Email Columns contain duplicate values. contact.list.whatsapp.columns.not.supported: Contact list whatsapp columns are not supported. missing.column.data.type.specification.in.contact.list: Column data type specifications must be provided for all columns invalid.contact.email.column: The contact email columns are invalid. not.unique.whatsapp.columns: Whatsapp Columns contain duplicate values. invalid.retention.expiration.in.past: The retention expiration date is in the past. contact.column.length.limit.exceeded: The length of each contact column must not exceed the limit. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.contact.phone.column: The contact phone columns are invalid. invalid.zip.code.column: The zip code column must be a column of the contact list and cannot be a phone column contact.columns.do.not.contain.email.column: The contact columns do not contain email column invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.retention.missing.preferred.timezone: The retention configuration is missing preferred timezone. column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed: The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed. invalid.column.data.type.specifications.max.values: The numeric column data type specifications max value is invalid. not.unique.phone.columns: Phone Number Columns contain duplicate values. contact.columns.do.not.contain.whatsapp.column: The contact columns do not contain one or more of the specified whatsapp columns no.email.columns: No email columns provided max.entity.count.reached: The maximum contact list count has been reached. phone.columns.limit.exceeded: Number of phone columns must not exceed the limit. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable cannot.have.zip.code.column.without.automatic.time.zone.mapping: The zip code column can only be used when automatic time zone mapping is also being used contact.list.email.columns.not.supported: Contact list email columns not supported. missing.column.data.type.specification.max.length: The numeric column data type specifications max length value is required. name.cannot.be.blank: A name must be provided. contact.columns.do.not.contain.phone.number.column: The contact columns do not contain phone number column bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: '' missing.column.data.type.specification.max: The numeric column data type specifications max value is required. division.not.found: The division could not be found. invalid.retention.days: The retention days values are invalid. no.contact.columns.defined: There are no contact columns defined. constraint.validation: '%s' contact.list.both.phone.email.column.empty: Contact list phone and email columns are empty. invalid.column.data.type.specifications.max.length.values: The text column data type specifications max length value is invalid. not.unique.contact.columns: Contact Columns contains duplicate values. missing.column.data.type.specification.min: The numeric column data type specifications min value is required. 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. cannot.have.callable.time.column.with.automatic.time.zone.mapping: The phone columns cannot reference callable time columns when automatic time zone mapping is being used email.columns.limit.exceeded: Number of email columns must not exceed the limit. contact.columns.dont.match: Contact columns field and ordered contact columns field must match. whatsapp.columns.limit.exceeded: Number of whatsapp columns must not exceed the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.retention.configuration: The retention configuration is invalid. column.data.type.specification.column.name.not.found: Column data type specification column name is not a valid contact list column invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' contact.columns.limit.exceeded: Number of contact columns must not exceed the limit. invalid.contact.data.value: The contact data values are invalid. invalid.column.data.type.specifications.min.values: The numeric column data type specifications min value is invalid. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: 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.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:add x-purecloud-method-name: postOutboundContactlists delete: tags: - Outbound summary: Delete multiple contact lists. description: '' operationId: deleteOutboundContactlists produces: - application/json parameters: - name: id in: query description: contact list id(s) to delete required: true type: array items: type: string collectionFormat: multi responses: '204': description: Contact lists accepted for delete. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.deletes: There were too many contact lists in the request. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. bulk.delete.conflict: Not all the requested contact lists could be deleted. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:delete x-purecloud-method-name: deleteOutboundContactlists /api/v2/outbound/contactlists/uploads: post: tags: - Outbound summary: Generate presigned upload URL for contact list. description: '' operationId: postOutboundContactlistsUploads produces: - application/json parameters: - in: body name: body description: contactListUploadUrlRequest required: true schema: $ref: '#/definitions/ContactListUploadUrlRequest' responses: '200': description: Presigned url successfully created to upload contactlist schema: $ref: '#/definitions/UploadUrlResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - upload x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:upload x-purecloud-method-name: postOutboundContactlistsUploads /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}: get: tags: - Outbound summary: Get a contact. description: '' operationId: getOutboundContactlistContact produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - name: contactId in: path description: Contact ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DialerContact' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contact:view x-purecloud-method-name: getOutboundContactlistContact put: tags: - Outbound summary: Update a contact. description: '' operationId: putOutboundContactlistContact produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - name: contactId in: path description: Contact ID required: true type: string - in: body name: body description: Contact required: true schema: $ref: '#/definitions/DialerContact' responses: '200': description: successful operation schema: $ref: '#/definitions/DialerContact' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.missing.columns: The contact is missing columns from its contact list. contact.list.clear.in.progress: The contact list is currently being cleared. 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] contact.does.not.exist: The contact does not exist. constraint.validation: '%s' invalid.update: An attempt was made to update a contact in an invalid way invalid.contact.id: An attempt was made to update a contact with an invalid contact ID contact.column.length.limit.exceeded: The length of each contact column must not exceed the limit. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. contact.missing.data: The data field is required. contact.id.length.limit.exceeded: The length of a contact id must not exceed the limit. contact.columns.limit.exceeded: Number of contact columns must not exceed the limit. contact.datum.length.limit.exceeded: The length of each piece of contact data must not exceed the limit. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:edit x-purecloud-method-name: putOutboundContactlistContact delete: tags: - Outbound summary: Delete a contact. description: '' operationId: deleteOutboundContactlistContact produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - name: contactId in: path description: Contact 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: contact.in.use: The contact cannot be deleted because it is currently in use. invalid.delete: An attempt was made to delete a contact in an invalid way bad.request: The request could not be understood by the server due to 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: contact.list.not.found: The contact list could not be found. contact.not.found: The contact could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:delete x-purecloud-method-name: deleteOutboundContactlistContact /api/v2/outbound/contactlists/{contactListId}/clear: post: tags: - Outbound summary: Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. description: '' operationId: postOutboundContactlistClear produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string responses: '204': description: Contacts will be deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.is.on.running.campaign: The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] contact.list.import.in.progress: The contacts cannot be removed from a contactlist that is currently in progress of an import. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:delete x-purecloud-method-name: postOutboundContactlistClear /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}: get: tags: - Outbound summary: Get bulk operation job. description: '' operationId: getOutboundContactlistContactsBulkJob produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - name: jobId in: path description: Job ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ContactsBulkOperationJob' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlistContactsBulkJob /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs: get: tags: - Outbound summary: Get 10 most recent bulk operation jobs associated with contact list. description: '' operationId: getOutboundContactlistContactsBulkJobs produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ContactsBulkOperationJobListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contactList:view x-purecloud-method-name: getOutboundContactlistContactsBulkJobs /api/v2/outbound/contactlists/{contactListId}/contacts/bulk: post: tags: - Outbound summary: Get contacts from a contact list. description: '' operationId: postOutboundContactlistContactsBulk produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - in: body name: body description: ContactIds to get. required: true schema: type: array items: type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/DialerContact' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.contacts.requested: Only 50 contacts can be retrieved at a time. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contact:view x-purecloud-method-name: postOutboundContactlistContactsBulk /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove: post: tags: - Outbound summary: Start an async job to delete contacts using a filter. description: '' operationId: postOutboundContactlistContactsBulkRemove produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - in: body name: body description: Contact filter information. required: true schema: $ref: '#/definitions/ContactBulkSearchParameters' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactsBulkOperationJob' '202': description: Contacts deletion has been started on the Contact List. schema: $ref: '#/definitions/ContactsBulkOperationJob' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.clear.in.progress: The contact list is currently being cleared. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable contact.bulk.operation.in.progress: There is already a bulk operation in progress for this contact list. invalid.date: 'Dates must be specified as ISO-8601 strings. 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' invalid.contact.list.filter: The contact list filter provided is not valid. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:delete x-purecloud-method-name: postOutboundContactlistContactsBulkRemove /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update: post: tags: - Outbound summary: Start an async job to bulk edit contacts. description: '' operationId: postOutboundContactlistContactsBulkUpdate produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - in: body name: body description: Contact bulk edit request information. required: true schema: $ref: '#/definitions/ContactBulkEditRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactsBulkOperationJob' '202': description: Contacts edit has been started on the Contact List. schema: $ref: '#/definitions/ContactsBulkOperationJob' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.update: An attempt was made to update contact(s) in an invalid way contact.list.clear.in.progress: The contact list is currently being cleared. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable contact.bulk.operation.in.progress: There is already a bulk operation in progress for this contact list. invalid.date: 'Dates must be specified as ISO-8601 strings. 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' invalid.contact.list.filter: The contact list filter provided is not valid. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:edit x-purecloud-method-name: postOutboundContactlistContactsBulkUpdate /api/v2/outbound/contactlists/{contactListId}/contacts/search: post: tags: - Outbound summary: Query contacts from a contact list. description: '' operationId: postOutboundContactlistContactsSearch produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - in: body name: body description: Contact search parameters. required: true schema: $ref: '#/definitions/ContactListingRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ContactListingResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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' invalid.contact.list.filter: The contact list filter provided is not valid. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:contact:view x-purecloud-method-name: postOutboundContactlistContactsSearch /api/v2/outbound/contactlists/{contactListId}/contacts: post: tags: - Outbound summary: Add contacts to a contact list. description: '' operationId: postOutboundContactlistContacts produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - in: body name: body description: Contact required: true schema: type: array items: $ref: '#/definitions/WritableDialerContact' - name: priority in: query description: Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. required: false type: boolean - name: clearSystemData in: query description: Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. required: false type: boolean - name: doNotQueue in: query description: Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter. required: false type: boolean responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/DialerContact' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.contacts.added: Too many contacts added, the limit is 1000 per request uploads.black.listed: This organization has been prohibited from uploading contacts. Please contact support. contact.missing.columns: The contact is missing columns from its contact list. invalid.contact.columns: The contact columns are invalid. contact.list.clear.in.progress: The contact list is currently being cleared. bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create contacts in an invalid way invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.update: An attempt was made to update contacts in an invalid way invalid.contact.id: The custom contactId field is not valid. It cannot contain special characters. contact.column.length.limit.exceeded: The length of each contact column must not exceed the limit. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. contact.missing.data: The data field is required. contact.id.length.limit.exceeded: The length of a contact id must not exceed the limit. contact.columns.limit.exceeded: Number of contact columns must not exceed the limit. contact.datum.length.limit.exceeded: The length of each piece of contact data must not exceed the limit. contacts.per.org.limit.exceeded: The organization has reached the limit on total contacts invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal service error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:add x-purecloud-method-name: postOutboundContactlistContacts delete: tags: - Outbound summary: Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted description: '' operationId: deleteOutboundContactlistContacts produces: - application/json parameters: - name: contactListId in: path description: Contact List ID required: true type: string - name: contactIds in: query description: ContactIds to delete. required: true type: array items: type: string collectionFormat: multi responses: '200': description: Contacts Deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.contacts.added: There were too many contacts in the request, the limit is 250 invalid.contact.id: One or more of the contacts was invalidly formed with non UTF-8 characters. invalid.delete: An attempt was made to delete contacts in an invalid way bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable no.contacts.specified: There were no contacts specified in the request. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: contact.list.not.found: The contact list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:contact:delete x-purecloud-method-name: deleteOutboundContactlistContacts /api/v2/outbound/dnclists/uploads: post: tags: - Outbound summary: Generate presigned upload URL for dnc list. description: '' operationId: postOutboundDnclistsUploads produces: - application/json parameters: - in: body name: body description: dncListUploadUrlRequest required: true schema: $ref: '#/definitions/DNCListUploadUrlRequest' responses: '200': description: Presigned url successfully created to upload dnc list schema: $ref: '#/definitions/UploadUrlResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - upload x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:upload x-purecloud-method-name: postOutboundDnclistsUploads /api/v2/outbound/conversations/{conversationId}/dnc: post: tags: - Outbound summary: Add phone numbers to a Dialer DNC list. description: '' operationId: postOutboundConversationDnc produces: - application/json parameters: - name: conversationId in: path description: Conversation ID required: true type: string responses: default: description: successful operation '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: conversation.error.conversation.not.found: The conversation does not exist. dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:add x-purecloud-method-name: postOutboundConversationDnc /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns: delete: tags: - Outbound summary: Deletes all or expired custom exclusion column entries from a DNC list. description: This operation is only for Internal DNC lists of custom exclusion column entries operationId: deleteOutboundDnclistCustomexclusioncolumns produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: expiredOnly in: query description: Set to true to only remove DNC entries that are expired required: false type: boolean default: false responses: '204': description: DNC custom exclusion column entries deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.import.in.progress: Custom exclusion column entries cannot be removed from a dnclist while it is being imported. dnc.source.operation.not.supported: An attempt was made to clear a DNC list that is not of type Internal custom bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dnc.list.invalid.contact.method: An attempt was made to add to or delete from a DNC list that is not of Contact Method Any '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:delete x-purecloud-method-name: deleteOutboundDnclistCustomexclusioncolumns patch: tags: - Outbound summary: Add entries to or delete entries from a DNC list. description: Only Internal DNC lists may be deleted from operationId: patchOutboundDnclistCustomexclusioncolumns produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC Custom exclusion column entries required: true schema: $ref: '#/definitions/DncPatchCustomExclusionColumnsRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to add to or delete from a DNC list that is not of type Rds-custom 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] dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ constraint.validation: '%s' invalid.dnc.patch.request: Custom exclusion column entries must be provided in the request response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.dnc.patch.action: An action must be provided in the request dnc.list.invalid.contact.method: An attempt was made to add to or delete from a DNC list that is not of Contact Method Any dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC entries. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' dnc.delete.entries.max.per.request.exceeded: There were too many entries in the request, the limit is 250 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:edit x-purecloud-method-name: patchOutboundDnclistCustomexclusioncolumns /api/v2/outbound/dnclists/divisionviews/{dncListId}: get: tags: - Outbound summary: Get a basic DncList information object description: This returns a simplified version of a DncList, consisting of the name, division, import status, and size. operationId: getOutboundDnclistsDivisionview produces: - application/json parameters: - name: dncListId in: path description: Dnclist ID required: true type: string - name: includeImportStatus in: query description: Include import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/DncListDivisionView' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:dncList:search x-purecloud-method-name: getOutboundDnclistsDivisionview /api/v2/outbound/dnclists/divisionviews: get: tags: - Outbound summary: Query a list of simplified dnc list objects. description: This return a simplified version of dnc lists, consisting of the name, division, import status, and size. operationId: getOutboundDnclistsDivisionviews produces: - application/json parameters: - name: includeImportStatus in: query description: Include import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: dncSourceType in: query description: DncSourceType required: false type: string enum: - rds - rds_custom - dnc.com - gryphon - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/DncListDivisionViewListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.bulk.retrieves: Only 100 dnc lists can be retrieved by id at a time bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:dncList:search x-purecloud-method-name: getOutboundDnclistsDivisionviews /api/v2/outbound/dnclists/{dncListId}/emailaddresses: post: tags: - Outbound summary: Add email addresses to a DNC list. description: Only Internal DNC lists may be appended to operationId: postOutboundDnclistEmailaddresses produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC email addresses required: true schema: type: array items: type: string responses: '204': description: Accepted - Adding email addresses '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to append emails to a DNC list that is not of type Internal bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC records. See details dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The date was invalid. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:add x-purecloud-method-name: postOutboundDnclistEmailaddresses delete: tags: - Outbound summary: Deletes all or expired email addresses from a DNC list. description: This operation is Only for Internal DNC lists of email addresses operationId: deleteOutboundDnclistEmailaddresses produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: expiredOnly in: query description: Set to true to only remove DNC entries that are expired required: false type: boolean default: false responses: '204': description: DNC email addresses deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.import.in.progress: The email addresses cannot be removed from a dnclist while it is being imported. dnc.source.operation.not.supported: An attempt was made to clear a DNC list that is not of type Internal bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dnc.list.invalid.contact.method: An attempt was made to delete emails from a DNC list that is not of Contact Method Email '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: DNC list delete all or expired entries feature not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:delete x-purecloud-method-name: deleteOutboundDnclistEmailaddresses patch: tags: - Outbound summary: Add emails to or Delete emails from a DNC list. description: Only Internal DNC lists may be added to or deleted from operationId: patchOutboundDnclistEmailaddresses produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC Emails required: true schema: $ref: '#/definitions/DncPatchEmailsRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to add emails addresses to or delete email addresses from a DNC list that is not of type rds_custom" 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] dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ constraint.validation: '%s' invalid.dnc.patch.request: Email addresses must be provided in the request response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.dnc.patch.action: An action must be provided in the request dnc.list.invalid.contact.method: An attempt was made to add emails to or delete emails from a DNC list that is not of Contact Method Email dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC records. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' dnc.delete.entries.max.per.request.exceeded: There were too many entries in the request, the limit is 250 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: DNC list delete all or expired entries feature not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:edit x-purecloud-method-name: patchOutboundDnclistEmailaddresses /api/v2/outbound/dnclists/{dncListId}/export: get: tags: - Outbound summary: Get the URI of a DNC list export. description: '' operationId: getOutboundDnclistExport produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: download in: query description: Redirect to download uri required: false type: string default: 'false' responses: '200': description: successful operation schema: $ref: '#/definitions/ExportUri' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: dnc.list.not.found: The do not call list could not be found. no.available.list.export.uri: There is no available download URI for the dnc list at this time. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:dnc:view - outbound:dncList:view x-purecloud-method-name: getOutboundDnclistExport post: tags: - Outbound summary: Initiate the export of a dnc list. description: Returns 200 if received OK. operationId: postOutboundDnclistExport produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DomainEntityRef' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.import.in.progress: The dnc list cannot be exported while it is being imported. unexportable.dnc.list.type: Only internal dnc lists can be exported. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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] dnc.list.export.in.progress: An export is already in progress for this dnc list. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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: dnc.list.not.found: The dnc list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ALL permissions: - outbound:dnc:view - outbound:dncList:view x-purecloud-method-name: postOutboundDnclistExport /api/v2/outbound/dnclists/{dncListId}/importstatus: get: tags: - Outbound summary: Get dialer dncList import status. description: '' operationId: getOutboundDnclistImportstatus produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ImportStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:view x-purecloud-method-name: getOutboundDnclistImportstatus /api/v2/outbound/dnclists/{dncListId}/phonenumbers: post: tags: - Outbound summary: Add phone numbers to a DNC list. description: Only Internal DNC lists may be appended to operationId: postOutboundDnclistPhonenumbers produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC Phone Numbers required: true schema: type: array items: type: string - name: expirationDateTime in: query description: Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format required: false type: string responses: default: description: successful operation '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to append numbers to a DNC list that is not of type Internal 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] dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The date was invalid. constraint.validation: '%s' dnc.phone.numbers.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC records. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' dnc.phone.numbers.per.organization.limit.exceeded: The organization has reached the limit on total DNC records. See details '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:add x-purecloud-method-name: postOutboundDnclistPhonenumbers delete: tags: - Outbound summary: Deletes all or expired phone numbers from a DNC list. description: This operation is Only for Internal DNC lists of phone numbers operationId: deleteOutboundDnclistPhonenumbers produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: expiredOnly in: query description: Set to true to only remove DNC entries that are expired required: false type: boolean default: false responses: '204': description: DNC phone numbers deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.import.in.progress: The phone numbers cannot be removed from a dnclist while it is being imported. dnc.source.operation.not.supported: An attempt was made to clear a DNC list that is not of type Internal bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dnc.list.invalid.contact.method: An attempt was made to delete numbers from a DNC list that is not of Contact Method Phone '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: DNC list delete all or expired entries feature not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:delete x-purecloud-method-name: deleteOutboundDnclistPhonenumbers patch: tags: - Outbound summary: Add numbers to or delete numbers from a DNC list. description: Only Internal DNC lists may be added to deleted from operationId: patchOutboundDnclistPhonenumbers produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC Phone Numbers required: true schema: $ref: '#/definitions/DncPatchPhoneNumbersRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to add numbers to or delete numbers from a DNC list that is not of type rds_custom 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] dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ constraint.validation: '%s' invalid.dnc.patch.request: Phone numbers must be provided in the request response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.dnc.patch.action: An action must be provided in the request dnc.list.invalid.contact.method: An attempt was made to add numbers to or delete numbers from a DNC list that is not of Contact Method Phone dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC records. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' dnc.delete.entries.max.per.request.exceeded: There were too many entries in the request, the limit is 250 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: DNC list delete all or expired entries feature not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:edit x-purecloud-method-name: patchOutboundDnclistPhonenumbers /api/v2/outbound/dnclists/{dncListId}: get: tags: - Outbound summary: Get dialer DNC list description: '' operationId: getOutboundDnclist produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: includeImportStatus in: query description: Import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/DncList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: dnc.list.not.found: The dialer DNC list was not found. not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:view x-purecloud-method-name: getOutboundDnclist put: tags: - Outbound summary: Update dialer DNC list description: '' operationId: putOutboundDnclist produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DncList required: true schema: $ref: '#/definitions/DncList' responses: '200': description: successful operation schema: $ref: '#/definitions/DncList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. dnc.source.configuration.invalid.campaign.id: The DNCScrub Campaign Id in dnc source configuration is invalid invalid.property: Value [%s] is not a valid property for object [%s] cannot.update.dnc.list.type: The Dnc source cannot be updated. cannot.update.custom.exclusion.column: The dnc custom exclusion column cannot be updated. dnc.list.phone.columns.empty: '' dnc.records.per.list.limit.exceeded: The dnc records per list exceeded the limit. constraint.validation: '%s' invalid.update: '' response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. dnc.source.authentication.failed: External dnc source was not able to authenticate. dnc.source.region.not.supported: The dnc source is not supported in the region dnc.source.server.error: External dnc source returned an error condition dnc.records.per.organization.limit.exceeded: The dnc records per organization exceeded the limit. dnc.source.configuration.invalid: The dnc source configuration is invalid invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:edit x-purecloud-method-name: putOutboundDnclist delete: tags: - Outbound summary: Delete dialer DNC list description: '' operationId: deleteOutboundDnclist produces: - application/json parameters: - name: dncListId in: path description: DncList 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: dnc.list.in.use: The dialer DNC list is in use. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:delete x-purecloud-method-name: deleteOutboundDnclist /api/v2/outbound/dnclists/{dncListId}/whatsappnumbers: delete: tags: - Outbound summary: Deletes all or expired whatsApp numbers from a DNC list. description: This operation is only for Internal DNC lists of whatsApp numbers operationId: deleteOutboundDnclistWhatsappnumbers produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - name: expiredOnly in: query description: Set to true to only remove DNC whatsApp numbers that are expired required: false type: boolean default: false responses: '204': description: DNC whatsApp numbers deleted. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.import.in.progress: WhatsApp numbers cannot be removed from a dnclist while it is being imported. dnc.source.operation.not.supported: An attempt was made to clear a DNC list that is not of type Internal bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable dnc.list.invalid.contact.method: An attempt was made to add to or delete from a DNC list that is not of Contact Method WhatsApp '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The do not call list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:delete x-purecloud-method-name: deleteOutboundDnclistWhatsappnumbers patch: tags: - Outbound summary: Add entries to or delete entries from a DNC list. description: Only Internal DNC lists may be deleted from operationId: patchOutboundDnclistWhatsappnumbers produces: - application/json parameters: - name: dncListId in: path description: DncList ID required: true type: string - in: body name: body description: DNC whatsApp numbers required: true schema: $ref: '#/definitions/DncPatchWhatsAppNumbersRequest' responses: '204': description: No Content '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.source.operation.not.supported: An attempt was made to add to or delete from a DNC list that is not of type Rds 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] dnc.records.per.list.limit.exceeded: The DNC list has reached the limit on total records. See details invalid.date.value: The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ constraint.validation: '%s' invalid.dnc.patch.request: WhatsApp numbers must be provided in the request response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.dnc.patch.action: An action must be provided in the request dnc.list.invalid.contact.method: An attempt was made to add to or delete from a DNC list that is not of Contact Method WhatsApp dnc.records.per.organization.limit.exceeded: The organization has reached the limit on total DNC entries. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' dnc.delete.entries.max.per.request.exceeded: There were too many entries in the request, the limit is 250 '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: dnc.list.not.found: The DNC list could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dnc:edit x-purecloud-method-name: patchOutboundDnclistWhatsappnumbers /api/v2/outbound/dnclists: get: tags: - Outbound summary: Query dialer DNC lists description: '' operationId: getOutboundDnclists produces: - application/json parameters: - name: includeImportStatus in: query description: Import status required: false type: boolean default: false - name: includeSize in: query description: Include size required: false type: boolean default: false - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: dncSourceType in: query description: DncSourceType required: false type: string enum: - rds - rds_custom - dnc.com - gryphon - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/DncListEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:view x-purecloud-method-name: getOutboundDnclists post: tags: - Outbound summary: Create dialer DNC list description: '' operationId: postOutboundDnclists produces: - application/json parameters: - in: body name: body description: DncList required: true schema: $ref: '#/definitions/DncListCreate' responses: '200': description: successful operation schema: $ref: '#/definitions/DncList' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. dnc.list.missing.custom.exclusion.column: A custom exclusion column must be provided for this list type. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.create: '' dnc.source.configuration.invalid.campaign.id: The DNCScrub Campaign Id in dnc source configuration is invalid invalid.property: Value [%s] is not a valid property for object [%s] dnc.list.phone.columns.empty: '' dnc.records.per.list.limit.exceeded: The dnc records per list exceeded the limit. constraint.validation: '%s' max.entity.count.reached: The maximum dnc list count has been reached. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. dnc.source.authentication.failed: External dnc source was not able to authenticate. dnc.source.region.not.supported: The dnc source is not supported in the region dnc.source.server.error: External dnc source returned an error condition dnc.records.per.organization.limit.exceeded: The dnc records per organization exceeded the limit. dnc.source.configuration.invalid: The dnc source configuration is invalid invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: 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. '501': description: Not Implemented schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.implemented: Feature toggle is not enabled security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:dncList:add x-purecloud-method-name: postOutboundDnclists /api/v2/outbound/events/{eventId}: get: tags: - Outbound summary: Get Dialer Event description: '' operationId: getOutboundEvent produces: - application/json parameters: - name: eventId in: path description: Event Log ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EventLog' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:eventLog:view x-purecloud-method-name: getOutboundEvent /api/v2/outbound/events: get: tags: - Outbound summary: Query Event Logs description: '' operationId: getOutboundEvents produces: - application/json parameters: - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: category in: query description: Category required: false type: string - name: level in: query description: Level required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/DialerEventEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:eventLog:view x-purecloud-method-name: getOutboundEvents /api/v2/outbound/filespecificationtemplates/bulk: delete: tags: - Outbound summary: Delete multiple file specification templates. description: '' operationId: deleteOutboundFilespecificationtemplatesBulk produces: - application/json parameters: - name: id in: query description: File Specification template id(s) to delete required: true type: array items: type: string collectionFormat: multi responses: '204': description: File specification templates accepted for delete. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.deletes: There were too many file specification templates in the request. bad.request: The request could not be understood by the server due to 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. bulk.delete.conflict: Not all the requested file specification templates could be deleted. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:delete x-purecloud-method-name: deleteOutboundFilespecificationtemplatesBulk /api/v2/outbound/filespecificationtemplates: get: tags: - Outbound summary: Query File Specification Templates description: '' operationId: getOutboundFilespecificationtemplates produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/FileSpecificationTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:view x-purecloud-method-name: getOutboundFilespecificationtemplates post: tags: - Outbound summary: Create File Specification Template description: '' operationId: postOutboundFilespecificationtemplates produces: - application/json parameters: - in: body name: body description: FileSpecificationTemplate required: true schema: $ref: '#/definitions/FileSpecificationTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/FileSpecificationTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. column.length.out.of.bounds: Column length is out of bounds name.length.exceeded: The name length exceeds the limit of 64 characters. invalid.find.pattern: '"find" is not valid Java Regular Expression' bad.request: The request could not be understood by the server due to malformed syntax. skipped.lines.out.of.bounds: Provided number of lines to be skipped is out of bounds column.start.position.out.of.bounds: Column startPosition is out of bounds invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' find.value.out.of.bounds: '"find" is out of bounds' replace.value.out.of.bounds: '"replaceWith" is out of bounds' missing.column.name: Column name is required response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.column.information: FixedLength format and Delimited format without header must have information about columns invalid.delimiter.value: When using Custom delimiter, the delimiterValue must be single character string invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' too.many.preprocessing.rules: Too many pre-processing rules '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:add x-purecloud-method-name: postOutboundFilespecificationtemplates /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}: get: tags: - Outbound summary: Get File Specification Template description: '' operationId: getOutboundFilespecificationtemplate produces: - application/json parameters: - name: fileSpecificationTemplateId in: path description: File Specification Template ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/FileSpecificationTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:view x-purecloud-method-name: getOutboundFilespecificationtemplate put: tags: - Outbound summary: Update File Specification Template description: '' operationId: putOutboundFilespecificationtemplate produces: - application/json parameters: - name: fileSpecificationTemplateId in: path description: File Specification Template ID required: true type: string - in: body name: body description: fileSpecificationTemplate required: true schema: $ref: '#/definitions/FileSpecificationTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/FileSpecificationTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. column.length.out.of.bounds: Column length is out of bounds name.length.exceeded: The name length exceeds the limit of 64 characters. invalid.find.pattern: '"find" is not valid Java Regular Expression' bad.request: The request could not be understood by the server due to malformed syntax. skipped.lines.out.of.bounds: Provided number of lines to be skipped is out of bounds column.start.position.out.of.bounds: Column startPosition is out of bounds invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' find.value.out.of.bounds: '"find" is out of bounds' replace.value.out.of.bounds: '"replaceWith" is out of bounds' missing.column.name: Column name is required response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. missing.column.information: FixedLength format and Delimited format without header must have information about columns invalid.delimiter.value: When using Custom delimiter, the delimiterValue must be single character string invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' too.many.preprocessing.rules: Too many pre-processing rules '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:edit x-purecloud-method-name: putOutboundFilespecificationtemplate delete: tags: - Outbound summary: Delete File Specification Template description: '' operationId: deleteOutboundFilespecificationtemplate produces: - application/json parameters: - name: fileSpecificationTemplateId in: path description: File Specification Template ID required: true type: string responses: '204': description: File Specification template deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:fileSpecificationTemplate:delete x-purecloud-method-name: deleteOutboundFilespecificationtemplate /api/v2/outbound/importtemplates/{importTemplateId}/importstatus: get: tags: - Outbound summary: Get the import status for an import template. description: '' operationId: getOutboundImporttemplateImportstatus produces: - application/json parameters: - name: importTemplateId in: path description: importTemplateId required: true type: string - name: listNamePrefix in: query description: listNamePrefix required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ImportStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:view x-purecloud-method-name: getOutboundImporttemplateImportstatus /api/v2/outbound/importtemplates/{importTemplateId}: get: tags: - Outbound summary: Get Import Template description: '' operationId: getOutboundImporttemplate produces: - application/json parameters: - name: importTemplateId in: path description: Import Template ID required: true type: string - name: includeImportStatus in: query description: Import status required: false type: boolean default: false responses: '200': description: successful operation schema: $ref: '#/definitions/ImportTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:view x-purecloud-method-name: getOutboundImporttemplate put: tags: - Outbound summary: Update Import Template description: '' operationId: putOutboundImporttemplate produces: - application/json parameters: - name: importTemplateId in: path description: Import Template ID required: true type: string - in: body name: body description: importTemplate required: true schema: $ref: '#/definitions/ImportTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. contact.list.template.not.found: Could not update the import template because the contact list template could not be found. name.length.exceeded: The name length exceeds the limit of 64 characters. 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] criteria.value.cannot.be.blank: Criteria value must be provided. constraint.validation: '%s' invalid.contact.list.filter: Could not update the import template because the contact list filter is not valid. invalid.criteria.value: Could not update the import template because the criteria value is invalid response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. contact.list.template.required: A contact list template id must be provided. spllitting.information.cannot.be.blank: The splitting information must be provided when useSplittingCriteria is true. criteria.value.is.out.of.bounds: Criteria value is out of bounds. invalid.list.name.format: List name format is not valid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' contact.list.filter.not.found: Could not update the import template because the contact list filter could not be found. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:edit x-purecloud-method-name: putOutboundImporttemplate delete: tags: - Outbound summary: Delete Import Template description: '' operationId: deleteOutboundImporttemplate produces: - application/json parameters: - name: importTemplateId in: path description: Import Template ID required: true type: string responses: '204': description: Import template deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable import.template.in.use: The import template is in use. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:delete x-purecloud-method-name: deleteOutboundImporttemplate /api/v2/outbound/importtemplates: get: tags: - Outbound summary: Query Import Templates description: '' operationId: getOutboundImporttemplates produces: - application/json parameters: - name: includeImportStatus in: query description: Import status required: false type: boolean default: false - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending - name: contactListTemplateId in: query description: Contact List Template ID required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ImportTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:view x-purecloud-method-name: getOutboundImporttemplates post: tags: - Outbound summary: Create Import Template description: '' operationId: postOutboundImporttemplates produces: - application/json parameters: - in: body name: body description: ImportTemplate required: true schema: $ref: '#/definitions/ImportTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportTemplate' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. contact.list.template.not.found: Could not update the import template because the contact list template could not be found. name.length.exceeded: The name length exceeds the limit of 64 characters. 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] criteria.value.cannot.be.blank: Criteria value must be provided. constraint.validation: '%s' invalid.contact.list.filter: Could not update the import template because the contact list filter is not valid. max.entity.count.reached: The maximum import template count has been reached. invalid.criteria.value: Could not update the import template because the criteria value is invalid response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. contact.list.template.required: A contact list template id must be provided. spllitting.information.cannot.be.blank: The splitting information must be provided when useSplittingCriteria is true. criteria.value.is.out.of.bounds: Criteria value is out of bounds. invalid.list.name.format: List name format is not valid. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' contact.list.filter.not.found: Could not update the import template because the contact list filter could not be found. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. duplicate.name: The name already exists. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An internal server error occurred. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:add x-purecloud-method-name: postOutboundImporttemplates delete: tags: - Outbound summary: Delete multiple import templates. description: '' operationId: deleteOutboundImporttemplates produces: - application/json parameters: - name: id in: query description: import template id(s) to delete required: true type: array items: type: string collectionFormat: multi responses: '204': description: Import templates accepted for delete. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.deletes: There were too many import templates in the request. bad.request: The request could not be understood by the server due to 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. bulk.delete.import.template: Not all the requested import templates could be deleted. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:delete x-purecloud-method-name: deleteOutboundImporttemplates /api/v2/outbound/importtemplates/bulk/add: post: tags: - Outbound summary: Add multiple import templates description: '' operationId: postOutboundImporttemplatesBulkAdd produces: - application/json parameters: - in: body name: body description: import template(s) to add required: true schema: type: array items: $ref: '#/definitions/ImportTemplate' responses: '200': description: successful operation schema: $ref: '#/definitions/ImportTemplateEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.import.templates.added: The number of import templates being added exceeds the limit bad.request: No import templates were provided in request. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:importTemplate:add x-purecloud-method-name: postOutboundImporttemplatesBulkAdd /api/v2/outbound/messagingcampaigns/progress: post: tags: - Outbound summary: Get progress for a list of messaging campaigns description: '' operationId: postOutboundMessagingcampaignsProgress produces: - application/json parameters: - in: body name: body description: Messaging Campaign IDs required: true schema: type: array items: type: string responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/CampaignProgress' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: callback.error.missing.callback.numbers: Callback numbers missing callback.error.missing.queue.id: Callback missing queue ID bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: postOutboundMessagingcampaignsProgress /api/v2/outbound/settings: get: tags: - Outbound summary: Get the outbound settings for this organization description: '' operationId: getOutboundSettings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/OutboundSettings' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:settings:view x-purecloud-method-name: getOutboundSettings patch: tags: - Outbound summary: Update the outbound settings for this organization description: '' operationId: patchOutboundSettings produces: - application/json parameters: - in: body name: body description: outboundSettings required: true schema: $ref: '#/definitions/OutboundSettings' - name: useMaxCallsPerAgentDecimal in: query description: Use maxCallsPerAgent with decimal precision required: false type: boolean enum: - 'true' - 'false' responses: '204': description: Accepted - Processing Update '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.callable.window.stop.time: Latest callable time must not be later than 21:00 invalid.country.code: Invalid country country provided for atzm supportedCountries invalid.callable.window: Earliest callable time must be before Latest callable time and only one callable time window is allowed bad.request: The request could not be understood by the server due to malformed syntax. invalid.max.calls.per.agent: Max calls per agent must be between values 1 and 15. missing.time.zone: Time zone must be provided for unmapped call window invalid.time.zone: Invalid time zone for unmapped call window invalid.property: Value [%s] is not a valid property for object [%s] invalid.abandon.seconds: Abandon seconds must be between 1 and 300. constraint.validation: '%s' invalid.callable.window.start.time: Earliest callable time must not be earlier than 08:00 invalid.update: An attempt was made to update the outbound settings in an invalid way invalid.max.line.utilization: Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: outbound settings version does not match expected '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:settings:edit x-purecloud-method-name: patchOutboundSettings /api/v2/outbound/rulesets/{ruleSetId}: get: tags: - Outbound summary: Get a Rule Set by ID. description: '' operationId: getOutboundRuleset produces: - application/json parameters: - name: ruleSetId in: path description: Rule Set ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/RuleSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:ruleSet:view x-purecloud-method-name: getOutboundRuleset put: tags: - Outbound summary: Update a Rule Set. description: '' operationId: putOutboundRuleset produces: - application/json parameters: - name: ruleSetId in: path description: Rule Set ID required: true type: string - in: body name: body description: RuleSet required: true schema: $ref: '#/definitions/RuleSet' responses: '200': description: successful operation schema: $ref: '#/definitions/RuleSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.rule.action: '' name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.rule.condition: '' invalid.property: Value [%s] is not a valid property for object [%s] data.action.not.found: The requested data action could not be found constraint.validation: '%s' invalid.update: '' rule.conflict: Duplicated Rule IDs and/or names. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.rule.condition.category: The condition is not valid for the given category. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.rule.action.category: The action is not valid for the given category. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:ruleSet:edit x-purecloud-method-name: putOutboundRuleset delete: tags: - Outbound summary: Delete a Rule Set. description: '' operationId: deleteOutboundRuleset produces: - application/json parameters: - name: ruleSetId in: path description: Rule Set ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:ruleSet:delete x-purecloud-method-name: deleteOutboundRuleset /api/v2/outbound/rulesets: get: tags: - Outbound summary: Query a list of Rule Sets. description: '' operationId: getOutboundRulesets produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/RuleSetEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:ruleSet:view x-purecloud-method-name: getOutboundRulesets post: tags: - Outbound summary: Create a Rule Set. description: '' operationId: postOutboundRulesets produces: - application/json parameters: - in: body name: body description: RuleSet required: true schema: $ref: '#/definitions/RuleSet' responses: '200': description: successful operation schema: $ref: '#/definitions/RuleSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.rule.action: '' name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.create: '' invalid.rule.condition: '' invalid.property: Value [%s] is not a valid property for object [%s] data.action.not.found: The requested data action could not be found constraint.validation: '%s' max.entity.count.reached: The maximum rule set count has been reached. rule.conflict: Duplicated Rule IDs and/or names. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.rule.condition.category: The condition is not valid for the given category. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.rule.action.category: The action is not valid for the given category. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:ruleSet:add x-purecloud-method-name: postOutboundRulesets /api/v2/outbound/sequences/{sequenceId}: get: tags: - Outbound summary: Get a dialer campaign sequence. description: '' operationId: getOutboundSequence produces: - application/json parameters: - name: sequenceId in: path description: Campaign Sequence ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSequence' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaignSequence:view x-purecloud-method-name: getOutboundSequence put: tags: - Outbound summary: Update a new campaign sequence. description: '' operationId: putOutboundSequence produces: - application/json parameters: - name: sequenceId in: path description: Campaign Sequence ID required: true type: string - in: body name: body description: Organization required: true schema: $ref: '#/definitions/CampaignSequence' responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSequence' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. campaign.sequence.cannot.change.both.status.and.campaigns: '' name.length.exceeded: The name length exceeds the limit of 64 characters. invalid.interval.time: '' bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name already exists. invalid.create: An attempt was made to create the schedule in an invalid way recurrences.exceeded.limit: The number of recurrences exceeds the limit. invalid.number.of.occurrences: The number of occurrences is a required field for numbered ranges and cannot exceed the limit. campaign.sequence.missing.campaign: The dialer campaign sequence is missing the campaign. recurrence.invalid.alteration.start.time: The alteration start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.end.time: The end time of an interval must not be in the past campaign.sequence.cannot.add.running.campaign.to.on.sequence: '' campaign.sequence.cannot.remove.running.campaign: '' invalid.pattern.type: The pattern type is a required field and must be a valid pattern type. recurrence.invalid.end.time: The end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" constraint.validation: '%s' future.intervals.exceeded.limit: '' invalid.update: An attempt was made to update the schedule in an invalid way invalid.alteration.type: The alteration type is a required field and must be a valid alteration type. campaign.sequence.invalid.current.campaign: Current campaign is invalid recurrence.id.duplicate.found: Duplicate recurrence ID found. 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.update.bad.status.transition: The status transition is invalid and failed to update. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.range.end: The range end date must be a valid future date, greater than the recurrence start date, and in the format "YYYY-MM-DDThh:mm:ss" invalid.timezone: The time zone of a schedule must be a valid timezone string like ‘America/New_York’ invalid.pattern.interval: The interval field is a required field and must be a number between 1 and the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.attributes.supplied: The schedule contains unsupported attributes invalid.days.of.week: The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week. recurrence.alterations.exceeded.limit: The number of alterations within the recurrence has exceeded the limit campaign.sequence.invalid.campaign: At least one campaign is invalid overlapping.interval: Each interval must not overlap with any other interval response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.start.time: The start time of an interval must not be in the past recurrence.invalid.start.time: The start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" campaign.sequence.is.empty: The dialer campaign sequence is empty. invalid.range.type: The range type is a required field and must be a valid range type. recurrence.id.not.allowed: Recurrence ID is not allowed. recurrence.invalid.alteration.end.time: The alteration end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" invalid.associated.resource.type: The associated resource type must be 'sequences' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. campaign.not.found: The campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. invalid.update.wrong.version: '' '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignSequence:edit x-purecloud-method-name: putOutboundSequence delete: tags: - Outbound summary: Delete a dialer campaign sequence. description: '' operationId: deleteOutboundSequence produces: - application/json parameters: - name: sequenceId in: path description: Campaign Sequence 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: campaign.sequence.in.use: The campaign sequence is already in use. bad.request: The request could not be understood by the server due to 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignSequence:delete x-purecloud-method-name: deleteOutboundSequence /api/v2/outbound/schedules/sequences/{sequenceId}: get: tags: - Outbound summary: Get a dialer sequence schedule. description: '' operationId: getOutboundSchedulesSequence produces: - application/json parameters: - name: sequenceId in: path description: Sequence ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/SequenceSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: campaign.sequence.not.found: The campaign sequence 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:view - outbound:campaignSequenceSchedule:view x-purecloud-method-name: getOutboundSchedulesSequence put: tags: - Outbound summary: Update a new sequence schedule. description: '' operationId: putOutboundSchedulesSequence produces: - application/json parameters: - name: sequenceId in: path description: Sequence ID required: true type: string - in: body name: body description: SequenceSchedule required: true schema: $ref: '#/definitions/SequenceSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/SequenceSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.update: '' invalid.interval.time: '' bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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' future.intervals.exceeded.limit: '' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: campaign.sequence.not.found: The campaign sequence 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. invalid.update.wrong.version: The sequence schedule version does not match expected '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:edit - outbound:campaignSequenceSchedule:edit x-purecloud-method-name: putOutboundSchedulesSequence delete: tags: - Outbound summary: Delete a dialer sequence schedule. description: '' operationId: deleteOutboundSchedulesSequence produces: - application/json parameters: - name: sequenceId in: path description: Sequence ID required: true type: string responses: '200': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: campaign.sequence.not.found: The campaign sequence was not found. sequence.not.found: Sequence 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: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:delete - outbound:campaignSequenceSchedule:delete x-purecloud-method-name: deleteOutboundSchedulesSequence /api/v2/outbound/schedules/sequences: get: tags: - Outbound summary: Query for a list of dialer sequence schedules. description: '' operationId: getOutboundSchedulesSequences produces: - application/json parameters: [] responses: '200': description: successful operation schema: type: array items: $ref: '#/definitions/SequenceSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.interval.time: '' bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:schedule:view - outbound:campaignSequenceSchedule:view x-purecloud-method-name: getOutboundSchedulesSequences /api/v2/outbound/sequences: get: tags: - Outbound summary: Query a list of dialer campaign sequences. description: '' operationId: getOutboundSequences produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: allowEmptyResult in: query description: Whether to return an empty page when there are no results for that page required: false type: boolean default: false - name: filterType in: query description: Filter type required: false type: string default: Prefix enum: - Equals - RegEx - Contains - Prefix - LessThan - LessThanEqualTo - GreaterThan - GreaterThanEqualTo - BeginsWith - EndsWith - name: name in: query description: Name required: false type: string - name: sortBy in: query description: Sort by required: false type: string - name: sortOrder in: query description: Sort order required: false type: string default: a enum: - ascending - descending responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSequenceEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaignSequence:view x-purecloud-method-name: getOutboundSequences post: tags: - Outbound summary: Create a new campaign sequence. description: '' operationId: postOutboundSequences produces: - application/json parameters: - in: body name: body description: Organization required: true schema: $ref: '#/definitions/CampaignSequence' responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignSequence' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: name.cannot.be.blank: A name must be provided. name.length.exceeded: The name length exceeds the limit of 64 characters. bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: A campaign sequence with this name already exists. invalid.create: '' campaign.sequence.missing.campaign: The dialer campaign sequence is missing a campaign. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' max.entity.count.reached: The maximum campaign sequence count has been reached. campaign.sequence.invalid.campaign: At least one campaign is invalid campaign.sequence.invalid.current.campaign: Current campaign is invalid response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. campaign.sequence.is.empty: The dialer campaign sequence is empty. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:campaignSequence:add x-purecloud-method-name: postOutboundSequences /api/v2/outbound/wrapupcodemappings: get: tags: - Outbound summary: Get the Dialer wrap up code mapping. description: '' operationId: getOutboundWrapupcodemappings produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/WrapUpCodeMapping' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:wrapUpCodeMapping:view x-purecloud-method-name: getOutboundWrapupcodemappings put: tags: - Outbound summary: Update the Dialer wrap up code mapping. description: '' operationId: putOutboundWrapupcodemappings produces: - application/json parameters: - in: body name: body description: wrapUpCodeMapping required: true schema: $ref: '#/definitions/WrapUpCodeMapping' responses: '200': description: successful operation schema: $ref: '#/definitions/WrapUpCodeMapping' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.update: An attempt was made to update a wrap up code mapping in an invalid way business.categories.mutually.exclusive: Business categories are mutually exclusive business.categories.rpc.required: Business category requires Right_Party_Contact flag bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. invalid.update.wrong.version: Wrap up code mapping version does not match expected '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:wrapUpCodeMapping:edit x-purecloud-method-name: putOutboundWrapupcodemappings /api/v2/outbound/diagnostics/campaigns/{campaignId}/summary: get: tags: - Outbound summary: Get diagnostic summary for a single campaign description: '' operationId: getOutboundDiagnosticsCampaignSummary produces: - application/json parameters: - name: campaignId in: path description: Campaign ID required: true type: string - name: start in: query description: Start datetime (ISO 8601 or Unix epoch) required: true type: string - name: end in: query description: End datetime (ISO 8601 or Unix epoch) required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignDiagnosticSummary' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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.param: Invalid or missing request parameter (e.g. campaignId, start, or end). invalid.property: Value [%s] is not 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: response.size.exceeded: Response size would exceed the allowed limit. Reduce the time interval between start and end. request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.error: An error occurred processing the request. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '422': schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: start.time.before.ttl: Start time must not be earlier than the retention window (now - TTL days). end.time.in.future: End time must not be more than 10 minutes in the future (clock skew tolerance). invalid.interval: 'Invalid interval: start greater than end or start and end are equal.' security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:campaignDiagnostic:view x-purecloud-method-name: getOutboundDiagnosticsCampaignSummary /api/v2/outbound/digitalrulesets/{digitalRuleSetId}: get: tags: - Outbound summary: Get an Outbound Digital Rule Set description: '' operationId: getOutboundDigitalruleset produces: - application/json parameters: - name: digitalRuleSetId in: path description: The Digital Rule Set ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/DigitalRuleSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:digitalRuleSet:view x-purecloud-method-name: getOutboundDigitalruleset put: tags: - Outbound summary: Update an Outbound Digital Rule Set description: '' operationId: putOutboundDigitalruleset produces: - application/json parameters: - name: digitalRuleSetId in: path description: The Digital Rule Set ID required: true type: string - in: body name: body description: Digital Rule Set required: true schema: $ref: '#/definitions/DigitalRuleSet' responses: '200': description: successful operation schema: $ref: '#/definitions/DigitalRuleSet' '409': description: Conflict. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. version.conflict: Unexpected digital rule set version '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.rule.action: One or more rule actions are invalid name.length.exceeded: The name length exceeds the limit of 64 characters missing.rule.actions: Each rule must have at least one action configured too.many.rule.actions: The number of actions in one or more rules exceeds the limit. See details bad.request: The request could not be understood by the server due to malformed syntax. duplicate.name: The name is in use by another digital rule set too.many.set.whats.app.integration.actions: The limit for the number of set whats app integration actions has been exceeded. See details invalid.rule.condition: One or more rule conditions are invalid invalid.rule.category: A category must be provided for each rule rule.name.length.exceeded: The name length of a rule exceeds the limit of 64 characters invalid.rule.name: A name must be provided for each rule constraint.validation: '%s' invalid.update: An attempt was made to update a digital rule set in an invalid way. See details invalid.name: A name must be provided too.many.rule.conditions: The number of conditions in one or more rules exceeds the limit. See details 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. too.many.set.sms.phone.number.actions: The limit for the number of set sms phone number actions per rule set has been exceeded. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] too.many.of.action: One or more actions exceed the limit for that action. See details too.many.data.action.conditions.per.ruleset: The limit for the number of data action conditions per rule set has been exceeded. See details invalid.rule.order: An order must be provided for each rule missing.rule.conditions: At least one condition must be configured on each rule rule.set.invalid.contact.list: The contactListId must be a valid UUID representing a contact list too.many.rules: The number of rules exceeds the limit. See details rule.conflict: A unique id and unique name must be provided for each rule response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.rule.condition.category: One or more rule conditions are invalid for the rule's category invalid.rule.action.category: One or more rule actions are invalid for the rule's category '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:digitalRuleSet:edit x-purecloud-method-name: putOutboundDigitalruleset delete: tags: - Outbound summary: Delete an Outbound Digital Rule Set description: '' operationId: deleteOutboundDigitalruleset produces: - application/json parameters: - name: digitalRuleSetId in: path description: The Digital Rule Set ID required: true type: string responses: '204': description: Digital Rule Set Deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.delete: An attempt was made to delete a digital rule set in an invalid way. See details bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable referential.integrity.error: Could not delete the resource because it is referenced by another entity. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:digitalRuleSet:delete x-purecloud-method-name: deleteOutboundDigitalruleset /api/v2/outbound/digitalrulesets: get: tags: - Outbound summary: Query a list of Outbound Digital Rule Sets description: '' operationId: getOutboundDigitalrulesets produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: sortBy in: query description: The field to sort by required: false type: string default: name enum: - name - name: sortOrder in: query description: The direction to sort required: false type: string default: ascending enum: - ascending - descending - name: name in: query description: Name required: false type: string - name: id in: query description: A list of digital rule set ids to bulk fetch required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/DigitalRuleSetEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:digitalRuleSet:view x-purecloud-method-name: getOutboundDigitalrulesets post: tags: - Outbound summary: Create an Outbound Digital Rule Set description: '' operationId: postOutboundDigitalrulesets produces: - application/json parameters: - in: body name: body description: Digital Rule Set required: true schema: $ref: '#/definitions/DigitalRuleSet' responses: '200': description: successful operation schema: $ref: '#/definitions/DigitalRuleSet' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.rule.action: One or more rule actions are invalid name.length.exceeded: The name length exceeds the limit of 64 characters missing.rule.actions: Each rule must have at least one action configured too.many.rule.actions: The number of actions in one or more rules exceeds the limit. See details bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to update a digital rule set in an invalid way. See details duplicate.name: The name is in use by another digital rule set too.many.set.whats.app.integration.actions: The limit for the number of set whats app integration actions has been exceeded. See details invalid.rule.condition: One or more rule conditions are invalid invalid.rule.category: A category must be provided for each rule rule.name.length.exceeded: The name length of a rule exceeds the limit of 64 characters invalid.rule.name: A name must be provided for each rule constraint.validation: '%s' invalid.name: A name must be provided too.many.rule.conditions: The number of conditions in one or more rules exceeds the limit. See details 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. too.many.set.sms.phone.number.actions: The limit for the number of set sms phone number actions per rule set has been exceeded. See details invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] too.many.of.action: One or more actions exceed the limit for that action. See details too.many.data.action.conditions.per.ruleset: The limit for the number of data action conditions per rule set has been exceeded. See details invalid.rule.order: An order must be provided for each rule missing.rule.conditions: At least one condition must be configured on each rule rule.set.invalid.contact.list: The contactListId must be a valid UUID representing a contact list too.many.rules: The number of rules exceeds the limit. See details rule.conflict: A unique id and unique name must be provided for each rule response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.rule.condition.category: One or more rule conditions are invalid for the rule's category invalid.rule.action.category: One or more rule actions are invalid for the rule's category '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:digitalRuleSet:add x-purecloud-method-name: postOutboundDigitalrulesets /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}: get: tags: - Outbound summary: Get a basic Messaging Campaign information object description: This returns a simplified version of a Messaging Campaign, consisting of id, name, and division. operationId: getOutboundMessagingcampaignsDivisionview produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignDivisionView' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:search - outbound:emailCampaign:search - outbound:whatsAppCampaign:search x-purecloud-method-name: getOutboundMessagingcampaignsDivisionview /api/v2/outbound/messagingcampaigns/divisionviews: get: tags: - Outbound summary: Query a list of basic Messaging Campaign information objects description: This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division. operationId: getOutboundMessagingcampaignsDivisionviews produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: sortOrder in: query description: The direction to sort required: false type: string default: a enum: - ascending - descending - name: name in: query description: Name required: false type: string - name: type in: query description: Campaign Type required: false type: string enum: - EMAIL - SMS - WHATSAPP - name: id in: query description: id required: false type: array items: type: string collectionFormat: multi - name: senderSmsPhoneNumber in: query description: Sender SMS Phone Number required: false type: string - name: contentTemplateId in: query description: Content template ID required: false type: string - name: campaignStatus in: query description: Campaign Status required: false type: string enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignDivisionViewEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:search - outbound:emailCampaign:search - outbound:whatsAppCampaign:search x-purecloud-method-name: getOutboundMessagingcampaignsDivisionviews /api/v2/outbound/messagingcampaigns/{messagingCampaignId}: get: tags: - Outbound summary: Get an Outbound Messaging Campaign description: '' operationId: getOutboundMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaign' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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 resource could not be found. resource.not.found: Specified campaignId was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: getOutboundMessagingcampaign put: tags: - Outbound summary: Update an Outbound Messaging Campaign description: '' operationId: putOutboundMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string - in: body name: body description: MessagingCampaign required: true schema: $ref: '#/definitions/MessagingCampaign' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaign' '409': description: Conflict. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. version.conflict: Unexpected messaging campaign version '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.whatsapp.content.template.responsetype: The response type of the content template must be 'MessagingTemplate' invalid.column.data.type.specification.data.type: Column data type specification data type must match the contact sort column data type email.reply.to.address.domain.not.found: The reply-to address domain could not be found contact.list.not.found: The contact list could not be found invalid.email.reply.to.address.domain: The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud too.many.messages.per.minute.with.data.actions.requested: The total number of messages per minute for this organization and campaign with data actions would be exceeded by turning this campaign on (see documentation) cannot.update.campaign.type: The campaign type cannot be updated to a different type configuration invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.whatsapp.phone.number.button.limit: The limit for WhatsApp phone number buttons has been exceeded. cannot.update.dynamic.contact.queueing.settings: Dynamic queueing cannot be changed once it's set invalid.contact.list: A valid contact list must be provided invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.whatsapp.content.template.contenttype: The content type of the content template must be 'text/plain' invalid.message.column: The message column must be provided, and must be a valid column on the selected contact list invalid.whatsapp.content.template.messaging.template: The messaging template of the content template must contain a WhatsApp configuration. invalid.status.transition: The campaign status transition is invalid too.many.data.action.conditions.per.campaign: The limit for the number of data action conditions per campaign has been exceeded. See details missing.whatsapp.columns.in.contactlist: The contact list for a WhatsApp Campaign must have at least one WhatsApp column configured. invalid.dnc.list: One or more DNC List references are invalid email.content.template.not.authorized: The user does not have authorization to access the content template too.many.whatsapp.columns: The limit for the number of WhatsApp columns has been exceeded. See details. invalid.whatsapp.url.button.limit: The limit for WhatsApp url buttons has been exceeded. email.reply.to.address.route.not.found: The reply-to address route could not be found bad.request: The request could not be understood by the server due to malformed syntax. too.many.set.whats.app.integration.actions: The limit for the number of set whats app integration actions has been exceeded. See details invalid.whatsapp.button.limit: The limit for total WhatsApp buttons has been exceeded. invalid.callable.time.set: The provided callable time set is invalid invalid.email.from.address.friendly.name: The from address friendly name must be a between 1 and 64 characters long constraint.validation: '%s' invalid.email.reply.to.address.route.pattern: The reply-to address route must have a pattern configured too.many.messages.per.minute.per.phone.number.requested: The total number of messages per minute for this organization and phone number would be exceeded by turning this campaign on (see documentation) invalid.phone.column: The phone column must be provided, and must be a valid column on the selected contact list missing.email.content.template.body: The content template must contain exactly one response text of type body whatsapp.integration.not.found: The WhatsApp integration could not be found invalid.email.from.address: The from address must be provided 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. contact.list.filter.mismatch: The contact list on the contact list filter does not match the one on the campaign callable.time.set.not.allowed.for.whatsapp: A callable time set cannot be included on the campaign when it is configured for whatsapp invalid.email.content.template.subject.content.type: The content type of the content template subject must be 'text/plain' another.campaign.starting: There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on contact.sort.duplicate.field.names: Multiple Contact Sorts may not be applied to the same field contact.sort.size.exceeded: A maximum of 4 Contact Sorts may be configured invalid.sms.content.template.responsetype: The response type of the content template must be 'CampaignSmsTemplate' contact.sort.field.not.found: One or more contact sort fields are not valid contact list columns invalid.email.content.template.response.type: The responseType of the content template must be 'CampaignEmailTemplate' invalid.whatsapp.content.template.content: The content of the content template must not be blank. invalid.sms.content.template.contentType: The content type of the content template must be 'text/plain' invalid.property: Value [%s] is not a valid property for object [%s] invalid.email.content.template.subject.content: The content of the content template subject must not be blank whatsapp.invalid.integration.provider.type: The WhatsApp integration must contain a provider type of 'whatsapp' sms.phone.number.in.use: The SMS phone number is in use by another messaging campaign dynamic.queueing.active.campaigns.count.exceeded: The limit for active dynamic queueing campaigns has been exceeded too.many.email.columns: The limit for number of email columns has been exceeded. See details whatsapp.content.template.not.found: The content template could not be found too.many.contact.list.filters: Only one contact list filter is allowed per campaign callable.time.set.conflicts.with.automatic.time.zone.mapping: A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping sms.content.template.mms.phone.number.type.not.supported: The Content template with mms is not supported for the sms phone number type active.campaigns.limit.exceeded: The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one. missing.time.zone.in.contactlist: When using a callable time set, the contact list must have at least one time zone column defined invalid.type.config: Exactly one of [emailConfig, smsConfig] must be provided missing.email.columns.in.contactlist: The contact list must have at least one email column configured when the campaign is configured for email column.data.type.specification.not.found.for.contact.sort: A column data type specification must be defined for contact sort column name.length.exceeded: The name length exceeds the limit of 64 characters active.campaigns.with.data.action.conditions.limit.exceeded: The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details duplicate.name: The name is in use by another messaging campaign invalid.email.reply.to.address.route.domain: The reply-to address route must have a reply route domain configured email.reply.to.address.domain.not.verified: The reply-to address domain must have a verification result of 'VERIFIED' missing.column.data.type.specification.in.contact.list: Column data type specifications must be defined on the campaign's contact list invalid.sender.sms.phone.number: The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number email.reply.to.address.route.not.inbound: The reply-to address route must have one of queueId or workflowId configured invalid.update: An attempt was made to update a messaging campaign in an invalid way. See details invalid.content.template.id.column: contentTemplateIdColumn must be a valid column on the contact list invalid.content.template.texts: The Template texts is a required field and cannot exceed the limit. invalid.response.asset.type: The asset type on the response must be valid for the supported content profile configured on the phone number. invalid.name: A name must be provided missing.email.content.template.subject: The content template must contain exactly one response text of type subject too.many.set.sms.phone.number.actions: The limit for the number of set sms phone number actions has been exceeded. See details contact.list.filter.not.found: The contact list filter could not be found dnc.list.not.found: One or more dnc lists could not be found invalid.rule.set: One or more rule set references are invalid invalid.sms.config.message: Only one of the messaging options should be set - messageColumn or contentTemplateId email.from.address.domain.not.found: The from address domain could not be found whatsapp.content.template.not.authorized: The user does not have authorization to access the content template simultaneous.field.and.status.update: A Messaging Campaign cannot have other fields changed in the same update as a status transition rule.set.not.found: One or more rule sets could not be found content.template.id.column.not.enabled: The contentTemplateIdColumn feature is not yet enabled for this organization invalid.email.content.template.body.content.type: The content type of the content template body must be 'text/plain' or 'text/html invalid.division: A valid division must be provided invalid.whatsapp.columns: The WhatsApp columns must be provided, and all entries must be valid columns on the contact list invalid.whatsapp.rules: Digital Rules are currently not supported for WhatsApp Campaigns invalid.whatsapp.button.substitution.param: The limit for WhatsApp button substitutions has been exceeded. sms.phone.number.not.found: The SMS phone number could not be found response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.dnc.list.contact.method: One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details contact.list.in.use: The contact list is in use by another messaging campaign invalid.sms.content.template.content: The content of the content template is blank invalid.email.content.template.body.content: The content of the content template body must not be blank missing.contact.list.filter: A contact list filter must be provided when dynamic filtering is enabled. rule.set.count.exceeded: The limit for the number of rule sets has been exceeded. See details sms.content.template.mms.not.supported: The Content template with mms is not supported for the sms phone number callable.time.set.not.found: The callable time set could not be found content.template.id.column.conflicts.with.config.column: contentTemplateIdColumn cannot be the same column as a config column invalid.messages.per.minute: Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation) dnc.list.invalid.custom.exclusion.column: The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List invalid.email.content.template.texts: The content template must contain exactly two response texts dynamic.queueing.campaigns.count.exceeded: The limit for dynamic queueing campaigns has been exceeded sms.content.template.not.found: The Content template could not be found invalid.email.reply.to.address.route: The reply-to address route must be provided, and must be a route configured on the reply-to address domain missing.phone.columns.in.contactlist: The contact list must have at least one phone number column configured when the campaign is configured for SMS invalid.email.columns: The email columns must be provided, and all entries must be valid columns on the contact list content.template.id.column.conflicts.with.message.column: contentTemplateIdColumn cannot be configured when messageColumn is set dnc.list.count.exceeded: A maximum of 10 dnc lists may be configured email.content.template.not.found: The content template could not be found invalid.email.from.address.local.part: The from address local part must be provided, and must be between 1 and 64 characters long too.many.messages.per.minute.requested: The total number of messages per minute for this organization and campaign type would be exceeded by turning this campaign on (see documentation) sms.content.template.not.authorized: User doesn't have authorization to access content template invalid.whatsapp.header.substitution.param: The limit for WhatsApp header substitutions has been exceeded. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.email.from.address.domain: The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud contact.list.import.in.progress: The contact list is still importing contacts whatsapp.dynamic.queueing.not.supported: Dynamic Queuing is currently not supported for WhatsApp Campaigns '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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 messaging campaign could not be found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:edit - outbound:emailCampaign:edit - outbound:whatsAppCampaign:edit x-purecloud-method-name: putOutboundMessagingcampaign delete: tags: - Outbound summary: Delete an Outbound Messaging Campaign description: '' operationId: deleteOutboundMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaign' '204': description: Messaging Campaign Deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.delete: An attempt was made to delete a messaging campaign in an invalid way. See details bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable cannot.delete.running.campaign: A messaging campaign in status ON or STOPPING cannot be deleted '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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. resource.not.found: The resource could not be found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:delete - outbound:emailCampaign:delete - outbound:whatsAppCampaign:delete x-purecloud-method-name: deleteOutboundMessagingcampaign /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress: get: tags: - Outbound summary: Get messaging campaign's progress description: '' operationId: getOutboundMessagingcampaignProgress produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CampaignProgress' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: getOutboundMessagingcampaignProgress delete: tags: - Outbound summary: Reset messaging campaign progress and recycle the messaging campaign description: Documented permissions are applicable based on campaign type. operationId: deleteOutboundMessagingcampaignProgress produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '204': description: Accepted - the messaging campaign will be recycled momentarily '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:edit - outbound:messagingCampaign:recycle - outbound:emailCampaign:edit - outbound:emailCampaign:recycle - outbound:whatsAppCampaign:edit - outbound:whatsAppCampaign:recycle x-purecloud-method-name: deleteOutboundMessagingcampaignProgress /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics: get: tags: - Outbound summary: Get messaging campaign diagnostics description: '' operationId: getOutboundMessagingcampaignDiagnostics produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignDiagnostics' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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 resource could not be found. resource.not.found: Specified campaignId was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: getOutboundMessagingcampaignDiagnostics /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start: post: tags: - Outbound summary: Start the campaign description: Documented permissions are applicable based on campaign type. operationId: postOutboundMessagingcampaignStart produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '204': description: OK - The campaign is started '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:start - outbound:emailCampaign:start - outbound:whatsAppCampaign:start x-purecloud-method-name: postOutboundMessagingcampaignStart /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop: post: tags: - Outbound summary: Stop the campaign description: Documented permissions are applicable based on campaign type. operationId: postOutboundMessagingcampaignStop produces: - application/json parameters: - name: messagingCampaignId in: path description: The Messaging Campaign ID required: true type: string responses: '204': description: OK - The campaign is stopped '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: You are not authorized to perform the requested action. app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:stop - outbound:emailCampaign:stop - outbound:whatsAppCampaign:stop x-purecloud-method-name: postOutboundMessagingcampaignStop /api/v2/outbound/messagingcampaigns: get: tags: - Outbound summary: Query a list of Messaging Campaigns description: '' operationId: getOutboundMessagingcampaigns produces: - application/json parameters: - name: pageSize in: query description: Page size. The max that will be returned is 100. required: false type: integer default: 25 format: int32 - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: sortBy in: query description: The field to sort by required: false type: string default: name enum: - campaignStatus - name - type - name: sortOrder in: query description: The direction to sort required: false type: string default: ascending enum: - ascending - descending - name: name in: query description: Name required: false type: string - name: contactListId in: query description: Contact List ID required: false type: string - name: divisionId in: query description: Division ID(s) required: false type: array items: type: string collectionFormat: multi - name: type in: query description: Campaign Type required: false type: string enum: - EMAIL - SMS - WHATSAPP - name: senderSmsPhoneNumber in: query description: Sender SMS Phone Number required: false type: string - name: id in: query description: A list of messaging campaign ids to bulk fetch required: false type: array items: type: string collectionFormat: multi - name: contentTemplateId in: query description: Content template ID required: false type: string - name: campaignStatus in: query description: Campaign Status required: false type: string enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping - name: ruleSetIds in: query description: Ruleset ID(s) required: false type: array items: type: string collectionFormat: multi responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:view - outbound:emailCampaign:view - outbound:whatsAppCampaign:view x-purecloud-method-name: getOutboundMessagingcampaigns post: tags: - Outbound summary: Create a Messaging Campaign description: '' operationId: postOutboundMessagingcampaigns produces: - application/json parameters: - in: body name: body description: Messaging Campaign required: true schema: $ref: '#/definitions/MessagingCampaign' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaign' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.whatsapp.content.template.responsetype: The response type of the content template must be 'MessagingTemplate' invalid.column.data.type.specification.data.type: Column data type specification data type must match the contact sort column data type email.reply.to.address.domain.not.found: The reply-to address domain could not be found contact.list.not.found: The contact list could not be found invalid.email.reply.to.address.domain: The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.sms.content.template.contenttype: The content type of the content template must be 'text/plain' invalid.whatsapp.phone.number.button.limit: The limit for WhatsApp phone number buttons has been exceeded. invalid.contact.list: A valid contact list must be provided invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.whatsapp.content.template.contenttype: The content type of the content template must be 'text/plain' invalid.message.column: The message column must be provided, and must be a valid column on the selected contact list invalid.whatsapp.content.template.messaging.template: The messaging template of the content template must contain a WhatsApp configuration. too.many.data.action.conditions.per.campaign: The limit for the number of data action conditions per campaign has been exceeded. See details missing.whatsapp.columns.in.contactlist: The contact list for a WhatsApp Campaign must have at least one WhatsApp column configured. invalid.dnc.list: One or more DNC List references are invalid max.entity.count.reached: The maximum messaging campaign count has been reached email.from.address.domain.not.verified: The from address domain must have a cname verification result of 'VERIFIED' email.content.template.not.authorized: The user does not have authorization to access the content template too.many.whatsapp.columns: The limit for the number of WhatsApp columns has been exceeded. See details. invalid.whatsapp.url.button.limit: The limit for WhatsApp url buttons has been exceeded. email.reply.to.address.route.not.found: The reply-to address route could not be found bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create an invalid messaging campaign. See details invalid.whatsapp.button.limit: The limit for total WhatsApp buttons has been exceeded. invalid.callable.time.set: The provided callable time set is invalid invalid.email.from.address.friendly.name: The from address friendly name must be a between 1 and 64 characters long constraint.validation: '%s' invalid.email.reply.to.address.route.pattern: The reply-to address route must have a pattern configured invalid.phone.column: The phone column must be provided, and must be a valid column on the selected contact list missing.email.content.template.body: The content template must contain exactly one response text of type body whatsapp.integration.not.found: The WhatsApp integration could not be found invalid.email.from.address: The from address must be provided 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. contact.list.filter.mismatch: The contact list on the contact list filter does not match the one on the campaign callable.time.set.not.allowed.for.whatsapp: A callable time set cannot be included on the campaign when it is configured for whatsapp invalid.email.content.template.subject.content.type: The content type of the content template subject must be 'text/plain' contact.sort.duplicate.field.names: Multiple Contact Sorts may not be applied to the same field contact.sort.size.exceeded: A maximum of 4 Contact Sorts may be configured invalid.sms.content.template.responsetype: The response type of the content template must be 'CampaignSmsTemplate' contact.sort.field.not.found: One or more contact sort fields are not valid contact list columns invalid.email.content.template.response.type: The response type of the content template must be 'CampaignEmailTemplate' invalid.whatsapp.content.template.content: The content of the content template must not be blank. invalid.property: Value [%s] is not a valid property for object [%s] invalid.email.content.template.subject.content: The content of the content template subject must not be blank whatsapp.invalid.integration.provider.type: The WhatsApp integration must contain a provider type of 'whatsapp' dynamic.queueing.active.campaigns.count.exceeded: The limit for active dynamic queueing campaigns has been exceeded too.many.email.columns: The limit for number of email columns has been exceeded. See details whatsapp.content.template.not.found: The content template could not be found too.many.contact.list.filters: Only one contact list filter is allowed per campaign callable.time.set.conflicts.with.automatic.time.zone.mapping: A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping sms.content.template.mms.phone.number.type.not.supported: The Content template with mms is not supported for the sms phone number type missing.time.zone.in.contactlist: When using a callable time set, the contact list must have at least one time zone column defined invalid.type.config: Exactly one of [smsConfig] must be provided missing.email.columns.in.contactlist: The contact list must have at least one email column configured when the campaign is configured for email column.data.type.specification.not.found.for.contact.sort: A column data type specification must be defined for contact sort column name.length.exceeded: The name length exceeds the limit of 64 characters active.campaigns.with.data.action.conditions.limit.exceeded: The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details duplicate.name: The name is in use by another messaging campaign invalid.email.reply.to.address.route.domain: The reply-to address route must have a reply route domain configured email.reply.to.address.domain.not.verified: The reply-to address domain must have a verification result of 'VERIFIED' missing.column.data.type.specification.in.contact.list: Column data type specifications must be defined on the campaign's contact list invalid.sender.sms.phone.number: The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number email.reply.to.address.route.not.inbound: The reply-to address route must have one of queueId or workflowId configured invalid.content.template.id.column: contentTemplateIdColumn must be a valid column on the contact list invalid.content.template.texts: The Template texts is a required field and cannot exceed the limit. invalid.response.asset.type: The asset type on the response must be valid for the supported content profile configured on the phone number. invalid.name: A name must be provided missing.email.content.template.subject: The content template must contain exactly one response text of type subject contact.list.filter.not.found: The contact list filter could not be found dnc.list.not.found: One or more dnc lists could not be found invalid.rule.set: One or more rule set references are invalid invalid.sms.config.message: Only one of the messaging options should be set - messageColumn or contentTemplateId email.from.address.domain.not.found: The from address domain could not be found whatsapp.content.template.not.authorized: The user does not have authorization to access the content template rule.set.not.found: One or more rule sets could not be found content.template.id.column.not.enabled: The contentTemplateIdColumn feature is not yet enabled for this organization invalid.email.content.template.body.content.type: The content type of the content template body must be 'text/plain' or 'text/html' invalid.division: A valid division must be provided invalid.whatsapp.columns: The WhatsApp columns must be provided, and all entries must be valid columns on the contact list invalid.whatsapp.rules: Digital Rules are currently not supported for WhatsApp Campaigns invalid.whatsapp.button.substitution.param: The limit for WhatsApp button substitutions has been exceeded. sms.phone.number.not.found: The SMS phone number could not be found response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.dnc.list.contact.method: One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details invalid.sms.content.template.content: The content of the content template is blank invalid.email.content.template.body.content: The content of the content template body must not be blank rule.set.count.exceeded: The limit for the number of rule sets has been exceeded. See details sms.content.template.mms.not.supported: The Content template with mms is not supported for the sms phone number callable.time.set.not.found: The callable time set could not be found content.template.id.column.conflicts.with.config.column: contentTemplateIdColumn cannot be the same column as a config column invalid.messages.per.minute: Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation) dnc.list.invalid.custom.exclusion.column: The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List invalid.email.content.template.texts: The content template must contain exactly two response texts dynamic.queueing.campaigns.count.exceeded: The limit for dynamic queueing campaigns has been exceeded sms.content.template.not.found: The content template could not be found invalid.email.reply.to.address.route: The reply-to address route must be provided, and must be a route configured on the reply-to address domain missing.phone.columns.in.contactlist: The contact list must have at least one phone number column configured when the campaign is configured for SMS invalid.email.columns: The email columns must be provided, and all entries must be valid columns on the contact list content.template.id.column.conflicts.with.message.column: contentTemplateIdColumn cannot be configured when messageColumn is set dnc.list.count.exceeded: A maximum of 10 dnc lists may be configured email.content.template.not.found: The content template could not be found invalid.email.from.address.local.part: The from address local part must be provided, and must be between 1 and 64 characters long sms.content.template.not.authorized: The user does not have authorization to access the content template invalid.whatsapp.header.substitution.param: The limit for WhatsApp header substitutions has been exceeded. invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.email.from.address.domain: The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud contact.list.import.in.progress: The contact list is still importing contacts whatsapp.dynamic.queueing.not.supported: Dynamic Queuing is currently not supported for WhatsApp Campaigns '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid 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 messaging campaign could not be found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaign:add - outbound:emailCampaign:add - outbound:whatsAppCampaign:add x-purecloud-method-name: postOutboundMessagingcampaigns /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}: get: tags: - Outbound summary: Get an email campaign schedule. description: '' operationId: getOutboundSchedulesEmailcampaign produces: - application/json parameters: - name: emailCampaignId in: path description: Email Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/EmailCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The email campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:emailCampaignSchedule:view - outbound:emailCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesEmailcampaign put: tags: - Outbound summary: Update an email campaign schedule. description: '' operationId: putOutboundSchedulesEmailcampaign produces: - application/json parameters: - name: emailCampaignId in: path description: Email Campaign ID required: true type: string - in: body name: body description: EmailCampaignSchedule required: true schema: $ref: '#/definitions/EmailCampaignSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/EmailCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.interval.time: The end time of each interval must be after its start time bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create the email campaign schedule in an invalid way recurrences.exceeded.limit: The number of recurrences exceeds the limit. invalid.number.of.occurrences: The number of occurrences is a required field for numbered ranges and cannot exceed the limit. recurrence.invalid.alteration.start.time: The alteration start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.end.time: The end time of an interval must not be in the past invalid.pattern.type: The pattern type is a required field and must be a valid pattern type. recurrence.invalid.end.time: The end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" constraint.validation: '%s' future.intervals.exceeded.limit: The number of future intervals on the schedule must not exceed 500 invalid.update: An attempt was made to update the email campaign schedule in an invalid way invalid.alteration.type: The alteration type is a required field and must be a valid alteration type. recurrence.id.duplicate.found: Duplicate recurrence ID found. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.range.end: The range end date must be a valid future date, greater than the recurrence start date, and in the format "YYYY-MM-DDThh:mm:ss" invalid.timezone: The time zone of a schedule must be a valid timezone string like ‘America/New_York’ invalid.pattern.interval: The interval field is a required field and must be a number between 1 and the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.attributes.supplied: The schedule contains unsupported attributes invalid.days.of.week: The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week. recurrence.alterations.exceeded.limit: The number of alterations within the recurrence has exceeded the limit overlapping.interval: Each interval must not overlap with any other interval response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.start.time: The start time of an interval must not be in the past recurrence.invalid.start.time: The start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.range.type: The range type is a required field and must be a valid range type. recurrence.id.not.allowed: Recurrence ID is not allowed. recurrence.invalid.alteration.end.time: The alteration end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" invalid.associated.resource.type: The associated resource type of a schedule must be 'emailcampaigns' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The email campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:emailCampaignSchedule:edit - outbound:emailCampaign:editSchedule x-purecloud-method-name: putOutboundSchedulesEmailcampaign delete: tags: - Outbound summary: Delete an email campaign schedule. description: '' operationId: deleteOutboundSchedulesEmailcampaign produces: - application/json parameters: - name: emailCampaignId in: path description: Email Campaign ID required: true type: string responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The email campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:emailCampaignSchedule:delete - outbound:emailCampaign:deleteSchedule x-purecloud-method-name: deleteOutboundSchedulesEmailcampaign /api/v2/outbound/schedules/emailcampaigns: get: tags: - Outbound summary: Query for a list of email campaign schedules. description: '' operationId: getOutboundSchedulesEmailcampaigns produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/EmailCampaignScheduleEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:emailCampaignSchedule:view - outbound:emailCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesEmailcampaigns /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}: get: tags: - Outbound summary: Get a messaging campaign schedule. description: '' operationId: getOutboundSchedulesMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: Messaging Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaignSchedule:view - outbound:messagingCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesMessagingcampaign put: tags: - Outbound summary: Update a new messaging campaign schedule. description: '' operationId: putOutboundSchedulesMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: Messaging Campaign ID required: true type: string - in: body name: body description: MessagingCampaignSchedule required: true schema: $ref: '#/definitions/MessagingCampaignSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.interval.time: The end time of each interval must be after its start time bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create the messaging campaign schedule in an invalid way recurrences.exceeded.limit: The number of recurrences exceeds the limit. invalid.number.of.occurrences: The number of occurrences is a required field for numbered ranges and cannot exceed the limit. recurrence.invalid.alteration.start.time: The alteration start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.end.time: The end time of an interval must not be in the past invalid.pattern.type: The pattern type is a required field and must be a valid pattern type. recurrence.invalid.end.time: The end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" constraint.validation: '%s' future.intervals.exceeded.limit: The number of future intervals on the schedule must not exceed 500 invalid.update: An attempt was made to update the messaging campaign schedule in an invalid way invalid.alteration.type: The alteration type is a required field and must be a valid alteration type. recurrence.id.duplicate.found: Duplicate recurrence ID found. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.range.end: The range end date must be a valid future date, greater than the recurrence start date, and in the format "YYYY-MM-DDThh:mm:ss" invalid.timezone: The time zone of a schedule must be a valid timezone string like ‘America/New_York’ invalid.pattern.interval: The interval field is a required field and must be a number between 1 and the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.attributes.supplied: The schedule contains unsupported attributes invalid.days.of.week: The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week. recurrence.alterations.exceeded.limit: The number of alterations within the recurrence has exceeded the limit overlapping.interval: Each interval must not overlap with any other interval response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.start.time: The start time of an interval must not be in the past recurrence.invalid.start.time: The start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.range.type: The range type is a required field and must be a valid range type. recurrence.id.not.allowed: Recurrence ID is not allowed. recurrence.invalid.alteration.end.time: The alteration end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" invalid.associated.resource.type: The associated resource type of the schedule must be 'messagingcampaigns' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaignSchedule:edit - outbound:messagingCampaign:editSchedule x-purecloud-method-name: putOutboundSchedulesMessagingcampaign delete: tags: - Outbound summary: Delete a messaging campaign schedule. description: '' operationId: deleteOutboundSchedulesMessagingcampaign produces: - application/json parameters: - name: messagingCampaignId in: path description: Messaging Campaign ID required: true type: string responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaignSchedule:delete - outbound:messagingCampaign:deleteSchedule x-purecloud-method-name: deleteOutboundSchedulesMessagingcampaign /api/v2/outbound/schedules/messagingcampaigns: get: tags: - Outbound summary: Query for a list of messaging campaign schedules. description: '' operationId: getOutboundSchedulesMessagingcampaigns produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/MessagingCampaignScheduleEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:messagingCampaignSchedule:view - outbound:messagingCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesMessagingcampaigns /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}: get: tags: - Outbound summary: Get a WhatsApp campaign schedule. description: '' operationId: getOutboundSchedulesWhatsappcampaign produces: - application/json parameters: - name: whatsAppCampaignId in: path description: WhatsApp Campaign ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:whatsAppCampaignSchedule:view - outbound:whatsAppCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesWhatsappcampaign put: tags: - Outbound summary: Update a WhatsApp campaign schedule. description: '' operationId: putOutboundSchedulesWhatsappcampaign produces: - application/json parameters: - name: whatsAppCampaignId in: path description: WhatsApp Campaign ID required: true type: string - in: body name: body description: WhatsAppCampaignSchedule required: true schema: $ref: '#/definitions/WhatsAppCampaignSchedule' responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppCampaignSchedule' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.interval.time: The end time of each interval must be after its start time bad.request: The request could not be understood by the server due to malformed syntax. invalid.create: An attempt was made to create the messaging campaign schedule in an invalid way recurrences.exceeded.limit: The number of recurrences exceeds the limit. invalid.number.of.occurrences: The number of occurrences is a required field for numbered ranges and cannot exceed the limit. recurrence.invalid.alteration.start.time: The alteration start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.end.time: The end time of an interval must not be in the past invalid.pattern.type: The pattern type is a required field and must be a valid pattern type. recurrence.invalid.end.time: The end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" constraint.validation: '%s' future.intervals.exceeded.limit: The number of future intervals on the schedule must not exceed 500 invalid.update: An attempt was made to update the messaging campaign schedule in an invalid way invalid.alteration.type: The alteration type is a required field and must be a valid alteration type. recurrence.id.duplicate.found: Duplicate recurrence ID found. invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' invalid.range.end: The range end date must be a valid future date, greater than the recurrence start date, and in the format "YYYY-MM-DDThh:mm:ss" invalid.timezone: The time zone of a schedule must be a valid timezone string like ‘America/New_York’ invalid.pattern.interval: The interval field is a required field and must be a number between 1 and the limit. invalid.property: Value [%s] is not a valid property for object [%s] invalid.attributes.supplied: The schedule contains unsupported attributes invalid.days.of.week: The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week. recurrence.alterations.exceeded.limit: The number of alterations within the recurrence has exceeded the limit overlapping.interval: Each interval must not overlap with any other interval response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.start.time: The start time of an interval must not be in the past recurrence.invalid.start.time: The start date must be a valid future date in the format "YYYY-MM-DDThh:mm:ss" invalid.range.type: The range type is a required field and must be a valid range type. recurrence.id.not.allowed: Recurrence ID is not allowed. recurrence.invalid.alteration.end.time: The alteration end date must be a valid future date before the start date, in the format "YYYY-MM-DDThh:mm:ss" invalid.associated.resource.type: The associated resource type of the schedule must be 'whatsappcampaigns' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:whatsAppCampaignSchedule:edit - outbound:whatsAppCampaign:editSchedule x-purecloud-method-name: putOutboundSchedulesWhatsappcampaign delete: tags: - Outbound summary: Delete a WhatsApp campaign schedule. description: '' operationId: deleteOutboundSchedulesWhatsappcampaign produces: - application/json parameters: - name: whatsAppCampaignId in: path description: WhatsApp Campaign ID required: true type: string responses: '204': description: Operation was successful. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. campaign.not.found: The messaging campaign was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - outbound x-inin-requires-permissions: type: ANY permissions: - outbound:whatsAppCampaignSchedule:delete - outbound:whatsAppCampaign:deleteSchedule x-purecloud-method-name: deleteOutboundSchedulesWhatsappcampaign /api/v2/outbound/schedules/whatsappcampaigns: get: tags: - Outbound summary: Query for a list of WhatsApp campaign schedules. description: '' operationId: getOutboundSchedulesWhatsappcampaigns produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/WhatsAppCampaignScheduleEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. 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: - outbound - outbound:readonly x-inin-requires-permissions: type: ANY permissions: - outbound:whatsAppCampaignSchedule:view - outbound:whatsAppCampaign:viewSchedule x-purecloud-method-name: getOutboundSchedulesWhatsappcampaigns definitions: ContactAddressConditionSettings: type: object required: - operator - value properties: operator: type: string description: The operator to use when comparing address values. enum: - Equals - Contains - BeginsWith - EndsWith value: type: string example: +1555, outlook.com description: The value to compare against the contact's address. ContactableStatus: type: object properties: contactable: type: boolean description: Indicates whether or not the entire contact is contactable for the associated media type. columnStatus: type: object description: A map of individual contact method columns to whether the individual column is contactable for the associated media type. additionalProperties: $ref: '#/definitions/ColumnStatus' 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. CampaignRuleActionEntities: type: object properties: campaigns: type: array description: The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. items: $ref: '#/definitions/DomainEntityRef' sequences: type: array description: The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. items: $ref: '#/definitions/DomainEntityRef' emailCampaigns: type: array description: The list of Email campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a Email campaign. items: $ref: '#/definitions/DomainEntityRef' smsCampaigns: type: array description: The list of SMS campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a SMS campaign. items: $ref: '#/definitions/DomainEntityRef' useTriggeringEntity: type: boolean description: If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition. 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). MessagingCampaignScheduleEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessagingCampaignSchedule' 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 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 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' MediaSummary: type: object properties: contactCenter: $ref: '#/definitions/MediaSummaryDetail' enterprise: $ref: '#/definitions/MediaSummaryDetail' CampaignRuleEntities: type: object properties: campaigns: type: array description: The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. items: $ref: '#/definitions/DomainEntityRef' sequences: type: array description: The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. items: $ref: '#/definitions/DomainEntityRef' emailCampaigns: type: array description: The list of Email campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a Email campaign. items: $ref: '#/definitions/DomainEntityRef' smsCampaigns: type: array description: The list of SMS campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a SMS campaign. items: $ref: '#/definitions/DomainEntityRef' ContactListTemplateBulkRetrieveBody: type: object required: - ids properties: ids: type: array description: The IDs of the Contact List Templates to retrieve. items: type: string MarkContactAddressUncontactableActionSettings: type: object DigitalRuleSetEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/DigitalRuleSet' 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 ContactListTemplateEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ContactListTemplate' 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 CampaignSequence: type: object required: - campaigns - currentCampaign - status properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update campaigns: type: array description: The ordered list of Campaigns that this CampaignSequence will run. items: $ref: '#/definitions/DomainEntityRef' currentCampaign: type: integer format: int32 description: A zero-based index indicating which Campaign this CampaignSequence is currently on. readOnly: true status: type: string description: The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'. enum: - 'on' - 'off' - complete stopMessage: type: string description: A message indicating if and why a CampaignSequence has stopped unexpectedly. readOnly: true repeat: type: boolean description: Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false. selfUri: type: string format: uri description: The URI for this object readOnly: true CallableWindow: type: object properties: mapped: description: The time interval to place outbound calls, for contacts that can be mapped to a time zone. $ref: '#/definitions/AtzmTimeSlot' unmapped: description: The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone. $ref: '#/definitions/AtzmTimeSlotWithTimeZone' 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 ContactsExportRequest: type: object properties: contactListFilterId: type: string description: Contact List Filter ID. criteria: description: Criteria to filter the contacts by. $ref: '#/definitions/ContactBulkSearchCriteria' contactIds: type: array description: Contact IDs to be exported. items: type: string SkillCombinationInfo: type: object properties: skillCombination: type: array description: A skill combination in the contact queue items: type: string totalCount: type: integer format: int64 description: Number of total contacts in the contact queue for this skill combination readOnly: true remainingCount: type: integer format: int64 description: Number of remaining contacts in the contact queue for this skill combination 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 ContactListingRequest: type: object required: - pageNumber - pageSize properties: contactListFilterId: type: string description: Contact List Filter ID. criteria: description: Criteria to filter the contacts by. $ref: '#/definitions/ContactBulkSearchCriteria' pageNumber: type: integer format: int32 description: Page number. pageSize: type: integer format: int32 description: Page size. The max that will be returned is 100. contactSorts: type: array description: The order in which to sort contacts. items: $ref: '#/definitions/ContactSort' ContactColumnToDataActionFieldMapping: type: object required: - contactColumnName - dataActionField properties: contactColumnName: type: string description: The name of a contact column whose data will be passed to the data action dataActionField: type: string description: The name of an input field from the data action that the contact column data will be passed to AppendToDncActionSettings: type: object required: - expire properties: expire: type: boolean description: Whether to expire the record appended to the DNC list. expirationDuration: type: string example: P19DT15H13M description: If 'expire' is set to true, how long to keep the record. listType: type: string description: The Dnc List Type to append entries to enum: - Rds - RdsCustom ContactListFilterClause: type: object properties: filterType: type: string description: How to join predicates together. enum: - AND - OR predicates: type: array description: Conditions to filter the contacts by. items: $ref: '#/definitions/ContactListFilterPredicate' RuleSetDiagnostic: type: object properties: ruleSet: description: A campaign rule set readOnly: true $ref: '#/definitions/DomainEntityRef' warnings: type: array description: Diagnostic warnings for the rule set readOnly: true items: type: string enum: - WRAPUP_CODE_NOT_IN_QUEUE - CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST - NO_DNC_LIST_FOR_APPEND - PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW ReplyToEmailAddress: type: object required: - domain - route properties: domain: description: The InboundDomain used for the email address. $ref: '#/definitions/DomainEntityRef' route: description: The InboundRoute used for the email address. $ref: '#/definitions/DomainEntityRef' UploadUrlResponse: type: object properties: url: type: string description: Presigned URL to PUT the file to readOnly: true uploadKey: type: string description: Key that identifies the file in the storage including the file name readOnly: true headers: type: object description: Required headers when uploading a file through PUT request to the URL readOnly: true additionalProperties: type: string MediaSummaryDetail: type: object properties: active: type: integer format: int32 acw: type: integer format: int32 EmailConfig: type: object required: - emailColumns - fromAddress properties: emailColumns: type: array description: The contact list columns specifying the email address(es) of the contact. items: type: string contentTemplate: description: The content template used to formulate the email to send to the contact. $ref: '#/definitions/DomainEntityRef' fromAddress: description: The email address that will be used as the sender of the email. $ref: '#/definitions/FromEmailAddress' replyToAddress: description: The email address from which any reply will be sent. $ref: '#/definitions/ReplyToEmailAddress' CampaignRuleWeekDayOfMonthInterval: type: object required: - max - min properties: min: description: The minimum value of the interval. Required for the "between" operator $ref: '#/definitions/CampaignRuleWeekDayOfMonth' max: description: The maximum value of the interval. Required for the "between" operator $ref: '#/definitions/CampaignRuleWeekDayOfMonth' DncPatchWhatsAppNumbersRequest: type: object properties: action: type: string description: The action to perform enum: - Add - Remove whatsAppNumbers: type: array description: 'The list of whatsApp numbers to Add to / Remove from the DNC list ' items: type: string expirationDateTime: type: string description: Expiration date for DNC whatsApp numbers in yyyy-MM-ddTHH:mmZ format CampaignPerformanceDataContactRate: type: object properties: connectRatio: type: number description: Ratio of connects to attempts 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' DNCListUploadUrlRequest: type: object required: - contentType - id properties: signedUrlTimeoutSeconds: type: integer format: int32 description: The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds contentType: type: string description: The content type of the file to upload. Allows all types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet id: type: string description: Id of your dnc list to upload to phoneColumns: type: string description: The column names from your file from which to upload dnc phone numbers. emailColumns: type: string description: The column names from your file from which to upload dnc emails. customExclusionColumns: type: string description: The column names from your file from which to upload dnc custom exclusion column entries. expirationDateTimeColumn: type: string description: The column name from your file to use as the dnc expiration date time. whatsAppColumns: type: string description: The column names from your file from which to upload dnc whatsapp. DncListCreate: type: object required: - dncSourceType - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the DncList. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update importStatus: description: The status of the import process readOnly: true $ref: '#/definitions/ImportStatus' size: type: integer format: int64 description: The total number of phone numbers in the DncList. readOnly: true dncSourceType: type: string description: The type of the DncList. enum: - rds - rds_custom - dnc.com - gryphon contactMethod: type: string description: The contact method. Required if dncSourceType is rds. enum: - Email - Phone - Any - WhatsApp loginId: type: string description: A dnc.com loginId. Required if the dncSourceType is dnc.com. campaignId: type: string description: A dnc.com campaignId. Optional if the dncSourceType is dnc.com. dncCodes: type: array description: The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. uniqueItems: true items: type: string licenseId: type: string description: A gryphon license number. Required if the dncSourceType is gryphon. division: description: The division this DncList belongs to. $ref: '#/definitions/DomainEntityRef' customExclusionColumn: type: string description: The column to evaluate exclusion against. Required if the dncSourceType is rds_custom. selfUri: type: string format: uri description: The URI for this object readOnly: true CommonCampaignEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CommonCampaign' 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 DncListDivisionViewListing: type: object properties: entities: type: array items: $ref: '#/definitions/DncListDivisionView' 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 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' CampaignDiagnosticCampaignState: type: object properties: state: type: string description: Campaign status enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping dateStart: type: string format: date-time description: 'Start datetime of the state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'End datetime of the state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dialingMode: type: string description: Dialing mode for the campaign state (e.g., "power", "preview", "predictive") enum: - agentless - preview - power - predictive - progressive - external ContactBulkEditRequest: type: object properties: contactListFilterId: type: string description: Contact List Filter ID. criteria: description: Criteria to filter the contacts by. $ref: '#/definitions/ContactBulkSearchCriteria' contactIds: type: array description: Contact IDs to be bulk edited. items: type: string contact: description: Contact object with details of fields used for patching. $ref: '#/definitions/DialerContact' generateDownloadURI: type: boolean description: 'Whether to do backup export as part of Bulk Operation or not. Default: true.' 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. CampaignRuleWeekDayOfMonthParameters: type: object properties: thresholdValue: description: The operand for the "equals", "before" and "after" operators $ref: '#/definitions/CampaignRuleWeekDayOfMonth' interval: description: The operand for the "between" operator $ref: '#/definitions/CampaignRuleWeekDayOfMonthInterval' 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 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). ImportTemplateEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ImportTemplate' 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 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. ContactListEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ContactList' 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 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 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 CampaignTimeSlot: type: object required: - day - startTime - stopTime properties: startTime: type: string example: 08:00:00 description: The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss stopTime: type: string example: 08:00:00 description: The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss day: type: integer format: int32 example: 1 description: 'The day of the interval. Valid values: [1-7], representing Monday through Sunday' 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 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 CampaignProgress: type: object required: - campaign - contactList properties: campaign: description: Identifier of the campaign $ref: '#/definitions/DomainEntityRef' contactList: description: Identifier of the contact list $ref: '#/definitions/DomainEntityRef' numberOfContactsCalled: type: integer format: int64 description: Number of contacts called during the campaign readOnly: true numberOfContactsMessaged: type: integer format: int64 description: Number of contacts messaged during the campaign readOnly: true totalNumberOfContacts: type: integer format: int64 description: Total number of contacts in the campaign readOnly: true percentage: type: integer format: int64 description: Percentage of contacts processed during the campaign readOnly: true numberOfContactsSkipped: type: object description: Number of contacts skipped during the campaign readOnly: true additionalProperties: type: integer format: int32 CampaignSequenceEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CampaignSequence' 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 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' SplittingInformation: type: object properties: criteria: type: string description: The splitting criteria type enum: - Percentage - Quantity - Column - Custom criteriaValue: type: string description: The criteria value for the specified criteria type createRemainderContactList: type: boolean description: Whether to create remainder contact list useWaterfallRule: type: boolean description: Whether to use waterfall rule 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' CampaignRuleAction: type: object required: - actionType - campaignRuleActionEntities properties: id: type: string parameters: description: The parameters for the CampaignRuleAction. Required for certain actionTypes. $ref: '#/definitions/CampaignRuleParameters' actionType: type: string description: The action to take on the campaignRuleActionEntities. enum: - turnOnCampaign - turnOffCampaign - turnOnSequence - turnOffSequence - setCampaignPriority - recycleCampaign - setCampaignDialingMode - setCampaignAbandonRate - setCampaignNumberOfLines - setCampaignWeight - setCampaignMaxCallsPerAgent - setCampaignMessagesPerMinute - changeCampaignQueue - changeCampaignTemplate campaignRuleActionEntities: description: The list of entities that this action will apply to. $ref: '#/definitions/CampaignRuleActionEntities' 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' CallableContactsDiagnostic: type: object properties: attemptLimits: description: Attempt limits for the campaign's contact list readOnly: true $ref: '#/definitions/DomainEntityRef' dncLists: type: array description: Do not call lists for the campaign readOnly: true items: $ref: '#/definitions/DomainEntityRef' callableTimeSet: description: Callable time sets for the campaign readOnly: true $ref: '#/definitions/DomainEntityRef' ruleSets: type: array description: Rule sets for the campaign readOnly: true items: $ref: '#/definitions/DomainEntityRef' ResourceConditionValue: type: object properties: type: type: string enum: - SCALAR - VARIABLE - USER - QUEUE - TEAM value: type: string MessagingCampaign: type: object required: - contactList - messagesPerMinute properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update division: description: The division this entity belongs to. $ref: '#/definitions/DomainEntityRef' campaignStatus: type: string description: The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'. enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping callableTimeSet: description: The callable time set for this messaging campaign. $ref: '#/definitions/DomainEntityRef' contactList: description: The contact list that this messaging campaign will send messages for. $ref: '#/definitions/DomainEntityRef' dncLists: type: array description: The dnc lists to check before sending a message for this messaging campaign. items: $ref: '#/definitions/DomainEntityRef' alwaysRunning: type: boolean description: Whether this messaging campaign is always running contactSorts: type: array description: The order in which to sort contacts for dialing, based on up to four columns. items: $ref: '#/definitions/ContactSort' messagesPerMinute: type: integer format: int32 description: How many messages this messaging campaign will send per minute. ruleSets: type: array description: Rule Sets to be applied while this campaign is sending messages items: $ref: '#/definitions/DomainEntityRef' contactListFilters: type: array description: The contact list filter to check before sending a message for this messaging campaign. items: $ref: '#/definitions/DomainEntityRef' errors: type: array description: A list of current error conditions associated with this messaging campaign. items: $ref: '#/definitions/RestErrorDetail' dynamicContactQueueingSettings: description: Indicates (when true) that the campaign supports dynamic queueing of the contact list at the time of a request for contacts. $ref: '#/definitions/DynamicContactQueueingSettings' emailConfig: description: Configuration for this messaging campaign to send Email messages. $ref: '#/definitions/EmailConfig' smsConfig: description: Configuration for this messaging campaign to send SMS messages. $ref: '#/definitions/SmsConfig' whatsAppConfig: description: Configuration for this messaging campaign to send WhatsApp messages. $ref: '#/definitions/WhatsAppConfig' selfUri: type: string format: uri description: The URI for this object readOnly: true MessagingCampaignDiagnostics: type: object properties: timeZoneRescheduledContactsCount: type: integer format: int32 description: Current number of time zone rescheduled messages on the campaign readOnly: true filteredOutContactsCount: type: integer format: int32 description: Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on. readOnly: true DigitalCondition: type: object properties: inverted: type: boolean description: If true, inverts the result of evaluating this condition. Default is false. contactColumnConditionSettings: description: The settings for a 'contact list column' condition. $ref: '#/definitions/ContactColumnConditionSettings' contactAddressConditionSettings: description: The settings for a 'contact address' condition. $ref: '#/definitions/ContactAddressConditionSettings' contactAddressTypeConditionSettings: description: The settings for a 'contact address type' condition. $ref: '#/definitions/ContactAddressTypeConditionSettings' lastAttemptByColumnConditionSettings: description: The settings for a 'last attempt by column' condition. $ref: '#/definitions/LastAttemptByColumnConditionSettings' lastAttemptOverallConditionSettings: description: The settings for a 'last attempt overall' condition. $ref: '#/definitions/LastAttemptOverallConditionSettings' lastResultByColumnConditionSettings: description: The settings for a 'last result by column' condition. $ref: '#/definitions/LastResultByColumnConditionSettings' lastResultOverallConditionSettings: description: The settings for a 'last result overall' condition. $ref: '#/definitions/LastResultOverallConditionSettings' dataActionConditionSettings: description: The settings for a 'data action' condition. $ref: '#/definitions/DataActionConditionSettings' LastResultOverallConditionSettings: type: object properties: emailWrapupCodes: type: array description: A list of wrapup code identifiers to match for Email. items: type: string smsWrapupCodes: type: array description: A list of wrapup code identifiers to match for SMS. items: type: string whatsAppWrapupCodes: type: array description: A list of wrapup code identifiers to match for WhatsApp. items: type: string 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' 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' CampaignOutboundLinesDistribution: type: object properties: campaign: description: The Campaign for which dialing group distribution information was requested $ref: '#/definitions/AddressableEntityRef' maxOutboundLineCount: type: integer format: int32 description: Maximum outbound calls that can be placed for Campaign's Edge Group or Site maxLineUtilization: type: number description: Maximum ratio of dialer calls to Campaign's Edge Group or Site capacity availableOutboundLines: type: integer format: int32 description: Number of available outbound lines in Campaign's Edge Group or Site reservedLines: type: integer format: int32 description: Number of reserved outbound lines in Campaign's Edge Group or Site campaignsWithReservedLines: type: array description: Information about campaigns with reserving lines in Campaign's Edge Group or Site items: $ref: '#/definitions/CampaignOutboundLinesReservation' campaignsWithDynamicallyAllocatedLines: type: array description: Information about campaigns using dynamic lines allocation in Campaign's Edge Group or Site items: $ref: '#/definitions/CampaignOutboundLinesAllocation' description: Lines distribution information or Campaign's Edge Group or Site AgentOwnedRouting: type: object properties: enableAgentOwnedCallbacks: type: boolean description: Indicates if Agent Owned Callbacks are enabled for the queue maxOwnedCallbackHours: type: integer format: int32 description: The max amount of time a callback can be owned (in hours); Allowable range 1 - 168 hour(s) (inclusive) maxOwnedCallbackDelayHours: type: integer format: int32 description: The max amount of time a callback can be scheduled out into the future (in hours); Allowable range 1 - 720 hour(s) (inclusive) UserConversationSummary: type: object properties: userId: type: string call: $ref: '#/definitions/MediaSummary' callback: $ref: '#/definitions/MediaSummary' email: $ref: '#/definitions/MediaSummary' message: $ref: '#/definitions/MediaSummary' chat: $ref: '#/definitions/MediaSummary' socialExpression: $ref: '#/definitions/MediaSummary' video: $ref: '#/definitions/MediaSummary' Education: type: object properties: school: type: string fieldOfStudy: type: string notes: type: string description: Notes about education has a 2000 character limit dateStart: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' dateEnd: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' DncList: type: object required: - dncSourceType - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the DncList. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update importStatus: description: The status of the import process readOnly: true $ref: '#/definitions/ImportStatus' size: type: integer format: int64 description: The total number of phone numbers in the DncList. readOnly: true dncSourceType: type: string description: The type of the DncList. readOnly: true enum: - rds - rds_custom - dnc.com - gryphon contactMethod: type: string description: The contact method. Required if dncSourceType is rds. enum: - Email - Phone - Any - WhatsApp loginId: type: string description: A dnc.com loginId. Required if the dncSourceType is dnc.com. campaignId: type: string description: A dnc.com campaignId. Optional if the dncSourceType is dnc.com. dncCodes: type: array description: The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. uniqueItems: true items: type: string licenseId: type: string description: A gryphon license number. Required if the dncSourceType is gryphon. division: description: The division this DncList belongs to. $ref: '#/definitions/DomainEntityRef' customExclusionColumn: type: string description: The column to evaluate exclusion against. Required if the dncSourceType is rds_custom. selfUri: type: string format: uri description: The URI for this object readOnly: true 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 CommonCampaign: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Campaign. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' mediaType: type: string description: The media type used for this campaign. enum: - email - sms - voice - whatsapp selfUri: type: string format: uri description: The URI for this object readOnly: true MessagingCampaignDivisionView: 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' selfUri: type: string format: uri description: The URI for this object readOnly: true 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' CampaignEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Campaign' 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 LocationImage: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string 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' WritableDialerContact: type: object required: - contactListId - data properties: id: type: string description: The globally unique identifier for the object. contactListId: type: string description: The identifier of the contact list containing this contact. data: type: object example: '{ ''firstname'': ''name'', ''surname'': ''name2'', ''phone'': ''123456789''}' description: An ordered map of the contact's columns and corresponding values. additionalProperties: type: string latestSmsEvaluations: type: object description: A map of SMS records for the contact phone columns. readOnly: true additionalProperties: $ref: '#/definitions/MessageEvaluation' latestEmailEvaluations: type: object description: A map of email records for the contact email columns. readOnly: true additionalProperties: $ref: '#/definitions/MessageEvaluation' latestWhatsAppEvaluations: type: object description: A map of whatsapp records for the contact whatsapp columns. additionalProperties: $ref: '#/definitions/MessageEvaluation' callable: type: boolean description: Indicates whether or not the contact can be called. phoneNumberStatus: type: object description: A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not. additionalProperties: $ref: '#/definitions/PhoneNumberStatus' contactableStatus: type: object description: A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type. additionalProperties: $ref: '#/definitions/ContactableStatus' dateCreated: type: string format: date-time description: 'Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true DigitalDataActionConditionPredicate: type: object required: - comparisonValue - inverted - outputField - outputFieldMissingResolution - outputOperator properties: outputField: type: string description: The name of an output field from the data action's output to use for this condition outputOperator: type: string description: The operation with which to evaluate this condition enum: - Equals - LessThan - LessThanEquals - GreaterThan - GreaterThanEquals - Contains - BeginsWith - EndsWith - Before - After comparisonValue: type: string description: The value to compare against for this condition inverted: type: boolean description: If true, inverts the result of evaluating this Predicate. Default is false. outputFieldMissingResolution: type: boolean description: The result of this predicate if the requested output field is missing from the data action's result CampaignRuleCampaignRunTimeSettings: type: object properties: includeWaitingTime: type: boolean description: 'When true counts all campaign running time, otherwise only running time that a campaign was not waiting. Default: true' EvaluationSettings: type: object properties: revisionsEnabled: type: boolean description: Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations. disputesEnabled: type: boolean description: Whether disputes are allowed for evaluations. Does not apply for calibration evaluations. disputesAllowedPerEvaluation: type: integer format: int32 description: The maximum number of disputes allowed for an evaluation. disputesAssignees: type: array description: A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation. items: $ref: '#/definitions/EvaluationSettingsAssignee' ConditionalGroupRouting: type: object properties: rules: type: array description: The set of rules to be executed for each conversation items: $ref: '#/definitions/ConditionalGroupRoutingRule' MediaSettings: type: object properties: enableAutoAnswer: type: boolean description: Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings. alertingTimeoutSeconds: type: integer format: int32 description: The alerting timeout for the media type, in seconds serviceLevel: description: The targeted service level for the media type $ref: '#/definitions/ServiceLevel' autoAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for an auto-answer interaction manualAnswerAlertToneSeconds: type: number format: double description: How long to play the alerting tone for a manual-answer interaction DynamicLineBalancingSettingsPatchRequest: type: object properties: enabled: type: boolean description: Indicates that this campaign is subject of dynamic line balancing relativeWeight: type: integer format: int32 description: Relative weight of this campaign in dynamic line balancing 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' AttemptLimits: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update maxAttemptsPerContact: type: integer format: int32 description: The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined. maxAttemptsPerNumber: type: integer format: int32 description: The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined. timeZoneId: type: string description: 'If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' resetPeriod: type: string description: After how long the number of attempts will be set back to 0. Defaults to NEVER. enum: - NEVER - TODAY - DAYS_2 - DAYS_3 - DAYS_4 - DAYS_5 - DAYS_6 - DAYS_7 - DAYS_8 - DAYS_9 - DAYS_10 - DAYS_11 - DAYS_12 - DAYS_13 - DAYS_14 - DAYS_15 - DAYS_16 - DAYS_17 - DAYS_18 - DAYS_19 - DAYS_20 - DAYS_21 - DAYS_22 - DAYS_23 - DAYS_24 - DAYS_25 - DAYS_26 - DAYS_27 - DAYS_28 - DAYS_29 - DAYS_30 recallEntries: type: object description: Configuration for recall attempts. additionalProperties: $ref: '#/definitions/RecallEntry' selfUri: type: string format: uri description: The URI for this object readOnly: true 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. CampaignDiagnostics: type: object properties: callableContacts: description: Campaign properties that can impact which contacts are callable readOnly: true $ref: '#/definitions/CallableContactsDiagnostic' queueUtilizationDiagnostic: description: Information regarding the campaign's queue readOnly: true $ref: '#/definitions/QueueUtilizationDiagnostic' ruleSetDiagnostics: type: array description: Information regarding the campaign's rule sets readOnly: true items: $ref: '#/definitions/RuleSetDiagnostic' outstandingInteractionsCount: type: integer format: int32 description: Current number of outstanding interactions on the campaign readOnly: true scheduledInteractionsCount: type: integer format: int32 description: Current number of scheduled interactions on the campaign readOnly: true timeZoneRescheduledCallsCount: type: integer format: int32 description: Current number of time zone rescheduled calls on the campaign readOnly: true filteredOutContactsCount: type: integer format: int32 description: Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on. readOnly: true idleAgents: type: integer format: int32 description: Information regarding the campaign's available agents. readOnly: true effectiveIdleAgents: type: number format: double description: Information regarding the campaign's effective available agents. readOnly: true linesUtilization: description: Information on the campaign's lines utilization. readOnly: true $ref: '#/definitions/CampaignLinesUtilization' numberOfContactsCalled: type: integer format: int64 description: Number of contacts called during the campaign. readOnly: true totalNumberOfContacts: type: integer format: int64 description: Total number of contacts in the campaign. readOnly: true campaignErrors: type: array description: A list of current error conditions associated with the campaign. readOnly: true items: $ref: '#/definitions/RestErrorDetail' campaignSkillStatistics: description: Information regarding the campaign's skills readOnly: true $ref: '#/definitions/CampaignSkillStatistics' CampaignRuleCondition: type: object required: - conditionType - parameters properties: id: type: string parameters: description: The parameters for the CampaignRuleCondition. $ref: '#/definitions/CampaignRuleParameters' conditionType: type: string description: The type of condition to evaluate. enum: - campaignProgress - campaignAgents - campaignRecordsAttempted - campaignContactsMessaged - campaignBusinessSuccess - campaignBusinessFailure - campaignBusinessNeutral - campaignValidAttempts - campaignRightPartyContacts - timeOfDay - dayOfWeek - dayOfMonth - weekDayOfMonth - specificDate - campaignRunTime - campaignWaitTime dateTimeParameters: description: Parameters for conditions (timeOfDay, dayOfWeek, dayOfMonth, weekDayOfMonth and specificDate) $ref: '#/definitions/CampaignRuleDateTimeConditionParameters' campaignRunTimeSettings: description: Settings for campaignRunTime conditions $ref: '#/definitions/CampaignRuleCampaignRunTimeSettings' campaignWaitTimeSettings: description: Settings for campaignWaitTime conditions $ref: '#/definitions/CampaignRuleCampaignWaitTimeSettings' AgentOwnedMappingPreviewListing: type: object properties: entities: type: array items: $ref: '#/definitions/AgentOwnedMappingPreview' 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 CampaignPerformanceData: type: object required: - campaign properties: campaign: description: Identifier of the campaign $ref: '#/definitions/DomainEntityRef' division: description: The division the campaign belongs to $ref: '#/definitions/AddressableEntityRef' contactRate: description: Information regarding the campaign's connect rate $ref: '#/definitions/CampaignPerformanceDataContactRate' idleAgents: type: integer format: int32 description: Number of available agents not currently being utilized effectiveIdleAgents: type: number description: Number of effective available agents not currently being utilized adjustedCallsPerAgent: type: number description: Calls per agent adjusted by pace outstandingCalls: type: integer format: int32 description: Number of campaign calls currently ongoing scheduledCalls: type: integer format: int32 description: Number of campaign calls currently scheduled rightPartyContactsCount: type: integer format: int32 description: Information on the campaign's number of Right Party Contacts campaignStatus: type: string description: The status of the campaign enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping dialingMode: type: string description: The strategy this Campaign will use for dialing enum: - agentless - preview - power - predictive - progressive - external progress: description: Information on the campaign's progress $ref: '#/definitions/CampaignPerformanceDataProgress' linesUtilization: description: Information on the campaign's lines utilization $ref: '#/definitions/CampaignLinesUtilization' businessCategoryMetrics: description: Information on the campaign's business category metrics $ref: '#/definitions/CampaignBusinessCategoryMetrics' CampaignDiagnosticSummary: type: object properties: campaignId: type: string description: Campaign ID dateStart: type: string format: date-time description: 'Start of the interval. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'End of the interval. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' campaignStates: type: array description: Array of campaign states items: $ref: '#/definitions/CampaignDiagnosticCampaignState' campaignInfo: type: array description: Array of diagnostic windows items: $ref: '#/definitions/CampaignDiagnosticWindow' campaignHealthStates: type: array description: Array of campaign health states items: $ref: '#/definitions/CampaignDiagnosticCampaignHealthState' configChanges: type: array description: Configuration changes occurring within the time window items: $ref: '#/definitions/CampaignDiagnosticConfigChange' UpdateContactColumnActionSettings: type: object required: - properties - updateOption properties: properties: type: object example: '{"phoneNumber":"+11234567890"}, {"lastContactedTime":""' description: A mapping of contact columns to their new values. additionalProperties: type: string updateOption: type: string description: The type of update to make to the specified contact column(s). enum: - Set - Increment - Decrement - CurrentTime 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 DiagnosticsSettings: type: object properties: reportLowMaxCallsPerAgentAlert: type: boolean description: Whether to report on low max calls per agent alerts. Agent: type: object properties: stage: type: string description: The current stage for this agent 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 CampaignLinesUtilization: type: object properties: assignedOutboundLines: type: integer format: int32 description: Number of outbound lines assigned to the campaign totalAvailableOutboundLines: type: integer format: int32 description: Total number of available outbound lines in Campaign's Edge Group or Site CampaignDivisionView: 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' selfUri: type: string format: uri description: The URI for this object readOnly: true SetWhatsAppIntegrationActionSettings: type: object required: - whatsAppIntegrationId properties: whatsAppIntegrationId: type: string description: The ID of the WhatsApp integration. FileSpecificationTemplate: type: object required: - format - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the File Specification template. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update description: type: string description: Description of the file specification template format: type: string description: File format enum: - FixedLength - Delimited numberOfHeadingLinesSkipped: type: integer format: int32 description: Number of heading lines to be skipped numberOfTrailingLinesSkipped: type: integer format: int32 description: Number of trailing lines to be skipped header: type: boolean description: If true indicates that delimited file has a header row, which can provide column names delimiter: type: string description: Kind of delimiter enum: - Comma - Pipe - Colon - Tab - Semicolon - Custom delimiterValue: type: string description: Delimiter character, used only when delimiter="Custom" columnInformation: type: array description: Columns specification items: $ref: '#/definitions/Column' preprocessingRules: type: array description: Preprocessing rules items: $ref: '#/definitions/PreprocessingRule' selfUri: type: string format: uri description: The URI for this object readOnly: true QuestionSettings: type: object properties: questionContextId: type: string description: The context id of the question in the group settings: $ref: '#/definitions/AiScoringSetting' LastAttemptOverallConditionSettings: type: object required: - mediaTypes - operator - value properties: mediaTypes: type: array description: A list of media types to evaluate. items: type: string enum: - Voice - Email - Sms - WhatsApp operator: type: string description: The operator to use when comparing values. enum: - Before - After value: type: string example: P1DT1H1M description: The period value to compare against the contact's data. 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 CampaignRuleDayOfMonthInterval: type: object properties: min: type: string description: 'The minimal day of month (exact day: 1-31) for the "between" operator' max: type: string description: 'The maximum value of month (exact day: 1-31 or "LAST_DAY") for the "between" operator' 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.' MessagingCampaignEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessagingCampaign' 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 ContactListDivisionView: type: object required: - columnNames 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' columnNames: type: array description: The names of the contact data columns. items: type: string phoneColumns: type: array description: Indicates which columns are phone numbers. items: $ref: '#/definitions/ContactPhoneNumberColumn' emailColumns: type: array description: Indicates which columns are email addresses. items: $ref: '#/definitions/EmailColumn' whatsAppColumns: type: array description: Indicates which columns are whatsApp contacts. items: $ref: '#/definitions/WhatsAppColumn' importStatus: description: The status of the import process. readOnly: true $ref: '#/definitions/ImportStatus' size: type: integer format: int64 description: The number of contacts in the ContactList. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true 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. CampaignRuleEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CampaignRule' 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 LastResultByColumnConditionSettings: type: object properties: emailColumnName: type: string description: The name of the contact column to evaluate for Email. emailWrapupCodes: type: array description: A list of wrapup code identifiers to match for Email. items: type: string smsColumnName: type: string description: The name of the contact column to evaluate for SMS. smsWrapupCodes: type: array description: A list of wrapup code identifiers to match for SMS. items: type: string whatsAppColumnName: type: string description: The name of the contact column to evaluate for WhatsApp. whatsAppWrapupCodes: type: array description: A list of wrapup code identifiers to match for WhatsApp. items: type: string ImportStatus: type: object required: - completedRecords - percentComplete - state - totalRecords properties: state: type: string description: current status of the import readOnly: true enum: - IN_PROGRESS - FAILED totalRecords: type: integer format: int64 description: total number of records to be imported readOnly: true completedRecords: type: integer format: int64 description: number of records finished importing readOnly: true percentComplete: type: integer format: int32 description: percentage of records finished importing readOnly: true failureReason: type: string description: if the import has failed, the reason for the failure readOnly: true targetContactListIds: type: array description: The contact list Ids for target contact lists. readOnly: true items: type: string listNamePrefix: type: string description: The prefix for the contact list name readOnly: true 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 ContactBulkSearchParameters: type: object properties: contactListFilterId: type: string description: Contact List Filter ID. Either this property or criteria is required. criteria: description: Criteria to filter the contacts by. Either this property or contactListFilterId is required. $ref: '#/definitions/ContactBulkSearchCriteria' generateDownloadURI: type: boolean description: 'Whether to do backup export as part of Bulk Operation or not. Default: true.' RestErrorDetail: type: object required: - error properties: error: type: string description: name of the error readOnly: true details: type: string description: additional information regarding the error readOnly: true userParams: type: array description: parameters to be inserted into details. items: $ref: '#/definitions/UserParam' 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 CampaignRuleDateTimeConditionParameters: type: object properties: inverted: type: boolean description: If true, inverts the result of evaluating this sub-condition. Default is false timeOfDay: description: Parameters for "timeOfDay" conditionType $ref: '#/definitions/CampaignRuleTimeOfDayParameters' dayOfWeek: description: Parameters for "dayOfWeek" conditionType $ref: '#/definitions/CampaignRuleDayOfWeekParameters' dayOfMonth: description: Parameters for "dayOfMonth" conditionType $ref: '#/definitions/CampaignRuleDayOfMonthParameters' specificDate: description: Parameters for "specificDate" conditionType $ref: '#/definitions/CampaignRuleSpecificDateParameters' weekDayOfMonth: description: Parameters for "weekDayOfMonth" conditionType $ref: '#/definitions/CampaignRuleWeekDayOfMonthParameters' TopicDuration: type: object properties: totalMilliseconds: type: integer format: int64 description: The total duration of the topic phrase within the conversation readOnly: true CampaignRuleParameters: type: object properties: operator: type: string description: The operator for comparison. Required for a CampaignRuleCondition. enum: - equals - greaterThan - greaterThanEqualTo - lessThan - lessThanEqualTo - before - after - between - in value: type: string description: The value for comparison. Required for a CampaignRuleCondition. priority: type: string description: The priority to set a campaign to. Required for the 'setCampaignPriority' action. enum: - '1' - '2' - '3' - '4' - '5' dialingMode: type: string description: The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action. enum: - agentless - preview - power - predictive - progressive - external abandonRate: type: number description: The abandon rate to set a campaign to. Required for the 'setCampaignAbandonRate' action. outboundLineCount: type: integer format: int32 description: The number of outbound lines to set a campaign to. Required for the 'setCampaignNumberOfLines' action. relativeWeight: type: integer format: int32 description: The relative weight to set a campaign to. Required for the 'setCampaignWeight' action. maxCallsPerAgent: type: number description: The maximum number of calls per agent to set a campaign to. Required for the 'setCampaignMaxCallsPerAgent' action. queue: description: The queue a campaign to. Required for the 'changeCampaignQueue' action. $ref: '#/definitions/DomainEntityRef' messagesPerMinute: type: integer format: int32 description: The number of messages per minute to set a messaging campaign to. smsMessagesPerMinute: type: integer format: int32 description: The number of messages per minute to set a SMS messaging campaign to. emailMessagesPerMinute: type: integer format: int32 description: The number of messages per minute to set a Email messaging campaign to. smsContentTemplate: description: The content template to set a SMS campaign to. $ref: '#/definitions/DomainEntityRef' emailContentTemplate: description: The content template to set a Email campaign to. $ref: '#/definitions/DomainEntityRef' forDuration: description: ISO-8601 Duration for which condition expression must be continuously true before condition is evaluated as true $ref: '#/definitions/Duration' MessageEvaluation: type: object properties: contactColumn: type: string description: The name of the contact column that was wrapped up contactAddress: type: string description: The address (phone or email) that was wrapped up messageType: type: string description: The type of message sent enum: - Sms - Email - WhatsApp wrapupCodeId: type: string description: The id of the wrap-up code timestamp: type: string format: date-time description: 'The time that the wrap-up was applied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' 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' SmsConfig: type: object required: - messageColumn - phoneColumn - senderSmsPhoneNumber properties: messageColumn: type: string description: The Contact List column specifying the message to send to the contact. phoneColumn: type: string description: The Contact List column specifying the phone number to send a message to. senderSmsPhoneNumber: description: A reference to the SMS Phone Number that will be used as the sender of a message. $ref: '#/definitions/SmsPhoneNumberRef' contentTemplate: description: The content template used to formulate the message to send to the contact. $ref: '#/definitions/DomainEntityRef' CampaignPerformanceDataListing: type: object properties: entities: type: array items: $ref: '#/definitions/CampaignPerformanceData' RuleSet: type: object required: - name - rules properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the RuleSet. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactList: description: A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions. $ref: '#/definitions/DomainEntityRef' queue: description: A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions. $ref: '#/definitions/DomainEntityRef' rules: type: array description: The list of rules. items: $ref: '#/definitions/DialerRule' selfUri: type: string format: uri description: The URI for this object readOnly: true 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' EmailAddress: type: object properties: email: type: string name: type: string 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 ConnectRate: type: object properties: attempts: type: integer format: int64 description: Number of call attempts made readOnly: true connects: type: integer format: int64 description: Number of calls with a live voice detected readOnly: true connectRatio: type: number format: double description: Ratio of connects to attempts readOnly: true 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' ContactListFilterPredicate: type: object properties: column: type: string description: Contact list column from the ContactListFilter's contactList. columnType: type: string description: The type of data in the contact column. enum: - numeric - alphabetic operator: type: string description: The operator for this ContactListFilterPredicate. enum: - EQUALS - LESS_THAN - LESS_THAN_EQUALS - GREATER_THAN - GREATER_THAN_EQUALS - CONTAINS - BEGINS_WITH - ENDS_WITH - BEFORE - AFTER - BETWEEN - IN value: type: string description: Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes). range: description: A range of values. Required for operators BETWEEN and IN. $ref: '#/definitions/ContactListFilterRange' inverted: type: boolean description: Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false). DomainRole: type: object properties: id: type: string description: The ID of the role name: type: string description: The name of the role 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 CampaignRuleDayOfMonthParameters: type: object properties: thresholdValue: type: string description: The operand for the "before" and "after" operators, can be either exact day (1-31) or "LAST_DAY" inSet: type: array description: The operand for the "in" operator, each element can be either exact day (1,31) or "LAST_DAY", "EVEN_DAY", "ODD_DAY" items: type: string interval: description: The interval operand for the "between" operator $ref: '#/definitions/CampaignRuleDayOfMonthInterval' Duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean nano: type: integer format: int32 negative: type: boolean units: type: array items: $ref: '#/definitions/TemporalUnit' Range: type: object required: - type properties: type: type: string description: 'Range type (NoEnd: without an end date. EndDate: with an end date. Numbered: with a specific number of occurrences)' enum: - NoEnd - EndDate - Numbered end: type: string example: '2023-12-21T16:30:25' description: The end date time of the last occurrence of the range as an ISO-8601 string. Required for EndDate range type. numberOfOccurrences: type: integer format: int32 description: 'The number of times the schedule will be repeated, e.g: 2. Required to set for Numbered range type.' TimeZoneMappingPreview: type: object properties: contactList: description: The associated ContactList $ref: '#/definitions/DomainEntityRef' contactsPerTimeZone: type: object description: The number of contacts per time zone that mapped to only that time zone additionalProperties: type: integer format: int64 contactsMappedUsingZipCode: type: object description: The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column additionalProperties: type: integer format: int64 contactsMappedToASingleZone: type: integer format: int64 description: The total number of contacts that mapped to a single time zone contactsMappedToASingleZoneUsingZipCode: type: integer format: int64 description: The total number of contacts that mapped to a single time zone and were mapped using the zip code column contactsMappedToMultipleZones: type: integer format: int64 description: The total number of contacts that mapped to multiple time zones contactsMappedToMultipleZonesUsingZipCode: type: integer format: int64 description: The total number of contacts that mapped to multiple time zones and were mapped using the zip code column contactsInDefaultWindow: type: integer format: int64 description: The total number of contacts that will be dialed during the default window contactListSize: type: integer format: int64 description: The total number of contacts in the contact list ContactListTemplate: type: object required: - columnNames properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update columnNames: type: array description: The names of the contact data columns. items: type: string phoneColumns: type: array description: Indicates which columns are phone numbers. items: $ref: '#/definitions/ContactPhoneNumberColumn' emailColumns: type: array description: Indicates which columns are email addresses items: $ref: '#/definitions/EmailColumn' whatsAppColumns: type: array description: Indicates which columns are whatsApp contacts items: $ref: '#/definitions/WhatsAppColumn' previewModeColumnName: type: string description: A column to check if a contact should always be dialed in preview mode. previewModeAcceptedValues: type: array description: The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode. items: type: string attemptLimits: description: AttemptLimits for this ContactListTemplate. $ref: '#/definitions/DomainEntityRef' automaticTimeZoneMapping: type: boolean description: Indicates if automatic time zone mapping is to be used for this ContactListTemplate. zipCodeColumnName: type: string description: The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true. columnDataTypeSpecifications: type: array description: The settings of the columns selected for dynamic queueing items: $ref: '#/definitions/ColumnDataTypeSpecification' trimWhitespace: type: boolean description: Whether to trim white space when importing a ContactListTemplate csv file, default value = true selfUri: type: string format: uri description: The URI for this object readOnly: true CampaignRuleWarningParameters: type: object properties: actionId: type: string description: ID of action conditionId: type: string description: ID of condition actionType: type: string description: Type of action enum: - turnOnCampaign - turnOffCampaign - turnOnSequence - turnOffSequence - setCampaignPriority - recycleCampaign - setCampaignDialingMode - setCampaignAbandonRate - setCampaignNumberOfLines - setCampaignWeight - setCampaignMaxCallsPerAgent - setCampaignMessagesPerMinute - changeCampaignQueue - changeCampaignTemplate conditionType: type: string description: Type of condition enum: - campaignProgress - campaignAgents - campaignRecordsAttempted - campaignContactsMessaged - campaignBusinessSuccess - campaignBusinessFailure - campaignBusinessNeutral - campaignValidAttempts - campaignRightPartyContacts - timeOfDay - dayOfWeek - dayOfMonth - weekDayOfMonth - specificDate - campaignRunTime - campaignWaitTime CallableTime: type: object required: - timeSlots - timeZoneId properties: timeSlots: type: array description: The time intervals for which it is acceptable to place outbound calls. items: $ref: '#/definitions/CampaignTimeSlot' name: type: string description: The name for the callable time. timeZoneId: type: string description: 'The time zone for the time slots; for example, Africa/Abidjan. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' 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., DataActionConditionPredicate: type: object required: - comparisonValue - inverted - outputField - outputFieldMissingResolution - outputOperator properties: outputField: type: string description: The name of an output field from the data action's output to use for this condition outputOperator: type: string description: The operation with which to evaluate this condition enum: - EQUALS - LESS_THAN - LESS_THAN_EQUALS - GREATER_THAN - GREATER_THAN_EQUALS - CONTAINS - BEGINS_WITH - ENDS_WITH - BEFORE - AFTER comparisonValue: type: string description: The value to compare against for this condition inverted: type: boolean description: If true, inverts the result of evaluating this Predicate. Default is false. outputFieldMissingResolution: type: boolean description: The result of this predicate if the requested output field is missing from the data action's result CampaignRuleSpecificDateInterval: type: object properties: min: type: string description: The minimum value of the interval in yyyy-MM-dd format (if includeYear=true) or in MM-dd format (if includeYear=false). Required for the "between" operator max: type: string description: The maximum value of the interval in yyyy-MM-dd format (if includeYear=true) or in MM-dd format (if includeYear=false). Required for the "between" operator PhoneNumberColumn: type: object properties: columnName: type: string type: type: string callableTimeColumnName: type: string DoNotSendActionSettings: type: object 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 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' OutboundSettings: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update maxCallsPerAgent: type: integer format: int32 description: The maximum number of calls that can be placed per agent on any campaign maxCallsPerAgentDecimal: type: number format: double description: The maximum number of calls that can be placed per agent on any campaign with decimal precision maxConfigurableCallsPerAgent: type: integer format: int32 description: The maximum number of calls that can be configured to be placed per agent on any campaign readOnly: true maxLineUtilization: type: number format: double description: The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0] abandonSeconds: type: number format: double description: The number of seconds used to determine if a call is abandoned complianceAbandonRateDenominator: type: string description: The denominator to be used in determining the compliance abandon rate enum: - ALL_CALLS - CALLS_THAT_REACHED_QUEUE automaticTimeZoneMapping: description: The settings for automatic time zone mapping. Note that changing these settings will change them for both voice and messaging campaigns. $ref: '#/definitions/AutomaticTimeZoneMappingSettings' rescheduleTimeZoneSkippedContacts: type: boolean description: Whether or not to reschedule time-zone blocked contacts selfUri: type: string format: uri description: The URI for this object readOnly: true WhatsAppColumn: type: object required: - columnName - type properties: columnName: type: string description: The name of the whatsApp column. type: type: string description: Indicates the type of the whatsApp column. For example, 'work' or 'personal'. contactableTimeColumnName: type: string description: A name of the contactableTimeColumn contactableTimeColumn: type: string description: A column that indicates the timezone to use for a given contact when checking contactable times. FileSpecificationTemplateEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/FileSpecificationTemplate' 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 ConfigurationOverrides: type: object properties: priority: type: boolean description: Indicates whether or not the contact will be placed in front of the queue or at the end of the queue. 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 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 Image: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string QueueUtilizationDiagnostic: type: object properties: queue: description: Identifier of the queue readOnly: true $ref: '#/definitions/DomainEntityRef' usersInQueue: type: integer format: int32 description: The number of users joined to the queue readOnly: true activeUsersInQueue: type: integer format: int32 description: The number of users active on the queue readOnly: true usersOnQueue: type: integer format: int32 description: The number of users with a status of on-queue readOnly: true usersNotUtilized: type: integer format: int32 description: The number of users in the queue currently not engaged readOnly: true usersOnQueueWithStation: type: integer format: int32 description: The number of users in the queue with a station readOnly: true usersOnACampaignCall: type: integer format: int32 description: The number of users currently engaged in a campaign call readOnly: true usersOnDifferentEdgeGroup: type: integer format: int32 description: The number of users whose station is homed to an edge different from the campaign readOnly: true usersOnANonCampaignCall: type: integer format: int32 description: The number of users currently engaged in a communication that is not part of the campaign readOnly: true AutomaticTimeZoneMappingSettings: type: object properties: callableWindows: type: array description: The time intervals to use for automatic time zone mapping. items: $ref: '#/definitions/CallableWindow' supportedCountries: type: array description: The countries that are supported for automatic time zone mapping. items: type: string 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 WhatsAppCampaignScheduleEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/WhatsAppCampaignSchedule' 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 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' DigitalRuleSet: type: object required: - rules properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactList: description: A ContactList to provide suggestions for contact columns on relevant conditions and actions. $ref: '#/definitions/DomainEntityRef' rules: type: array description: The list of rules. items: $ref: '#/definitions/DigitalRule' selfUri: type: string format: uri description: The URI for this object readOnly: true DataActionContactColumnFieldMapping: type: object required: - contactColumnName - dataActionField properties: contactColumnName: type: string description: The name of a contact column whose data will be passed to the data action dataActionField: type: string description: The name of an input field from the data action that the contact column data will be passed to ColumnDataTypeSpecification: type: object properties: columnName: type: string description: The column name of a column selected for dynamic queueing columnDataType: type: string description: The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP) enum: - NUMERIC - TEXT - TIMESTAMP min: type: integer format: int32 description: The minimum length of the numeric column selected for dynamic queueing max: type: integer format: int32 description: The maximum length of the numeric column selected for dynamic queueing maxLength: type: integer format: int32 description: The maximum length of the text column selected for dynamic queueing 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 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. Bullseye: type: object properties: rings: type: array description: The bullseye rings configured for this queue. items: $ref: '#/definitions/Ring' FromEmailAddress: type: object required: - domain properties: domain: description: The OutboundDomain used for the email address. $ref: '#/definitions/DomainEntityRef' friendlyName: type: string description: The friendly name of the email address. localPart: type: string description: The local part of the email address. CampaignDiagnosticCampaignHealthState: type: object properties: state: type: string description: Campaign health state name enum: - healthy - WaitingForAgents - WaitingForContacts - WaitingForLines - WarnThresholdCPS - WarnMaxCPAalarm dateStart: type: string format: date-time description: 'Start datetime of the health state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'End datetime of the health state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' PhoneNumberStatus: type: object properties: callable: type: boolean description: Indicates whether or not a phone number is callable. ContactListFilterBulkRetrieveBody: type: object required: - ids properties: ids: type: array description: The IDs of the Contact List Filters to retrieve. items: type: string DialerEventEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/EventLog' 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 ContactListFilterEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ContactListFilter' 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 SetContentTemplateActionSettings: type: object required: - emailContentTemplateId - smsContentTemplateId - whatsAppContentTemplateId properties: smsContentTemplateId: type: string description: A String containing the SMS contentTemplateId. emailContentTemplateId: type: string description: A String containing the Email contentTemplateId. whatsAppContentTemplateId: type: string description: A string containing the WhatsApp contentTemplateId. ColumnStatus: type: object properties: contactable: type: boolean description: Indicates whether or not an individual contact method column is contactable. ContactAddressTypeConditionSettings: type: object required: - operator - value properties: operator: type: string description: The operator to use when comparing the address types. enum: - Equals - Contains - BeginsWith - EndsWith value: type: string description: The type value to compare against the contact column type. 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' ContactListFilter: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the list. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactList: description: The contact list the filter is based on. Required if sourceType is ContactList $ref: '#/definitions/DomainEntityRef' contactListTemplate: description: The contact list template the filter is based on. Required if sourceType is ContactListTemplate $ref: '#/definitions/DomainEntityRef' sourceType: type: string description: The source type the filter is based on. enum: - ContactList - ContactListTemplate clauses: type: array description: Groups of conditions to filter the contacts by. items: $ref: '#/definitions/ContactListFilterClause' filterType: type: string description: How to join clauses together. enum: - AND - OR selfUri: type: string format: uri description: The URI for this object readOnly: true LastAttemptByColumnConditionSettings: type: object required: - operator - value properties: emailColumnName: type: string description: The name of the contact column to evaluate for Email. smsColumnName: type: string description: The name of the contact column to evaluate for SMS. whatsAppColumnName: type: string description: The name of the contact column to evaluate for WhatsApp. operator: type: string description: The operator to use when comparing values. enum: - Before - After value: type: string example: P1DT1H1M description: The period value to compare against the contact's data. 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 ContactsBulkOperationJob: type: object properties: id: type: string description: The globally unique job identifier. readOnly: true state: type: string description: The job state. readOnly: true enum: - InProgress - Complete - Failed type: type: string description: The job type. readOnly: true enum: - BulkDelete - BulkEdit totalRecords: type: integer format: int64 description: Total records that will be impacted by the bulk operation. readOnly: true completedRecords: type: integer format: int64 description: Amount of records that have been impacted by the bulk operation. readOnly: true percentComplete: type: integer format: int32 description: Percentage of records that have been impacted by the bulk operation. readOnly: true failureReason: description: Information on failure reason. readOnly: true $ref: '#/definitions/ErrorInfo' downloadURI: type: string description: URI to download the original backup contacts. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true DialerAction: type: object required: - actionTypeName - type properties: type: type: string description: The type of this DialerAction. enum: - Action - modifyContactAttribute - dataActionBehavior actionTypeName: type: string description: Additional type specification for this DialerAction. enum: - DO_NOT_DIAL - MODIFY_CONTACT_ATTRIBUTE - SWITCH_TO_PREVIEW - APPEND_NUMBER_TO_DNC_LIST - APPEND_CUSTOM_ENTRY_TO_DNC_LIST - SCHEDULE_CALLBACK - CONTACT_UNCALLABLE - NUMBER_UNCALLABLE - SET_CALLER_ID - SET_SKILLS - DATA_ACTION updateOption: type: string description: Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE. enum: - SET - INCREMENT - DECREMENT - CURRENT_TIME properties: type: object description: 'A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key ''callbackOffset'' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: ''callerAddress'', which should be the caller id phone number, and ''callerName''. For either key, you can also specify a column on the contact to get the value from. To do this, specify ''contact.Column'', where ''Column'' is the name of the contact column from which to get the value. SET_SKILLS takes a key ''skills'' with an array of skill ids wrapped into a string (Example: {''skills'': ''[''skillIdHere'']''} ).' additionalProperties: type: string dataAction: description: The Data Action to use for this action. Required for a dataActionBehavior. $ref: '#/definitions/DomainEntityRef' contactColumnToDataActionFieldMappings: type: array description: A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionBehavior. items: $ref: '#/definitions/ContactColumnToDataActionFieldMapping' contactIdField: type: string description: The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionBehavior. callAnalysisResultField: type: string description: The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionBehavior. agentWrapupField: type: string description: The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionBehavior. 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 CampaignStats: type: object properties: contactRate: description: Information regarding the campaign's connect rate readOnly: true $ref: '#/definitions/ConnectRate' idleAgents: type: integer format: int32 description: Number of available agents not currently being utilized readOnly: true effectiveIdleAgents: type: number format: double description: Number of effective available agents not currently being utilized readOnly: true adjustedCallsPerAgent: type: number format: double description: Calls per agent adjusted by pace readOnly: true outstandingCalls: type: integer format: int32 description: Number of campaign calls currently ongoing readOnly: true scheduledCalls: type: integer format: int32 description: Number of campaign calls currently scheduled readOnly: true timeZoneRescheduledCalls: type: integer format: int32 description: Number of campaign calls currently timezone rescheduled readOnly: true filteredOutContactsCount: type: integer format: int32 description: Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on. readOnly: true rightPartyContactsCount: type: integer format: int32 description: Information on the campaign's number of Right Party Contacts readOnly: true validAttempts: type: integer format: int32 description: Information on the campaign's valid attempts readOnly: true linesUtilization: description: Information on the campaign's lines utilization readOnly: true $ref: '#/definitions/CampaignLinesUtilization' businessCategoryMetrics: description: Information on the campaign's business category metrics readOnly: true $ref: '#/definitions/CampaignBusinessCategoryMetrics' 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 CampaignInteractions: type: object properties: campaign: $ref: '#/definitions/DomainEntityRef' pendingInteractions: type: array items: $ref: '#/definitions/CampaignInteraction' proceedingInteractions: type: array items: $ref: '#/definitions/CampaignInteraction' previewingInteractions: type: array items: $ref: '#/definitions/CampaignInteraction' interactingInteractions: type: array items: $ref: '#/definitions/CampaignInteraction' scheduledInteractions: type: array items: $ref: '#/definitions/CampaignInteraction' 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' CampaignRuleSpecificDateParameters: type: object properties: includeYear: type: boolean description: 'If true, includes year in date comparison for specificDate type. When false, only month and day are compared. Default is true. ' thresholdValue: type: string description: The operand for the "equals", "after" and "before" operators in yyyy-MM-dd (if includeYear=true) or MM-dd (if includeYear=false) format. interval: description: The operand for the "between" operator $ref: '#/definitions/CampaignRuleSpecificDateInterval' CampaignOutboundLinesReservation: type: object properties: campaign: description: The Campaign $ref: '#/definitions/DomainEntityRef' linesReserved: type: integer format: int32 description: The number of lines reserved for the campaign ContactSort: type: object properties: fieldName: type: string direction: type: string description: The direction in which to sort contacts. enum: - ASC - DESC numeric: type: boolean description: Whether or not the column contains numeric data. DigitalRule: type: object required: - actions - category - conditions - name - order properties: id: type: string description: The identifier of the rule. readOnly: true name: type: string description: The name of the rule. order: type: integer format: int32 description: The ranked order of the rule. Rules are processed from lowest number to highest. category: type: string description: The category of the rule. enum: - PreContact - PostContact conditions: type: array description: A list of conditions to evaluate. All of the Conditions must evaluate to true to trigger the actions. items: $ref: '#/definitions/DigitalCondition' actions: type: array description: The list of actions to be taken if all conditions are true. items: $ref: '#/definitions/DigitalAction' 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. PagedSkillCombinationListing: type: object properties: entities: type: array items: $ref: '#/definitions/SkillCombinationInfo' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 pageCount: type: integer format: int32 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 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 ContactListDivisionViewListing: type: object properties: entities: type: array items: $ref: '#/definitions/ContactListDivisionView' 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 CallRecord: type: object properties: lastAttempt: type: string format: date-time description: 'Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true lastResult: type: string description: Result of the last attempt to reach this number readOnly: true Reoccurrence: type: object required: - end - pattern - range - start properties: id: type: string start: type: string example: '2023-11-21T16:30:25' description: The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss end: type: string example: '2023-11-21T16:30:25' description: The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss timeZone: type: string description: 'The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence''s time zone if specified, then the schedule''s time zone if set, and finally defaulting to UTC if neither defines a time zone. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' pattern: description: 'The schedule pattern e.g.: Daily/Weekly' $ref: '#/definitions/Pattern' range: description: 'The schedule range e.g.: EndDate/NoEnd/Numbered' $ref: '#/definitions/Range' alterations: type: array description: Modifications to the original recurrence schedule (Exclusions/Inclusions) items: $ref: '#/definitions/Alteration' nextOccurrenceDetails: description: The next occurrence details for the next start and end occurrences for the recurrence readOnly: true $ref: '#/definitions/NextOccurrenceDetails' ScheduleInterval: type: object required: - end - start properties: start: type: string description: The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ end: type: string description: The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ ContactsBulkOperationJobListing: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/ContactsBulkOperationJob' selfUri: type: string format: uri EmailCampaignScheduleEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/EmailCampaignSchedule' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 Page: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string versionId: type: string createdDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' rootContainer: type: object additionalProperties: type: object properties: type: object additionalProperties: type: object selfUri: type: string format: uri description: The URI for this object readOnly: true MarkContactUncontactableActionSettings: type: object required: - mediaTypes properties: mediaTypes: type: array description: A list of media types to evaluate. items: type: string enum: - Voice - Email - Sms - WhatsApp Reaction: type: object required: - reactionType properties: data: type: string description: Parameter for this reaction. For transfer_flow, this would be the outbound flow id. name: type: string description: Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name. reactionType: type: string description: The reaction to take for a given call analysis result. enum: - hangup - transfer - transfer_flow - play_file CampaignSkillStatistics: type: object properties: skillCombinations: type: integer format: int32 description: Number of available skill combinations for the campaign readOnly: true eligibleSkilledAgents: type: integer format: int32 description: Number of eligible agents with skills for campaign readOnly: true 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' 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' ContactColumnTimeZone: type: object properties: timeZone: type: string description: 'Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' columnType: type: string description: Column Type will be either PHONE or ZIP readOnly: true enum: - PHONE - ZIP DomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri Column: type: object properties: columnName: type: string description: Column name. Mandatory for Fixed position/length file format. columnNumber: type: integer format: int32 description: 0 based column number in delimited file format startPosition: type: integer format: int32 description: Zero-based position of the first column's character. Mandatory for Fixed position/length file format. length: type: integer format: int32 description: Column width. Mandatory for Fixed position/length file format. DynamicLineBalancingSettings: type: object properties: enabled: type: boolean description: Indicates that this campaign is subject of dynamic line balancing relativeWeight: type: integer format: int32 description: Relative weight of this campaign in dynamic line balancing OccurrenceDetails: type: object properties: dateOfNextOccurrence: type: string format: date-time example: '2023-12-21T16:30:25.00Z' description: The date of the next start or end occurrence for the recurrence as an ISO-8601 string numberOfOccurrences: type: integer format: int32 description: The number of start or end occurrences that have been processed for the recurrence. CampaignRuleTimeOfDayParameters: type: object properties: interval: description: The operand for the "between" operator $ref: '#/definitions/CampaignRuleTimeOfDayInterval' thresholdValue: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' Campaign: type: object required: - callerAddress - callerName - contactList - dialingMode - name - phoneColumns properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Campaign. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactList: description: The ContactList for this Campaign to dial. $ref: '#/definitions/DomainEntityRef' queue: description: The Queue for this Campaign to route calls to. Required for all dialing modes except agentless. $ref: '#/definitions/DomainEntityRef' dialingMode: type: string description: The strategy this Campaign will use for dialing. enum: - agentless - preview - power - predictive - progressive - external script: description: The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless. $ref: '#/definitions/DomainEntityRef' edgeGroup: description: The EdgeGroup that will place the calls. Required for all dialing modes except preview. $ref: '#/definitions/DomainEntityRef' site: description: The identifier of the site to be used for dialing; can be set in place of an edge group. $ref: '#/definitions/DomainEntityRef' campaignStatus: type: string description: The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates. enum: - 'on' - stopping - 'off' - complete - invalid - forced_off - forced_stopping phoneColumns: type: array description: The ContactPhoneNumberColumns on the ContactList that this Campaign should dial. items: $ref: '#/definitions/PhoneColumn' abandonRate: type: number format: double description: The targeted compliance abandon rate percentage. Required for power and predictive campaigns. dncLists: type: array description: DncLists for this Campaign to check before placing a call. items: $ref: '#/definitions/DomainEntityRef' callableTimeSet: description: The callable time set for this campaign to check before placing a call. $ref: '#/definitions/DomainEntityRef' callAnalysisResponseSet: description: The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview. $ref: '#/definitions/DomainEntityRef' errors: type: array description: A list of current error conditions associated with the campaign. readOnly: true items: $ref: '#/definitions/RestErrorDetail' callerName: type: string description: The caller id name to be displayed on the outbound call. callerAddress: type: string example: (555) 555-5555 description: The caller id phone number to be displayed on the outbound call. outboundLineCount: type: integer format: int32 description: The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. ruleSets: type: array description: Rule sets to be applied while this campaign is dialing. items: $ref: '#/definitions/DomainEntityRef' skipPreviewDisabled: type: boolean description: Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. previewTimeOutSeconds: type: integer format: int64 description: The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns. alwaysRunning: type: boolean description: Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually. contactSort: description: The order in which to sort contacts for dialing, based on a column. $ref: '#/definitions/ContactSort' contactSorts: type: array description: The order in which to sort contacts for dialing, based on up to four columns. items: $ref: '#/definitions/ContactSort' noAnswerTimeout: type: integer format: int32 description: How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns. callAnalysisLanguage: type: string description: The language the edge will use to analyze the call. priority: type: integer format: int32 description: The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. contactListFilters: type: array description: Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. items: $ref: '#/definitions/DomainEntityRef' division: description: The division this campaign belongs to. $ref: '#/definitions/DomainEntityRef' agentOwnedColumn: type: string description: Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns. dynamicContactQueueingSettings: description: Settings for dynamic queueing of contacts. $ref: '#/definitions/DynamicContactQueueingSettings' skillColumns: type: array description: The skill columns on the ContactList that this Campaign should take into account when dialing items: type: string previewAutoEnd: type: boolean description: Option to enable preview auto end maxCallsPerAgent: type: integer format: int32 description: The maximum number of calls that can be placed per agent on this campaign maxCallsPerAgentDecimal: type: number format: double description: The maximum number of calls that can be placed per agent on this campaign with decimal precision callbackAutoAnswer: type: boolean description: The option manages the auto-answer callback calls dynamicLineBalancingSettings: description: Dynamic line balancing settings $ref: '#/definitions/DynamicLineBalancingSettings' diagnosticsSettings: description: Campaign diagnostics settings $ref: '#/definitions/DiagnosticsSettings' selfUri: type: string format: uri description: The URI for this object readOnly: true CampaignPatchRequest: type: object properties: outboundLineCount: type: integer format: int32 description: The number of outbound lines to be concurrently dialed. abandonRate: type: number description: The targeted compliance abandon rate percentage maxCallsPerAgent: type: number description: The maximum number of calls that can be placed per agent on this campaign dynamicLineBalancingSettings: description: Dynamic line balancing settings $ref: '#/definitions/DynamicLineBalancingSettingsPatchRequest' queue: description: The Queue for this Campaign to route calls to. $ref: '#/definitions/AddressableEntityRef' description: Campaign patch request DncPatchPhoneNumbersRequest: type: object properties: action: type: string description: The action to perform enum: - Add - Remove phoneNumbers: type: array description: 'The list of phone numbers to Add to / Remove from the DNC list ' items: type: string expirationDateTime: type: string description: Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format SetSmsPhoneNumberActionSettings: type: object required: - senderSmsPhoneNumber properties: senderSmsPhoneNumber: type: string description: The string address for the sms phone number. CallableTimeSetEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CallableTimeSet' 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 Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string CampaignBusinessCategoryMetrics: type: object properties: successCount: type: integer format: int32 description: Number of calls categorized as business success neutralCount: type: integer format: int32 description: Number of calls categorized as business neutral failureCount: type: integer format: int32 description: Number of calls categorized as business failure CampaignDiagnosticWindow: type: object properties: state: type: string description: Name of informational attribute enum: - WarnMaxCPAalarm dateStart: type: string format: date-time description: 'Start datetime of the window. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateEnd: type: string format: date-time description: 'End datetime of the window. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' MessagingCampaignSchedule: type: object required: - intervals - messagingCampaign properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update intervals: type: array description: A list of intervals during which to run the associated Campaign. items: $ref: '#/definitions/ScheduleInterval' recurrences: type: array description: Recurring schedules of the campaign items: $ref: '#/definitions/Reoccurrence' timeZone: type: string description: 'The time zone for this messaging campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' messagingCampaign: description: The Campaign that this messaging campaign schedule is for. $ref: '#/definitions/DivisionedDomainEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true CampaignRuleWeekDayOfMonth: type: object required: - dayOfWeek properties: dayOfWeek: type: integer format: int32 description: Day of week (1-7) month: type: integer format: int32 description: Month (1-12) occurrence: type: integer format: int32 description: Occurrence 1-4, -1 (last) 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' 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' 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. CallBasic: 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' EmailCampaignSchedule: type: object required: - emailCampaign - intervals properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update intervals: type: array description: A list of intervals during which to run the associated Campaign. items: $ref: '#/definitions/ScheduleInterval' recurrences: type: array description: Recurring schedules of the campaign items: $ref: '#/definitions/Reoccurrence' timeZone: type: string description: 'The time zone for this email campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' emailCampaign: description: The Campaign that this email campaign schedule is for. $ref: '#/definitions/DivisionedDomainEntityRef' 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 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]. PhoneColumn: type: object required: - columnName - type properties: columnName: type: string description: The name of the phone column. type: type: string description: The type of the phone column. For example, 'cell' or 'home'. Cobrowsesession: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none initialState: type: string description: The initial connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - scheduled - none id: type: string description: A globally unique identifier for this communication. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transport.failure - error - peer - other - spam - uncallable self: description: Address and name data for a call endpoint. $ref: '#/definitions/Address' cobrowseSessionId: type: string description: The co-browse session ID. cobrowseRole: type: string description: This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). controlling: type: array description: ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). items: type: string viewerUrl: type: string description: The URL that can be used to open co-browse session in web browser. providerEventTime: type: string format: date-time description: 'The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the co-browse session. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. segments: type: array description: The time line of the participant's call, divided into activity segments. items: $ref: '#/definitions/Segment' wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. DivisionedDomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri division: description: The division this entity belongs to. readOnly: true $ref: '#/definitions/DivisionReference' DigitalAction: type: object properties: updateContactColumnActionSettings: description: The settings for an 'update contact column' action. $ref: '#/definitions/UpdateContactColumnActionSettings' doNotSendActionSettings: description: The settings for a 'do not send' action. $ref: '#/definitions/DoNotSendActionSettings' appendToDncActionSettings: description: The settings for an 'Append to DNC' action. $ref: '#/definitions/AppendToDncActionSettings' markContactUncontactableActionSettings: description: The settings for a 'mark contact uncontactable' action. $ref: '#/definitions/MarkContactUncontactableActionSettings' markContactAddressUncontactableActionSettings: description: The settings for an 'mark contact address uncontactable' action. $ref: '#/definitions/MarkContactAddressUncontactableActionSettings' setContentTemplateActionSettings: description: The settings for a 'Set content template' action. $ref: '#/definitions/SetContentTemplateActionSettings' setSmsPhoneNumberActionSettings: description: The settings for a 'set sms phone number' action. $ref: '#/definitions/SetSmsPhoneNumberActionSettings' setWhatsAppIntegrationActionSettings: description: The settings for a 'set WhatsApp integration' action. $ref: '#/definitions/SetWhatsAppIntegrationActionSettings' CampaignInteraction: type: object properties: id: type: string campaign: $ref: '#/definitions/DomainEntityRef' agent: $ref: '#/definitions/DomainEntityRef' contact: $ref: '#/definitions/DomainEntityRef' destinationAddress: type: string activePreviewCall: type: boolean description: Boolean value if there is an active preview call on the interaction lastActivePreviewWrapupTime: type: string format: date-time description: 'The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' creationTime: type: string format: date-time description: 'The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' callPlacedTime: type: string format: date-time description: 'The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' callRoutedTime: type: string format: date-time description: 'The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' previewConnectedTime: type: string format: date-time description: 'The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' queue: $ref: '#/definitions/DomainEntityRef' script: $ref: '#/definitions/DomainEntityRef' disposition: type: string description: 'Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer' enum: - DISCONNECT - LIVE_VOICE - BUSY - MACHINE - NO_ANSWER - SIT_CALLABLE - SIT_UNCALLABLE - FAX callerName: type: string callerAddress: type: string previewPopDeliveredTime: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' conversation: $ref: '#/definitions/ConversationBasic' dialerSystemParticipantId: type: string description: conversation participant id that is the dialer system participant to monitor the call from dialer perspective dialingMode: type: string skills: type: array description: Any skills that are attached to the call for routing uniqueItems: true items: $ref: '#/definitions/DomainEntityRef' SkillsToRemove: type: object properties: name: type: string id: type: string selfUri: type: string format: uri ContactCallbackRequest: type: object required: - campaignId - contactId - contactListId - phoneColumn - schedule properties: campaignId: type: string description: Campaign identifier contactListId: type: string description: Contact list identifier contactId: type: string description: Contact identifier phoneColumn: type: string description: Name of the phone column containing the number to be called schedule: type: string description: 'The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ", example = "2016-01-02T16:59:59"' CallableTimeSet: type: object required: - callableTimes - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the CallableTimeSet. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update callableTimes: type: array description: The list of CallableTimes for which it is acceptable to place outbound calls. items: $ref: '#/definitions/CallableTime' selfUri: type: string format: uri description: The URI for this object readOnly: true DialerContact: type: object required: - contactListId - data properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string contactListId: type: string description: The identifier of the contact list containing this contact. data: type: object example: '{ ''firstname'': ''name'', ''surname'': ''name2'', ''phone'': ''123456789''}' description: An ordered map of the contact's columns and corresponding values. additionalProperties: type: string callRecords: type: object description: A map of call records for the contact phone columns. readOnly: true additionalProperties: $ref: '#/definitions/CallRecord' latestSmsEvaluations: type: object description: A map of SMS records for the contact phone columns. readOnly: true additionalProperties: $ref: '#/definitions/MessageEvaluation' latestEmailEvaluations: type: object description: A map of email records for the contact email columns. readOnly: true additionalProperties: $ref: '#/definitions/MessageEvaluation' latestWhatsAppEvaluations: type: object description: A map of whatsapp records for the contact whatsapp columns. additionalProperties: $ref: '#/definitions/MessageEvaluation' callable: type: boolean description: Indicates whether or not the contact can be called. phoneNumberStatus: type: object description: A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not. additionalProperties: $ref: '#/definitions/PhoneNumberStatus' contactableStatus: type: object description: A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type. additionalProperties: $ref: '#/definitions/ContactableStatus' contactColumnTimeZones: type: object description: 'Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip' readOnly: true additionalProperties: $ref: '#/definitions/ContactColumnTimeZone' configurationOverrides: description: the priority property within ConfigurationOverides indicates whether or not the contact to be placed in front of the queue or at the end of the queue readOnly: true $ref: '#/definitions/ConfigurationOverrides' dateCreated: type: string format: date-time description: 'Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. 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 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 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. CampaignPerformanceDataProgress: type: object properties: percentage: type: number description: Percentage of contacts processed during the campaign CampaignRule: type: object required: - campaignRuleActions - campaignRuleConditions - campaignRuleEntities - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the CampaignRule. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update campaignRuleEntities: description: The list of entities that this CampaignRule monitors. $ref: '#/definitions/CampaignRuleEntities' campaignRuleConditions: type: array description: The list of conditions that are evaluated on the entities. items: $ref: '#/definitions/CampaignRuleCondition' campaignRuleActions: type: array description: The list of actions that are executed if the conditions are satisfied. items: $ref: '#/definitions/CampaignRuleAction' matchAnyConditions: type: boolean enabled: type: boolean description: Whether or not this CampaignRule is currently enabled. Required on updates. campaignRuleProcessing: type: string description: CampaignRule processing algorithm enum: - v2 conditionGroups: type: array description: List of condition groups that are evaluated, used only with campaignRuleProcessing="v2" items: $ref: '#/definitions/CampaignRuleConditionGroup' executionSettings: description: CampaignRule execution settings $ref: '#/definitions/CampaignRuleExecutionSettings' timeZoneId: type: string description: The time zone to use for date-time conditions. warnings: type: array description: A list of current warning conditions associated with the campaign rule. readOnly: true items: $ref: '#/definitions/CampaignRuleWarning' selfUri: type: string format: uri description: The URI for this object readOnly: true 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. 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 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. Division: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ConversationReference: type: object properties: id: type: string selfUri: type: string format: uri ConversationMessageMetadataEvent: type: object properties: eventType: type: string description: Type of this event element enum: - CoBrowse - Typing - Presence - Video - Unknown subType: type: string description: Event subtype enum: - 'On' - Join - Offering - OfferingExpired - OfferingAccepted - OfferingRejected - Disconnect - Clear - SignIn - SessionExpired - Authenticate - AuthenticateFailure - AuthenticateCancel - Unknown description: Metadata information about a message event. SocialExpression: type: object properties: state: type: string description: The connection state of this communication. enum: - alerting - dialing - contacting - offering - connected - disconnected - terminated - none id: type: string description: A globally unique identifier for this communication. socialMediaId: type: string description: A globally unique identifier for the social media. socialMediaHub: type: string description: The social network of the communication socialUserName: type: string description: The user name for the communication. previewText: type: string description: The text preview of the communication contents recordingId: type: string description: A globally unique identifier for the recording associated with this chat. segments: type: array description: The time line of the participant's chat, divided into activity segments. items: $ref: '#/definitions/Segment' held: type: boolean description: True if this call is held and the person on this side hears silence. disconnectType: type: string description: System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. enum: - endpoint - client - system - timeout - transfer - transfer.conference - transfer.consult - transfer.forward - transfer.noanswer - transfer.notavailable - transport.failure - error - peer - other - spam - uncallable startHoldTime: type: string format: date-time description: 'The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' startAlertingTime: type: string format: date-time description: 'The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' connectedTime: type: string format: date-time description: 'The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' disconnectedTime: type: string format: date-time description: 'The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' provider: type: string description: The source provider for the social expression. scriptId: type: string description: The UUID of the script to use. peerId: type: string description: The id of the peer communication corresponding to a matching leg for this communication. wrapup: description: Call wrap up or disposition data. $ref: '#/definitions/Wrapup' afterCallWork: description: After-call work for the communication. $ref: '#/definitions/AfterCallWork' afterCallWorkRequired: type: boolean description: Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. JourneyCustomerSession: type: object required: - id - type properties: id: type: string description: An ID of a Customer/User's session within the Journey System at a point-in-time type: type: string description: The type of the Customer/User's session within the Journey System (e.g. web, app) 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 CommonCampaignDivisionViewEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/CommonCampaignDivisionView' 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 CampaignRuleWarning: type: object required: - code - message properties: code: type: string description: Warning code for this warning. enum: - ConditionsNoEntities - ConditionsNoSequences - ConditionsNoCampaigns - ConditionsNoMessagingCampaigns - ActionNoEntities - ActionNoSequences - ActionNoCampaigns - ActionNoMessagingCampaigns - NoQueue - NoContentTemplates - NoSmsContentTemplate - NoEmailContentTemplate - ConditionsWaitingForLinesOnlyPreviewOrExternal - ConditionsWaitingForAgentsOnlyAgentless message: type: string description: Warning message for this warning. params: description: Additional warning information $ref: '#/definitions/CampaignRuleWarningParameters' 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' DivisionReference: 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 CampaignOutboundLinesAllocation: type: object properties: campaign: description: The Campaign $ref: '#/definitions/DomainEntityRef' campaignWeight: type: integer format: int32 description: The relative weight of the campaign linesAssigned: type: integer format: int32 description: The number of lines dynamically assigned to the campaign legacyWeight: type: boolean description: true if relative weight of the campaign is not explicitly specified, false otherwise ErrorInfo: type: object properties: message: type: string code: type: string 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. ContactListingResponse: type: object properties: entities: type: array items: $ref: '#/definitions/DialerContact' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 contactsCount: 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 TimeAndDateSubCondition: type: object properties: type: type: string description: The type of time/date sub-condition. enum: - timeOfDay - dayOfWeek - dayOfMonth - specificDate operator: type: string description: The operator to use for comparison. enum: - EQUALS - LESS_THAN - LESS_THAN_EQUALS - GREATER_THAN - GREATER_THAN_EQUALS - CONTAINS - BEGINS_WITH - ENDS_WITH - BEFORE - AFTER - IN - BETWEEN inverted: type: boolean description: If true, inverts the result of evaluating this sub-condition. Default is false. includeYear: type: boolean description: If true, includes year in date comparison for specificDate type. When false, only month and day are compared. Default is true. Only applicable for specificDate type. thresholdValue: type: string description: 'Threshold value for BEFORE or AFTER operators. Format depends on type: timeOfDay: HH:mm, dayOfWeek: 1-7 (Monday-Sunday), dayOfMonth: 1-31 and/ or LAST_DAY, ODD_DAY, EVEN_DAY, specificDate: yyyy-MM-dd (if includeYear=true) or MM-dd (if includeYear=false). For single-value comparison, use a list with one element.' range: description: A range of values for BETWEEN and IN operators. Format follows the same rules as 'thresholdValue'. $ref: '#/definitions/TimeAndDateSubConditionRange' TimeAndDateSubConditionRange: type: object properties: min: type: string description: 'The minimum value of the range. Required for the operator BETWEEN. Format depends on type: timeOfDay: HH:mm, dayOfWeek: 1-7 (Monday-Sunday), dayOfMonth: 1-31, specificDate: yyyy-MM-dd (if includeYear=true) or MM-dd (if includeYear=false).' max: type: string description: The maximum value of the range. Required for the operator BETWEEN. Format follows the same rules as 'min'. inSet: type: array description: 'A set of values that the date/ time data should be in. Required for the IN operator. Format depends on type: dayOfWeek: 1-7 (Monday-Sunday), dayOfMonth: 1-31, and/ or LAST_DAY, ODD_DAY, EVEN_DAY,specificDate: yyyy-MM-dd (if includeYear=true) or MM-dd (if includeYear=false).' uniqueItems: true items: type: string RuleSetEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/RuleSet' 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 ContactList: type: object required: - columnNames properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update division: description: The division this entity belongs to. $ref: '#/definitions/DomainEntityRef' columnNames: type: array description: The names of the contact data columns. items: type: string phoneColumns: type: array description: Indicates which columns are phone numbers. items: $ref: '#/definitions/ContactPhoneNumberColumn' emailColumns: type: array description: Indicates which columns are email addresses items: $ref: '#/definitions/EmailColumn' whatsAppColumns: type: array description: Indicates which columns are whatsApp contacts items: $ref: '#/definitions/WhatsAppColumn' importStatus: description: The status of the import process. readOnly: true $ref: '#/definitions/ImportStatus' previewModeColumnName: type: string description: A column to check if a contact should always be dialed in preview mode. previewModeAcceptedValues: type: array description: The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode. items: type: string size: type: integer format: int64 description: The number of contacts in the ContactList. readOnly: true attemptLimits: description: AttemptLimits for this ContactList. $ref: '#/definitions/DomainEntityRef' automaticTimeZoneMapping: type: boolean description: Indicates if automatic time zone mapping is to be used for this ContactList. zipCodeColumnName: type: string description: The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true. columnDataTypeSpecifications: type: array description: The settings of the columns selected for dynamic queueing items: $ref: '#/definitions/ColumnDataTypeSpecification' trimWhitespace: type: boolean description: Whether to trim white space when importing a contactlist csv file, default value = true selfUri: type: string format: uri description: The URI for this object readOnly: true ExportUri: type: object properties: uri: type: string exportTimestamp: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' AtzmTimeSlotWithTimeZone: type: object properties: earliestCallableTime: type: string example: 08:00 description: The earliest time to dial a contact. Valid format is HH:mm latestCallableTime: type: string example: '21:00' description: The latest time to dial a contact. Valid format is HH:mm timeZoneId: type: string example: America/New York description: The time zone to use for contacts that cannot be mapped. UserStations: type: object properties: associatedStation: description: Current associated station for this user. readOnly: true $ref: '#/definitions/UserStation' effectiveStation: description: The station where the user can be reached based on their default and associated station. readOnly: true $ref: '#/definitions/UserStation' defaultStation: description: Default station to be used if not associated with a station. readOnly: true $ref: '#/definitions/UserStation' lastAssociatedStation: description: Last associated station for this user. readOnly: true $ref: '#/definitions/UserStation' OAuthLastTokenIssued: type: object properties: dateIssued: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' ConversationMessageMetadataContent: type: object properties: contentType: type: string description: Type of this content element. enum: - Reactions - Attachment - Location - QuickReply - Notification - ButtonResponse - Story - Mention - Card - Carousel - Text - QuickReplyV2 - DatePicker - InteractiveApplication - ListPicker - PaymentRequest - PaymentResponse - Push - Form - RoadsideAssistance - RichLink - NotificationResponse - Unknown subType: type: string description: Content subtype enum: - Image - Video - Audio - File - Link - Mention - Reply - Button - QuickReply - Postback - Unknown description: Metadata information about a message content. ConversationBasic: type: object required: - 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' divisions: type: array description: Identifiers of divisions associated with this conversation items: $ref: '#/definitions/ConversationDivisionMembership' 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 participants: type: array readOnly: true items: $ref: '#/definitions/ParticipantBasic' 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 CampaignRuleDayOfWeekParameters: type: object properties: inSet: type: array description: The operand for the "in" operator, each value in 1-7 (Monday-Sunday) format items: type: integer format: int32 interval: description: The operand for the "between" operator $ref: '#/definitions/CampaignRuleDayOfWeekInterval' CampaignRuleCampaignWaitTimeSettings: type: object required: - waitType properties: waitType: type: string description: Campaign wait type enum: - WaitingForAgents - WaitingForContacts - WaitingForLines PreprocessingRule: type: object properties: find: type: string description: The regular expression to which file lines are to be matched. replaceWith: type: string description: The string to be substituted for each match. global: type: boolean description: Replaces all matching substrings in every line. ignoreCase: type: boolean description: Enables case-insensitive matching 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' CallbackBasic: 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' EventLog: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string errorEntity: $ref: '#/definitions/DomainEntityRef' relatedEntity: $ref: '#/definitions/DomainEntityRef' timestamp: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' level: type: string enum: - INFO - WARNING - ERROR category: type: string enum: - CALLBACK - CALL_RESTRICTION - CALL_RULE - CAMPAIGN - CAMPAIGN_RULE - CONTACT - CONTACT_LIST_FILTER - DIGITAL_RULE - DNC_LIST - ENTITY_LIMIT - IMPORT_ERROR - MESSAGE_RESTRICTION - MESSAGING_CAMPAIGN - IMPORT_TEMPLATE - ORGANIZATION_CONFIGURATION - SCHEDULE - MESSAGING_CAMPAIGN_SCHEDULE - EMAIL_CAMPAIGN_SCHEDULE - WHATSAPP_CAMPAIGN_SCHEDULE - RETENTION_POLICY correlationId: type: string eventMessage: $ref: '#/definitions/EventMessage' selfUri: type: string format: uri description: The URI for this object readOnly: true PagelessDomainEntityListingEvaluationVersion: type: object properties: total: type: integer format: int64 entities: type: array items: $ref: '#/definitions/EvaluationVersion' selfUri: type: string format: uri WhatsAppCampaignSchedule: type: object required: - intervals - whatsAppCampaign properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update intervals: type: array description: A list of intervals during which to run the associated Campaign. items: $ref: '#/definitions/ScheduleInterval' recurrences: type: array description: Recurring schedules of the campaign items: $ref: '#/definitions/Reoccurrence' timeZone: type: string description: 'The time zone for this WhatsApp campaign schedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' whatsAppCampaign: description: The Campaign that this WhatsApp campaign schedule is for. $ref: '#/definitions/DivisionedDomainEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true NextOccurrenceDetails: type: object properties: startOccurrenceDetails: description: The details for the next start occurrence for the recurrence. $ref: '#/definitions/OccurrenceDetails' endOccurrenceDetails: description: The details for the next end occurrence for the recurrence. $ref: '#/definitions/OccurrenceDetails' User: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' chat: $ref: '#/definitions/Chat' department: type: string email: type: string primaryContactInfo: type: array description: Auto populated from addresses. readOnly: true items: $ref: '#/definitions/Contact' addresses: type: array description: Email addresses and phone numbers for this user items: $ref: '#/definitions/Contact' state: type: string description: The current state for this user. readOnly: true enum: - active - inactive - deleted title: type: string username: type: string manager: $ref: '#/definitions/User' images: type: array items: $ref: '#/definitions/Image' version: type: integer format: int32 description: Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. certifications: type: array items: type: string biography: $ref: '#/definitions/Biography' employerInfo: $ref: '#/definitions/EmployerInfo' preferredName: type: string description: Preferred full name of the agent routingStatus: description: ACD routing status readOnly: true $ref: '#/definitions/RoutingStatus' presence: description: Active presence readOnly: true $ref: '#/definitions/UserPresence' integrationPresence: description: Integration presence readOnly: true $ref: '#/definitions/UserPresence' conversationSummary: description: Summary of conversion statistics for conversation types. readOnly: true $ref: '#/definitions/UserConversationSummary' outOfOffice: description: Determine if out of office is enabled readOnly: true $ref: '#/definitions/OutOfOffice' geolocation: description: Current geolocation position readOnly: true $ref: '#/definitions/Geolocation' station: description: Effective, default, and last station information readOnly: true $ref: '#/definitions/UserStations' authorization: description: Roles and permissions assigned to the user readOnly: true $ref: '#/definitions/UserAuthorization' profileSkills: type: array description: Profile skills possessed by the user readOnly: true items: type: string locations: type: array description: The user placement at each site location. readOnly: true items: $ref: '#/definitions/Location' groups: type: array description: The groups the user is a member of readOnly: true items: $ref: '#/definitions/Group' team: description: The team the user is a member of readOnly: true $ref: '#/definitions/Team' workPlanBidRanks: description: The WFM work plan bid rank settings for the user readOnly: true $ref: '#/definitions/WorkPlanBidRanks' skills: type: array description: Routing (ACD) skills possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingSkill' languages: type: array description: Routing (ACD) languages possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingLanguage' acdAutoAnswer: type: boolean description: acd auto answer languagePreference: type: string description: preferred language by the user readOnly: true lastTokenIssued: $ref: '#/definitions/OAuthLastTokenIssued' dateLastLogin: type: string format: date-time description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateWelcomeSent: type: string format: date-time description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true InternalMessageDetails: type: object properties: messageId: type: string description: UUID identifying the internal message media. messageTime: type: string format: date-time description: 'The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' TemporalUnit: type: object properties: durationEstimated: type: boolean duration: $ref: '#/definitions/Duration' timeBased: type: boolean dateBased: type: boolean CampaignDivisionViewListing: type: object properties: entities: type: array items: $ref: '#/definitions/CampaignDivisionView' 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 FilterPreviewResponse: type: object properties: filteredContacts: type: integer format: int64 totalContacts: type: integer format: int64 preview: type: array items: $ref: '#/definitions/DialerContact' 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 EventMessage: type: object properties: code: type: string enum: - ACTIVE_CAMPAIGNS_LIMIT_EXCEEDED - ALL_CAMPAIGNS_BLACKLISTED - ANOTHER_CAMPAIGN_STARTING - APPROACHING_CONTACT_LIMIT - APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT - APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT - APPROACHING_ENTITY_LIMIT - AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID - CAMPAIGN_BLACKLISTED - CAMPAIGN_BUILD_CONTACT_QUEUE_ERROR - CAMPAIGN_CHECK_JOB_DUPLICATE - CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH - CAMPAIGN_CALLS_PER_AGENT_LOW - CAMPAIGN_EMAIL_BODY_CHARACTER_LIMIT_EXCEEDED - CAMPAIGN_EMAIL_SUBJECT_CHARACTER_LIMIT_EXCEEDED - CAMPAIGN_WHATSAPP_HEADER_VALUE_LIMIT_EXCEEDED - CAMPAIGN_WHATSAPP_BUTTON_URL_VALUE_LIMIT_EXCEEDED - CAMPAIGN_INVALIDATED - CAMPAIGN_FORCE_STOPPED - CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED - CAMPAIGN_START_ERROR - CAMPAIGN_RULE_START_ERROR - CAMPAIGN_SCRIPT_STAGE_MISSING - CAMPAIGN_SET_DIALING_MODE_ERROR - CAMPAIGN_STOPPED - CAMPAIGN_THROTTLED - CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED - CAMPAIGN_WEIGHT_ZERO - INVALID_CALLABLE_TIME_ZONE - CALLBACK_CREATION_INVALID_NUMBER - CALL_RULE_INVALID_CONTACT_COLUMN - CALL_RULE_MISSING_DATA_ACTION_INPUT - CALL_RULE_MISMATCH_TYPE - CALL_RULE_INVALID_OPERATOR - CALL_RULE_NO_DNC_LISTS_CONFIGURED - CALL_RULE_UPDATED_PHONE_COLUMN - CONTACT_LIST_FILTER_EVALUATION_FAILED - CONTACT_LIST_FILTER_INTERNAL_ERROR - CONTACT_COLUMNS_LIMIT_EXCEEDED - CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED - CONTACT_ID_LENGTH_LIMIT_EXCEEDED - CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED - CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID - DATA_ACTION_EXECUTION_FAILED - DATA_ACTION_AUTHENTICATION_FAILURE - DATA_ACTION_NOT_FOUND - DATA_ACTION_TOO_MANY_REQUESTS - DATA_ACTION_TOO_MANY_REQUESTS_REMOTE - ACTION_EXECUTION_FAILED - ACTION_EXECUTION_FAILED_INVALID_PARAMETER - DIGITAL_RULE_EVALUATION_FAILED - DIGITAL_RULE_INTERNAL_ERROR - DIGITAL_RULE_NO_DNC_LISTS_CONFIGURED - DIGITAL_RULE_UPDATED_CONTACT_ADDRESS - DIGITAL_RULE_SMS_PHONE_NUMBER_TYPE_MISMATCH - DIGITAL_RULE_ERROR_SKIPPED - DNC_AUTHENTICATION_FAILURE - EXCEEDED_CONTACT_LIMIT - EXCEEDED_DNC_RECORD_LIMIT - EXCEEDED_DNC_PHONE_NUMBER_LENGTH - INACTIVE_EDGES_FAILED_PLACE_CALLS - INACTIVE_EDGES_TURNED_CAMPAIGN_OFF - INVALID_AGENT - INVALID_EMAIL_ADDRESS - INVALID_PHONE_NUMBER - IMPORT_FAILED_TO_READ_HEADERS - IMPORT_COULD_NOT_PARSE_AN_ENTRY - IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT - IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS - IMPORT_INVALID_CUSTOM_ID - IMPORT_INVALID_DATA - IMPORT_INVALID_EMAIL_ADDRESSES - IMPORT_INVALID_PHONE_NUMBERS - IMPORT_INVALID_EXPIRATION_DATE - IMPORT_EXPIRATION_DATE_EXCEEDS_MAX_DAYS - IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT - IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT - IMPORT_MISSING_CUSTOM_ID - IMPORT_NO_COLUMNS_DEFINED - IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST - IMPORT_LIST_NO_LONGER_EXISTS - IMPORT_NO_LISTS_CREATED_NO_CONTACTS_MATCH_FILTER - IMPORT_TARGET_CONTACT_LIST_NAME_EXISTS - IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID - IMPORT_FAILED_CONTACT_DATA_GREATER_THAN_MAX_LENGTH - IMPORT_FAILED_CONTACT_DATA_NOT_WITHIN_MIN_MAX_RANGE - IMPORT_FAILED_CONTACT_DATA_INVALID_DATATYPE - IMPORT_TOO_MANY_COLUMNS - IMPORT_TOO_MANY_EXTRA_COLUMNS - IMPORT_INVALID_RETENTION_TYPE - IMPORT_INVALID_RETENTION_DAYS_MUST_BE_SET - IMPORT_INVALID_RETENTION_DAYS_MUST_NOT_BE_SET - IMPORT_INVALID_RETENTION_DAYS_MUST_BE_POSITIVE - IMPORT_INVALID_RETENTION_DAYS_EXCEEDS_LIMIT - IMPORT_INVALID_RETENTION_EXPIRATION_DATE_MUST_BE_SET - IMPORT_INVALID_RETENTION_EXPIRATION_DATE_MUST_NOT_BE_SET - IMPORT_INVALID_RETENTION_EXPIRATION_DATE_INVALID_FORMAT - IMPORT_INVALID_RETENTION_EXPIRATION_DATE_NO_SECONDS - IMPORT_INVALID_RETENTION_EXPIRATION_DATE_EXCEEDS_LIMIT - IMPORT_INVALID_RETENTION_MISSING_TYPE - IMPORT_INVALID_RETENTION_MISSING_PREFERRED_TIMEZONE - IMPORT_INVALID_RETENTION_EXPIRATION_IN_PAST - IMPORT_CONTACT_LIST_NAME_LENGTH_EXCEEDED - FAILED_TO_DELETE_CONTACT_LIST - RESOURCE_NOT_FOUND - INVALID_CONTACT_UPDATE - ORGANIZATION_HAS_NO_DOMAIN_SET - QUEUE_NOT_FOUND - RECYCLE_CAMPAIGN - SCHEDULED_CAMPAIGN_INVALID - SCHEDULE_UNKNOWN_ERROR - SMS_CONTENT_TEMPLATE_NOT_FOUND - RECURRING_SCHEDULE_NEXT_OCCURRENCE_FAILURE - RECURRING_SCHEDULE_ENDED - RECURRING_SCHEDULE_MISSED_OCCURRENCES - VERSION_CONFLICT message: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: object documentationUri: type: string resourceURIs: type: array items: type: string WrapUpCodeMapping: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update defaultSet: type: array description: The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping. uniqueItems: true items: type: string enum: - CONTACT_UNCALLABLE - NUMBER_UNCALLABLE - RIGHT_PARTY_CONTACT - BUSINESS_SUCCESS - BUSINESS_FAILURE - BUSINESS_NEUTRAL mapping: type: object description: A map from wrap-up code identifiers to a set of wrap-up flags. additionalProperties: type: array uniqueItems: true items: type: string enum: - CONTACT_UNCALLABLE - NUMBER_UNCALLABLE - RIGHT_PARTY_CONTACT - BUSINESS_SUCCESS - BUSINESS_FAILURE - BUSINESS_NEUTRAL selfUri: type: string format: uri description: The URI for this object readOnly: true SequenceSchedule: type: object required: - intervals - sequence properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update intervals: type: array description: A list of intervals during which to run the associated CampaignSequence. items: $ref: '#/definitions/ScheduleInterval' recurrences: type: array description: Recurring schedules of the campaign items: $ref: '#/definitions/Reoccurrence' timeZone: type: string description: 'The time zone for this SequenceSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' sequence: description: The CampaignSequence that this SequenceSchedule is for. $ref: '#/definitions/DomainEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true DialerRule: type: object required: - category - conditions - name properties: id: type: string description: The identifier of the rule. readOnly: true name: type: string description: The name of the rule. order: type: integer format: int32 description: The ranked order of the rule. Rules are processed from lowest number to highest. category: type: string description: The category of the rule. enum: - DIALER_PRECALL - DIALER_WRAPUP conditions: type: array description: A list of Conditions. All of the Conditions must evaluate to true to trigger the actions. items: $ref: '#/definitions/Condition' actions: type: array description: The list of actions to be taken if the conditions are true. items: $ref: '#/definitions/DialerAction' EmailColumn: type: object required: - columnName - type properties: columnName: type: string description: The name of the email column. type: type: string description: Indicates the type of the email column. For example, 'work' or 'personal'. contactableTimeColumnName: type: string description: A name of the contactableTimeColumn contactableTimeColumn: type: string description: A column that indicates the timezone to use for a given contact when checking contactable times. 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' ContactListFilterRange: type: object properties: min: type: string description: The minimum value of the range. Required for the operator BETWEEN. max: type: string description: The maximum value of the range. Required for the operator BETWEEN. minInclusive: type: boolean description: Whether or not to include the minimum in the range. maxInclusive: type: boolean description: Whether or not to include the maximum in the range. inSet: type: array description: A set of values that the contact data should be in. Required for the IN operator. uniqueItems: true items: type: string CampaignSchedule: type: object required: - campaign - intervals properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update intervals: type: array description: A list of intervals during which to run the associated Campaign. items: $ref: '#/definitions/ScheduleInterval' recurrences: type: array description: Recurring schedules of the campaign items: $ref: '#/definitions/Reoccurrence' timeZone: type: string description: 'The time zone for this CampaignSchedule. Defaults to UTC if empty or not provided. See here for a list of valid time zones https://www.iana.org/time-zones. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London' campaign: description: The Campaign that this CampaignSchedule is for. $ref: '#/definitions/DivisionedDomainEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true 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 Condition: type: object properties: type: type: string description: The type of the condition. enum: - wrapupCondition - systemDispositionCondition - contactAttributeCondition - phoneNumberCondition - phoneNumberTypeCondition - callAnalysisCondition - contactPropertyCondition - dataActionCondition - timeAndDateCondition inverted: type: boolean description: If true, inverts the result of evaluating this Condition. Default is false. attributeName: type: string description: An attribute name associated with this Condition. Required for a contactAttributeCondition. value: type: string description: A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition. valueType: type: string description: The type of the value associated with this Condition. Not used for a DataActionCondition. enum: - STRING - NUMERIC - DATETIME - PERIOD operator: type: string description: An operation with which to evaluate the Condition. Not used for a DataActionCondition. enum: - EQUALS - LESS_THAN - LESS_THAN_EQUALS - GREATER_THAN - GREATER_THAN_EQUALS - CONTAINS - BEGINS_WITH - ENDS_WITH - BEFORE - AFTER - IN - BETWEEN codes: type: array description: List of wrap-up code identifiers. Required for a wrapupCondition. items: type: string property: type: string description: A value associated with the property type of this Condition. Required for a contactPropertyCondition. propertyType: type: string description: The type of the property associated with this Condition. Required for a contactPropertyCondition. enum: - LAST_ATTEMPT_BY_COLUMN - LAST_ATTEMPT_OVERALL - LAST_WRAPUP_BY_COLUMN - LAST_WRAPUP_OVERALL dataAction: description: The Data Action to use for this condition. Required for a dataActionCondition. $ref: '#/definitions/DomainEntityRef' dataNotFoundResolution: type: boolean description: The result of this condition if the data action returns a result indicating there was no data. Required for a DataActionCondition. contactIdField: type: string description: The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionCondition. callAnalysisResultField: type: string description: The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionCondition. agentWrapupField: type: string description: The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionCondition. contactColumnToDataActionFieldMappings: type: array description: A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionCondition. items: $ref: '#/definitions/ContactColumnToDataActionFieldMapping' predicates: type: array description: A list of predicates defining the comparisons to use for this condition. Required for a dataActionCondition. items: $ref: '#/definitions/DataActionConditionPredicate' subConditions: type: array description: A list of sub-conditions to evaluate. Required for a timeAndDateCondition. items: $ref: '#/definitions/TimeAndDateSubCondition' matchAnyConditions: type: boolean description: If true, only one sub-condition must match for the condition to be true. If false, all sub-conditions must match. Default is false. Required for a timeAndDateCondition. timeZoneId: type: string description: The time zone to use for this condition. Required for a timeAndDateCondition. Empty: type: object CommonCampaignDivisionView: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the Campaign. division: description: The division to which this entity belongs. $ref: '#/definitions/Division' mediaType: type: string description: The media type used for this campaign. enum: - email - sms - voice - whatsapp selfUri: type: string format: uri description: The URI for this object readOnly: true AgentOwnedMappingPreview: type: object properties: agentOwnedColumn: type: string description: The raw value of the agent-owned column readOnly: true email: type: string description: The email address of the user, if it exists readOnly: true userId: type: string description: The id of the user, if it exists readOnly: true exists: type: boolean description: Whether the user exists readOnly: true isQueueMember: type: boolean description: Whether the user is a member of the campaign's queue readOnly: true recordCount: type: integer format: int32 description: The number of contact records whose agent-owned column matches the raw value readOnly: true CampaignRuleDayOfWeekInterval: type: object properties: min: type: integer format: int32 description: The minimum value of the interval in 1-7 (Monday-Sunday). Required for the "between" operator max: type: integer format: int32 description: The maximum value of the interval in 1-7 (Monday-Sunday). Required for the "between" operator 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 QueueMessagingAddresses: type: object properties: smsAddress: $ref: '#/definitions/DomainEntityRef' openMessagingRecipient: $ref: '#/definitions/DomainEntityRef' whatsAppRecipient: $ref: '#/definitions/DomainEntityRef' DncPatchCustomExclusionColumnsRequest: type: object properties: action: type: string description: The action to perform enum: - Add - Remove customExclusionColumnEntries: type: array description: 'The list of custom exclusion column entries to Add to / Remove from the DNC list ' items: type: string expirationDateTime: type: string description: Expiration date for DNC customExclusionColumnEntries in yyyy-MM-ddTHH:mmZ format 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 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 Alteration: type: object properties: type: type: string description: 'Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)' enum: - Exclusion - Inclusion start: type: string example: '2023-12-21T16:30:25' description: The start date of an alteration range as an ISO-8601 string end: type: string example: '2023-12-21T16:30:25' description: The end date of an alteration range as an ISO-8601 string Pattern: type: object required: - interval - type properties: type: type: string description: Pattern type (Daily/Weekly) enum: - Daily - Weekly interval: type: integer format: int32 description: The interval of days between the occurrences for Daily pattern type, and weeks between the occurrences for Weekly daysOfWeek: type: array description: The day(s) of week the occurrence should be repeated. Required to set for Weekly pattern type. E.g. ["Monday", "Wednesday"] items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday CampaignRuleConditionGroup: type: object required: - conditions - matchAnyConditions properties: matchAnyConditions: type: boolean description: Whether or not this condition group should be evaluated as true if any of sub conditions is matched conditions: type: array description: The parameters for the CampaignRuleCondition. items: $ref: '#/definitions/CampaignRuleCondition' AttemptLimitsEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/AttemptLimits' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 QuestionGroupSettings: type: object properties: questionGroupContextId: type: string description: The context id of the question group in the form. questionSettings: type: array items: $ref: '#/definitions/QuestionSettings' MessagingCampaignDivisionViewEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/MessagingCampaignDivisionView' 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 LocationEmergencyNumber: type: object properties: e164: type: string number: type: string type: type: string description: The type of emergency number. enum: - default - elin EmployerInfo: type: object properties: officialName: type: string employeeId: type: string employeeType: type: string dateHire: type: string CampaignRuleTimeOfDayInterval: type: object properties: min: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' max: type: string format: local-time description: 'Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS' 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 ContactListUploadUrlRequest: type: object required: - contentType properties: signedUrlTimeoutSeconds: type: integer format: int32 description: The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds contentType: type: string description: The content type of the file to upload. Allows MIME types are text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet id: type: string description: Id of your contact list to upload to contactIdName: type: string description: The column name from your file to use as the contact id. importTemplateId: type: string description: Id of your import template to use. listNamePrefix: type: string description: String that will replace %N in the listNameFormat specified on the import template. clearSystemData: type: boolean description: Whether to clear system data divisionIdForTargetContactLists: type: string description: Id of the division to be used for the creation of the target contact lists. If not provided, Home division will be used. fileSpecificationTemplateId: type: string description: File specification template ID 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 AtzmTimeSlot: type: object properties: earliestCallableTime: type: string example: 08:00 description: The earliest time to dial a contact. Valid format is HH:mm latestCallableTime: type: string example: '21:00' description: The latest time to dial a contact. Valid format is HH:mm DncListDivisionView: 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' importStatus: description: The status of the import process. readOnly: true $ref: '#/definitions/ImportStatus' size: type: integer format: int64 description: The number of contacts in the DncList. readOnly: true dncSourceType: type: string description: The type of the DncList. readOnly: true enum: - rds - rds_custom - dnc.com - gryphon contactMethod: type: string description: The contact method. Required if dncSourceType is rds. enum: - Email - Phone - Any - WhatsApp selfUri: type: string format: uri description: The URI for this object readOnly: true ContactBulkSearchCriteria: type: object properties: clauses: type: array description: Groups of conditions to filter the contacts by. items: $ref: '#/definitions/ContactListFilterClause' filterType: type: string description: How to join clauses together. enum: - AND - OR CampaignRuleExecutionSettings: type: object required: - frequency properties: frequency: type: string description: Execution control frequency enum: - onEachTrigger - oncePerDay timeZoneId: type: string example: Africa/Abidjan description: The time zone for the execution control frequency="oncePerDay"; for example, Africa/Abidjan. This property is ignored when frequency is not "oncePerDay" DncPatchEmailsRequest: type: object properties: action: type: string description: The action to perform enum: - Add - Remove emailAddresses: type: array description: 'The list of email addresses to Add to / Remove from the DNC list ' items: type: string expirationDateTime: type: string description: Expiration date for DNC email addresses in yyyy-MM-ddTHH:mmZ format ResponseSetEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/ResponseSet' 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 ContactPhoneNumberColumn: type: object required: - columnName - type properties: columnName: type: string description: The name of the phone column. type: type: string description: Indicates the type of the phone column. For example, 'cell' or 'home'. callableTimeColumnName: type: string description: A name of the callableTimeColumn callableTimeColumn: type: string description: A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true. UserParam: type: object properties: key: type: string value: type: string Chat: type: object properties: jabberId: type: string RecallEntry: type: object properties: nbrAttempts: type: integer format: int32 minutesBetweenAttempts: type: integer format: int32 ImportTemplate: type: object required: - contactListTemplate properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the import template. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update contactListTemplate: description: ContactListTemplate for this ImportTemplate. $ref: '#/definitions/DomainEntityRef' contactListFilter: description: ContactListFilter for this ImportTemplate. $ref: '#/definitions/DomainEntityRef' useSplittingCriteria: type: boolean description: Whether or not to use splitting criteria. Default is false. splittingInformation: description: How to split contact records, required if useSplittingCriteria is true. $ref: '#/definitions/SplittingInformation' listNameFormat: type: string description: The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required. enum: - ListNamePrefix - ListNamePrefixMonthDayYear - ListNamePrefixMonthDayYearHourMinuteSecond - ListNamePrefixPart - ListNamePrefixMonthDayYearPart - ListNamePrefixMonthDayYearHourMinuteSecondPart - Custom customListNameFormatValue: type: string description: 'Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second.' importStatus: description: The status of the import process. readOnly: true $ref: '#/definitions/ImportStatus' selfUri: type: string format: uri description: The URI for this object readOnly: true CampaignDiagnosticConfigChange: type: object properties: date: type: string format: date-time description: 'Timestamp when the configuration change occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' field: type: string description: Field name that was changed value: type: string description: New value assigned to the configuration field action: type: string description: Type of operation applied enum: - Update - Create - Delete WhatsAppConfig: type: object required: - contentTemplate - whatsAppColumns - whatsAppIntegration properties: whatsAppColumns: type: array description: The contact list columns specifying the WhatsApp address(es) of the contact. items: type: string whatsAppIntegration: description: The WhatsApp integration used to send message to the contact. $ref: '#/definitions/AddressableEntityRef' contentTemplate: description: The content template used to formulate the WhatsApp message to send to the contact. $ref: '#/definitions/DomainEntityRef' JourneyContext: type: object required: - customer properties: customer: description: A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomer' customerSession: description: A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context) $ref: '#/definitions/JourneyCustomerSession' triggeringAction: description: A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) $ref: '#/definitions/JourneyAction' QueueEmailAddress: type: object properties: domain: $ref: '#/definitions/DomainEntityRef' route: $ref: '#/definitions/InboundRoute' DncListEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/DncList' 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 Actions: type: object properties: skillsToRemove: type: array uniqueItems: true items: $ref: '#/definitions/SkillsToRemove' TranscriptTopic: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the object. readOnly: true topicPhrase: type: string description: 'The phrase which detected the topic. ' readOnly: true transcriptPhrase: type: string description: The transcript phrase which detected the topic. readOnly: true confidence: type: integer format: int32 description: The detection confidence of the topic. readOnly: true startTimeMilliseconds: type: integer format: int64 description: The start time of the topic phrase. readOnly: true duration: $ref: '#/definitions/TopicDuration' offset: description: Location of the phrase readOnly: true $ref: '#/definitions/TopicOffset' recordingLocation: type: integer format: int64 description: Location of the phrase in the recording in milliseconds readOnly: true ConversationQueueMediaSettings: type: object properties: alertingTimeoutSeconds: type: integer format: int32 description: Specifies how long the agent has to answer an interaction before being marked as not responding. autoAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for auto answered interactions. manualAnswerAlertToneSeconds: type: number format: double description: Specifies the duration of the alerting sound to be played for manually answered interactions. enableAutoAnswer: type: boolean description: Flag to indicate if auto answer is enabled for the given media type or media subtype. 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' SmsPhoneNumberRef: type: object required: - phoneNumber properties: phoneNumber: type: string description: A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 selfUri: type: string format: uri 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 DataActionConditionSettings: type: object required: - dataActionId - dataNotFoundResolution properties: dataActionId: type: string description: The Data Action Id to use for this condition. contactIdField: type: string description: The input field from the data action that the contactId will be passed into. dataNotFoundResolution: type: boolean description: The result of this condition if the data action returns a result indicating there was no data. predicates: type: array description: A list of predicates defining the comparisons to use for this condition. items: $ref: '#/definitions/DigitalDataActionConditionPredicate' contactColumnToDataActionFieldMappings: type: array description: A list of mappings defining which contact data fields will be passed to which data action input fields. items: $ref: '#/definitions/DataActionContactColumnFieldMapping' 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 ResponseSet: type: object required: - name - responses properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The name of the ResponseSet. dateCreated: type: string format: date-time description: 'Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true version: type: integer format: int32 description: Required for updates, must match the version number of the most recent update responses: type: object description: 'Map of disposition identifiers to reactions. For example: {"disposition.classification.callable.person": {"reactionType": "transfer"}}.' additionalProperties: $ref: '#/definitions/Reaction' beepDetectionEnabled: type: boolean description: Whether to enable answering machine beep detection amdSpeechDistinguishEnabled: type: boolean description: Whether to enable answering machine detection liveSpeakerDetectionMode: type: string description: Setting level of live speaker detection based on ringbacks enum: - Disabled - Low - Medium - High selfUri: type: string format: uri description: The URI for this object readOnly: true ContactColumnConditionSettings: type: object required: - columnName - operator - value - valueType properties: columnName: type: string description: The name of the contact list column to evaluate. operator: type: string description: The operator to use when comparing values. enum: - Equals - LessThan - LessThanEquals - GreaterThan - GreaterThanEquals - Contains - BeginsWith - EndsWith - Before - After value: type: string example: 'For Numeric: ''1234'', ''1234.56'', ''$1,234.56''. For DateTime: ''2022-01-01T12:01:23.456-0000''. For Period: ''P1DT1H1M''. ' description: The value to compare against the contact's data. valueType: type: string description: The data type the value should be treated as. enum: - DateTime - Numeric - Period - String DynamicContactQueueingSettings: type: object properties: sort: type: boolean description: Whether to sort contacts dynamically filter: type: boolean description: Whether to filter contacts dynamically 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 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 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' ParticipantBasic: 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/CallBasic' callbacks: type: array items: $ref: '#/definitions/CallbackBasic' 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. 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 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' 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/