openapi: 3.0.2
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go
info:
title: Digital - Custom Messaging
description: Send messages related to non-session (asynchronous) based communication.
contact:
name: Avaya API Team
url: https://developers.avayacloud.com/onecloud-ccaas
email: apiteam@avaya.com
license:
name: Avaya Software Development Kit (SDK) Software License Terms
url: http://support.avaya.com/css/P8/documents/101038288
version: 1.0.4
servers:
- url: '{protocol}://{server}{basePath}'
description: Open API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.api.avayacloud.com
basePath:
default: /api/digital/custom-messaging/v1
- url: '{protocol}://{server}{basePath}/async/{apiVersion}'
description: Internal Connector API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.cc.avayacloud.com
basePath:
default: /api/digital
apiVersion:
enum:
- v1
default: v1
- url: '{protocol}://{server}:{port}'
description: Internal API
variables:
protocol:
enum:
- http
- https
default: http
server:
default: async-gateway
port:
enum:
- '80'
- '443'
default: '80'
tags:
- name: Asynchronous Messages
description: 'Messages related to non-session based communication with the contact center are considered to be asynchronous
messages. Based on the information passed, the contact center will either model this against existing entities like conversation,
engagement or dialog, or else new entities will be created.
'
- name: Provider Dialogs
description: 'When a message for a conversation, represented by providerDialogId, is sent, a corresponding engagement and
dialog is either created or existing engagement and dialog is utilized. The engagement and dialog in AXP is closed by
agents or bots or the system. However in scenarios where provider wants to terminate a conversation, disconnect AXP from
participating in the conversation, clean up an inactive conversation or handle any erroneous situation, call this API
to terminate the live dialog within AXP.
'
- name: Indicators
description: 'Indicators are used to indicate the status of the conversation or the activity. For example, when a customer
is typing a message, the typing indicator is sent to the contact center.
'
security:
- {}
- BearerAuth: []
AppKey: []
paths:
/accounts/{accountId}/attachments:
post:
tags:
- Asynchronous Messages
summary: Upload Attachments
description: '**This API is deprecated. Instead use the Media Store APIs to upload attachments.** Upload message attachments.
'
operationId: uploadDigitalAsyncAttachments
parameters:
- $ref: '#/components/parameters/accountId'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AttachmentFiles'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentResponse'
examples:
Upload-Attachments-Response:
$ref: '#/components/examples/AttachmentResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
deprecated: true
/accounts/{accountId}/messages:
post:
tags:
- Asynchronous Messages
summary: Send Async Message
description: 'Sends messages related to an asynchronous or long lived communication to the contact center. Messages
sent with same ''providerDialogId'' are considered part of same the conversation.
'
operationId: sendDigitalAsyncMessage
parameters:
- $ref: '#/components/parameters/accountId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendAsyncMessage'
examples:
Messaging-Plaintext-Message:
$ref: '#/components/examples/SendPlaintextAsyncMessage'
HTML-Email:
$ref: '#/components/examples/SendEmailHtmlAsyncMessage'
Messaging-Send-Message-File:
$ref: '#/components/examples/SendMessageRequestFile'
Messaging-Send-Message-Image:
$ref: '#/components/examples/SendMessageRequestImage'
Messaging-Send-Message-Postback:
$ref: '#/components/examples/SendMessageRequestPostback'
Messaging-Send-Message-Location:
$ref: '#/components/examples/SendMessageRequestLocation'
Messaging-Send-Message-Reply:
$ref: '#/components/examples/SendMessageReply'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncMessage'
examples:
Plaintext-Response:
$ref: '#/components/examples/PlaintextAsyncMessageResponse'
HTML-Email-Response:
$ref: '#/components/examples/HtmlEmailAsyncMessageResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
deprecated: false
/accounts/{accountId}/provider-dialogs/{providerDialogId}:typing:
post:
tags:
- Indicators
summary: Typing Indicator
description: 'Send an indicator to the contact center that the customer is typing.
'
operationId: sendTypingIndicator
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/providerDialogId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypingIndicator'
examples:
Typing-Indicator:
$ref: '#/components/examples/TypingIndicator'
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
deprecated: false
/accounts/{accountId}/provider-dialogs/{providerDialogId}:disconnect:
post:
tags:
- Provider Dialogs
summary: Disconnect Dialog
description: 'Disconnects the customer from the live dialog within AXP associated with the conversation. This eventually
terminates the dialog. For asynchronous messaging, calling this API will not be required under usual circumstances. However
in scenarios where provider wants to terminate a conversation, disconnect AXP from participating in the conversation, clean
up an inactive conversation or handle any erroneous situation, call this API to terminate the live dialog within AXP.
'
operationId: disconnectProviderDialog
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/providerDialogId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisconnectProviderDialog'
examples:
Disconnect-Provider-Dialog:
$ref: '#/components/examples/DisconnectProviderDialog'
description: request
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DisconnectProviderDialog'
examples:
Disconnect-Provider-Dialog:
$ref: '#/components/examples/DisconnectProviderDialogResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
deprecated: false
components:
parameters:
accountId:
name: accountId
description: The unique 6 character internal id that represents the customer account.
required: true
in: path
schema:
type: string
minLength: 6
maxLength: 6
pattern: ^[a-zA-Z]{6}$
example: ABCDEF
providerDialogId:
name: providerDialogId
description: 'The provider side identifier for a Contact Center dialog. Messages with same ''providerDialogId'' value
are considered part of same conversation. If no or blank value is passed while sending a message, a new individual
dialog will be created. For integrating third party providers, provide the identifier that represents an individual
conversation in the third party provider.
'
required: true
in: path
schema:
type: string
minLength: 3
maxLength: 256
example: ed7e49dc8458c71d1d2f1e31
responses:
Accepted:
description: Accepted
BadRequest:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorConstraintViolation'
Unauthorized:
description: Unauthorized.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorUnauthorized'
Forbidden:
description: Forbidden.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorForbidden'
InternalServerError:
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorInternalServerError'
schemas:
SendAsyncMessage:
type: object
required:
- channelProviderId
- channelId
- businessAccountName
- customerIdentifiers
- body
properties:
channelProviderId:
type: string
description: The unique id that represents the channel provider
minLength: 3
maxLength: 256
channelId:
type: string
minLength: 3
maxLength: 50
description: The unique id representing the Contact Center Channel. Only valid Contact Center Channel Id's are accepted.
See Contact Center Channel list in Developers guide for further details.
businessAccountName:
type: string
minLength: 3
maxLength: 256
description: The name of the business account configured on the channel provider. For custom messaging integration,
provide the unique id of the integration (integrationId) here.
customerIdentifiers:
$ref: '#/components/schemas/CustomerIdentifiers'
senderName:
type: string
maxLength: 70
description: The optional display name of the user that sent the message. If not provided, display name from the
session will be used.
providerSenderId:
type: string
maxLength: 256
description: The provider side identifier for the user who sent the message.
providerDialogId:
type: string
maxLength: 256
description: The provider side identifier for a Contact Center dialog. Messages with same 'providerDialogId' value
are considered part of same conversation. If no or blank value is passed, this message will be treated as a new
individual dialog
providerMessageId:
type: string
maxLength: 256
description: The provider side identifier for the message.
providerParentMessageId:
type: string
maxLength: 256
description: The provider side identifier for the message that is the parent of this message
body:
$ref: '#/components/schemas/BodyElement'
fallbackText:
type: string
maxLength: 256
description: Fallback message text that clients can show if they are not capable of rendering the body
headers:
$ref: '#/components/schemas/MessageHeaders'
attachments:
type: array
maxItems: 25
items:
$ref: '#/components/schemas/AttachmentContentIdMap'
customData:
type: object
maxProperties: 20
description: Any data complementing the actual message body that is valuable for recipient clients. For example
any additional reference links, key words, hash tag references, additional content information etc. Key is limited
to 64 characters
additionalProperties:
type: string
maxLength: 256
engagementParameters:
type: object
maxProperties: 20
description: Optional key/value context information on the engagement. This information might be used to make business
decisions on how the engagement is treated. For example, the client application might want to send hints about
customer's interest based on the customer's searches or FAQ browsing. Key is limited to 64 characters
additionalProperties:
type: string
maxLength: 256
correlationId:
type: string
maxLength: 256
description: The correlation id can be used to uniquely identify the client request. This is an optional field but
when specified it will be included in any callback events and can be used to correlate the callback event with
the original API request.
AsyncMessage:
type: object
description: A conversation message
required:
- accountId
- channelProviderId
- channelId
- senderParticipantId
- senderParticipantName
- senderParticipantType
- body
- status
- customerIdentifiers
properties:
messageId:
type: string
description: The unique 36 character internal id for this specific message.
accountId:
type: string
description: The unique 6 character internal id that represents the customer account
dialogId:
type: string
description: The unique 36 character internal id that represents the dialog.
engagementId:
type: string
description: The unique 36 character internal id that represents the engagement.
status:
$ref: '#/components/schemas/MessageStatus'
sessionId:
type: string
description: The unique 36 character internal id that represents the users session.
businessAccountName:
type: string
description: The name of the business account configured on the channel provider. For custom messaging integration,
provide the unique id of the integration (integrationId) here.
customerIdentifiers:
$ref: '#/components/schemas/CustomerIdentifiers'
channelProviderId:
type: string
description: The unique id that represents the channel provider
channelId:
type: string
description: The unique id representing the Contact Center Channel. Only valid Contact Center Channel Id's are accepted.
See Contact Center Channel list in Developers guide for further details.
senderParticipantId:
type: string
description: The unique id that represents the sender of the message.
senderParticipantName:
type: string
description: The optional display name of the user that sent the message. If not provided, display name from the
session will be used.
senderParticipantType:
$ref: '#/components/schemas/ParticipantType'
body:
$ref: '#/components/schemas/BodyElement'
fallbackText:
type: string
description: Fallback message text that clients can show if they are not capable of rendering the body element
headers:
$ref: '#/components/schemas/MessageHeaders'
attachments:
type: array
items:
$ref: '#/components/schemas/Attachment'
description: List of Attachments
recipientParticipants:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Participant'
description: List of recipient participants
customData:
type: object
description: Any data complementing the actual message body that is valuable for recipient clients. For example
any additional reference links, key words, hash tag references, additional content information etc.
additionalProperties:
type: string
messageIndex:
type: integer
description: The index of the message within the context of the dialog
parentMessageId:
type: string
description: The unique 36 character internal id for the message that is the parent of this message
providerDialogId:
type: string
description: The provider side identifier for a Contact Center dialog.
providerSenderId:
type: string
description: The provider side identifier for the user who sent the message.
providerMessageId:
type: string
description: The provider side identifier for the message.
providerParentMessageId:
type: string
description: The provider side identifier for the message that is the parent of this message
engagementParameters:
type: object
maxProperties: 10
description: Optional key/value context information on the engagement. This information might be used to make business
decisions on how the engagement is treated. For example, the client application might want to send hints about
customer's interest based on the customer's searches or FAQ browsing
additionalProperties:
type: string
receivedAt:
type: string
format: date-time
description: The datetime when the Contact Center received the message (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z')
lastUpdatedAt:
type: string
format: date-time
description: The datetime when the message was last updated (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z')
correlationId:
type: string
description: The correlation id can be used to uniquely identify the client request. This is an optional field but
when specified it will be included in any callback events and can be used to correlate the callback event with
the original API request.
TypingIndicator:
type: object
description: Typing indicator
required:
- channelProviderId
- businessAccountName
properties:
channelProviderId:
type: string
description: The unique id that represents the channel provider
minLength: 3
maxLength: 256
businessAccountName:
type: string
description: The name of the business account configured on the channel provider. For custom messaging integration,
provide the unique id of the integration (integrationId) here.
minLength: 3
maxLength: 256
correlationId:
type: string
description: The correlation id can be used to uniquely identify the client request. This is an optional field but
when specified it will be included in any callback events and can be used to correlate the callback event with
the original API request.
maxLength: 256
Participant:
type: object
description: This event indicates that system will no longer exchange messages for this connection
required:
- participantId
- participantType
- connectionId
- channelProviderId
properties:
participantId:
type: string
description: The unique id that represents the participant.
participantType:
$ref: '#/components/schemas/ParticipantType'
displayName:
type: string
description: Display name of the participant
connectionId:
type: string
description: The unique 36 character internal id (uuid) that represents the Connection.
providerParticipantId:
type: string
description: The provider side identifier for the participant
channelProviderId:
type: string
description: The unique id that represents the channel provider
CustomerIdentifiers:
type: object
description: Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.
minProperties: 1
maxProperties: 10
additionalProperties:
type: array
description: 'Identifiers related to the Customer. The maximum length of an identifier key is 50 characters and must
be a valid "name" of a pre-configured identifier in Customer Journey.
'
maxItems: 5
items:
type: string
minLength: 1
maxLength: 256
DisconnectProviderDialog:
type: object
required:
- channelProviderId
- businessAccountName
properties:
providerDialogId:
type: string
readOnly: true
description: The provider side identifier for a Contact Center dialog.
channelProviderId:
type: string
description: The unique id that represents the channel provider
minLength: 3
maxLength: 256
businessAccountName:
type: string
minLength: 3
maxLength: 256
description: The name of the business account configured on the channel provider. For custom messaging integration,
provide the unique id of the integration (integrationId) here.
reason:
type: string
description: Reason for termination of client session of a customer
enum:
- USER_CLOSED
- USER_INACTIVE
- SYSTEM_CLOSED
- UNKNOWN
example: SYSTEM_CLOSED
correlationId:
type: string
maxLength: 256
description: The correlation id is used to uniquely identify the client request. This is an optional field but when
specified can be used to correlate the callback event with the original API request. If the client does not pass
any value for the correlation id in the request, a unique value will be generated automatically and sent back
in the response.
Attachment:
type: object
description: Meta information about the media
required:
- attachmentId
- name
- size
- contentType
- url
properties:
attachmentId:
type: string
description: The unique 36 character internal id for the attachment
minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
name:
type: string
maxLength: 256
description: The name of the attachment
size:
type: integer
format: int64
description: The size of the attachment in bytes
contentType:
type: string
maxLength: 256
description: The content type of the attachment
contentId:
type: string
maxLength: 256
description: The content id of the attachment
url:
type: string
maxLength: 2048
description: The URL link to retrieve the attachment
captionText:
type: string
maxLength: 256
description: The text describing the caption of the attachment
thumbnailUrl:
type: string
maxLength: 2048
description: The URL link to retrieve the thumbnail of the attachment
additionalProperties:
type: object
maxItems: 10
description: Any additional properties of the attachment like labels, tags, revision numbers, display properties,
etc.
additionalProperties:
type: string
AttachmentContentIdMap:
type: object
description: Meta information about the media
required:
- attachmentId
properties:
attachmentId:
type: string
description: The unique 36 character internal id for the attachment
minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
contentId:
type: string
maxLength: 256
description: The content id of the attachment
AttachmentFiles:
type: object
required:
- attachmentFiles
properties:
attachmentFiles:
type: array
maxItems: 25
description: List of media attachments for a message.
items:
type: string
format: binary
description: Media attachment for a message
AttachmentResponse:
type: array
items:
$ref: '#/components/schemas/Attachment'
MessageHeaders:
type: object
description: The header of the message
properties:
sourceAddress:
type: string
description: The source address is intended to represent the address from which the AXP engagement was created.
It might represent a mailbox, a Twitter account, a Facebook account, a chat integration will be the same as the
(To) address
example: https://www.facebook.com/Ixcc-112670754648669
maxLength: 256
sourceType:
type: string
description: The source of the engagement. For example the platform as a keyword (Facebook, Twitter, Instagram)
example: Facebook
maxLength: 100
priority:
type: string
maxLength: 32
description: The priority of the message set by the provider
sensitivity:
type: string
maxLength: 32
description: The sensitivity of the message set by the provider
encoding:
type: string
maxLength: 32
description: The encoding used for the body of the message
subject:
type: string
maxLength: 256
description: The subject of the message set by the provider
from:
type: string
maxLength: 256
description: The sender of the message set by the provider
to:
type: array
description: The To (recipients) of the message set by the provider
maxItems: 20
items:
type: string
maxLength: 256
cc:
type: array
maxItems: 20
description: The Cc (recipients) of the message set by the provider. This field is mainly used for email messages
items:
type: string
maxLength: 256
bcc:
type: array
maxItems: 20
description: The Bcc (recipients) of the message set by the provider. This field is mainly used for email messages
items:
type: string
maxLength: 256
replyTo:
type: string
maxLength: 256
description: The address to use when replying.
clientDeviceTag:
type: string
maxLength: 256
description: The tag used to identify the client device that was used to send the message.
messageSourceServerTag:
type: string
maxLength: 256
description: The tag used by a service to identify that this message was sent by itself.
providerTimestamp:
type: string
format: date-time
description: The date time when the message was captured by the provider (in ISO 8601 format including timezone,
'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z')
additionalHeaders:
type: object
description: The additional header fields of the message. For example if the payload is of a specific version that
the clients rendering the payload need to be aware of that information can be sent here. Total size is limited
to 256KB (including keys and values).
additionalProperties:
type: string
x-disable-custom-linter-rules:
- request-body-validation
BodyElement:
type: object
description: Definition of the body element such as the type of element, the message text and format
required:
- elementType
properties:
elementType:
type: string
minLength: 1
maxLength: 50
description: The type of the body element such as text, image, attachment, carousel, location, or form
elementText:
$ref: '#/components/schemas/ElementText'
payload:
type: string
description: Data required to help render the message on end clients
maxLength: 4096
richMediaPayload:
$ref: '#/components/schemas/RichMediaPayload'
RichMediaPayload:
type: object
description: Rich media payload data
properties:
selectedAction:
$ref: '#/components/schemas/Action'
actions:
type: array
description: An array of actions associated with the message
minItems: 1
maxItems: 5
readOnly: true
items:
$ref: '#/components/schemas/Action'
items:
type: array
description: An array of items associated with the message
minItems: 1
maxItems: 10
readOnly: true
items:
$ref: '#/components/schemas/Item'
coordinates:
$ref: '#/components/schemas/Coordinates'
location:
$ref: '#/components/schemas/Location'
Action:
type: object
description: An action button that the user can click to trigger an action
required:
- type
properties:
type:
type: string
description: The type of action. Supported types of action types are link, reply, postback, and locationRequest.
Messages sent by customer are allowed to have only reply and postback as action type.
minLength: 1
maxLength: 50
example: postback
text:
type: string
description: The text on an action button
maxLength: 50
example: Book Appointment
payload:
type: string
description: The payload of 'postback' or 'reply' action button
maxLength: 512
example: BOOK_APPOINTMENT
uri:
type: string
description: The URI that will be used by the clients when 'link' action button is clicked. Supports only https
url.
format: uri
example: https://example.com/items/info
iconUrl:
type: string
description: The URL of the image of the icon on a 'reply' action button. Supports only https url.
format: uri
example: https://example.com/images/icon.png
Coordinates:
type: object
description: The coordinates of a location
required:
- lat
- long
properties:
lat:
type: number
description: The latitude of a location
format: double
minimum: -90
maximum: 90
example: -18.516634
long:
type: number
description: The longitude of a location
format: double
minimum: -180
maximum: 180
example: 73.928104
Location:
type: object
description: The information about a location
properties:
address:
type: string
description: The address of the location
maxLength: 512
example: Nth Floor, UVW Park, XYZ Street, Some Country, PIN CODE - 123456
name:
type: string
description: The name of the location
maxLength: 50
example: ABC Enterprises
Item:
type: object
description: An item of a carousel or a list
required:
- title
- actions
properties:
title:
type: string
description: The title of the item in carousel or list
minLength: 1
maxLength: 50
example: Tacos
mediaUrl:
type: string
description: The URL of the image to be shown inside the item in carousel or list
format: uri
example: https://example.com/images/image.png
description:
type: string
description: Description of the item in carousel or list
maxLength: 256
example: Car with hybrid features
actions:
type: array
description: An array of actions associated with the item in carousel or list
minItems: 1
maxItems: 5
items:
$ref: '#/components/schemas/Action'
MessageStatus:
description: The delivery status of the message
type: string
enum:
- NONE
- SENT
- DELIVERED
- READ
- FAILED
- DELETED
ElementText:
type: object
description: The message text and format of the message body
required:
- text
properties:
text:
type: string
maxLength: 524288
description: The message text
textFormat:
$ref: '#/components/schemas/TextFormat'
TextFormat:
description: The message text format
example: PLAINTEXT
type: string
enum:
- PLAINTEXT
- HTML
- MARKDOWN
ParticipantType:
description: The type of participant
type: string
enum:
- CUSTOMER
- AGENT
- SUPERVISOR
- SYSTEM
- BOT
Problem:
type: object
description: 'Problem Detail as a way to carry machine-readable details of errors in a HTTP response to avoid
the need to define new error response formats for HTTP APIs RFC 7807
'
properties:
type:
type: string
format: uri
description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable
documentation for the problem type (e.g., using HTML).
'
default: about:blank
example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title:
type: string
description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited
for non technical stakeholders and not localized).
'
example: Service Unavailable
nullable: true
status:
type: integer
format: int32
description: 'The HTTP status code generated by the origin server for this occurrence of the problem.
'
minimum: 100
maximum: 600
exclusiveMaximum: true
example: 503
nullable: true
detail:
type: string
description: 'A human readable explanation specific to this occurrence of the problem.
'
example: Connection to database timed out
nullable: true
instance:
type: string
format: uri
description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further
information if dereferenced.
'
nullable: true
violations:
type: array
description: 'A list of violations that occurred as a result of invalid data provided as part of a request.
'
nullable: true
items:
type: object
properties:
field:
type: string
description: 'The name of the field in the request that caused the violation. This can be the name of a path
parameter, query parameter, or a field within the request body.
'
example: accountId
message:
type: string
description: 'A human readable explanation specific to this occurrence of the violation.
'
example: must match "^[a-zA-Z]{6}$"
code:
type: integer
format: int32
description: 'The violation code generated by the server for this occurrence of the violation. Use this code
when implementing any error handling logic instead of the message, as the message can change.
'
example: 20006
example:
- field: emailAddress
message: must not be null
code: 20002
- field: accountId
message: must match "^[a-zA-Z]{6}$"
code: 20006
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: This API uses Bearer Token Authorization Flow
bearerFormat: JWT
AppKey:
type: apiKey
in: header
name: appkey
description: This API needs an appKey as header.
examples:
SendPlaintextAsyncMessage:
value:
channelId: Messaging
channelProviderId: 591c2529-c3a3-4062-a213-b239c18f543b
businessAccountName: e94e278d-72e7-48cc-80fc-dba9f8dd1c36
customerIdentifiers:
emailAddresses:
- john@company.com
phoneNumbers:
- +91 20 4101 8003
body:
elementType: text
elementText:
text: I need some help to sell my car
textFormat: PLAINTEXT
senderName: John Doe
providerSenderId: d29c456135dcbe326e490bb2
providerDialogId: ed7e49dc8458c71d1d2f1e31
providerMessageId: 611c9a6a4a250100d4bd2c54
providerParentMessageId: 611c9a6a4a250100d4bd2c54
customData:
sentiment: neutral
engagementParameters:
model: 512GTB
interestedModel: 488GTB
headers:
messageSourceServerTag: MessageConnector01
clientDeviceTag: android
additionalHeaders:
Content-Version: '2.0'
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendEmailHtmlAsyncMessage:
value:
channelProviderId: 4af56dfe-9d07-46dc-b1d2-60bdd179bcd9
channelId: Email
businessAccountName: acme@example.com
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: text
elementText:
text: I need some help to sell my car
textFormat: HTML
headers:
to:
- support@example.com
from: john@example.com
cc:
- supportManagement@example.com
subject: Procedure to sell a call
messageSourceServerTag: imap-provider-1
additionalHeaders:
Content-Language: en
attachmentIds:
- attachmentId: 0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd67
contentId: my-car-image-cid
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
AttachmentResponse:
value:
- attachmentId: 0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd69
name: MyCarImage.png
size: 33774
contentType: image/png
url: https://ixcc-sandbox.avayacloud.com/api/media-store/v1/accounts/NQJPUB/media/0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd69
captionText: Car Image
thumbnailUrl: https://ixcc-sandbox.avayacloud.com/api/media-store/v1/accounts/NQJPUB/media/0ffa058c-77c6-4dbc-9fce-b0ee9e5ccd68
additionalProperties:
tags: '["car-image"]'
PlaintextAsyncMessageResponse:
value:
messageId: f314569c-710b-11eb-9439-0242ac130002
accountId: DYNNUG
dialogId: fc741b00-710b-11eb-9439-0242ac130002
engagementId: 8d7cf5b8-70ad-11eb-9439-0242ac130002
status: DELIVERED
sessionId: 10494b78-710c-11eb-9439-0242ac130002
businessAccountName: e94e278d-72e7-48cc-80fc-dba9f8dd1c36
customerIdentifiers:
emailAddresses:
- john@company.com
phoneNumbers:
- +91 20 4101 8003
channelProviderId: 591c2529-c3a3-4062-a213-b239c18f543b
channelId: Messaging
senderParticipantId: 277cacfe-710c-11eb-9439-0242ac130002
senderParticipantName: John Doe
senderParticipantType: AGENT
body:
elementType: text
elementText:
text: I need some help to sell my car
textFormat: PLAINTEXT
customData:
sentiment: Neutral
messageIndex: 0
parentMessageId: 5963c0d619a30a2e00de36b8
providerDialogId: ed7e49dc8458c71d1d2f1e31
providerSenderId: d29c456135dcbe326e490bb2
providerMessageId: 611c9a6a4a250100d4bd2c54
providerParentMessageId: 611c9a6a4a250100d4bd2c54
engagementParameters:
model: 512GTB
interestedModel: 488GTB
receivedAt: '2018-11-13T20:25:39.534Z'
lastUpdatedAt: '2018-11-13T20:25:39.734Z'
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
HtmlEmailAsyncMessageResponse:
value:
messageId: f314569c-710b-11eb-9439-0242ac130002
accountId: DYNNUG
dialogId: fc741b00-710b-11eb-9439-0242ac130002
engagementId: 8d7cf5b8-70ad-11eb-9439-0242ac130002
status: DELIVERED
sessionId: 10494b78-710c-11eb-9439-0242ac130002
businessAccountName: acme@example.com
customerIdentifiers:
emailAddresses:
- john@company.com
channelProviderId: 4af56dfe-9d07-46dc-b1d2-60bdd179bcd9
channelId: Email
senderParticipantId: 277cacfe-710c-11eb-9439-0242ac130002
senderParticipantName: John Doe
senderParticipantType: AGENT
body:
elementType: text
elementText:
text: I need some help to sell my car
textFormat: PLAINTEXT
attachments:
- attachmentId: 0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd69
name: company-logo.png
size: 2383
contentType: image/png
url: https://ixcc-sandbox.avayacloud.com/api/media-store/v1/accounts/NQJPUB/media/0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd67
captionText: Company Logo
contentId: company-logo-cid
thumbnailUrl: https://ixcc-sandbox.avayacloud.com/api/media-store/v1/accounts/NQJPUB/media/0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd67
additionalProperties:
tags: '["logo-small"]'
customData:
sentiment: Neutral
messageIndex: 0
parentMessageId: 5963c0d619a30a2e00de36b8
providerDialogId: ed7e49dc8458c71d1d2f1e31
providerSenderId: d29c456135dcbe326e490bb2
providerMessageId: 611c9a6a4a250100d4bd2c54
providerParentMessageId: 611c9a6a4a250100d4bd2c54
engagementParameters:
model: 512GTB
interestedModel: 488GTB
receivedAt: '2018-11-13T20:25:39.534Z'
lastUpdatedAt: '2018-11-13T20:25:39.734Z'
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendMessageRequestFile:
value:
channelProviderId: cef29866-0467-47ce-b97d-9f7731571bdd
channelId: Messaging
businessAccountName: ac134b16-100f-4b0e-886b-8473af6a29ca
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: file
elementText:
text: This file contains car's brochure
textFormat: PLAINTEXT
attachmentIds:
- attachmentId: 0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd67
engagementParameters:
model: 512GTB
interestedModel: 488GTB
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendMessageRequestImage:
value:
channelProviderId: cef29866-0467-47ce-b97d-9f7731571bdd
channelId: Messaging
businessAccountName: ac134b16-100f-4b0e-886b-8473af6a29ca
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: image
elementText:
text: Car's Front View for insurance
textFormat: PLAINTEXT
attachmentIds:
- attachmentId: 0ffa058c-77c7-4dbc-9fce-b0ee9e5ccd67
engagementParameters:
model: 512GTB
interestedModel: 488GTB
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendMessageRequestPostback:
value:
channelProviderId: cef29866-0467-47ce-b97d-9f7731571bdd
channelId: Messaging
businessAccountName: ac134b16-100f-4b0e-886b-8473af6a29ca
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: postback
elementText:
text: ''
textFormat: PLAINTEXT
richMediaPayload:
selectedAction:
type: postback
text: Book Appointment
payload: BOOK_APPOINTMENT
engagementParameters:
model: 512GTB
interestedModel: 488GTB
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendMessageRequestLocation:
value:
channelProviderId: cef29866-0467-47ce-b97d-9f7731571bdd
channelId: Messaging
businessAccountName: ac134b16-100f-4b0e-886b-8473af6a29ca
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: location
elementText:
text: ''
textFormat: PLAINTEXT
richMediaPayload:
coordinates:
lat: -18.516634
long: 73.928104
location:
address: Nth Floor, UVW Park, XYZ Street, Some Country, PIN CODE - 123456
name: ABC Enterprises
engagementParameters:
model: 512GTB
interestedModel: 488GTB
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
SendMessageReply:
value:
channelProviderId: cef29866-0467-47ce-b97d-9f7731571bdd
channelId: Messaging
businessAccountName: ac134b16-100f-4b0e-886b-8473af6a29ca
customerIdentifiers:
emailAddresses:
- john@company.com
providerDialogId: 616imlgwg266hjs670nl
providerMessageId: 611c9a6a4a250100d4bd2c54
body:
elementType: reply
elementText:
text: ''
textFormat: PLAINTEXT
richMediaPayload:
selectedAction:
type: reply
text: Good
payload: GOOD
iconUrl: https://example.com/icons/good.png
engagementParameters:
model: 512GTB
interestedModel: 488GTB
parentMessageId: 0683305e-ff90-4ac1-8475-1810832f7a32
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
TypingIndicator:
value:
channelProviderId: 4af56dfe-9d07-46dc-b1d2-60bdd179bcd9
businessAccountName: e94e278d-72e7-48cc-80fc-dba9f8dd1c36
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
DisconnectProviderDialog:
value:
channelProviderId: 591c2529-c3a3-4062-a213-b239c18f543b
businessAccountName: e94e278d-72e7-48cc-80fc-dba9f8dd1c36
reason: SYSTEM_CLOSED
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
DisconnectProviderDialogResponse:
value:
providerDialogId: ed7e49dc8458c71d1d2f1e31
channelProviderId: 591c2529-c3a3-4062-a213-b239c18f543b
businessAccountName: e94e278d-72e7-48cc-80fc-dba9f8dd1c36
reason: SYSTEM_CLOSED
correlationId: zc38400d-c44f-4451-8316-e75c4efbt779
ErrorConstraintViolation:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process
this request until the client resolves the semantic errors described in the violations section.
violations:
- field: accountId
message: must match "^[a-zA-Z]{6}$"
ErrorUnauthorized:
description: Unauthorized
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
title: Unauthorized
status: 401
detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
ErrorForbidden:
description: Forbidden
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
title: Forbidden
status: 403
detail: According to the access control policy the current user and/or accountId does not have permission to access
this resource.
ErrorInternalServerError:
description: Internal Server Error
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#internal-error
title: Internal Server Error
status: 500
detail: An internal server error was encountered.