Ada subpackage_conversations API is one of 13 APIs that Ada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include subpackage_conversations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
11 operations
across 9 paths,
and defines 43 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 5 base URLs: https://example.ada.support, https://example.att.ada.support, https://example.maple.ada.support, https://example.ficanex.ada.support, https://example.eu.ada.support.
11 operations9 paths43 schemas4 GET1 PATCH6 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ada.cx
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Ada subpackage_conversations API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
Paths & Operations 11
Across 9 paths, the API surfaces 11 operations — 4 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Conversation (31 properties), Conversation_2 (31 properties), Conversation_3 (7 properties), EmailConversationCreateRequest (7 properties). Each schema is shown below with its type and property counts.
PaginationMetadata
object
1 property
MessageLogsType
string
The type of the message
ConversationMetadata
ConversationsResponseMeta
object
1 property
Conversation
object
31 properties
ConversationMetavariables
object
Object of metavariables and their values active during this conversations
MessageLogs
object
5 properties
ConversationVariables
object
Object of autocapture and global variables and their values last active during this conversations
Message
object
6 properties
MessageCreateRequestContent
The message content
MessageCreateRequest
object
2 properties2 required
TextContent
object
The content of the text message
2 properties2 required
LinkContentType
string
The type of the message
ConversationCreateRequestMetadata
Conversation_3
object
7 properties
ConversationCreateRequest
object
3 properties1 required
MessageList
object
2 properties2 required
ConversationMessageAuthor
object
Information about the message author
4 properties1 required
Conversations_endHandoff_Response_200
object
1 property
MessageLogsAuthor
object
Information about the message author
4 properties
TextContentType
string
The type of the message
ConversationPatchRequestMetadata
Conversation_2
object
31 properties
FileContentType
string
The type of the message
ConversationStatus
string
The status of the conversation
EmailConversationCreateResponse
object
1 property
MessageEvents
ErrorsErrorsItems
object
3 properties2 required
LinkContent
object
The content of a standalone link style messages, such as CSAT
3 properties
ConversationPatchRequest
object
1 property1 required
EmailConversationCreateRequestMetadata
object
Any metadata associated with the conversation, up to 4 KB. All metadata passed through this field will appear as metavariables in your dashboard.
ConversationCsat
object
Object of customer satisfaction survey data for this conversation
EmailConversationCreateRequest
object
7 properties3 required
FileContent
object
The content of a file message
4 properties4 required
ConversationMessageAuthorRole
string
The author's role
MessageLogsAuthorRole
string
The author's role
Conversations_endConversation_Response_200
object
1 property
ConversationsResponse_2
object
3 properties
MessageLogsContent
The message content. The structure varies based on the type field. Supported types: text, link, file.
ConversationsResponse
object
2 properties
Errors
object
1 property1 required
MessageContent
The message content
AttachmentUploadResponse
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
