{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:23:52.205997667Z"
},
"tags":[
{
"name":"customer-engagement",
"description":"Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.\n",
"x-type":"category",
"x-displayName":"Customer Engagement"
},
{
"name":"conversations",
"description":"Conversations is a solution that allows Enterprises to engage in conversations with their customers over multiple channels. The solution is available either as a web-based cloud platform web interface or over HTTP API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger. It supports conversation threading, conversation management including queues and routing, agent assignment, resolution management and conversation history overview.",
"x-type":"product",
"x-displayName":"Conversations"
},
{
"name":"conversation-management",
"description":"",
"x-type":"section",
"x-displayName":"Conversation management"
},
{
"name":"conversation-tags",
"description":"",
"x-type":"section",
"x-displayName":"Conversation tags"
},
{
"name":"conversation-messages",
"description":"",
"x-type":"section",
"x-displayName":"Conversation messages"
},
{
"name":"conversation-events",
"description":"",
"x-type":"section",
"x-displayName":"Conversation events"
},
{
"name":"conversation-notes",
"description":"",
"x-type":"section",
"x-displayName":"Conversation notes"
},
{
"name":"conversation-agents",
"description":"",
"x-type":"section",
"x-displayName":"Conversation agents"
},
{
"name":"conversation-queues",
"description":"",
"x-type":"section",
"x-displayName":"Conversation queues"
},
{
"name":"conversation-routing",
"description":"",
"x-type":"section",
"x-displayName":"Conversation routing"
},
{
"name":"bots",
"description":"",
"x-type":"section",
"x-displayName":"Bots"
},
{
"name":"metadata",
"description":"",
"x-type":"section",
"x-displayName":"Metadata"
},
{
"name":"templates",
"description":"",
"x-type":"section",
"x-displayName":"Templates"
},
{
"name":"conversation-forms",
"description":"",
"x-type":"section",
"x-displayName":"Conversation forms"
},
{
"name":"account-configuration",
"description":"",
"x-type":"section",
"x-displayName":"Account Configuration"
},
{
"name":"agent-configuration-calls",
"description":"",
"x-type":"section",
"x-displayName":"Agent Configuration (Calls)"
},
{
"name":"outbound-call-conversation-calls",
"description":"",
"x-type":"section",
"x-displayName":"Outbound Call Conversation (Calls)"
},
{
"name":"waiting-strategies-calls",
"description":"",
"x-type":"section",
"x-displayName":"Waiting Strategies (Calls)"
},
{
"name":"recording-configuration-calls",
"description":"",
"x-type":"section",
"x-displayName":"Recording Configuration (Calls)"
},
{
"name":"recording-metadata-calls",
"description":"",
"x-type":"section",
"x-displayName":"Recording metadata (Calls)"
},
{
"name":"recording-calls",
"description":"",
"x-type":"section",
"x-displayName":"Recording (Calls)"
},
{
"name":"wrap-up-configuration-calls",
"description":"",
"x-type":"section",
"x-displayName":"Wrap Up Configuration (Calls)"
},
{
"name":"wrap-up-time-calls",
"description":"",
"x-type":"section",
"x-displayName":"Wrap Up Time (Calls)"
},
{
"name":"transfers-calls",
"description":"",
"x-type":"section",
"x-displayName":"Transfers (Calls)"
},
{
"name":"transfer-to-external-number-configuration-calls",
"description":"",
"x-type":"section",
"x-displayName":"Transfer to External Number Configuration (Calls)"
},
{
"name":"transfer-strategy-calls",
"description":"",
"x-type":"section",
"x-displayName":"Transfer Strategy (Calls)"
},
{
"name":"call-hold-calls",
"description":"",
"x-type":"section",
"x-displayName":"Call Hold (Calls)"
},
{
"name":"hold-configuration-calls",
"description":"",
"x-type":"section",
"x-displayName":"Hold Configuration (Calls)"
},
{
"name":"call-timeout-calls",
"description":"",
"x-type":"section",
"x-displayName":"Call Timeout (Calls)"
},
{
"name":"working-hours",
"description":"",
"x-type":"section",
"x-displayName":"Working Hours"
},
{
"name":"tts-options-calls",
"description":"",
"x-type":"section",
"x-displayName":"TTS options (Calls)"
},
{
"name":"away-audio-messages",
"description":"",
"x-type":"section",
"x-displayName":"Away Audio Messages"
},
{
"name":"web-forms",
"description":"",
"x-type":"section",
"x-displayName":"Web Forms"
}
],
"paths":{
"/ccaas/1/conversations":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Get conversations",
"description":"Use this method to get a list of conversations with pagination and filtering option. Using the filter is optional. The result can be filtered by one or many optional filters described in parameters. More info",
"operationId":"get-conversations",
"parameters":[
{
"name":"conversationIds",
"in":"query",
"description":"Optional. List of conversation Ids.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"queueIds",
"in":"query",
"description":"Optional. List of queue Ids.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"tagNames",
"in":"query",
"description":"Optional. List of tag names.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"agentId",
"in":"query",
"description":"Optional. Id of an agent assigned to conversations.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"status",
"in":"query",
"description":"Optional. Conversation status.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"OPEN",
"WAITING",
"SOLVED",
"CLOSED"
]
}
},
{
"name":"priority",
"in":"query",
"description":"Optional. Conversation priority.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"URGENT",
"HIGH",
"NORMAL",
"LOW"
]
}
},
{
"name":"createdAfter",
"in":"query",
"description":"Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"createdBefore",
"in":"query",
"description":"Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedAfter",
"in":"query",
"description":"Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedBefore",
"in":"query",
"description":"Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"closedAfter",
"in":"query",
"description":"Optional. Filter results closed after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"closedBefore",
"in":"query",
"description":"Optional. Filter results closed before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Create conversation",
"description":"Use this method to create a new conversation. All conversation parameters are optional. More info",
"operationId":"create-conversation",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Get conversation",
"description":"Use this method to get a single conversation. More info",
"operationId":"get-conversation",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Update conversation",
"description":"Use this method to update a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).More info",
"operationId":"update-conversation",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"patch":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Patch conversation",
"description":"Use this method to patch a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).More info",
"operationId":"patch-conversation",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation being patched.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/tags":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Add tag to conversation",
"description":"Use this method to add a tag to the conversation. With tag(s) you can categorize conversations for assignment and/or reporting purposes. More info",
"operationId":"add-conversation-tag",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation the tag is added to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"statusCode":"SUCCESS",
"message":"Tag added to conversation successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid tag name":{
"summary":"Invalid tag name",
"description":"Invalid tag name",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/assignee":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Change conversation assignment",
"description":"Use this method to update a conversation assignee. Assignee cannot be updated in closed conversations. For Agent Takeovers (bot replaced by an agent), the Infobip platform will additionally update [Answers](https://www.infobip.com/docs/answers) that a bot is no longer in control of the conversation. More info",
"operationId":"change-conversation-assignment",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation for which the assignment is to be updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid agent Id":{
"summary":"Invalid agent Id",
"description":"Invalid agent Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Unassign conversation agent",
"description":"Use this method to remove an assigned agent from conversation. More info",
"operationId":"unassign-conversation-agent",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to unassign agent from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/tags/{tagName}":{
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Remove tag from conversation",
"description":"Use this method to remove the tag from the conversation. Operation only deletes the link between a tag and the conversation. More info",
"operationId":"delete-conversation-tag",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to remove/unlink the tag from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"tagName",
"in":"path",
"description":"Name of the tag to remove/unlink from conversation. This value must be URL-encoded.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"statusCode":"SUCCESS",
"message":"Tag removed successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid tag name":{
"summary":"Invalid tag name",
"description":"Invalid tag name",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/route":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Route conversation",
"description":"Use this method to route the existing conversation.\nThis method will remove the assigned agent from a conversation (if one exists), and send the conversation to the [routing process](../#customer-engagement/conversations/update-routing).\nClosed Conversations cannot be routed.",
"operationId":"route-conversation",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation being routed.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"topic":"Conversation topic",
"summary":"Conversation summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/simulate-routing":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Simulate routing result for conversation",
"description":"Use this method to simulate routing for an existing conversation.\nThis method will resolve the routing rule applicable to the current conversation state and return the queue ID and priority\nthat would be applied if the conversation was actually routed at this moment.\nClosed conversations cannot be routed.\n",
"operationId":"simulate-routing-result-for-conversation",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation on which routing is simulated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationRoutingResultApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1ddece93-041f-42ac-8e25-d05801dfe358",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"priority":"HIGH"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Conversation is closed":{
"summary":"Conversation is closed",
"description":"Conversation is closed",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Closed conversation cannot be changed"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/conversations/{conversationId}/related-comments":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Get related comments",
"description":"Use this method to return social comments related to a specified inbound comment within a conversation.\nIt returns up to 50 older and 50 newer comments that are on the same hierarchy level as the inbound comment.\n",
"operationId":"get-related-comments",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"ID of the conversation to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedCommentsApiResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Missing Conversation Id":{
"summary":"Missing Conversation Id",
"description":"Missing Conversation Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid conversationId 'related-comments' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/conversations/{conversationId}/links":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-management"
],
"summary":"Get linked conversations",
"description":"Use this method to get a list of conversations linked to the specified conversation. More info",
"operationId":"get-linked-conversations",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"ID of the conversation to get links for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversations"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"linkedConversations":[
{
"parentConversation":{
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"topic":"Billing inquiry",
"channel":"WHATSAPP",
"status":"OPEN",
"customerDisplayName":"John Doe"
},
"childConversation":{
"conversationId":"e43bc422-09c9-4591-8b9d-82debcf04e0d",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"topic":"Follow-up",
"channel":"LIVE_CHAT",
"status":"OPEN",
"customerDisplayName":"John Doe"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/tags":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-tags"
],
"summary":"Get tags",
"description":"Use this method to get a list of tags with pagination and filtering options. Using a filter is optional. The result can be filtered only by conversation Id so the result list will be tagged for a specific conversation. More info",
"operationId":"get-tags",
"parameters":[
{
"name":"conversationId",
"in":"query",
"description":"Optional. Conversation Ids linked to tags.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"name",
"in":"query",
"description":"Optional. Tag name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagsApiResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-tags"
],
"summary":"Create tag",
"description":"Use this method to create a new tag. Tags can be assigned to the conversations to categorize them into topics or customer intents. Tags can be created ad hoc over the create tag method or automatically within the journey automation flow when a conversation is transferred to Agents. More info",
"operationId":"create-tag",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"name":"Tag 1",
"createdAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Tag already exists":{
"summary":"Tag already exists",
"description":"Tag already exists",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Tag already exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/tags/{tagName}":{
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-tags"
],
"summary":"Delete tag",
"description":"Use this method to delete the tag.\nDeleting tag will remove the tag from all associated conversations. This operation cannot be reverted! More info",
"operationId":"delete-tags",
"parameters":[
{
"name":"tagName",
"in":"path",
"description":"Name of the Tag being deleted. This value must be URL-encoded.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Tag deleted successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid tagName":{
"summary":"Invalid tagName",
"description":"Invalid tagName",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/messages":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-messages"
],
"summary":"Get messages",
"description":"Use this method to get a list of messages from a conversation with pagination and filtering option. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.",
"operationId":"get-messages",
"parameters":[
{
"name":"messageIds",
"in":"query",
"description":"Optional. List of messages Ids.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"channel",
"in":"query",
"description":"Optional. Message chanel.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"LIVE_CHAT",
"LINE",
"TELEGRAM",
"INSTAGRAM_MESSAGING",
"KAKAO_SANGDAM",
"VIBER_BOT",
"APPLE_BUSINESS_CHAT",
"EMAIL"
]
}
},
{
"name":"direction",
"in":"query",
"description":"Optional. Message direction.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"INBOUND",
"OUTBOUND"
]
}
},
{
"name":"createdAfter",
"in":"query",
"description":"Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"createdBefore",
"in":"query",
"description":"Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to get messages from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":500,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-messages"
],
"summary":"Create message",
"description":"Inbound messages are automatically threaded in conversations if the channels and senders are configured for using Conversations.\nTo send an outbound message use this method with the following parameters, adding it to an existing conversation.\nPlease note that the response from sending a TEMPLATE content type is a message of the TEXT content type, containing the\ntemplate content filled with parameters. \n\nAlso, HTTP header should contain parameter \"x-agent-id\" as agent identifier,\nbut only in case conversations are assigned to agents. More info",
"operationId":"create-message",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to set message for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateMessageApiRequest"
},
"examples":{
"Sending SMS message.":{
"summary":"Sending SMS message.",
"description":"Sending SMS message.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"SMS",
"contentType":"TEXT",
"content":{
"text":"Text content."
}
}
},
"Sending WHATSAPP message with IMAGE content.":{
"summary":"Sending WHATSAPP message with IMAGE content.",
"description":"Sending WHATSAPP message with IMAGE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Sending WHATSAPP message with LOCATION content.":{
"summary":"Sending WHATSAPP message with LOCATION content.",
"description":"Sending WHATSAPP message with LOCATION content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"LOCATION",
"content":{
"longitude":-1.826323,
"latitude":51.178844,
"locationName":"Location",
"address":"Address"
}
}
},
"Sending VIBER message with LOCATION content.":{
"summary":"Sending VIBER message with LOCATION content.",
"description":"Sending VIBER message with LOCATION content.",
"value":{
"from":"DemoCompany",
"to":"44776333666",
"channel":"VIBER",
"contentType":"LOCATION",
"content":{
"longitude":1.2,
"latitude":3.4,
"locationName":"Location",
"address":"Address Name"
}
}
},
"Sending WHATSAPP message with DOCUMENT content.":{
"summary":"Sending WHATSAPP message with DOCUMENT content.",
"description":"Sending WHATSAPP message with DOCUMENT content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"DOCUMENT",
"content":{
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Sending WHATSAPP message with VIDEO content.":{
"summary":"Sending WHATSAPP message with VIDEO content.",
"description":"Sending WHATSAPP message with VIDEO content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"VIDEO",
"content":{
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Sending WHATSAPP message with AUDIO content.":{
"summary":"Sending WHATSAPP message with AUDIO content.",
"description":"Sending WHATSAPP message with AUDIO content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"AUDIO",
"content":{
"url":"https://www.url.com/assets/audio.mp3"
}
}
},
"Sending WHATSAPP message with CONTACT content.":{
"summary":"Sending WHATSAPP message with CONTACT content.",
"description":"Sending WHATSAPP message with CONTACT content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"CONTACT",
"content":{
"contacts":[
{
"name":{
"first_name":"First Name",
"last_name":"Last Name",
"formatted_name":"Formatted First Last Name"
},
"org":{
"company":"Company Name"
},
"emails":[
{
"email":"first@last@company.com",
"type":"private"
}
],
"urls":[
{
"url":"https://url.com/assets/profile",
"type":"PROFILE"
}
],
"birthday":"2019-02-18",
"addresses":[
{
"city":"City",
"country":"Country",
"countryCode":"123",
"street":"Street name",
"type":"WORK",
"zip":"12345"
}
],
"phones":[
{
"phone":"+123 456 789",
"type":"Mobile",
"waId":"123456"
},
{
"phone":"+123 456 7890",
"type":"Work"
}
]
}
]
}
}
},
"Sending WHATSAPP message with TEMPLATE content.":{
"summary":"Sending WHATSAPP message with TEMPLATE content.",
"description":"Sending WHATSAPP message with TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"TEMPLATE",
"content":{
"templateName":"welcome_multiple_languages",
"language":"es",
"parameters":[
{
"default":"Pablo"
}
]
}
}
},
"Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.":{
"summary":"Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.",
"description":"Sending WHATSAPP message with TEXT MEDIA TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"text_media_template",
"language":"en",
"header":{
"placeholder":"Gustavo",
"type":"TEXT"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"support"
],
"type":"URL"
}
]
}
}
},
"Sending WHATSAPP message with INTERACTIVE URL BUTTON content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE URL BUTTON content.",
"description":"Sending WHATSAPP message with INTERACTIVE URL BUTTON content.",
"value":{
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"send reply header text",
"type":"IMAGE",
"url":"https://www.url.com/assets/image.jpg"
},
"body":{
"text":"send reply body text"
},
"footer":{
"text":"send reply footer text"
},
"action":{
"buttons":[
{
"id":"postback 1",
"title":"button 1",
"type":"BUTTON"
},
{
"id":"postback 2",
"title":"button 2",
"type":"BUTTON"
}
]
},
"type":"BUTTON"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE BUTTONS content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE BUTTONS content.",
"description":"Sending WHATSAPP message with INTERACTIVE BUTTONS content.",
"value":{
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"send reply header text",
"type":"TEXT"
},
"body":{
"text":"send reply body text"
},
"footer":{
"text":"send reply footer text"
},
"action":{
"displayText":"display text",
"url":"http://localhost:8000"
},
"type":"URL_BUTTON"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE LIST content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE LIST content.",
"description":"Sending WHATSAPP message with INTERACTIVE LIST content.",
"value":{
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"header text",
"type":"TEXT"
},
"body":{
"text":"body text"
},
"footer":{
"text":"footer text"
},
"action":{
"button":"options",
"sections":[
{
"title":"section1 title",
"rows":[
{
"id":"row1.1",
"title":"title1.1",
"description":"description1.1"
},
{
"id":"row1.2",
"title":"title1.2",
"description":"description1.2"
}
]
},
{
"title":"section2 title",
"rows":[
{
"id":"row2.1",
"title":"title2.1",
"description":"description2.1"
}
]
}
]
},
"type":"LIST"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE FLOW content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE FLOW content.",
"description":"Sending WHATSAPP message with INTERACTIVE FLOW content.",
"value":{
"from":"447701408772",
"to":"420951141432",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"header text",
"type":"TEXT"
},
"body":{
"text":"body text"
},
"footer":{
"text":"footer text"
},
"action":{
"flowActionContent":{
"mode":"PUBLISHED",
"messageVersion":1,
"flowToken":"Flow_token",
"flowId":"98E8D4AA79E2693357FAA",
"callToActionButton":"start",
"flowAction":"DATA_EXCHANGE",
"flowActionPayload":{
"screenId":"av4b064a-ca48-45c7-9384-ccf233fd81ee",
"data":{
"data":"test"
}
}
}
},
"type":"FLOW"
}
}
}
},
"Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.":{
"summary":"Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.",
"description":"Sending WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"document_media_template",
"language":"en",
"header":{
"type":"DOCUMENT",
"url":"https://www.url.com/assets",
"filename":"document.pdf"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"no"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.":{
"summary":"Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.",
"description":"Sending WHATSAPP message with IMAGE MEDIA TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"image_media_template",
"language":"en",
"header":{
"type":"IMAGE",
"url":"https://www.url.com/assets/image.jpg"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"no"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.":{
"summary":"Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.",
"description":"Sending WHATSAPP message with LOCATION MEDIA TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"location_media_template",
"language":"en",
"header":{
"latitude":45.79359,
"longitude":15.94613,
"type":"LOCATION"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"support"
],
"type":"URL"
}
]
}
}
},
"Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.":{
"summary":"Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.",
"description":"Sending WHATSAPP message with VIDEO MEDIA TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"video_media_template",
"language":"en",
"header":{
"type":"VIDEO",
"url":"https://www.url.com/assets/video.avi"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"no"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Sending WHATSAPP message with INTERACTIVE PRODUCT content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE PRODUCT content.",
"description":"Sending WHATSAPP message with INTERACTIVE PRODUCT content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"WHATSAPP_PRODUCT",
"content":{
"body":{
"text":"Test Product 1"
},
"footer":{
"text":"Test footer 1"
},
"action":{
"catalogId":"123456789",
"productRetailerId":"productRetailerId"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.",
"description":"Sending WHATSAPP message with INTERACTIVE MULTI PRODUCT content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"WHATSAPP_MULTI_PRODUCT",
"content":{
"header":{
"text":"Header multi 1"
},
"body":{
"text":"Test Multi Product 1"
},
"footer":{
"text":"Test multi footer 1"
},
"action":{
"catalogId":"123456789",
"sections":[
{
"title":"section 1",
"productItems":[
{
"productRetailerId":"retailerId"
},
{
"productRetailerId":"productRetailerId"
}
]
}
]
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.",
"description":"Sending WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"type":"CALL_PERMISSION_REQUEST"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.",
"description":"Sending WHATSAPP message with INTERACTIVE VOICE BUTTON content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"body":{
"text":"body text"
},
"action":{
"buttonDisplayText":"button display text"
},
"type":"VOICE_BUTTON"
}
}
}
},
"Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.":{
"summary":"Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.",
"description":"Sending WHATSAPP message with INTERACTIVE REQUEST CONTACT INFO BUTTON content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"body":{
"text":"body text"
},
"type":"REQUEST_CONTACT_INFO"
}
}
}
},
"Sending FACEBOOK message with a message tag.":{
"summary":"Sending FACEBOOK message with a message tag.",
"description":"Sending FACEBOOK message with a message tag.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"TEXT",
"content":{
"text":"Text content",
"tag":"ACCOUNT_UPDATE"
}
}
},
"Sending FACEBOOK message with IMAGE content.":{
"summary":"Sending FACEBOOK message with IMAGE content.",
"description":"Sending FACEBOOK message with IMAGE content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg",
"caption":"Image caption"
}
}
},
"Sending FACEBOOK TEXT message with QUICK REPLIES content.":{
"summary":"Sending FACEBOOK TEXT message with QUICK REPLIES content.",
"description":"Sending FACEBOOK TEXT message with QUICK REPLIES content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"TEXT",
"content":{
"text":"test",
"quickReplies":[
{
"type":"TEXT",
"title":"Option 1",
"payload":"Payload 1"
},
{
"type":"PHONE_NUMBER"
},
{
"type":"EMAIL"
}
]
}
}
},
"Sending FACEBOOK TEMPLATE message with CALL BUTTON content.":{
"summary":"Sending FACEBOOK TEMPLATE message with CALL BUTTON content.",
"description":"Sending FACEBOOK TEMPLATE message with CALL BUTTON content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"FACEBOOK_TEMPLATE",
"content":{
"payload":{
"type":"BUTTON",
"text":"payload",
"buttons":[
{
"title":"title",
"payload":"+123456789",
"type":"CALL"
}
]
}
}
}
},
"Sending FACEBOOK TEMPLATE message with URL BUTTON content.":{
"summary":"Sending FACEBOOK TEMPLATE message with URL BUTTON content.",
"description":"Sending FACEBOOK TEMPLATE message with URL BUTTON content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"FACEBOOK_TEMPLATE",
"content":{
"payload":{
"type":"BUTTON",
"text":"payload",
"buttons":[
{
"title":"URL Button title",
"url":"https://www.url.com/assets/url",
"type":"URL"
}
]
}
}
}
},
"Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.":{
"summary":"Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.",
"description":"Sending FACEBOOK TEMPLATE message with POSTBACK BUTTON content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"FACEBOOK_TEMPLATE",
"content":{
"payload":{
"type":"BUTTON",
"text":"payload",
"buttons":[
{
"title":"Yes",
"payload":"Yes",
"type":"POSTBACK"
},
{
"title":"No",
"payload":"No",
"type":"POSTBACK"
}
]
}
}
}
},
"Sending FACEBOOK message with GENERIC TEMPLATE content.":{
"summary":"Sending FACEBOOK message with GENERIC TEMPLATE content.",
"description":"Sending FACEBOOK message with GENERIC TEMPLATE content.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"FACEBOOK_TEMPLATE",
"content":{
"payload":{
"type":"GENERIC",
"text":"payload",
"elements":[
{
"title":"Title 1",
"subtitle":"Subtitle 1",
"imageUrl":"https://www.url.com/assets/image1.jpg",
"defaultAction":"https://www.url.com/assets/action1",
"buttons":[
{
"title":"title",
"payload":"+123456789",
"type":"CALL"
}
]
},
{
"title":"Title 2",
"subtitle":"Subtitle 2",
"imageUrl":"https://www.url.com/assets/image2.jpg",
"defaultAction":"https://www.url.com/assets/action2"
}
]
}
}
}
},
"Sending FACEBOOK TEXT message as a reply to Facebook comment.":{
"summary":"Sending FACEBOOK TEXT message as a reply to Facebook comment.",
"description":"Sending FACEBOOK TEXT message as a reply to Facebook comment.",
"value":{
"from":"113628916991966",
"to":"4394903220582780",
"channel":"FACEBOOK_MESSENGER",
"contentType":"PRIVATE_REPLY_TO_SOCIAL_COMMENT",
"content":{
"externalMessageId":"123456789",
"contentType":"TEXT",
"content":{
"text":"Hello, how can I help you?"
}
}
}
},
"Sending FACEBOOK POST TEXT message as a reply to Facebook comment.":{
"summary":"Sending FACEBOOK POST TEXT message as a reply to Facebook comment.",
"description":"Sending FACEBOOK POST TEXT message as a reply to Facebook comment.",
"value":{
"from":"342927978961470",
"to":"8278368984819644",
"channel":"FACEBOOK_POST",
"contentType":"TEXT",
"content":{
"text":"This is a text example for message send via API."
}
}
},
"Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.":{
"summary":"Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.",
"description":"Sending FACEBOOK POST TEXT message with mentions as a reply to Facebook comment.",
"value":{
"from":"342927978961470",
"to":"8278368984819644",
"channel":"FACEBOOK_POST",
"contentType":"TEXT",
"content":{
"socialMentions":[
{
"startPosition":0,
"endPosition":9,
"userExternalId":"151848451515"
}
],
"text":"@John.Doe This is a text example for message send via API."
}
}
},
"Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.":{
"summary":"Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.",
"description":"Sending INSTAGRAM POST TEXT message as a reply to Facebook comment.",
"value":{
"from":"342927978141470",
"to":"8278368984819678",
"channel":"INSTAGRAM_POST",
"contentType":"TEXT",
"content":{
"text":"This is a text example for message send via API."
}
}
},
"Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.":{
"summary":"Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.",
"description":"Sending INSTAGRAM POST TEXT message with mentions as a reply to Instagram comment.",
"value":{
"from":"342927978141470",
"to":"8278368984819678",
"channel":"INSTAGRAM_POST",
"contentType":"TEXT",
"content":{
"socialMentions":[
{
"startPosition":0,
"endPosition":9,
"userExternalId":"john.doe"
}
],
"text":"@John.Doe This is a text example for message send via API."
}
}
},
"Sending LIVE CHAT message with TEXT content.":{
"summary":"Sending LIVE CHAT message with TEXT content.",
"description":"Sending LIVE CHAT message with TEXT content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"TEXT",
"content":{
"text":"Text content."
}
}
},
"Sending LIVE CHAT message with LC_QUICK_REPLY content.":{
"summary":"Sending LIVE CHAT message with LC_QUICK_REPLY content.",
"description":"Sending LIVE CHAT message with LC_QUICK_REPLY content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"LC_QUICK_REPLY",
"content":{
"suggestedReplies":[
"Yes",
"No"
],
"sourceType":"TEXT",
"source":{
"text":"Ready to ask?"
}
}
}
},
"Sending LIVE CHAT message with BUTTON content.":{
"summary":"Sending LIVE CHAT message with BUTTON content.",
"description":"Sending LIVE CHAT message with BUTTON content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"BUTTON",
"content":{
"buttonType":"LIVECHAT",
"button":{
"text":"Try options below:",
"buttonPayloads":[
{
"title":"Yes",
"type":"POSTBACK",
"payload":"Yes"
},
{
"title":"No",
"type":"POSTBACK",
"payload":"No"
},
{
"title":"Google",
"type":"URL",
"payload":"https://google.com"
}
]
}
}
}
},
"Sending LIVE CHAT message with VIDEO content.":{
"summary":"Sending LIVE CHAT message with VIDEO content.",
"description":"Sending LIVE CHAT message with VIDEO content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"VIDEO",
"content":{
"caption":null,
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Sending LIVE CHAT message with IMAGE content.":{
"summary":"Sending LIVE CHAT message with IMAGE content.",
"description":"Sending LIVE CHAT message with IMAGE content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"IMAGE",
"content":{
"caption":null,
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Sending LIVE CHAT message with DOCUMENT content.":{
"summary":"Sending LIVE CHAT message with DOCUMENT content.",
"description":"Sending LIVE CHAT message with DOCUMENT content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"DOCUMENT",
"content":{
"caption":null,
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Sending LIVE CHAT message with LC_CAROUSEL content.":{
"summary":"Sending LIVE CHAT message with LC_CAROUSEL content.",
"description":"Sending LIVE CHAT message with LC_CAROUSEL content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"LC_CAROUSEL",
"content":{
"cards":[
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
},
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
}
]
}
}
},
"Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.":{
"summary":"Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.",
"description":"Sending LIVE CHAT message with LC_CAROUSEL message with QUICK REPLIES content.",
"value":{
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"contentType":"LC_CAROUSEL",
"content":{
"cards":[
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
},
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
}
],
"quickReplies":[
"quick",
"replies"
]
}
}
},
"Sending LIVE CHAT message with CUSTOM_DATA content.":{
"summary":"Sending LIVE CHAT message with CUSTOM_DATA content.",
"description":"Sending LIVE CHAT message with CUSTOM_DATA content.",
"value":{
"from":"c7c43fc4-0117-49c4-a1a3-2a527f413649",
"to":"57d2edb7-e64f-410c-90ec-f88c0ad59fd0",
"channel":"LIVE_CHAT",
"contentType":"CUSTOM_DATA",
"content":{
"agentMessage":"Message to be displayed to the agent.",
"userMessage":"Message to be displayed to the user.",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
},
"Sending TELEGRAM message with IMAGE content.":{
"summary":"Sending TELEGRAM message with IMAGE content.",
"description":"Sending TELEGRAM message with IMAGE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"TELEGRAM",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets",
"caption":"image.jpg"
}
}
},
"Sending TELEGRAM TEXT message with REPLY BUTTON content.":{
"summary":"Sending TELEGRAM TEXT message with REPLY BUTTON content.",
"description":"Sending TELEGRAM TEXT message with REPLY BUTTON content.",
"value":{
"from":"1234567890",
"to":"0987654321",
"channel":"TELEGRAM",
"contentType":"TEXT",
"content":{
"text":"Please share your contact data.",
"replyMarkup":{
"keyboard":[
[
{
"text":"Share contact information",
"type":"TEXT_WITH_CONTACT"
}
]
],
"resizeKeyboard":true,
"oneTimeKeyboard":true,
"selective":false,
"input_field_placeholder":"Placeholder text",
"type":"REPLY_KEYBOARD_MARKUP_V2"
}
}
}
},
"Sending VIBER BOT TEXT message with KEYBOARD content.":{
"summary":"Sending VIBER BOT TEXT message with KEYBOARD content.",
"description":"Sending VIBER BOT TEXT message with KEYBOARD content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"TEXT",
"content":{
"text":"hello world",
"keyboard":{
"backgroundColor":"#333333",
"actionBarState":"HIDDEN",
"buttonGrid":{
"buttonsGroupColumns":6,
"buttonsGroupRows":4,
"buttons":[
{
"action":{
"actionBody":"Button postback 1",
"actionType":"REPLY"
},
"columns":6,
"rows":1,
"text":{
"text":"Button 1"
},
"background":{
"color":"#00ffff"
}
},
{
"action":{
"actionBody":"Button postback 2",
"actionType":"REPLY"
},
"columns":6,
"rows":2,
"text":{
"text":"Button 2"
},
"background":{
"color":"#00ff00"
}
},
{
"action":{
"actionBody":"Button postback 3",
"actionType":"REPLY"
},
"columns":6,
"rows":1,
"text":{
"text":"Button 3"
},
"background":{
"color":"#ffff80"
}
}
]
}
}
}
}
},
"Sending VIBER BOT message with IMAGE content.":{
"summary":"Sending VIBER BOT message with IMAGE content.",
"description":"Sending VIBER BOT message with IMAGE content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Sending VIBER BOT message with VIDEO content.":{
"summary":"Sending VIBER BOT message with VIDEO content.",
"description":"Sending VIBER BOT message with VIDEO content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"VIBER_BOT_VIDEO",
"content":{
"url":"https://www.url.com/assets/video.avi",
"size":"1500"
}
}
},
"Sending VIBER BOT message with CONTACT content.":{
"summary":"Sending VIBER BOT message with CONTACT content.",
"description":"Sending VIBER BOT message with CONTACT content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"CONTACT",
"content":{
"contacts":[
{
"name":{
"firstName":"Infobip",
"formattedName":"Infobip"
},
"phones":[
{
"phone":"123456",
"type":"CELL",
"waId":"123456"
}
],
"emails":[
{
"email":"email@infobip.com",
"type":"EMAIL"
}
]
}
]
}
}
},
"Sending VIBER BOT message with LOCATION content.":{
"summary":"Sending VIBER BOT message with LOCATION content.",
"description":"Sending VIBER BOT message with LOCATION content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"LOCATION",
"content":{
"latitude":44.953,
"longitude":13.8564
}
}
},
"Sending VIBER BOT message with CAROUSEL content.":{
"summary":"Sending VIBER BOT message with CAROUSEL content.",
"description":"Sending VIBER BOT message with CAROUSEL content.",
"value":{
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"contentType":"VIBER_BOT_CAROUSEL",
"content":{
"heightScale":100,
"buttonGrid":{
"buttonsGroupColumns":3,
"buttonsGroupRows":4,
"buttons":[
{
"columns":3,
"rows":2,
"media":{
"imageUrl":"https://url.com/assets/image1.png",
"imageScaleType":"FIT"
},
"action":{
"actionBody":"image 1 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Example 1",
"size":"LARGE",
"horizontalAlign":"CENTER",
"verticalAlign":"MIDDLE"
},
"action":{
"actionBody":"Example 1 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Buy this one"
},
"background":{
"color":"#ff0000",
"frame":{
"cornerRadius":4
}
},
"action":{
"actionBody":"Buy Example 1",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":2,
"media":{
"imageUrl":"https://url.com/assets/image2.png",
"imageScaleType":"CROP"
},
"action":{
"actionBody":"image 2 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Example 2",
"size":"LARGE",
"horizontalAlign":"CENTER",
"verticalAlign":"MIDDLE"
},
"action":{
"actionBody":"Example 2 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Buy this one"
},
"background":{
"color":"#ff0000",
"frame":{
"cornerRadius":4
}
},
"action":{
"actionBody":"Buy Example 2",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":2,
"media":{
"imageUrl":"https://url.com/assets/image3.png",
"imageScaleType":"FIT"
},
"action":{
"actionBody":"image 3 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Example 3",
"size":"LARGE",
"horizontalAlign":"CENTER",
"verticalAlign":"MIDDLE"
},
"action":{
"actionBody":"Example 3 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Buy this one"
},
"background":{
"color":"#ff0000",
"frame":{
"cornerRadius":4
}
},
"action":{
"actionBody":"Buy Example 3",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":2,
"media":{
"imageUrl":"https://url.com/assets/image4.png"
},
"action":{
"actionBody":"image 4 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Example 4",
"size":"LARGE",
"horizontalAlign":"CENTER",
"verticalAlign":"MIDDLE"
},
"action":{
"actionBody":"Example 4 clicked",
"actionType":"REPLY"
}
},
{
"columns":3,
"rows":1,
"text":{
"text":"Buy this one"
},
"action":{
"actionBody":"Buy Example 4",
"actionType":"REPLY"
}
}
]
},
"fromDetails":{
"name":"Example Name"
}
}
}
},
"Sending INSTAGRAM MESSAGING message with TEMPLATE content.":{
"summary":"Sending INSTAGRAM MESSAGING message with TEMPLATE content.",
"description":"Sending INSTAGRAM MESSAGING message with TEMPLATE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"contentType":"INSTAGRAM_TEMPLATE",
"content":{
"payload":{
"elements":[
{
"title":"title 1",
"subtitle":"subtitle",
"imageUrl":"https://url.com/assets/image1.png",
"defaultAction":{
"url":"https://url.com/assets/profile1/default"
},
"buttons":[
{
"title":"Title",
"payload":"https://url.com/assets/buttons1.png",
"type":"URL"
},
{
"title":"button postback",
"payload":"payload",
"type":"POSTBACK"
}
]
},
{
"title":"title 2",
"subtitle":"subtitle",
"imageUrl":"https://url.com/assets/image2.png",
"defaultAction":{
"url":"https://url.com/assets/profile2/default"
},
"buttons":[
{
"title":"button postback 2",
"payload":"payload 2",
"type":"POSTBACK"
}
]
}
],
"type":"GENERIC"
}
}
}
},
"Sending INSTAGRAM MESSAGING message with TEXT content.":{
"summary":"Sending INSTAGRAM MESSAGING message with TEXT content.",
"description":"Sending INSTAGRAM MESSAGING message with TEXT content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"contentType":"TEXT",
"content":{
"text":"What type of services do you specialise in?"
}
}
},
"Sending INSTAGRAM MESSAGING message with IMAGE content.":{
"summary":"Sending INSTAGRAM MESSAGING message with IMAGE content.",
"description":"Sending INSTAGRAM MESSAGING message with IMAGE content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.":{
"summary":"Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.",
"description":"Sending INSTAGRAM MESSAGING message with INSTAGRAM_STICKER content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"contentType":"INSTAGRAM_STICKER",
"content":{
"sticker":"like_heart"
}
}
},
"Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.":{
"summary":"Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.",
"description":"Sending INSTAGRAM MESSAGING message with QUICK REPLIES content.",
"value":{
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"contentType":"TEXT",
"content":{
"text":"test",
"quickReplies":[
{
"type":"TEXT",
"title":"Option 1",
"payload":"Payload 1"
},
{
"type":"PHONE_NUMBER"
},
{
"type":"EMAIL"
}
]
}
}
},
"Sending LINE TEMPLATE message with BUTTONS content.":{
"summary":"Sending LINE TEMPLATE message with BUTTONS content.",
"description":"Sending LINE TEMPLATE message with BUTTONS content.",
"value":{
"from":"1654088914",
"to":"Ud1c123456789abcd12345efd7aa01234",
"channel":"LINE",
"contentType":"LINE_TEMPLATE",
"content":{
"type":"LINE_TEMPLATE",
"altText":"Buttons template with custom actions",
"template":{
"type":"BUTTONS",
"thumbnailImageUrl":"https://url.com/assets/image.png",
"imageAspectRatio":"RECTANGLE",
"imageSize":"COVER",
"imageBackgroundColor":"#FFFFFF",
"title":"Payload title",
"text":"Payload text",
"defaultAction":{
"type":"URI",
"label":"Example uri action",
"uri":"https://url.com/assets/defaults/action"
},
"actions":[
{
"type":"URI",
"label":"URI action",
"uri":"https://url.com/assets/action1"
},
{
"type":"DATETIMEPICKER",
"label":"Picker action",
"data":"Action data",
"mode":"DATETIME",
"min":"2024-01-01T00:00",
"max":"2024-12-01T00:00"
},
{
"type":"POSTBACK",
"label":"Postback action",
"data":"action=buy&itemid=123"
}
]
}
}
}
},
"Sending LINE TEMPLATE message with CAROUSEL content.":{
"summary":"Sending LINE TEMPLATE message with CAROUSEL content.",
"description":"Sending LINE TEMPLATE message with CAROUSEL content.",
"value":{
"from":"1654088914",
"to":"Ud1c123456789abcd12345efd7aa01234",
"channel":"LINE",
"contentType":"LINE_TEMPLATE",
"content":{
"altText":"Carousel template with custom actions",
"template":{
"type":"CAROUSEL",
"imageAspectRatio":"SQUARE",
"imageSize":"CONTAIN",
"columns":[
{
"thumbnailImageUrl":"https://url.com/assets/image1.png",
"imageBackgroundColor":"#FFFFFF",
"title":"Column 1 title",
"text":"Column 1 text",
"defaultAction":{
"type":"URI",
"label":"View detail 1",
"uri":"https://url.com/assets/defaults/action1"
},
"actions":[
{
"type":"URI",
"label":"View detail 1",
"uri":"https://url.com/assets/action1"
},
{
"type":"POSTBACK",
"label":"Buy item 1",
"data":"action=buy&itemid=1"
}
]
},
{
"thumbnailImageUrl":"https://url.com/assets/image2.png",
"imageBackgroundColor":"#BBBBBB",
"title":"Column 2 title",
"text":"Column 2 text",
"defaultAction":{
"type":"URI",
"label":"View detail 2",
"uri":"https://url.com/assets/defaults/action2"
},
"actions":[
{
"type":"URI",
"label":"View detail 2",
"uri":"https://url.com/assets/action2"
},
{
"type":"POSTBACK",
"label":"Buy item 2",
"data":"action=buy&itemid=2"
}
]
}
]
}
}
}
},
"Sending APPLE BUSINESS CHAT message with TEXT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with TEXT content.",
"description":"Sending APPLE BUSINESS CHAT message with TEXT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"TEXT",
"content":{
"text":"This is a text example for Apple Business Chat."
}
}
},
"Sending APPLE BUSINESS CHAT message with IMAGE content.":{
"summary":"Sending APPLE BUSINESS CHAT message with IMAGE content.",
"description":"Sending APPLE BUSINESS CHAT message with IMAGE content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Sending APPLE BUSINESS CHAT message with LOCATION content.":{
"summary":"Sending APPLE BUSINESS CHAT message with LOCATION content.",
"description":"Sending APPLE BUSINESS CHAT message with LOCATION content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"LOCATION",
"content":{
"latitude":-12.34,
"longitude":34.56,
"locationName":"Location Name",
"address":"Address Name"
}
}
},
"Sending APPLE BUSINESS CHAT message with VIDEO content.":{
"summary":"Sending APPLE BUSINESS CHAT message with VIDEO content.",
"description":"Sending APPLE BUSINESS CHAT message with VIDEO content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"VIDEO",
"content":{
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Sending APPLE BUSINESS CHAT message with DOCUMENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with DOCUMENT content.",
"description":"Sending APPLE BUSINESS CHAT message with DOCUMENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"DOCUMENT",
"content":{
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Sending APPLE BUSINESS CHAT message with LIST_PICKER content.":{
"summary":"Sending APPLE BUSINESS CHAT message with LIST_PICKER content.",
"description":"Sending APPLE BUSINESS CHAT message with LIST_PICKER content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"LIST_PICKER",
"content":{
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"item1ImageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"item1ImageIdentifier2"
},
{
"imageUrl":"https://www.url.com/assets/image3.jpg",
"identifier":"item2ImageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image4.jpg",
"identifier":"item2ImageIdentifier2"
}
],
"appleListPicker":{
"sections":[
{
"items":[
{
"identifier":"item1Identifier1",
"imageIdentifier":"item1ImageIdentifier1",
"order":0,
"style":"icon",
"subtitle":"item1Subtitle1",
"title":"item1Title1"
},
{
"identifier":"item1Identifier2",
"imageIdentifier":"item1ImageIdentifier2",
"order":1,
"style":"icon",
"subtitle":"item1Subtitle2",
"title":"item1Title2"
}
],
"order":0,
"title":"sectionTitle1",
"multipleSelection":false
},
{
"items":[
{
"identifier":"item2Identifier1",
"imageIdentifier":"item2ImageIdentifier1",
"order":0,
"style":"icon",
"subtitle":"item2Subtitle1",
"title":"item2Title1"
},
{
"identifier":"item2Identifier2",
"imageIdentifier":"item2ImageIdentifier2",
"order":1,
"style":"icon",
"subtitle":"item2Subtitle2",
"title":"item2Title2"
}
],
"order":1,
"title":"sectionTitle2",
"multipleSelection":true
}
]
},
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Sending APPLE BUSINESS CHAT message with RICH_LINK content.":{
"summary":"Sending APPLE BUSINESS CHAT message with RICH_LINK content.",
"description":"Sending APPLE BUSINESS CHAT message with RICH_LINK content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"RICH_LINK",
"content":{
"linkUrl":"https://www.url.com/assets/link",
"linkTitle":"Title",
"imageUrl":"https://www.url.com/assets/image.jpg",
"videoUrl":"https://www.url.com/assets/video.avi"
}
}
},
"Sending APPLE BUSINESS CHAT message with TIME_PICKER content.":{
"summary":"Sending APPLE BUSINESS CHAT message with TIME_PICKER content.",
"description":"Sending APPLE BUSINESS CHAT message with TIME_PICKER content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"TIME_PICKER",
"content":{
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"imageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"imageIdentifier2"
}
],
"event":{
"identifier":"eventIdentifier",
"title":"eventTitle",
"timeslots":[
{
"duration":12,
"startTime":1662045024085,
"identifier":"timeslotIdentifier1"
},
{
"duration":13,
"startTime":1662045024086,
"identifier":"timeslotIdentifier2"
}
],
"locationItem":{
"latitude":1.23,
"longitude":4.56,
"radius":7.89,
"title":"locationItemTitle"
},
"imageIdentifier":"imageIdentifier",
"timezoneOffset":1
},
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.",
"description":"Sending APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"APPLE_QUICK_REPLY_CONTENT",
"content":{
"quickReply":{
"summary":"quick reply summary",
"items":[
{
"identifier":"quickReplyItem1Identifier",
"title":"quickReplyItem1Title"
},
{
"identifier":"quickReplyItem2Identifier",
"title":"quickReplyItem2Title"
}
]
},
"requestIdentifier":"requestIdentifier1"
}
}
},
"Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.",
"description":"Sending APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"APPLE_FORM_CONTENT",
"content":{
"data":{
"pages":[
{
"type":"DATE_PICKER",
"pageIdentifier":"page1Identifier",
"subtitle":"page1Subtitle",
"nextPageIdentifier":"page1NextIdentifier",
"title":"page1Title",
"submitForm":true,
"options":{
"dateFormat":"UTF-8",
"startDate":"2022-08-15",
"maximumDate":"2022-08-01",
"minimumDate":"2022-08-31",
"labelText":"datePickerLabelText"
}
},
{
"type":"INPUT",
"pageIdentifier":"page2Identifier",
"subtitle":"page2Subtitle",
"nextPageIdentifier":"page2NextIdentifier",
"title":"page2Title",
"submitForm":true,
"hintText":"page2HintText",
"options":{
"regex":"inputRegex",
"placeholder":"inputPlaceholder",
"required":true,
"inputType":"multiline",
"labelText":"inputLabelText",
"prefixText":"inputLabelPrefixText",
"maximumCharacterCount":1,
"keyboardType":"namePhonePad",
"appleTextContentType":"namePrefix"
}
},
{
"type":"PICKER",
"items":[
{
"title":"item1Title",
"value":"item1Value",
"identifier":"item1Identifier"
},
{
"title":"item2Title",
"value":"item2Value",
"identifier":"item2Identifier"
}
],
"pageIdentifier":"page3Identifier",
"subtitle":"page3Subtitle",
"nextPageIdentifier":"page3NextIdentifier",
"title":"page3Title",
"submitForm":false,
"pickerTitle":"page3PickerTitle",
"selectedItemIndex":2
},
{
"type":"SELECT",
"items":[
{
"identifier":"item1Identifier",
"title":"item1Title",
"value":"item1Value",
"nextPageIdentifier":"item1NextIdentifier",
"imageIdentifier":"item1ImageIdentifier"
},
{
"identifier":"item2Identifier",
"title":"item2Title",
"value":"item2Value",
"nextPageIdentifier":"item2NextIdentifier",
"imageIdentifier":"item2ImageIdentifier"
}
],
"pageIdentifier":"page4Identifier",
"subtitle":"page4Subtitle",
"nextPageIdentifier":"page4NextIdentifier",
"title":"page4Title",
"submitForm":true,
"multipleSelection":false
}
],
"startPageIdentifier":"dataIdentifier",
"splash":{
"buttonTitle":"splash button title",
"splashText":"splash text",
"header":"splash header",
"imageIdentifier":"splash image identifier"
},
"isPrivate":false,
"showSummary":true
},
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"imageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"imageIdentifier2"
}
],
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.",
"description":"Sending APPLE BUSINESS CHAT message with APPLE_PAY_REQUEST_CONTENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"APPLE_PAY_REQUEST_CONTENT",
"content":{
"images":[
{
"imageUrl":"url_1",
"identifier":"imageIdentifier_1"
},
{
"imageUrl":"url_2",
"identifier":"imageIdentifier_2"
}
],
"receivedMessage":{
"style":"SMALL",
"title":"title_received",
"subtitle":"subtitle_received",
"imageIdentifier":"imageIdentifier_1"
},
"replyMessage":{
"style":"SMALL",
"title":"title_reply",
"subtitle":"subtitle_reply",
"imageIdentifier":"imageIdentifier_2"
},
"lineItems":[
{
"label":"item1",
"amount":"0.1",
"type":"Pending"
},
{
"label":"item2",
"amount":"1.1",
"type":"Final"
},
{
"label":"item3",
"amount":"1111000.992",
"type":"Pending"
}
],
"total":{
"label":"ApplePayLineItem",
"amount":"22.09",
"type":"Pending"
},
"shippingMethods":[
{
"amount":"15.02",
"detail":"shippingMethodDetail1",
"identifier":"identifier1",
"label":"label1"
},
{
"amount":"20.10",
"detail":"shippingMethodDetail2",
"identifier":"identifier2",
"label":"label2"
}
],
"requestIdentifier":"requestIdentifier_1"
}
}
},
"Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.",
"description":"Sending APPLE BUSINESS CHAT message with APPLE_AUTH_REQUEST_CONTENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"APPLE_AUTH_REQUEST_CONTENT",
"content":{
"images":[
{
"imageUrl":"url_1",
"identifier":"imageIdentifier_1"
},
{
"imageUrl":"url_2",
"identifier":"imageIdentifier_2"
}
],
"requestIdentifier":"requestIdentifier_1",
"receivedMessage":{
"style":"SMALL",
"title":"title_received",
"subtitle":"subtitle_received",
"imageIdentifier":"imageIdentifier_1"
},
"replyMessage":{
"style":"SMALL",
"title":"title_reply",
"subtitle":"subtitle_reply",
"imageIdentifier":"imageIdentifier_2"
}
}
}
},
"Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.":{
"summary":"Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.",
"description":"Sending APPLE BUSINESS CHAT message with APPLE_CUSTOM_INTERACTIVE_CONTENT content.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"contentType":"APPLE_CUSTOM_INTERACTIVE_CONTENT",
"content":{
"receivedMessage":{
"style":"SMALL",
"title":"title_received",
"subtitle":"subtitle_received",
"imageIdentifier":"imageIdentifier_1"
},
"replyMessage":{
"style":"SMALL",
"title":"title_reply",
"subtitle":"subtitle_reply",
"imageIdentifier":"imageIdentifier_2"
}
}
}
},
"Sending EMAIL message with EMAIL html content.":{
"summary":"Sending EMAIL message with EMAIL html content.",
"description":"Sending EMAIL message with EMAIL html content.",
"value":{
"from":"sender@example.com",
"to":"toRecipient1@example.com",
"channel":"EMAIL",
"contentType":"EMAIL",
"content":{
"toAddresses":[
"toRecipient1@example.com",
"toRecipient2@example.com"
],
"ccAddresses":[
"ccrecipient@example.com"
],
"bccAddresses":[
"bccrecipient@example.com"
],
"subject":"Sample Email Subject",
"contentHtml":"This is a sample email content."
}
}
},
"Sending EMAIL message with EMAIL text content.":{
"summary":"Sending EMAIL message with EMAIL text content.",
"description":"Sending EMAIL message with EMAIL text content.",
"value":{
"from":"sender@example.com",
"to":"toRecipient1@example.com",
"channel":"EMAIL",
"contentType":"EMAIL",
"content":{
"toAddresses":[
"toRecipient1@example.com",
"toRecipient2@example.com"
],
"ccAddresses":[
"ccRecipient@example.com"
],
"bccAddresses":[
"bccRecipient@example.com"
],
"subject":"Sample Email Subject",
"contentText":"This is a sample of the email content."
}
}
},
"Sending RCS message with TEXT content.":{
"summary":"Sending RCS message with TEXT content.",
"description":"Sending RCS message with TEXT content.",
"value":{
"from":"infobip",
"to":"385989295741",
"channel":"RCS",
"contentType":"TEXT",
"content":{
"text":"Test reply"
}
}
},
"Sending RCS message with FILE content.":{
"summary":"Sending RCS message with FILE content.",
"description":"Sending RCS message with FILE content.",
"value":{
"from":"infobip",
"to":"385989295741",
"channel":"RCS",
"contentType":"RCS_FILE",
"content":{
"file":{
"url":"https://url.com/assets/document.pdf"
},
"thumbnail":{
"url":"https://url.com/assets/thumbnail.pdf"
}
}
}
},
"Sending RCS message with CARD content.":{
"summary":"Sending RCS message with CARD content.",
"description":"Sending RCS message with CARD content.",
"value":{
"from":"infobip",
"to":"385989295741",
"channel":"RCS",
"contentType":"RCS_CARD",
"content":{
"orientation":"HORIZONTAL",
"alignment":"RIGHT",
"content":{
"title":"rcs card title",
"description":"rcs card description",
"media":{
"file":{
"url":"https://url.com/assets/image1.png"
},
"thumbnail":{
"url":"https://url.com/assets/image2.png"
},
"height":"MEDIUM"
}
}
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse"
},
"examples":{
"Successful response APPLE BUSINESS CHAT message with TEXT.":{
"summary":"Successful response APPLE BUSINESS CHAT message with TEXT.",
"description":"Successful response APPLE BUSINESS CHAT message with TEXT.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"This is a text example for Apple Business Chat."
}
}
},
"Successful response APPLE BUSINESS CHAT message with IMAGE.":{
"summary":"Successful response APPLE BUSINESS CHAT message with IMAGE.",
"description":"Successful response APPLE BUSINESS CHAT message with IMAGE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Successful response APPLE BUSINESS CHAT message with LOCATION.":{
"summary":"Successful response APPLE BUSINESS CHAT message with LOCATION.",
"description":"Successful response APPLE BUSINESS CHAT message with LOCATION.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LOCATION",
"content":{
"latitude":-12.34,
"longitude":34.56,
"locationName":"Location Name",
"address":"Address Name"
}
}
},
"Successful response APPLE BUSINESS CHAT message with VIDEO.":{
"summary":"Successful response APPLE BUSINESS CHAT message with VIDEO.",
"description":"Successful response APPLE BUSINESS CHAT message with VIDEO.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"VIDEO",
"content":{
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Successful response APPLE BUSINESS CHAT message with DOCUMENT.":{
"summary":"Successful response APPLE BUSINESS CHAT message with DOCUMENT.",
"description":"Successful response APPLE BUSINESS CHAT message with DOCUMENT.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"DOCUMENT",
"content":{
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Successful response APPLE BUSINESS CHAT message with LIST_PICKER.":{
"summary":"Successful response APPLE BUSINESS CHAT message with LIST_PICKER.",
"description":"Successful response APPLE BUSINESS CHAT message with LIST_PICKER.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LIST_PICKER",
"content":{
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"imageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"imageIdentifier2"
}
],
"appleListPicker":{
"sections":[
{
"items":[
{
"identifier":"item1Identifier1",
"imageIdentifier":"item1ImageIdentifier1",
"order":0,
"style":"item1Style1",
"subtitle":"item1Subtitle1",
"title":"item1Title1"
},
{
"identifier":"item1Identifier2",
"imageIdentifier":"item1ImageIdentifier2",
"order":1,
"style":"item1Style2",
"subtitle":"item1Subtitle2",
"title":"item1Title2"
}
],
"order":0,
"title":"sectionTitle1",
"multipleSelection":false
},
{
"items":[
{
"identifier":"item2Identifier1",
"imageIdentifier":"item2ImageIdentifier1",
"order":0,
"style":"item2Style1",
"subtitle":"item2Subtitle1",
"title":"item2Title1"
},
{
"identifier":"item2Identifier2",
"imageIdentifier":"item2ImageIdentifier2",
"order":1,
"style":"item2Style2",
"subtitle":"item2Subtitle2",
"title":"item2Title2"
}
],
"order":1,
"title":"sectionTitle2",
"multipleSelection":true
}
]
},
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Successful response APPLE BUSINESS CHAT message with RICH_LINK.":{
"summary":"Successful response APPLE BUSINESS CHAT message with RICH_LINK.",
"description":"Successful response APPLE BUSINESS CHAT message with RICH_LINK.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"RICH_LINK",
"content":{
"linkUrl":"https://www.url.com/assets/link",
"linkTitle":"Title",
"imageUrl":"https://www.url.com/assets/image.jpg",
"videoUrl":"https://www.url.com/assets/video.avi"
}
}
},
"Successful response APPLE BUSINESS CHAT message with TIME_PICKER.":{
"summary":"Successful response APPLE BUSINESS CHAT message with TIME_PICKER.",
"description":"Successful response APPLE BUSINESS CHAT message with TIME_PICKER.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TIME_PICKER",
"content":{
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"imageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"imageIdentifier2"
}
],
"event":{
"identifier":"eventIdentifier",
"title":"eventTitle",
"timeslots":[
{
"duration":12,
"startTime":"2022-09-01T15:10:24.085Z",
"identifier":"timeslotIdentifier1"
},
{
"duration":13,
"startTime":"2022-09-01T15:10:24.086Z",
"identifier":"timeslotIdentifier2"
}
],
"locationItem":{
"latitude":1.23,
"longitude":4.56,
"radius":7.89,
"title":"locationItemTitle"
},
"imageIdentifier":"imageIdentifier",
"timezoneOffset":1
},
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.":{
"summary":"Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.",
"description":"Successful response APPLE BUSINESS CHAT message with APPLE_QUICK_REPLY_CONTENT.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TIME_PICKER",
"content":{
"quickReply":{
"summaryText":null,
"items":[
{
"identifier":"quickReplyItem1Identifier",
"title":"quickReplyItem1Title"
},
{
"identifier":"quickReplyItem2Identifier",
"title":"quickReplyItem2Title"
}
]
},
"requestIdentifier":"requestIdentifier1"
}
}
},
"Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.":{
"summary":"Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.",
"description":"Successful response APPLE BUSINESS CHAT message with APPLE_FORM_CONTENT.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"APPLE_FORM_CONTENT",
"content":{
"data":{
"pages":[
{
"pageIdentifier":"page1Identifier",
"subtitle":"page1Subtitle",
"nextPageIdentifier":"page1NextIdentifier",
"title":"page1Title",
"submitForm":true,
"options":{
"dateFormat":"UTF-8",
"startDate":"2022-08-15",
"maximumDate":"2022-08-01",
"minimumDate":"2022-08-31",
"labelText":"datePickerLabelText"
},
"type":"DATE_PICKER"
},
{
"pageIdentifier":"page2Identifier",
"subtitle":"page2Subtitle",
"nextPageIdentifier":"page2NextIdentifier",
"title":"page2Title",
"submitForm":true,
"hintText":"page2HintText",
"options":{
"regex":"inputRegex",
"placeholder":"inputPlaceholder",
"required":true,
"inputType":"multiline",
"labelText":"inputLabelText",
"prefixText":"inputLabelPrefixText",
"maximumCharacterCount":1,
"keyboardType":"namePhonePad",
"appleTextContentType":"namePrefix"
},
"type":"INPUT"
},
{
"items":[
{
"title":"item1Title",
"value":"item1Value",
"identifier":"item1Identifier"
},
{
"title":"item2Title",
"value":"item2Value",
"identifier":"item2Identifier"
}
],
"pageIdentifier":"page3Identifier",
"subtitle":"page3Subtitle",
"nextPageIdentifier":"page3NextIdentifier",
"title":"page3Title",
"submitForm":false,
"pickerTitle":"page3PickerTitle",
"selectedItemIndex":2,
"type":"PICKER"
},
{
"items":[
{
"identifier":"item1Identifier",
"title":"item1Title",
"value":"item1Value",
"nextPageIdentifier":"item1NextIdentifier",
"imageIdentifier":"item1ImageIdentifier"
},
{
"identifier":"item2Identifier",
"title":"item2Title",
"value":"item2Value",
"nextPageIdentifier":"item2NextIdentifier",
"imageIdentifier":"item2ImageIdentifier"
}
],
"pageIdentifier":"page4Identifier",
"subtitle":"page4Subtitle",
"nextPageIdentifier":"page4NextIdentifier",
"title":"page4Title",
"submitForm":true,
"multipleSelection":false,
"type":"SELECT"
}
],
"startPageIdentifier":"dataIdentifier",
"splash":{
"buttonTitle":"splash button title",
"splashText":"splash text",
"header":"splash header",
"imageIdentifier":"splash image identifier"
},
"isPrivate":false,
"showSummary":true,
"private":false
},
"images":[
{
"imageUrl":"https://www.url.com/assets/image1.jpg",
"identifier":"imageIdentifier1"
},
{
"imageUrl":"https://www.url.com/assets/image2.jpg",
"identifier":"imageIdentifier2"
}
],
"requestIdentifier":"requestIdentifier1",
"receivedMessage":{
"style":"icon",
"title":"receivedMessageTitle",
"subtitle":"receivedMessageSubtitle",
"imageIdentifier":"receivedMessageImageIdentifier"
},
"replyMessage":{
"style":"small",
"title":"replyMessageTitle",
"subtitle":"replyMessageSubtitle",
"imageIdentifier":"replyMessageImageIdentifier"
}
}
}
},
"Successful response INSTAGRAM MESSAGING message with TEMPLATE.":{
"summary":"Successful response INSTAGRAM MESSAGING message with TEMPLATE.",
"description":"Successful response INSTAGRAM MESSAGING message with TEMPLATE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"INSTAGRAM_MESSAGING",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INSTAGRAM_TEMPLATE",
"content":{
"payload":{
"elements":[
{
"title":"title 1",
"subtitle":"subtitle",
"imageUrl":"https://url.com/assets/image1.png",
"defaultAction":{
"url":"https://url.com/assets/profile1"
},
"buttons":[
{
"title":"Title",
"payload":"https://url.com/assets/buttons1.png",
"type":"URL"
},
{
"title":"button postback",
"payload":"payload",
"type":"POSTBACK"
}
]
},
{
"title":"title 2",
"subtitle":"subtitle",
"imageUrl":"https://url.com/assets/image2.png",
"defaultAction":{
"url":"https://url.com/assets/profile2"
},
"buttons":[
{
"title":"button postback 2",
"payload":"payload 2",
"type":"POSTBACK"
}
]
}
],
"type":"GENERIC"
}
}
}
},
"Successful response LINE message buttons TEMPLATE.":{
"summary":"Successful response LINE message buttons TEMPLATE.",
"description":"Successful response LINE message buttons TEMPLATE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"1654088914",
"to":"Ud1c123456789abcd12345efd7aa01234",
"channel":"LINE",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LINE_TEMPLATE",
"content":{
"altText":"Buttons template with custom actions",
"template":{
"thumbnailImageUrl":"https://url.com/assets/image.png",
"imageAspectRatio":"RECTANGLE",
"imageSize":"COVER",
"imageBackgroundColor":"#FFFFFF",
"title":"Payload title",
"text":"Payload test",
"defaultAction":{
"label":"URI action",
"uri":"https://url.com/assets/defaults/action",
"altUri":null,
"type":"URI"
},
"actions":[
{
"label":"URI action",
"uri":"https://url.com/assets/action",
"altUri":null,
"type":"URI"
},
{
"label":"Picker action",
"data":"Action data",
"mode":"DATETIME",
"initial":null,
"max":"2024-01-01T00:00",
"min":"2024-01-01T00:00",
"type":"DATETIMEPICKER"
},
{
"label":"Postback action",
"data":"action=buy&itemid=123",
"displayText":null,
"text":null,
"type":"POSTBACK"
}
],
"type":"BUTTONS"
}
}
}
},
"Successful response LINE message carousel TEMPLATE.":{
"summary":"Successful response LINE message carousel TEMPLATE.",
"description":"Successful response LINE message carousel TEMPLATE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"1654088914",
"to":"Ud1c123456789abcd12345efd7aa01234",
"channel":"LINE",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LINE_TEMPLATE",
"content":{
"altText":"Carousel template with custom actions",
"template":{
"columns":[
{
"thumbnailImageUrl":"https://url.com/assets/image1.png",
"imageBackgroundColor":"#FFFFFF",
"title":"Column 1 title",
"text":"Column 1 text",
"defaultAction":{
"label":"View detail 1",
"uri":"https://url.com/assets/defaults/action1",
"altUri":null,
"type":"URI"
},
"actions":[
{
"label":"View detail 1",
"uri":"https://url.com/assets/action1",
"altUri":null,
"type":"URI"
},
{
"label":"Buy item 1",
"data":"action=buy&itemid=1",
"displayText":null,
"text":null,
"type":"POSTBACK"
}
]
},
{
"thumbnailImageUrl":"https://url.com/assets/image2.png",
"imageBackgroundColor":"#BBBBBB",
"title":"Column 2 title",
"text":"Column 2 text",
"defaultAction":{
"label":"View detail 2",
"uri":"https://url.com/assets/defaults/action2",
"altUri":null,
"type":"URI"
},
"actions":[
{
"label":"View detail 2",
"uri":"https://url.com/assets/action2",
"altUri":null,
"type":"URI"
},
{
"label":"Buy item 2",
"data":"action=buy&itemid=2",
"displayText":null,
"text":null,
"type":"POSTBACK"
}
]
}
],
"imageAspectRatio":"SQUARE",
"imageSize":"CONTAIN",
"type":"CAROUSEL"
}
}
}
},
"Successful response LIVE CHAT TEXT message.":{
"summary":"Successful response LIVE CHAT TEXT message.",
"description":"Successful response LIVE CHAT TEXT message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"Text content."
}
}
},
"Successful response LIVE CHAT LC_QUICK_REPLY message.":{
"summary":"Successful response LIVE CHAT LC_QUICK_REPLY message.",
"description":"Successful response LIVE CHAT LC_QUICK_REPLY message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LC_QUICK_REPLY",
"content":{
"suggestedReplies":[
"Yes",
"No"
],
"sourceType":"TEXT",
"source":{
"text":"Ready to ask?"
}
}
}
},
"Successful response LIVE CHAT BUTTON message.":{
"summary":"Successful response LIVE CHAT BUTTON message.",
"description":"Successful response LIVE CHAT BUTTON message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"BUTTON",
"content":{
"buttonType":"LIVECHAT",
"button":{
"text":"Try options below:",
"buttonPayloads":[
{
"title":"Yes",
"type":"POSTBACK",
"payload":"Yes"
},
{
"title":"No",
"type":"POSTBACK",
"payload":"No"
},
{
"title":"Google",
"type":"URL",
"payload":"https://google.com"
}
]
}
}
}
},
"Successful response LIVE CHAT VIDEO message.":{
"summary":"Successful response LIVE CHAT VIDEO message.",
"description":"Successful response LIVE CHAT VIDEO message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"VIDEO",
"content":{
"caption":null,
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Successful response LIVE CHAT IMAGE message.":{
"summary":"Successful response LIVE CHAT IMAGE message.",
"description":"Successful response LIVE CHAT IMAGE message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"IMAGE",
"content":{
"caption":null,
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Successful response LIVE CHAT DOCUMENT message.":{
"summary":"Successful response LIVE CHAT DOCUMENT message.",
"description":"Successful response LIVE CHAT DOCUMENT message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"DOCUMENT",
"content":{
"caption":null,
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Successful response LIVE CHAT LC_CAROUSEL message.":{
"summary":"Successful response LIVE CHAT LC_CAROUSEL message.",
"description":"Successful response LIVE CHAT LC_CAROUSEL message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LC_CAROUSEL",
"content":{
"cards":[
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
},
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
}
],
"quickReplies":null
}
}
},
"Successful response LIVE CHAT LC_CAROUSEL message with quick replies.":{
"summary":"Successful response LIVE CHAT LC_CAROUSEL message with quick replies.",
"description":"Successful response LIVE CHAT LC_CAROUSEL message with quick replies.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"LiveChatSender",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LC_QUICK_REPLY",
"content":{
"suggestedReplies":[
"quick",
"replies"
],
"reply":null,
"sourceType":"CAROUSEL",
"source":{
"cards":[
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
},
{
"title":"Card title",
"description":"Card description",
"imageUrl":"https://image.url",
"cardActions":[
{
"title":"Open URL",
"postbackData":"https://open.url",
"type":"URL"
},
{
"title":"Send postback data",
"postbackData":"data-to-send",
"type":"POSTBACK_DATA"
}
]
}
],
"quickReplies":null
}
}
}
},
"Successful response SMS message.":{
"summary":"Successful response SMS message.",
"description":"Successful response SMS message.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"SMS",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"Text content."
}
}
},
"Successful response TELEGRAM message with IMAGE.":{
"summary":"Successful response TELEGRAM message with IMAGE.",
"description":"Successful response TELEGRAM message with IMAGE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"TELEGRAM",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"IMAGE",
"content":{
"url":"https://www.url.com/assets",
"caption":"image.jpg"
}
}
},
"Successful response TELEGRAM message with REPLY button.":{
"summary":"Successful response TELEGRAM message with REPLY button.",
"description":"Successful response TELEGRAM message with REPLY button.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"1234567890",
"to":"0987654321",
"channel":"TELEGRAM",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"replyMarkup":{
"keyboard":[
[
{
"text":"Share contact information",
"type":"TEXT_WITH_CONTACT"
}
]
],
"resizeKeyboard":true,
"oneTimeKeyboard":true,
"selective":false,
"type":"REPLY_KEYBOARD_MARKUP_V2"
},
"text":"Please share your contact data.",
"showUrlPreview":null
}
}
},
"Successful response VIBER message with LOCATION content.":{
"summary":"Successful response VIBER message with LOCATION content.",
"description":"Successful response VIBER message with LOCATION content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"DemoCompany",
"to":"44776333666",
"channel":"VIBER",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LOCATION",
"content":{
"longitude":1.2,
"latitude":3.4,
"locationName":"Location",
"address":"Address Name"
}
}
},
"Successful response VIBER BOT message with TEXT & KEYBOARD.":{
"summary":"Successful response VIBER BOT message with TEXT & KEYBOARD.",
"description":"Successful response VIBER BOT message with TEXT & KEYBOARD.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"keyboard":{
"buttonGrid":{
"buttons":[
{
"columns":6,
"rows":1,
"action":{
"actionBody":"Button postback 1",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Button 1",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#00ffff",
"frame":null,
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
},
{
"columns":6,
"rows":2,
"action":{
"actionBody":"Button postback 2",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Button 2",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#00ff00",
"frame":null,
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
},
{
"columns":6,
"rows":1,
"action":{
"actionBody":"Button postback 3",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Button 3",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#ffff80",
"frame":null,
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
}
],
"buttonsGroupColumns":6,
"buttonsGroupRows":4
},
"backgroundColor":"#333333",
"keyboardDisplay":null,
"actionBarState":"HIDDEN"
},
"text":"hello world",
"showUrlPreview":null
}
}
},
"Successful response VIBER BOT message with IMAGE.":{
"summary":"Successful response VIBER BOT message with IMAGE.",
"description":"Successful response VIBER BOT message with IMAGE.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"IMAGE",
"content":{
"caption":null,
"url":"https://www.url.com/assets/image.jpg",
"previewUrl":null
}
}
},
"Successful response VIBER BOT message with VIDEO.":{
"summary":"Successful response VIBER BOT message with VIDEO.",
"description":"Successful response VIBER BOT message with VIDEO.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"VIBER_BOT_VIDEO",
"content":{
"caption":null,
"url":"https://www.url.com/assets/video.avi",
"thumbnailUrl":null,
"fileName":null,
"size":1500,
"duration":null
}
}
},
"Successful response VIBER BOT message with CONTACT.":{
"summary":"Successful response VIBER BOT message with CONTACT.",
"description":"Successful response VIBER BOT message with CONTACT.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"CONTACT",
"content":{
"contacts":[
{
"addresses":null,
"birthday":null,
"emails":[
{
"email":"email@infobip.com",
"type":"EMAIL"
}
],
"name":{
"firstName":"Infobip",
"lastName":null,
"middleName":null,
"nameSuffix":null,
"namePrefix":null,
"formattedName":"Infobip"
},
"org":null,
"phones":[
{
"phone":"123456",
"type":"CELL",
"waId":"123456"
}
],
"urls":null
}
]
}
}
},
"Successful response VIBER BOT message with LOCATION.":{
"summary":"Successful response VIBER BOT message with LOCATION.",
"description":"Successful response VIBER BOT message with LOCATION.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"LOCATION",
"content":{
"latitude":44.9589555,
"longitude":13.8513371,
"locationName":null,
"address":null
}
}
},
"Successful response VIBER BOT message with CAROUSEL.":{
"summary":"Successful response VIBER BOT message with CAROUSEL.",
"description":"Successful response VIBER BOT message with CAROUSEL.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"pa:5555160884103864311",
"to":"qTj/1PNa1/G8TUWwQBaRVA==",
"channel":"VIBER_BOT",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"VIBER_BOT_CAROUSEL",
"content":{
"fromDetails":{
"name":"Example Name",
"avatarUrl":null
},
"heightScale":100,
"backgroundColor":null,
"buttonGrid":{
"buttons":[
{
"columns":3,
"rows":2,
"action":{
"actionBody":"image 1 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":null,
"background":null,
"media":{
"imageUrl":"https://url.com/assets/image1.png",
"imageScaleType":"FIT"
}
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Example 1 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Example 1",
"verticalAlign":"MIDDLE",
"horizontalAlign":"CENTER",
"size":"LARGE",
"shouldFit":null
},
"background":null,
"media":null
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Buy Example 1",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Buy this one",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#ff0000",
"frame":{
"borderWidth":null,
"borderColor":null,
"cornerRadius":4
},
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
},
{
"columns":3,
"rows":2,
"action":{
"actionBody":"image 2 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":null,
"background":null,
"media":{
"imageUrl":"https://url.com/assets/image2.png",
"imageScaleType":"CROP"
}
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Example 2 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Example 2",
"verticalAlign":"MIDDLE",
"horizontalAlign":"CENTER",
"size":"LARGE",
"shouldFit":null
},
"background":null,
"media":null
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Buy Example 2",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Buy this one",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#ff0000",
"frame":{
"borderWidth":null,
"borderColor":null,
"cornerRadius":4
},
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
},
{
"columns":3,
"rows":2,
"action":{
"actionBody":"image 3 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":null,
"background":null,
"media":{
"imageUrl":"https://url.com/assets/image3.png",
"imageScaleType":"FIT"
}
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Example 3 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Example 3",
"verticalAlign":"MIDDLE",
"horizontalAlign":"CENTER",
"size":"LARGE",
"shouldFit":null
},
"background":null,
"media":null
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Buy Example 3",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Buy this one",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":{
"color":"#ff0000",
"frame":{
"borderWidth":null,
"borderColor":null,
"cornerRadius":4
},
"mediaUrl":null,
"mediaType":null,
"mediaScaleType":null,
"gifLoop":null
},
"media":null
},
{
"columns":3,
"rows":2,
"action":{
"actionBody":"image 4 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":null,
"background":null,
"media":{
"imageUrl":"https://url.com/assets/image4.png",
"imageScaleType":null
}
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Example 4 clicked",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Example 4",
"verticalAlign":"MIDDLE",
"horizontalAlign":"CENTER",
"size":"LARGE",
"shouldFit":null
},
"background":null,
"media":null
},
{
"columns":3,
"rows":1,
"action":{
"actionBody":"Buy Example 4",
"actionType":"REPLY",
"silent":null,
"openUrlSettings":null,
"openMapLocation":null
},
"text":{
"opacity":null,
"backgroundGradientColor":null,
"paddings":null,
"text":"Buy this one",
"verticalAlign":null,
"horizontalAlign":null,
"size":null,
"shouldFit":null
},
"background":null,
"media":null
}
],
"buttonsGroupColumns":3,
"buttonsGroupRows":4
}
}
}
},
"Successful response WHATSAPP message with IMAGE content.":{
"summary":"Successful response WHATSAPP message with IMAGE content.",
"description":"Successful response WHATSAPP message with IMAGE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"IMAGE",
"content":{
"caption":null,
"url":"https://www.url.com/assets/image.jpg"
}
}
},
"Successful response WHATSAPP message with DOCUMENT content.":{
"summary":"Successful response WHATSAPP message with DOCUMENT content.",
"description":"Successful response WHATSAPP message with DOCUMENT content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"DOCUMENT",
"content":{
"caption":null,
"url":"https://www.url.com/assets/document.doc"
}
}
},
"Successful response WHATSAPP message with VIDEO content.":{
"summary":"Successful response WHATSAPP message with VIDEO content.",
"description":"Successful response WHATSAPP message with VIDEO content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"VIDEO",
"content":{
"caption":null,
"url":"https://www.url.com/assets/video.avi"
}
}
},
"Successful response WHATSAPP message with AUDIO content.":{
"summary":"Successful response WHATSAPP message with AUDIO content.",
"description":"Successful response WHATSAPP message with AUDIO content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"AUDIO",
"content":{
"url":"https://www.url.com/assets/audio.jpg"
}
}
},
"Successful response WHATSAPP message with CONTACT content.":{
"summary":"Successful response WHATSAPP message with CONTACT content.",
"description":"Successful response WHATSAPP message with CONTACT content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"CONTACT",
"content":{
"contacts":[
{
"name":{
"first_name":"First Name",
"last_name":"Last Name",
"formatted_name":"Formatted First Last Name"
},
"org":{
"company":"Company Name"
},
"emails":[
{
"email":"first@last@company.com",
"type":"private"
}
],
"urls":[
{
"url":"https://url.com/assets/profile",
"type":"PROFILE"
}
],
"birthday":"2019-02-18",
"addresses":[
{
"city":"City",
"country":"Country",
"countryCode":"123",
"street":"Street name",
"type":"WORK",
"zip":"12345"
}
],
"phones":[
{
"phone":"+123 456 789",
"type":"Mobile",
"waId":"123456"
},
{
"phone":"+123 456 7890",
"type":"Work"
}
]
}
]
}
}
},
"Successful response WHATSAPP message with TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with TEMPLATE content.",
"description":"Successful response WHATSAPP message with TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"Template text"
}
}
},
"Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.",
"description":"Successful response WHATSAPP message with TEXT MEDIA TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"text_media_template",
"language":{
"code":"en",
"label":"English"
},
"header":{
"placeholder":"Gustavo",
"type":"TEXT"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"Contact support"
],
"type":"URL"
}
]
}
}
},
"Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.",
"description":"Successful response WHATSAPP message with DOCUMENT MEDIA TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"document_media_template",
"language":{
"code":"en",
"label":"English"
},
"header":{
"type":"DOCUMENT",
"url":"https://www.url.com/assets",
"filename":"document.pdf"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"Yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"No"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.",
"description":"Successful response WHATSAPP message with IMAGE MEDIA TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"image_media_template",
"language":{
"code":"en",
"label":"English"
},
"header":{
"type":"IMAGE",
"url":"https://www.url.com/assets/image.jpg"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"Yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"No"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.",
"description":"Successful response WHATSAPP message with LOCATION MEDIA TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"location_media_template",
"language":{
"code":"en",
"label":"English"
},
"header":{
"latitude":45.79359,
"longitude":15.94613,
"type":"LOCATION"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"Contact support"
],
"type":"URL"
}
]
}
}
},
"Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.":{
"summary":"Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.",
"description":"Successful response WHATSAPP message with VIDEO MEDIA TEMPLATE content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"MEDIA_TEMPLATE",
"content":{
"templateName":"video_media_template",
"language":{
"code":"en",
"label":"English"
},
"header":{
"type":"VIDEO",
"url":"https://www.url.com/assets/video.avi"
},
"body":{
"placeholders":[
"6-15",
"17-19"
]
},
"buttons":[
{
"parameters":[
"Yes"
],
"type":"QUICK_REPLY"
},
{
"parameters":[
"No"
],
"type":"QUICK_REPLY"
}
]
}
}
},
"Successful response WHATSAPP message with INTERACTIVE BUTTON content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE BUTTON content.",
"description":"Successful response WHATSAPP message with INTERACTIVE BUTTON content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"send reply header text",
"type":"IMAGE",
"url":"https://www.url.com/assets/image.jpg"
},
"body":{
"text":"send reply body text"
},
"footer":{
"text":"send reply footer text"
},
"action":{
"buttons":[
{
"id":"postback 1",
"title":"button 1",
"type":"BUTTON"
},
{
"id":"postback 2",
"title":"button 2",
"type":"BUTTON"
}
],
"button":null,
"sections":null
},
"type":"BUTTON"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.",
"description":"Successful response WHATSAPP message with INTERACTIVE URL BUTTON content.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"send reply header text",
"type":"TEXT"
},
"body":{
"text":"send reply body text"
},
"footer":{
"text":"send reply footer text"
},
"action":{
"displayText":"display text",
"url":"http://localhost:8000"
},
"type":"URL_BUTTON"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE LIST content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE LIST content.",
"description":"Successful response WHATSAPP message with INTERACTIVE LIST content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"447123456789",
"to":"44987654321",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"header":{
"text":"header text",
"type":"TEXT",
"url":null
},
"body":{
"text":"body text"
},
"footer":{
"text":"footer text"
},
"action":{
"buttons":null,
"button":"options",
"sections":[
{
"title":"section1 title",
"rows":[
{
"id":"row1.1",
"title":"title1.1",
"description":"description1.1"
},
{
"id":"row1.2",
"title":"title1.2",
"description":"description1.2"
}
]
},
{
"title":"section2 title",
"rows":[
{
"id":"row2.1",
"title":"title2.1",
"description":"description2.1"
}
]
}
]
},
"type":"LIST"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE PRODUCT content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE PRODUCT content.",
"description":"Successful response WHATSAPP message with INTERACTIVE PRODUCT content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"WHATSAPP_PRODUCT",
"content":{
"body":{
"text":"Test Product 1"
},
"footer":{
"text":"Test footer 1"
},
"action":{
"catalogId":"123456789",
"productRetailerId":"productRetailerId"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.",
"description":"Successful response WHATSAPP message with INTERACTIVE MULTI PRODUCT content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"WHATSAPP_MULTI_PRODUCT",
"content":{
"header":{
"text":"Header multi 1"
},
"body":{
"text":"Test Multi Product 1"
},
"footer":{
"text":"Test multi footer 1"
},
"action":{
"catalogId":"123456789",
"sections":[
{
"title":"section 1",
"productItems":[
{
"productRetailerId":"retailerId"
},
{
"productRetailerId":"productRetailerId"
}
]
}
]
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.",
"description":"Successful response WHATSAPP message with INTERACTIVE CALL PERMISSION REQUEST content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"type":"CALL_PERMISSION_REQUEST"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.",
"description":"Successful response WHATSAPP message with INTERACTIVE VOICE_BUTTON content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"447492263897",
"to":"44776333666",
"channel":"WHATSAPP",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"INTERACTIVE",
"content":{
"interactive":{
"body":{
"text":"body text"
},
"action":{
"buttonDisplayText":"button display text"
},
"type":"VOICE_BUTTON"
}
}
}
},
"Successful response WHATSAPP message with INTERACTIVE FLOW content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE FLOW content.",
"description":"Successful response WHATSAPP message with INTERACTIVE FLOW content.",
"value":{
"id":"22cb064a-ca48-45c7-9384-ccf233fd81ee",
"channel":"WHATSAPP",
"from":"447701408772",
"to":"420951141432",
"direction":"OUTBOUND",
"conversationId":"1227ce3b-93f8-4784-8e9b-099513c465f1",
"authorId":"409b6133-92be-4a8d-99ae-f4578f118f87",
"authorType":"AGENT",
"createdAt":"2025-09-10T13:03:39.173+00:00",
"updatedAt":"2025-09-10T13:03:39.173+00:00",
"content":{
"interactive":{
"header":{
"text":"header text",
"type":"TEXT",
"url":null
},
"body":{
"text":"body text"
},
"footer":{
"text":"footer text"
},
"action":{
"buttons":null,
"button":null,
"sections":null,
"flowActionContent":{
"mode":"PUBLISHED",
"messageVersion":1,
"flowToken":"Flow_token",
"flowId":"98E8D4AA79E2693357FAA",
"callToActionButton":"start",
"flowAction":"DATA_EXCHANGE",
"flowActionPayload":{
"screenId":"av4b064a-ca48-45c7-9384-ccf233fd81ee",
"data":{
"data":"test"
}
}
},
"displayText":null,
"url":null,
"buttonDisplayText":null
},
"type":"FLOW"
}
},
"contentType":"INTERACTIVE"
}
},
"Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.":{
"summary":"Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.",
"description":"Successful response WHATSAPP message with INTERACTIVE REQUEST_CONTACT_INFO_BUTTON content.",
"value":"{\n \"id\": \"22cb064a-ca48-45c7-9384-ccf233fd81ee\",\n \"channel\": \"WHATSAPP\",\n \"from\": \"447701408772\",\n \"to\": \"420951141432\",\n \"direction\": \"OUTBOUND\",\n \"conversationId\": \"1227ce3b-93f8-4784-8e9b-099513c465f1\",\n \"authorId\": \"409b6133-92be-4a8d-99ae-f4578f118f87\",\n \"authorType\": \"AGENT\",\n \"createdAt\": \"2025-09-10T13:03:39.173+00:00\",\n \"updatedAt\": \"2025-09-10T13:03:39.173+00:00\",\n \"contentType\": \"INTERACTIVE\"\n \"content\": {\n \"interactive\": {\n \"header\": null,\n \"body\": {\n \"text\": \"Requesting contact info\"\n },\n \"footer\": null,\n \"action\": null,\n \"type\": \"REQUEST_CONTACT_INFO\"\n }\n }\n}\n"
},
"Successful response EMAIL message with EMAIL html content.":{
"summary":"Successful response EMAIL message with EMAIL html content.",
"description":"Successful response EMAIL message with EMAIL html content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"sender@example.com",
"to":"toRecipient1@example.com",
"channel":"EMAIL",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"EMAIL",
"content":{
"toAddresses":[
"toRecipient1@example.com",
"toRecipient2@example.com"
],
"ccAddresses":[
"ccRecipient@example.com"
],
"bccAddresses":[
"bccRecipient@example.com"
],
"subject":"Sample Email Subject",
"contentHtml":"This is a sample email content."
}
}
},
"Successful response EMAIL message with EMAIL text content.":{
"summary":"Successful response EMAIL message with EMAIL text content.",
"description":"Successful response EMAIL message with EMAIL text content.",
"value":{
"id":"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"from":"sender@example.com",
"to":"toRecipient1@example.com",
"channel":"EMAIL",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"EMAIL",
"content":{
"toAddresses":[
"toRecipient1@example.com",
"toRecipient2@example.com"
],
"ccAddresses":[
"ccRecipient@example.com"
],
"bccAddresses":[
"bccRecipient@example.com"
],
"subject":"Sample Email Subject",
"contentText":"This is a sample of the email content."
}
}
},
"Successful response RCS message with TEXT content.":{
"summary":"Successful response RCS message with TEXT content.",
"description":"Successful response RCS message with TEXT content.",
"value":{
"id":"c8258ab8-d65b-4546-afbb-78a521b6acae",
"channel":"RCS",
"from":"infobip",
"to":"385989295741",
"direction":"OUTBOUND",
"conversationId":"2ca99fb3-0f2e-47b0-b463-8dbc408b92ec",
"authorId":"409b6133-92be-4a8d-99ae-f4578f118f78",
"authorType":"AGENT",
"createdAt":"2025-09-08T07:29:47.116+00:00",
"updatedAt":"2025-09-08T07:29:47.116+00:00",
"content":{
"text":"Test reply",
"showUrlPreview":null
},
"contentType":"TEXT"
}
},
"Successful response RCS message with FILE content.":{
"summary":"Successful response RCS message with FILE content.",
"description":"Successful response RCS message with FILE content.",
"value":{
"id":"aa62c649-bf35-4ec6-ae93-836a1ca3f5cc",
"channel":"RCS",
"from":"infobip",
"to":"385989295741",
"direction":"OUTBOUND",
"conversationId":"2ca88fb3-0f2e-47b0-b463-8dbc408b29ec",
"authorId":"409b6133-92be-4a8d-88ae-f4578f118f87",
"authorType":"AGENT",
"createdAt":"2025-09-08T07:08:24.708+00:00",
"updatedAt":"2025-09-08T07:08:24.708+00:00",
"content":{
"file":{
"url":"https://url.com/assets/document.pdf"
},
"thumbnail":{
"url":"https://url.com/assets/thumbnail.pdf"
},
"suggestions":null
},
"contentType":"RCS_FILE"
}
},
"Successful response RCS message with CARD content.":{
"summary":"Successful response RCS message with CARD content.",
"description":"Successful response RCS message with CARD content.",
"value":{
"id":"f4858822-e603-4244-8127-b91700b771ec",
"channel":"RCS",
"from":"infobip",
"to":"385989295741",
"direction":"OUTBOUND",
"conversationId":"2ca99fb3-0f2e-47b0-b463-8dbc518b29ec",
"authorId":"409b6133-92be-4a8d-99ae-f3378f118f87",
"authorType":"AGENT",
"createdAt":"2025-09-08T07:21:18.670+00:00",
"updatedAt":"2025-09-08T07:21:18.670+00:00",
"content":{
"orientation":"HORIZONTAL",
"alignment":"RIGHT",
"content":{
"title":"rcs card title",
"description":"rcs card description",
"media":{
"file":{
"url":"https://url.com/assets/image1.png"
},
"thumbnail":{
"url":"https://url.com/assets/image2.png"
},
"height":"MEDIUM"
},
"suggestions":null
},
"suggestions":null
},
"contentType":"RCS_CARD"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Missing 'to' field":{
"summary":"Missing 'to' field",
"description":"Missing 'to' field",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"to":[
"must not be blank"
]
}
}
}
}
},
"Missing 'from' field":{
"summary":"Missing 'from' field",
"description":"Missing 'from' field",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"from":[
"must not be blank"
]
}
}
}
}
},
"Content must not be blank":{
"summary":"Content must not be blank",
"description":"Content must not be blank",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content":[
"must not be blank"
]
}
}
}
}
},
"Content length exceeds limit":{
"summary":"Content length exceeds limit",
"description":"Content length exceeds limit",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"content":[
"size cannot be longer than 4096 characters."
]
}
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/events":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-events"
],
"summary":"Send a conversation event",
"description":"Use this endpoint to send an event to a conversation. E.g. indication when typing started or ended.More info",
"operationId":"send-event",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to set event for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventApiRequest"
},
"examples":{
"Sending APPLE BUSINESS CHAT Typing Started event.":{
"summary":"Sending APPLE BUSINESS CHAT Typing Started event.",
"description":"Sending APPLE BUSINESS CHAT Typing Started event.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"type":"TYPING_STARTED"
}
},
"Sending APPLE BUSINESS CHAT Typing Stopped event.":{
"summary":"Sending APPLE BUSINESS CHAT Typing Stopped event.",
"description":"Sending APPLE BUSINESS CHAT Typing Stopped event.",
"value":{
"from":"03dff63b-6100-44a9-b563-8fbc0295ec77",
"to":"urn:urnId",
"channel":"APPLE_BUSINESS_CHAT",
"type":"TYPING_STOPPED"
}
},
"Sending LIVE CHAT Typing Started event.":{
"summary":"Sending LIVE CHAT Typing Started event.",
"description":"Sending LIVE CHAT Typing Started event.",
"value":{
"from":"25774a87-078a-4fe7-8d43-127809479964",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"type":"TYPING_STARTED"
}
},
"Sending LIVE CHAT Typing Stopped event.":{
"summary":"Sending LIVE CHAT Typing Stopped event.",
"description":"Sending LIVE CHAT Typing Stopped event.",
"value":{
"from":"25774a87-078a-4fe7-8d43-127809479964",
"to":"CHAT-a91f021b-2a4e-4a47-865e-f2aef4088da0-1587662002",
"channel":"LIVE_CHAT",
"type":"TYPING_STOPPED"
}
},
"Sending WHATSAPP Typing Started event.":{
"summary":"Sending WHATSAPP Typing Started event.",
"description":"Sending WHATSAPP Typing Started event.",
"value":{
"from":"44123456789",
"to":"44321654987",
"channel":"WHATSAPP",
"type":"TYPING_STARTED"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Channel is not supported for provided event type":{
"summary":"Channel is not supported for provided event type",
"description":"Channel is not supported for provided event type",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Channel is not supported for provided event type"
}
}
}
},
"Typing events are not supported during Apple Satellite sessions":{
"summary":"Typing events are not supported during Apple Satellite sessions",
"description":"Typing events are not supported during Apple Satellite sessions",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Typing events are not supported during Apple Satellite sessions"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/notes":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-notes"
],
"summary":"Get notes",
"description":"Use this method to get a list of notes from conversation with pagination. More info",
"operationId":"get-notes",
"parameters":[
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to get notes from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-notes"
],
"summary":"Create note",
"description":"Use this method to create a new note. Use notes to notify your team on important matters regarding a conversation with a customer. More info",
"operationId":"create-note",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to set note to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateNoteApiRequest"
},
"examples":{
"Text note.":{
"summary":"Text note.",
"description":"Text note.",
"value":{
"content":"Note content",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a"
}
},
"Note with attachments.":{
"summary":"Note with attachments.",
"description":"Note with attachments.",
"value":{
"type":"ATTACHMENT",
"content":{
"text":"Note content",
"attachments":[
{
"id":"12345"
},
{
"id":"67890"
}
]
},
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse"
},
"examples":{
"Successful response for a text note":{
"summary":"Successful response for a text note",
"description":"Successful response for a text note",
"value":{
"id":"1367466e-7e5d-40d7-a78a-ace2780ed3dd",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"type":"INTERNAL",
"content":"Note content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
},
"Successful response for a note with attachments":{
"summary":"Successful response for a note with attachments",
"description":"Successful response for a note with attachments",
"value":{
"id":"1367466e-7e5d-40d7-a78a-ace2780ed3dd",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"agentId":"8066d92f-94b6-4596-b7e0-b6595ca76d2e",
"type":"ATTACHMENT",
"content":{
"text":"Note content",
"attachments":[
{
"id":"12345",
"fileName":"File 1 Name",
"fileExtension":"png",
"contentType":"image/png",
"fileSize":12,
"publicLink":"https://www.url.com/assets/image1.png"
},
{
"id":"56789",
"fileName":"File 2 Name",
"fileExtension":"png",
"contentType":"image/png",
"fileSize":34,
"publicLink":"https://www.url.com/assets/image1.png"
}
]
},
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/notes/{noteId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-notes"
],
"summary":"Get note",
"description":"Use this method to retrieve a note. More info",
"operationId":"get-note",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to get a note from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"noteId",
"in":"path",
"description":"Note Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"1367466e-7e5d-40d7-a78a-ace2780ed3dd",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"type":"INTERNAL",
"content":"Note content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/agents":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Get agents",
"description":"Use this method to get a list of agents with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in parameters. More info",
"operationId":"get-agents",
"parameters":[
{
"name":"agentIds",
"in":"query",
"description":"Optional filter. List of agents Id to match result.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"queueIds",
"in":"query",
"description":"Optional filter. List of queues Id to match result.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"displayName",
"in":"query",
"description":"Optional. Agent display name. This is case insensitive and will search for substring anywhere within string, 255 characters max.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"email",
"in":"query",
"description":"Optional. Agent email.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"email"
}
},
{
"name":"status",
"in":"query",
"description":"Optional. Indicates a status set by the agent reflecting their availability preferences.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"ACTIVE",
"BUSY",
"INVISIBLE",
"AWAY"
]
}
},
{
"name":"availability",
"in":"query",
"description":"Optional. Indicates the agent status set by the system reflecting the actual availability.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"ACTIVE",
"BUSY",
"INVISIBLE",
"AWAY"
]
}
},
{
"name":"role",
"in":"query",
"description":"Optional. Agent role.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"AGENT",
"SUPERVISOR"
]
}
},
{
"name":"enabled",
"in":"query",
"description":"Optional. Agent enable/disable toggle.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"createdAfter",
"in":"query",
"description":"Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"createdBefore",
"in":"query",
"description":"Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedAfter",
"in":"query",
"description":"Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedBefore",
"in":"query",
"description":"Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Create agent",
"description":"Use this method to add a new agent. More info",
"operationId":"create-agent",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"INVISIBLE",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/agents/{agentId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Get agent",
"description":"Use this method to get a single agent. More info",
"operationId":"get-agent",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the agent we want to retrieve.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseWithEmail"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"INVISIBLE",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000",
"email":"angus.toung@example.com"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Update agent",
"description":"Use this method to update an agent. More info",
"operationId":"update-agent",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the Agent we want to update.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"INVISIBLE",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-08-21T11:33:52.222+0000"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/agents/{agentId}/conversations":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Get agent conversations",
"description":"Use this method to get a list of conversations, an agent is assigned on, with pagination.",
"operationId":"get-agent-conversations",
"parameters":[
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"agentId",
"in":"path",
"description":"Agent id to get conversations.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/agents/{agentId}/status":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Change agents status",
"description":"Use this method to change agents status. More info",
"operationId":"update-agent-status",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the Agent we want to change status.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"ACTIVE",
"role":"SUPERVISOR",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-08-21T11:33:52.222+0000"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/agents/{agentId}/queues":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Add agent to queue",
"description":"Use this method to add an agent to a queue.",
"operationId":"add-agent-queue",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the Agent which should be assign to Queue.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.QueueAssignRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"statusCode":"SUCCESS",
"message":"Agent added to queue successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
},
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/agents/{agentId}/queues/{queueId}":{
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Remove agent from queue",
"description":"Use this method to remove an agent from a queue.\nOperation only deletes the link between a queue and the agent.",
"operationId":"remove-agent-queue",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the Agent which should be unlinked from queue.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"queueId",
"in":"path",
"description":"Id of the Queue which should be unlinked from agent.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"statusCode":"SUCCESS",
"message":"Agent removed from queue successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/agents/{agentId}/heartbeat":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-agents"
],
"summary":"Set agents heartbeat",
"description":"Use this method to set agents heartbeat. More info",
"operationId":"update-agent-heartbeat",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Id of the Agent we want to set heartbeat.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Heartbeat received."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/queues":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-queues"
],
"summary":"Get queues",
"description":"Use this method to get a list of queues with pagination and filtering options. Using a filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters.\nMore info",
"operationId":"get-queues",
"parameters":[
{
"name":"queueIds",
"in":"query",
"description":"Optional filter. List of queue Ids.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"agentId",
"in":"query",
"description":"Optional filter. Agent Id.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"workingHoursId",
"in":"query",
"description":"Optional filter. Working Hours Id.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"name",
"in":"query",
"description":"Optional. Queue name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-queues"
],
"summary":"Create queue",
"description":"Use this method to create a queue.\nQueues help manage conversations in a timely manner by organizing the team based on workload and knowledge.\nMore info",
"operationId":"create-queue",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateQueueApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Queue name",
"enabledAgentsCount":null,
"enabledRoutesCount":null,
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"isAutoAssignmentEnabled":false,
"stickyAgentTimeoutDays":30,
"isStickyAutoAssignmentEnabled":null,
"workingHoursId":null,
"isPrivate":false,
"deletedAt":null
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/queues/{queueId}":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-queues"
],
"summary":"Update queue",
"description":"Use this method to update the queue. More info",
"operationId":"update-queue",
"parameters":[
{
"name":"queueId",
"in":"path",
"description":"Id of the queue being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.UpdateQueueApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Queue name",
"enabledAgentsCount":null,
"enabledRoutesCount":null,
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"isAutoAssignmentEnabled":false,
"stickyAgentTimeoutDays":30,
"isStickyAutoAssignmentEnabled":null,
"workingHoursId":null,
"isPrivate":false,
"deletedAt":null
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-queues"
],
"summary":"Delete queue",
"description":"Use this method to delete a queue. More info",
"operationId":"delete-queue",
"parameters":[
{
"name":"queueId",
"in":"path",
"description":"Id of the queue to be deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Success request response":{
"summary":"Success request response",
"description":"Success request response",
"value":{
"statusCode":"SUCCESS",
"message":"Queue deleted successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/routing":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-routing"
],
"summary":"Get routing",
"description":"Use this method to get a list of rules within the routing. Pagination is set to single page result with a maximum of 999 items ordered by \"order\". As rules inside routing are stored, executed and retrieved in provided order with the SET method, that order can't be changed. More info",
"operationId":"get-routing",
"parameters":[
{
"name":"ruleIds",
"in":"query",
"description":"Optional. List of rule Ids.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"enabled",
"in":"query",
"description":"Optional. Rule enable/disable toggle.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RoutingRulesResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-routing"
],
"summary":"Create routing",
"description":"Create routing method creates a new routing setup if it does not exist or replaces the existing setup. As rules inside routing are stored, executed, and retrieved in the provided order with this method, that order cannot be changed. Every expression within routing can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. The query will be executed, one expression after another, in the order they are submitted until new a inbound message first matches the expression. Then the message will be assigned to the matched queue.\n\nThe order of rules inside routing is essential for proper routing, as rules match in the provided order. The first rule matching the message will be used.\nMore info",
"operationId":"update-routing",
"requestBody":{
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateRuleApiRequest"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Success":{
"summary":"Success",
"description":"Success",
"value":{
"statusCode":"SUCCESS",
"message":"Routing added successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-routing"
],
"summary":"Delete routing",
"description":"Use this method to delete routing. No parameters are required for this action.\n\nThis operation will delete routing with all rules inside, so all new inbound messages destined to routing will be routed to the default queue.\nMore info",
"operationId":"delete-routing",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Routing deleted successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/bots":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"bots"
],
"summary":"Get Bots",
"description":"Use this method to get bots with pagination. More info",
"operationId":"get-bots",
"parameters":[
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"bots"
],
"summary":"Create bot",
"description":"Use this method to create a bot. More info",
"operationId":"setup-bot",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot"
},
"examples":{
"Successful bot setup.":{
"summary":"Successful bot setup.",
"description":"Successful bot setup.",
"value":{
"id":"309BB921757DEAC9BE79EC6259B31C8A",
"displayName":"My Whatsapp Bot",
"webhookUrl":"www.webhookurl.com/link1",
"destination":"447492263897",
"channel":"WHATSAPP",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":true,
"sessionTimeoutInSec":120
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/bots/{botId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"bots"
],
"summary":"Get bot",
"description":"Use this method to get a bot. More info",
"operationId":"get-bot",
"parameters":[
{
"name":"botId",
"in":"path",
"description":"Id of the Bot to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"309BB921757DEAC9BE79EC6259B31C8A",
"displayName":"My Whatsapp Bot",
"channel":"WHATSAPP",
"destination":"447492263897",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":true,
"sessionTimeoutInSec":120
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"bots"
],
"summary":"Update bot",
"description":"Use this method to update a bot. More info",
"operationId":"update-bot",
"parameters":[
{
"name":"botId",
"in":"path",
"description":"Id of the Bot being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"New Whatsapp Bot",
"webhookUrl":"www.newwebhookurl.com/newlink",
"destination":"447492263897",
"channel":"WHATSAPP",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":false,
"sessionTimeoutInSec":120
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"bots"
],
"summary":"Delete bot",
"description":"Use this method to delete a bot.\nAll open conversations assigned to a bot will be rerouted. More info",
"operationId":"delete-bot",
"parameters":[
{
"name":"botId",
"in":"path",
"description":"Id of the Bot being deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Bot deleted successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid agent id given '1234567890ABCDEFGHIJKLMNOPRSTUVZ'"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/conversations/{conversationId}/metadata":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"metadata"
],
"summary":"Get metadata",
"description":"Use this method to retrieve conversation metadata. More info",
"operationId":"get-metadata",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to retrieve metadata for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"type":"string"
},
"examples":{
"Get metadata.":{
"summary":"Get metadata.",
"description":"Get metadata.",
"value":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"metadata"
],
"summary":"Put metadata",
"description":"Use this method to create or update conversation metadata. Method overwrites old metadata. More info",
"operationId":"create-metadata",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation for which we are upserting metadata.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"Metadata key-value pairs.",
"content":{
"application/json":{
"schema":{
"type":"object",
"minProperties":1
},
"examples":{
"Upsert metadata.":{
"summary":"Upsert metadata.",
"description":"Upsert metadata.",
"value":{
"key1":"value1",
"key2":"value2"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Metadata added to conversation successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"metadata"
],
"summary":"Delete metadata",
"description":"Use this method to delete conversation metadata. More info",
"operationId":"delete-metadata",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to delete metadata for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Metadata deleted successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"patch":{
"tags":[
"customer-engagement",
"conversations",
"metadata"
],
"summary":"Patch metadata",
"description":"Use this method for metadata partial updating. If there is no present metadata, one will be created from request. More info",
"operationId":"patch-metadata",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation to update metadata for.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"Metadata key-value pairs.",
"content":{
"application/json":{
"schema":{
"type":"object",
"minProperties":1
},
"examples":{
"Patch metadata.":{
"summary":"Patch metadata.",
"description":"Patch metadata.",
"value":{
"key1":"value1_updated",
"key3":"value3"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Metadata patch to conversation successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
},
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/templates":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"templates"
],
"summary":"Get templates",
"description":"Use this method to get a list of templates with pagination and filtering options. Using the filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters.\nResults are ordered by creation in descending order by default, meaning the newest template will be returned first.\nMore info",
"operationId":"get-templates",
"parameters":[
{
"name":"channel",
"in":"query",
"description":"Optional. Template channel.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"EMAIL",
"LIVE_CHAT",
"APPLE_BUSINESS_CHAT",
"LINE",
"TELEGRAM",
"VIBER_BOT",
"FACEBOOK_POST",
"INSTAGRAM_POST",
"INSTAGRAM_MESSAGING",
"GOOGLE_PLAY",
"KAKAO_SANGDAM"
]
}
},
{
"name":"language",
"in":"query",
"description":"Optional. Template language.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"Afrikaans",
"Albanian",
"Arabic",
"Azerbaijani",
"Bengali",
"Bulgarian",
"Catalan",
"Chinese (CHN)",
"Chinese (HKG)",
"Chinese (TAI)",
"Croatian",
"Czech",
"Danish",
"Dutch",
"English",
"English (UK)",
"English (US)",
"Estonian",
"Filipino",
"Finnish",
"French",
"Georgian",
"German",
"Greek",
"Gujarati",
"Hausa",
"Hebrew",
"Hindi",
"Hungarian",
"Indonesian",
"Irish",
"Italian",
"Japanese",
"Kannada",
"Kazakh",
"Kinyarwanda",
"Korean",
"Kyrgyz (Kyrgyzstan)",
"Lao",
"Latvian",
"Lithuanian",
"Macedonian",
"Malay",
"Malayalam",
"Marathi",
"Norwegian",
"Persian",
"Polish",
"Portuguese (BR)",
"Portuguese (POR)",
"Punjabi",
"Romanian",
"Russian",
"Serbian",
"Slovak",
"Slovenian",
"Spanish",
"Spanish (ARG)",
"Spanish (SPA)",
"Spanish (MEX)",
"Swahili",
"Swedish",
"Tamil",
"Telugu",
"Thai",
"Turkish",
"Ukrainian",
"Urdu",
"Uzbek",
"Vietnamese",
"Zulu"
]
}
},
{
"name":"createdAfter",
"in":"query",
"description":"Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"createdBefore",
"in":"query",
"description":"Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedAfter",
"in":"query",
"description":"Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedBefore",
"in":"query",
"description":"Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"contentType",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateResultPage"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"templates":[
{
"id":"c4391685-b21a-4c21-a470-5453e9382752",
"name":"First template name",
"language":"English",
"languageCode":"en",
"channel":"SMS",
"external":false,
"content":"Simple English text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"First template tag",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"attachments":[]
},
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"name":"Second template name",
"language":"Spanish",
"languageCode":"es",
"channel":"SMS",
"external":false,
"content":"Simple Spanish text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"Second template tag",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"attachments":[
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"fileName":"Second template file",
"fileExtension":"txt",
"fileSize":1024,
"contentType":"text/plain",
"publicLink":"https://example.com/second-template-file.txt",
"thumbLink":"https://example.com/second-template-file-thumb.png",
"uploadedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"fileName":"Second template image",
"fileExtension":"png",
"fileSize":2048,
"contentType":"image/png",
"publicLink":"https://example.com/second-template-image.png",
"thumbLink":"https://example.com/second-template-image-thumb.png",
"uploadedAt":"2024-01-01T00:00:00.000+00:00"
}
]
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"createdAt:DESC"
}
}
}
}
}
}
},
"400":{
"description":"BAD REQUEST",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-is-early-access":true
}
},
"/ccaas/1/templates/{templateId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"templates"
],
"summary":"Get template",
"description":"Use this method to get a single template. More info",
"operationId":"get-template",
"parameters":[
{
"name":"templateId",
"in":"path",
"description":"Id of the template to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"c4391685-b21a-4c21-a470-5453e9382752",
"name":"Template name",
"language":"English",
"languageCode":"en",
"channel":"SMS",
"external":false,
"content":"Simple text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"Template tag",
"createdAt":"2024-12-10T00:00:00.000+00:00",
"updatedAt":"2024-12-10T00:00:00.000+00:00"
}
],
"attachments":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-is-early-access":true
}
},
"/ccaas/2/conversation-forms/forms":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get conversation forms",
"description":"Use this method to get a list of forms with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.",
"operationId":"get-conversation-forms",
"parameters":[
{
"name":"title",
"in":"query",
"description":"Optional filter. Form title.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"isEnabled",
"in":"query",
"description":"Optional filter. Enabled status.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"isDefault",
"in":"query",
"description":"Optional filter. Default status.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Create conversation form",
"description":"Use this method to create a form.",
"operationId":"create-conversation-form",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest"
},
"examples":{
"Creating form with simple field.":{
"summary":"Creating form with simple field.",
"description":"Creating form with simple field.",
"value":{
"title":"Granulation",
"isEnabled":true,
"fields":[
{
"fieldId":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"isRequired":false
}
]
}
},
"Creating form with field containing conditionals.":{
"summary":"Creating form with field containing conditionals.",
"description":"Creating form with field containing conditionals.",
"value":{
"title":"Granulation",
"isEnabled":true,
"fields":[
{
"fieldId":"d85b8e46-f579-482f-b383-22648aae17b5",
"isRequired":false,
"conditions":[
{
"value":"complaint",
"conditionalFields":[
{
"fieldId":"e130e3f2-c8de-4ba9-a26e-8ac705642832",
"isRequired":false
}
]
},
{
"value":"inquiry",
"conditionalFields":[
{
"fieldId":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"isRequired":false
}
]
}
]
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form"
},
"examples":{
"Successful response form with simple field":{
"summary":"Successful response form with simple field",
"description":"Successful response form with simple field",
"value":{
"id":"75f57446-1d65-478a-87ed-22d17dc3d077",
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":[
{
"field":{
"id":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title":"Inquiry",
"type":"TEXT",
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:16.692653Z",
"updatedAt":"2021-06-29T10:00:16.692654Z",
"operators":[]
},
"isRequired":false,
"conditions":[]
}
],
"createdAt":"2021-06-29T10:01:11.633649Z",
"updatedAt":"2021-06-29T10:01:11.633650Z"
}
},
"Successful response form with field containing conditionals":{
"summary":"Successful response form with field containing conditionals",
"description":"Successful response form with field containing conditionals",
"value":{
"id":"75f57446-1d65-478a-87ed-22d17dc3d077",
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":[
{
"field":{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"isEnabled":true,
"isDefault":null,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-06-29T10:00:16.692653Z",
"updatedAt":"2021-06-29T10:00:16.692654Z",
"operators":[]
},
"isRequired":false,
"conditions":[
{
"id":"44982f5d-07ce-4c2e-88a8-6694fc598f21",
"value":"complaint",
"fields":[
{
"field":{
"id":"e130e3f2-c8de-4ba9-a26e-8ac705642832",
"title":"Complaints",
"type":"TEXT",
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:55.755685Z",
"updatedAt":"2021-06-29T10:00:55.755686Z",
"operators":[]
},
"isRequired":false
}
]
},
{
"id":"57bf2c95-c318-4c5a-9e03-a98193b178ae",
"value":"inquiry",
"fields":[
{
"field":{
"id":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title":"Inquiry",
"type":"TEXT",
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:33.777564Z",
"updatedAt":"2021-06-29T10:00:33.777565Z",
"operators":[]
},
"isRequired":false
}
]
}
]
}
],
"createdAt":"2021-06-29T10:01:11.633649Z",
"updatedAt":"2021-06-29T10:01:11.633650Z"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid field id":{
"summary":"Invalid field id",
"description":"Invalid field id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversation-forms/forms/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get conversation form",
"description":"Use this method to get a single form. ",
"operationId":"get-conversation-form",
"parameters":[
{
"name":"id",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"75f57446-1d65-478a-87ed-22d17dc3d077",
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":[
{
"field":{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"isEnabled":true,
"isDefault":false,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-06-29T10:00:16.692653Z",
"updatedAt":"2021-06-29T10:00:16.692654Z",
"operators":[]
},
"isRequired":true,
"conditions":[]
}
],
"createdAt":"2021-06-29T10:01:11.633649Z",
"updatedAt":"2021-06-29T10:01:11.633650Z"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Update conversation form",
"description":"Use this method to update a form.",
"operationId":"update-conversation-form",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form to update.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":[
{
"fieldId":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"isRequired":false
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"75f57446-1d65-478a-87ed-22d17dc3d077",
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":[
{
"field":{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"isEnabled":true,
"isDefault":false,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-06-29T10:00:16.692653Z",
"updatedAt":"2021-06-29T10:00:16.692654Z",
"operators":[]
},
"isRequired":true,
"conditions":[]
}
],
"createdAt":"2021-06-29T10:01:11.633649Z",
"updatedAt":"2021-06-29T10:01:11.633650Z"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid form id or field id":{
"summary":"Invalid form id or field id",
"description":"Invalid form id or field id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Delete conversation form",
"description":"Use this method to delete the form.",
"operationId":"delete-conversation-form",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the form to delete.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Form deleted successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversation-forms/fields":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get fields",
"description":"Use this method to get a list of fields with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.",
"operationId":"get-conversation-form-fields",
"parameters":[
{
"name":"title",
"in":"query",
"description":"Optional filter. Field title.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Create field",
"description":"Use this method to create a field.",
"operationId":"create-conversation-form-field",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest"
},
"examples":{
"Creating field of TEXT type.":{
"summary":"Creating field of TEXT type.",
"description":"Creating field of TEXT type.",
"value":{
"title":"Inquiry",
"type":"TEXT"
}
},
"Creating field of DROPDOWN type.":{
"summary":"Creating field of DROPDOWN type.",
"description":"Creating field of DROPDOWN type.",
"value":{
"title":"Type",
"type":"DROPDOWN",
"options":[
"inquiry",
"complaint"
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
},
"examples":{
"Successful response for field of TEXT type":{
"summary":"Successful response for field of TEXT type",
"description":"Successful response for field of TEXT type",
"value":{
"id":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title":"Inquiry",
"type":"TEXT",
"regex":null,
"isEnabled":true,
"options":[],
"createdAt":"2021-06-29T10:00:55.755685Z",
"updatedAt":"2021-06-29T10:00:55.755686Z",
"operators":[]
}
},
"Successful response for field of DROPDOWN type":{
"summary":"Successful response for field of DROPDOWN type",
"description":"Successful response for field of DROPDOWN type",
"value":{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"regex":null,
"isEnabled":true,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-06-29T10:00:55.755685Z",
"updatedAt":"2021-06-29T10:00:55.755686Z",
"operators":[]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversation-forms/fields/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get field",
"description":"Use this method to get a single field. ",
"operationId":"get-conversation-form-field",
"parameters":[
{
"name":"id",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title":"Inquiry",
"type":"TEXT",
"regex":null,
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:33.777564Z",
"updatedAt":"2021-06-29T10:00:33.777565Z",
"operators":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid field id":{
"summary":"Invalid field id",
"description":"Invalid field id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Update field",
"description":"Use this method to update a field.",
"operationId":"update-conversation-form-field",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the field being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest"
},
"examples":{
"Updating field.":{
"summary":"Updating field.",
"description":"Updating field.",
"value":{
"title":"Type",
"enabled":false
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"regex":null,
"isEnabled":false,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-06-29T10:00:55.755685Z",
"updatedAt":"2021-06-29T10:00:55.755686Z",
"operators":[]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid field id":{
"summary":"Invalid field id",
"description":"Invalid field id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Delete field",
"description":"Use this method to delete the field. \nDeleting a field will remove associated agent inputs in all non-closed conversations. This operation cannot be reverted!",
"operationId":"delete-conversation-form-field",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the field being deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Field deleted successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc given! No such field exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversation-forms/triggers":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get triggers",
"description":"Use this method to get a list of triggers with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filter described in the parameters.",
"operationId":"get-conversation-form-triggers",
"parameters":[
{
"name":"title",
"in":"query",
"description":"Optional filter. Trigger title.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.TriggerResultPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Create trigger",
"description":"The create trigger method creates a new trigger at the first order position in the existing setup. Triggers are used to assign proper form to a conversation, based on an expression. Every expression can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. Order of triggers is essential in the form assignment process, as triggers are match the provided order. First trigger matching the conversation will be used. \n More info",
"operationId":"create-conversation-form-trigger",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Creating trigger":{
"summary":"Creating trigger",
"description":"Creating trigger",
"value":{
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"b3695d3c-6415-4bdd-82fc-07f9309933ec",
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":0,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"timesTriggered":0
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid form id":{
"summary":"Invalid form id",
"description":"Invalid form id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversation-forms/triggers/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get trigger",
"description":"Use this method to get a single trigger. ",
"operationId":"get-conversation-form-trigger",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the trigger.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"b3695d3c-6415-4bdd-82fc-07f9309933ec",
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":0,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"timesTriggered":0
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id b3695d3c-6415-4bdd-82fc-07f9309933ec given! No such trigger exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Update trigger",
"description":"Use this method to update a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position. More info",
"operationId":"update-conversation-form-trigger",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the trigger to update.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Updating trigger":{
"summary":"Updating trigger",
"description":"Updating trigger",
"value":{
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":2,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"b3695d3c-6415-4bdd-82fc-07f9309933ec",
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":2,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"timesTriggered":0
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid form id":{
"summary":"Invalid form id",
"description":"Invalid form id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Delete trigger",
"description":"Use this method to delete a trigger.",
"operationId":"delete-conversation-form-trigger",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the trigger to delete.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Trigger deleted successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id b3695d3c-6415-4bdd-82fc-07f9309933ec given! No such trigger exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"patch":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Patch trigger",
"description":"Use this method to patch a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position.\n More info",
"operationId":"patch-conversation-form-trigger",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the trigger to patch.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Patching trigger":{
"summary":"Patching trigger",
"description":"Patching trigger",
"value":{
"orderIndex":2
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"b3695d3c-6415-4bdd-82fc-07f9309933ec",
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":2,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"timesTriggered":0
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid form id":{
"summary":"Invalid form id",
"description":"Invalid form id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversations/{conversationId}/form":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Get dispositions",
"description":"Use this method to get a conversation form with attached fields and values. ",
"operationId":"get-conversation-form-dispositions",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"formId",
"in":"query",
"description":"Id of the form. If none provided, the one currently assigned to a conversation is used.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionBasic"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"conversationId":"F876A7C5C73A1B3CA94FE405DF30D0A2",
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"fields":[
{
"fieldId":"d85b8e46-f579-482f-b383-22648aae17b5",
"dispositionId":"d7a2980d-5496-44aa-8046-bf2233e7999f",
"dispositionValue":"inquiry"
},
{
"fieldId":"e130e3f2-c8de-4ba9-a26e-8ac705642832",
"dispositionId":"8f7faac9-742c-42d6-bac7-c8a63f587e57",
"dispositionValue":null
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"No dispositions":{
"summary":"No dispositions",
"description":"No dispositions",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"No dispositions for conversationId F876A7C5C73A1B3CA94FE405DF30D0A2 and formId 75f57446-1d65-478a-87ed-22d17dc3d077."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Update or insert dispositions",
"description":"Use this method to create or update field value for a conversation. Method overwrites old dispositions.",
"operationId":"upsert-conversation-form-dispositions",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionApiRequest"
},
"examples":{
"Disposition insert or update":{
"summary":"Disposition insert or update",
"description":"Disposition insert or update",
"value":{
"fields":[
{
"fieldId":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"value":"updating an existing disposition"
},
{
"fieldId":"d85b8e46-f579-482f-b383-22648aae17b5",
"value":"creating a new disposition"
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Disposition updated successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Required request body is missing or not valid."
}
}
}
},
"Closed conversation":{
"summary":"Closed conversation",
"description":"Closed conversation",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Can not proceed with the action! Conversation is closed."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid conversation id":{
"summary":"Invalid conversation id",
"description":"Invalid conversation id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversations/{conversationId}/form/{id}":{
"delete":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Delete disposition",
"description":"Use this method to delete an agent input to a field from a conversation.",
"operationId":"delete-conversation-form-disposition",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"id",
"in":"path",
"description":"Id of the disposition being deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Disposition deleted successfully."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Closed conversation":{
"summary":"Closed conversation",
"description":"Closed conversation",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Can not proceed with the action! Conversation is closed."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid conversation id":{
"summary":"Invalid conversation id",
"description":"Invalid conversation id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversations/{conversationId}/form/assign":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Assign form to conversation",
"description":"Use this method to assign form to a conversation. ",
"operationId":"assign-conversation-form",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"formId",
"in":"query",
"description":"Id of the form to assign.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Form successfully assigned."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Disabled form":{
"summary":"Disabled form",
"description":"Disabled form",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Can not proceed with the action! Form 75f57446-1d65-478a-87ed-22d17dc3d077 is disabled."
}
}
}
},
"Closed conversation":{
"summary":"Closed conversation",
"description":"Closed conversation",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Can not proceed with the action! Conversation is closed."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid conversation id":{
"summary":"Invalid conversation id",
"description":"Invalid conversation id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists."
}
}
}
},
"Invalid form id":{
"summary":"Invalid form id",
"description":"Invalid form id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 75f57446-1d65-478a-87ed-22d17dc3d077 given! No such form exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/2/conversations/{conversationId}/form/unassign":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"conversation-forms"
],
"summary":"Un-assign form from conversation",
"description":"Use this method to remove a form from a given conversation. Un-assign is implemented by setting the formId property of the Conversation to null.",
"operationId":"un-assign-conversation-form",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Id of the conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Form successfully un-assigned."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Closed conversation":{
"summary":"Closed conversation",
"description":"Closed conversation",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Can not proceed with the action! Conversation is closed."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse"
},
"examples":{
"Invalid conversation id":{
"summary":"Invalid conversation id",
"description":"Invalid conversation id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 0006D2EC59B1DEB114FE3931FC365F29 given! No such conversation exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/account/configuration":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"account-configuration"
],
"summary":"Update account configuration",
"description":"This endpoint is deprecated as of March 12, 2025, meaning no fixes or updates will be provided. It will be completely removed on December 31, 2026. Configure the webhooks through the Subscription management section in your Infobip account or the existing Subscriptions management API.",
"operationId":"update-conversation-account-configuration",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AccountConfigurationRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Account configuration successfully updated."
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccca/1/agent-configs/{agentId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"agent-configuration-calls"
],
"summary":"Get agent configuration",
"description":"Use this method to retrieve the current agent-specific configuration.",
"operationId":"get-conversations-agent-config",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent ID used to retrieve the configuration.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"wrapUpSeconds":30,
"backgroundBlurSettings":{
"mode":"VIRTUAL_BACKGROUND",
"fileMetadata":{
"fileId":"91184DE7-92BF-4F94-875C-8E701AE71DF9",
"fileName":"background.jpg",
"fileSize":3605569,
"fileUrl":"https://file.cloudfront.net/client-contact-center-background-images/someImageUrl"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/outbound-call-conversation":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"outbound-call-conversation-calls"
],
"summary":"Create outbound call conversation",
"description":"Use this method to create a conversation associated with an outbound call. Expected usage is to trigger this endpoint and then start a call using the RTC SDK callConversations method. The created conversation ID is required when using the callConversations method to trigger an outbound call. Another option is to use the ID of a previously created call conversation. More info.",
"operationId":"create-conversation-outbound-call",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationRequestApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationResponseApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"from":"385998779621",
"to":"38761123333",
"conversationId":"718A037A2FE0D2D5AA2D12A7240ED8C4",
"agentId":"2010EA93ABC142E812C19F529BCBD22F"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing parameter":{
"summary":"Missing parameter",
"description":"Missing parameter",
"value":{
"status":"ERROR",
"message":"to: Param TO must have non blank value"
}
},
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"status":"ERROR",
"message":"No agent found with id=E5FB76C90DD4203DF04364004843BAFC"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/waiting-strategies":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"waiting-strategies-calls"
],
"summary":"Get all waiting strategies",
"description":"Use this method to retrieve all waiting strategies. More info.",
"operationId":"get-conversations-waiting-strategies",
"parameters":[
{
"name":"queueId",
"in":"query",
"description":"Optional filter. Queue id.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"pageNumber",
"in":"query",
"description":"Optional filter. Page number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer"
}
},
{
"name":"pageSize",
"in":"query",
"description":"Optional filter. Page size.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer"
}
},
{
"name":"sortDirection",
"in":"query",
"description":"Optional filter. This parameter is used to order your results. If an order is not given, the default order DESC will be applied. Supported values are ASC and DESC.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"sortBy",
"in":"query",
"description":"Optional filter. This parameter is used to specify sort criteria. If a criteria is not given, the default criteria CREATED_AT will be applied. Supported values are NAME and CREATED_AT.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"elements":[
{
"id":"e2cea358-0347-4d23-9d82-af00f8f5c5b2",
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
],
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
},
{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[],
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
],
"total":2,
"totalPages":1
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"waiting-strategies-calls"
],
"summary":"Create waiting strategy",
"description":"Use this method to add a new waiting strategy. To upload an audio file and get value for fileDescriptor field, use Upload audio files endpoint. More info.",
"operationId":"create-conversations-waiting-strategy",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest"
},
"examples":{
"Create sender-based waiting strategy.":{
"summary":"Create sender-based waiting strategy.",
"description":"Create sender-based waiting strategy.",
"value":{
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
}
}
},
"Create queue-based waiting strategy.":{
"summary":"Create queue-based waiting strategy.",
"description":"Create queue-based waiting strategy.",
"value":{
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse"
},
"examples":{
"Response for successfully creating a sender-based waiting strategy.":{
"summary":"Response for successfully creating a sender-based waiting strategy.",
"description":"Response for successfully creating a sender-based waiting strategy.",
"value":{
"id":"e2cea358-0347-4d23-9d82-af00f8f5c5b2",
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
],
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
},
"Response for successfully creating a queue-based waiting strategy.":{
"summary":"Response for successfully creating a queue-based waiting strategy.",
"description":"Response for successfully creating a queue-based waiting strategy.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[],
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing maximum wait time":{
"summary":"Missing maximum wait time",
"description":"Missing maximum wait time",
"value":{
"status":"ERROR",
"message":"maximumWaitTime: Missing Maximum Wait Time"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/waiting-strategies/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"waiting-strategies-calls"
],
"summary":"Get waiting strategy",
"description":"Use this method to retrieve a waiting strategy by its Id. More info.",
"operationId":"get-conversations-waiting-strategy",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Waiting Strategy to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse"
},
"examples":{
"Response for successfully retrieving a sender-based waiting strategy.":{
"summary":"Response for successfully retrieving a sender-based waiting strategy.",
"description":"Response for successfully retrieving a sender-based waiting strategy.",
"value":{
"id":"e2cea358-0347-4d23-9d82-af00f8f5c5b2",
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
],
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
},
"Response for successfully retrieving a queue-based waiting strategy.":{
"summary":"Response for successfully retrieving a queue-based waiting strategy.",
"description":"Response for successfully retrieving a queue-based waiting strategy.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[],
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"waiting-strategies-calls"
],
"summary":"Update waiting strategy",
"description":"Use this method to update a waiting strategy. To upload an audio file and get value for fileDescriptor field, use Upload audio files endpoint. More info.",
"operationId":"update-conversations-waiting-strategy",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Waiting Strategy being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest"
},
"examples":{
"Update sender-based waiting strategy.":{
"summary":"Update sender-based waiting strategy.",
"description":"Update sender-based waiting strategy.",
"value":{
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
}
}
},
"Update queue-based waiting strategy.":{
"summary":"Update queue-based waiting strategy.",
"description":"Update queue-based waiting strategy.",
"value":{
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse"
},
"examples":{
"Response for successfully updating a sender-based waiting strategy.":{
"summary":"Response for successfully updating a sender-based waiting strategy.",
"description":"Response for successfully updating a sender-based waiting strategy.",
"value":{
"id":"e2cea358-0347-4d23-9d82-af00f8f5c5b2",
"name":"Test Sender Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
],
"conditionType":"SENDER",
"condition":{
"senders":[
{
"clientType":"PSTN",
"identifier":"123456789"
},
{
"clientType":"WEBRTC",
"identifier":"conversations"
}
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
},
"Response for successfully updating a queue-based waiting strategy.":{
"summary":"Response for successfully updating a queue-based waiting strategy.",
"description":"Response for successfully updating a queue-based waiting strategy.",
"value":{
"id":"25774a87-078a-4fe7-8d43-127809479964",
"name":"Test Queue Waiting Strategy",
"maximumWaitTime":{
"unit":"SECONDS",
"value":5
},
"greetingMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"musicOnHold":{
"enabled":false,
"fileAudioSource":null
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":3
}
},
"maximumWaitTimeMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Greetings!",
"language":"en-gb",
"voice":{
"name":"Emma",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null
},
"senders":[],
"conditionType":"QUEUE",
"condition":{
"queues":[
"e80552ae-d8e6-4123-93a3-35e7721d1cdd",
"default"
]
},
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing maximum wait time":{
"summary":"Missing maximum wait time",
"description":"Missing maximum wait time",
"value":{
"status":"ERROR",
"message":"maximumWaitTime: Missing Maximum Wait Time"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"waiting-strategies-calls"
],
"summary":"Delete waiting strategy",
"description":"Use this method to delete a waiting strategy by its Id. More info.",
"operationId":"delete-conversations-waiting-strategy",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Waiting Strategy being deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Waiting Strategy deleted."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Waiting strategy not found":{
"summary":"Waiting strategy not found",
"description":"Waiting strategy not found",
"value":{
"status":"ERROR",
"message":"No record found with WS Id: e2cea358-0347-4d23-9d82-af00f8f5c5b2"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":100
}
]
}
},
"/ccaas/voice/2/account-recording-config":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Get account recording configuration",
"description":"Use this method to retrieve the account recording configuration. More info.",
"operationId":"get-conversations-account-recording-config",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Update account recording configuration",
"description":"Use this method to create or update an account recording configuration. More info.",
"operationId":"update-conversations-account-recording-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing Media Type":{
"summary":"Missing Media Type",
"description":"Missing Media Type",
"value":{
"status":"ERROR",
"message":"mediaType: Missing Media Type"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Create account recording configuration",
"description":"Use this method to create an account recording configuration. More info.",
"operationId":"create-conversations-account-recording-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing Media Type":{
"summary":"Missing Media Type",
"description":"Missing Media Type",
"value":{
"status":"ERROR",
"message":"mediaType: Missing Media Type"
}
},
"Account recording config already exists":{
"summary":"Account recording config already exists",
"description":"Account recording config already exists",
"value":{
"status":"ERROR",
"message":"Account recording config already exists!"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/agent-recording-configs":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Get agent recording configurations",
"description":"Use this method to retrieve agent recording configurations. More info.",
"operationId":"get-conversations-agent-recording-configs",
"parameters":[
{
"name":"agentIds",
"in":"query",
"description":"Agent ids of agent recording configs to get.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":[
{
"agentId":"06869037EBD6756A98B7C621D0869DA7",
"inbound":true,
"outbound":true,
"mediaType":"AUDIO_AND_VIDEO",
"useDefault":true,
"enabled":true,
"enabledChangedAt":21622024333000
},
{
"agentId":"05261D01CC88F5A8C0C7C3A1EF74E430",
"inbound":true,
"outbound":false,
"mediaType":"AUDIO",
"useDefault":true,
"enabled":false,
"enabledChangedAt":1622025585000
}
]
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/agent-recording-configs/{agentId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Get agent recording configuration",
"description":"Use this method to retrieve the agent recording configuration. More info.",
"operationId":"get-conversations-agent-recording-config",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent id of agent recording config to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"agentId":"05261D01CC88F5A8C0C7C3A1EF74E430",
"inbound":true,
"outbound":true,
"mediaType":"AUDIO_AND_VIDEO",
"useDefault":true,
"enabled":false,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Agent not found":{
"summary":"Agent not found",
"description":"Agent not found",
"value":{
"status":"ERROR",
"message":"No agent found with id=E5FB76C90DD4203DF04364004843BAFB"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Update agent recording configuration",
"description":"Use this method to create or update an agent recording configuration. More info.",
"operationId":"update-conversations-agent-recording-config",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent id of agent recording config to update.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Either outbound or inbound should be selected":{
"summary":"Either outbound or inbound should be selected",
"description":"Either outbound or inbound should be selected",
"value":{
"status":"ERROR",
"message":"mediaType: Missing Media Type; inbound: Either inbound or outbound should be selected"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Agent not found":{
"summary":"Agent not found",
"description":"Agent not found",
"value":{
"status":"ERROR",
"message":"No agent found with id=E5FB76C90DD4203DF04364004843BAFB"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"recording-configuration-calls"
],
"summary":"Create agent recording configuration",
"description":"Use this method to create an agent recording configuration. More info.",
"operationId":"create-conversations-agent-recording-config",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent id of agent recording config to create.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Either outbound or inbound should be selected":{
"summary":"Either outbound or inbound should be selected",
"description":"Either outbound or inbound should be selected",
"value":{
"status":"ERROR",
"message":"mediaType: Missing Media Type; inbound: Either inbound or outbound should be selected"
}
},
"Agent recording config already exists":{
"summary":"Agent recording config already exists",
"description":"Agent recording config already exists",
"value":{
"status":"ERROR",
"message":"Agent recording config already exists!"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Agent not found":{
"summary":"Agent not found",
"description":"Agent not found",
"value":{
"status":"ERROR",
"message":"No agent found with id=E5FB76C90DD4203DF04364004843BAFB"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/recording/metadata":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"recording-metadata-calls"
],
"summary":"Get recording metadata",
"description":"Use this method to retrieve a pageable list of recording metadata based on parameters.",
"operationId":"get-conversations-recording-metadata",
"parameters":[
{
"name":"recordingId",
"in":"query",
"description":"Unique id of the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"conversationId",
"in":"query",
"description":"Unique id of the conversation.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"conferenceId",
"in":"query",
"description":"Unique id of the conference.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"callId",
"in":"query",
"description":"Unique id of the call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"direction",
"in":"query",
"description":"Call direction of recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"filename",
"in":"query",
"description":"Filename of recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"participantId",
"in":"query",
"description":"Participant id associated with the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"participantIdentity",
"in":"query",
"description":"Participant identity associated with the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"participantName",
"in":"query",
"description":"Participant name associated with the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"participantType",
"in":"query",
"description":"Participant type associated with the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"mediaType",
"in":"query",
"description":"Media type of recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"deletedBy",
"in":"query",
"description":"Identity of the user who deleted the recorded file.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"transferredFrom",
"in":"query",
"description":"Identity of the user who has transferred the call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"transferredTo",
"in":"query",
"description":"Identity of the user to whom the call has been transferred.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"transferredFromQueue",
"in":"query",
"description":"Queue id from which the call has been transferred.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"transferredToQueue",
"in":"query",
"description":"Queue id to which the call has been transferred.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"durationFrom",
"in":"query",
"description":"Minimum duration to filter recorded files.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"durationTo",
"in":"query",
"description":"Maximum duration to filter recorded files.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"startedAtFrom",
"in":"query",
"description":"Lower bound for filtering by recording start time.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"startedAtTo",
"in":"query",
"description":"Upper bound for filtering by recording start time.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"deletedAtFrom",
"in":"query",
"description":"Lower bound for filtering by deleted at time.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"deletedAtTo",
"in":"query",
"description":"Upper bound for filtering by deleted at time.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64"
}
},
{
"name":"page",
"in":"query",
"description":"Page number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Page size.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":999,
"minimum":1
}
},
{
"name":"sortBy",
"in":"query",
"description":"Field by which the sorting will be done.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"sortDirection",
"in":"query",
"description":"Type of sorting.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Direction"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.RecordingMetadataApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"elements":[
{
"id":1,
"recordingId":"11f1b111-1111-1111-a111-1111e11f111e",
"conversationId":"11f1b111-1111-1111-a111-1111e11f111a",
"conferenceId":"11f1b111-1111-1111-a111-1111e11f111b",
"callId":"11f1b111-1111-1111-a111-1111e11f111c",
"direction":"INBOUND",
"recordingStatus":"SUCCESSFUL",
"composed":false,
"filename":"11f1b111-1111-1111-a111-1111e11f111a_IDENTITY_20230612155341-11f1b111-1111-1111-a111-1111e11f111e.wav",
"duration":28,
"participantId":"11f1b111-1111-1111-a111-1111e11f111d",
"participantIdentity":"customer1",
"participantName":"Customer 1",
"participantType":"CUSTOMER",
"mediaType":"AUDIO",
"startedAt":1686585221999,
"deletedAt":null,
"deletedBy":null,
"sftpPath":null,
"transferredFrom":null,
"transferredTo":null,
"transferredFromQueue":null,
"transferredToQueue":null
},
{
"id":2,
"recordingId":"52341263-0a22-1111-a1a1-1111bade8581",
"conversationId":"52341263-0a22-1111-a1a1-1111bade8582",
"conferenceId":"52341263-0a22-1111-a1a1-1111bade8583",
"callId":"52341263-0a22-1111-a1a1-1111bade8584",
"direction":"INBOUND",
"recordingStatus":"SUCCESSFUL",
"composed":false,
"filename":"52341263-0a22-1111-a1a1-1111bade8582_IDENTITY_20230612155341-52341263-0a22-1111-a1a1-1111bade8581.wav",
"duration":28,
"participantId":"52341263-0a22-1111-a1a1-1111bade8584",
"participantIdentity":"agent1",
"participantName":"Agent 1",
"participantType":"AGENT",
"mediaType":"AUDIO",
"startedAt":1686585221999,
"deletedAt":null,
"deletedBy":null,
"sftpPath":null,
"transferredFrom":null,
"transferredTo":null,
"transferredFromQueue":null,
"transferredToQueue":null
}
],
"total":2,
"totalPages":1
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Size must be greater or equal to 1":{
"summary":"Size must be greater or equal to 1",
"description":"Size must be greater or equal to 1",
"value":{
"status":"ERROR",
"message":"size: must be greater than or equal to 1"
}
},
"Page must be greater or equal to 0":{
"summary":"Page must be greater or equal to 0",
"description":"Page must be greater or equal to 0",
"value":{
"status":"ERROR",
"message":"page: must be greater than or equal to 0"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/recording/download/{recordingId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"recording-calls"
],
"summary":"Download call recording",
"description":"Use this endpoint to download a call recording using recordingId.",
"operationId":"download-call-recording",
"parameters":[
{
"name":"recordingId",
"in":"path",
"description":"Id of the recording to download.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"Range",
"in":"header",
"description":"Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/octet-stream":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody"
}
}
}
},
"206":{
"description":"Partial Content",
"content":{
"application/octet-stream":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody"
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"status":"ERROR",
"message":"Invalid range header format"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"Recording file abcdefgh-1234-5678-9012-abcdefgh not found!"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":100,
"requestedTokens":1,
"burstCapacity":100
}
]
}
},
"/ccaas/voice/2/account-wrap-up-config":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"wrap-up-configuration-calls"
],
"summary":"Get account wrap up configuration",
"description":"Use this method to retrieve the current account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. More info.",
"operationId":"get-conversations-account-wrap-up-config",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"wrapUpSeconds":30,
"canExtendWrapUp":true,
"enabled":true
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"wrap-up-configuration-calls"
],
"summary":"Update account wrap up configuration",
"description":"Use this method to update account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. More info.",
"operationId":"update-conversations-account-wrap-up-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"wrapUpSeconds":30,
"canExtendWrapUp":true,
"enabled":true
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Missing parameters":{
"summary":"Missing parameters",
"description":"Missing parameters",
"value":{
"status":"ERROR",
"message":"wrapUpSeconds: Missing wrapup duration."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccca/1/agent-configs/{agentId}/wrap-up":{
"put":{
"tags":[
"customer-engagement",
"conversations",
"wrap-up-configuration-calls"
],
"summary":"Update agent wrap up configuration",
"description":"Use this method to create or update agent wrap up configuration.",
"operationId":"update-conversations-agent-wrap-up-config",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent ID used to update the configuration.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"wrapUpSeconds",
"in":"query",
"description":"Wrap up duration in seconds for agent. Setting null will default to account wrap up duration. Send this parameter in request body instead.More info.",
"required":false,
"deprecated":true,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"minimum":0
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigWrapUpApiModel"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"wrapUpSeconds":30,
"backgroundBlurSettings":{
"mode":"VIRTUAL_BACKGROUND",
"fileMetadata":{
"fileId":"91184DE7-92BF-4F94-875C-8E701AE71DF9",
"fileName":"background.jpg",
"fileSize":3605569,
"fileUrl":"https://file.cloudfront.net/client-contact-center-background-images/someImageUrl"
}
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"status":"ERROR",
"message":"agentConfig.wrapUpSeconds: must be greater than or equal to 0"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/agent/{agentId}/wrap-up-time/add/{seconds}":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"wrap-up-time-calls"
],
"summary":"Add agent wrap up time",
"description":"Use this method to extend the agent wrap up time after a call, by specified number of seconds. Number of seconds should be a positive number. Agent should be in Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. More info.",
"operationId":"add-conversations-agent-wrap-up-time",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent id of agent wrap up to add.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"seconds",
"in":"path",
"description":"Number of seconds to extend wrap up time.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int32"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Agent wrap up time added successfully."
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Invalid seconds number":{
"summary":"Invalid seconds number",
"description":"Invalid seconds number",
"value":{
"status":"ERROR",
"message":"Number of seconds should be greater then 0."
}
},
"Agent not in Wrapping status":{
"summary":"Agent not in Wrapping status",
"description":"Agent not in Wrapping status",
"value":{
"status":"ERROR",
"message":"Agent is not in Wrapping status."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/agent/{agentId}/wrap-up-time/clear":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"wrap-up-time-calls"
],
"summary":"Clear agent wrap up time",
"description":"Use this method to clear the agent wrap up time after a call. After that, the agent will no longer have Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. More info.",
"operationId":"clear-conversations-agent-wrap-up-time",
"parameters":[
{
"name":"agentId",
"in":"path",
"description":"Agent id of agent wrap up to clear.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Agent wrap up time cleared successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/conversation/{conversationId}/transfer/agent":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"transfers-calls"
],
"summary":"Transfer call to another agent",
"description":"Use this method to transfer a call to another agent. Please note that the targeted agent must be available for the transfer to succeed. The conversation will be assigned to the targeted agent once they answer the call. More info.",
"operationId":"transfer-call-to-agent",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Conversation ID whose call is being transferred.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"82f57414-b989-4856-ac9f-32a54e9ee86b"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToAgentRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Call transferred successfully."
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"NOT FOUND",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Agent is not found":{
"summary":"Agent is not found",
"description":"Agent is not found",
"value":{
"status":"ERROR",
"message":"Destination for given transfer is not found."
}
}
}
}
}
},
"409":{
"description":"NOT AVAILABLE",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Agent is not available":{
"summary":"Agent is not available",
"description":"Agent is not available",
"value":{
"status":"ERROR",
"message":"Given destination for transfer is currently not available."
}
}
}
}
}
},
"412":{
"description":"PRECONDITION FAILED",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Conference is missing for given conversationId":{
"summary":"Conference is missing for given conversationId",
"description":"Conference is missing for given conversationId",
"value":{
"status":"ERROR",
"message":"Conference is missing for given conversationId."
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/transfer/queues":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"transfers-calls"
],
"summary":"Fetch queues eligible as transfer destination",
"description":"This method retrieves a list of all queues and returns them along with their current activity status. The activity status indicates whether or not a queue is currently inside of working hours. The list of queues and their activity can be used to determine which queues are currently able to receive incoming transfer requests. More info.",
"operationId":"get-transfer-queues",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":2000,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.PageResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"elements":[
{
"queueId":"FD213C73E81B6AFG241AA3462128BD2A",
"queueName":"Queue1",
"active":true,
"autoAssignmentEnabled":true
},
{
"queueId":"MAC923F1G7D439CF6F0A2K2L6EA6134",
"queueName":"Queue2",
"active":false,
"autoAssignmentEnabled":true
},
{
"queueId":null,
"queueName":"Default Queue",
"active":false,
"autoAssignmentEnabled":true
}
],
"total":3,
"totalPages":1
}
}
}
}
}
},
"400":{
"description":"BAD REQUEST",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Size must be greater or equal to 1":{
"summary":"Size must be greater or equal to 1",
"description":"Size must be greater or equal to 1",
"value":{
"status":"ERROR",
"message":"size: must be greater than or equal to 1"
}
},
"Page must be greater or equal to 0":{
"summary":"Page must be greater or equal to 0",
"description":"Page must be greater or equal to 0",
"value":{
"status":"ERROR",
"message":"page: must be greater than or equal to 0"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":100
}
]
}
},
"/ccaas/voice/2/conversation/{conversationId}/transfer/queue":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"transfers-calls"
],
"summary":"Transfer call to another queue",
"description":"Use this method to transfer a call to another queue. Please note that the targeted queue must be within working hours and have auto-assignment enabled for the transfer to succeed. The agent selection process will be run, and the conversation will be assigned to the agent who answers the call. More info.",
"operationId":"transfer-call-to-queue",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Conversation ID whose call is being transferred.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"82f57414-b989-4856-ac9f-32a54e9ee86b"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToQueueRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Call transferred successfully."
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"NOT FOUND",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Queue is not found":{
"summary":"Queue is not found",
"description":"Queue is not found",
"value":{
"status":"ERROR",
"message":"Destination for given transfer is not found."
}
}
}
}
}
},
"409":{
"description":"NOT AVAILABLE",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Queue is not available":{
"summary":"Queue is not available",
"description":"Queue is not available",
"value":{
"status":"ERROR",
"message":"Given destination for transfer is currently not available."
}
}
}
}
}
},
"412":{
"description":"PRECONDITION FAILED",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Conference is missing for given conversationId":{
"summary":"Conference is missing for given conversationId",
"description":"Conference is missing for given conversationId",
"value":{
"status":"ERROR",
"message":"Conference is missing for given conversationId."
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/conversation/{conversationId}/transfer/external-number":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"transfers-calls"
],
"summary":"Transfer call to external number",
"description":"Use this method to transfer the call to an external phone number. Depending on the Transfer to External Number configuration, the Agent can transfer the call to any valid phone number or only to the numbers in the People with the external_number tag. More info.",
"operationId":"transfer-call-to-external-number",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Conversation ID whose call is being transferred.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"82f57414-b989-4856-ac9f-32a54e9ee86b"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Call transferred successfully."
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/30bce31dfbdcb9fa9268f4e4ce1f7ccf05ef063a92c880be9d1b9efcfc2ac71a.ApiException"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Empty or invalid request payload"
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"409":{
"description":"Not Available",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"External number is not available":{
"summary":"External number is not available",
"description":"External number is not available",
"value":{
"status":"ERROR",
"message":"Given destination for transfer is currently not available."
}
}
}
}
}
},
"412":{
"description":"Precondition Failed",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Conference is missing for given conversationId":{
"summary":"Conference is missing for given conversationId",
"description":"Conference is missing for given conversationId",
"value":{
"status":"ERROR",
"message":"Conference is missing for given conversationId."
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/transfer-configs/external-number":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"transfer-to-external-number-configuration-calls"
],
"summary":"Get transfer to external number configuration",
"description":"Use this endpoint to get a Transfer to external number configuration. More info.",
"operationId":"get-transfer-to-external-number-config",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"tagName":"external_number",
"transferToAnyNumberEnabled":true,
"createdAt":"2022-11-18T09:23:44.033Z",
"updatedAt":"2023-01-24T21:44:31.630Z"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No transfer to external number config found."
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"transfer-to-external-number-configuration-calls"
],
"summary":"Update transfer to external number configuration",
"description":"Use this endpoint to update an already existing transfer to external number configuration. More info.",
"operationId":"update-transfer-to-external-number-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"tagName":"external_number",
"transferToAnyNumberEnabled":true,
"createdAt":"2022-11-18T09:23:44.033Z",
"updatedAt":"2023-01-24T21:44:31.630Z"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Empty or invalid request payload"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/transfer-configs/transfer-strategy":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"transfer-strategy-calls"
],
"summary":"Get transfer strategy",
"description":"Use this endpoint to get a Transfer Strategy. More info.",
"operationId":"get-transfer-strategy",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"642bf5f4ff5dd177aeb00889",
"musicOnHold":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"You're are being transferred...",
"language":"en",
"voice":{
"name":"Joanna",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":5
}
},
"createdAt":"2023-04-04T10:03:32.729Z",
"updatedAt":"2023-04-06T11:22:18.149Z"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No transfer strategy found."
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"transfer-strategy-calls"
],
"summary":"Update transfer strategy",
"description":"Use this endpoint to update an already existing Transfer Strategy. More info.",
"operationId":"update-transfer-strategy",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"642bf5f4ff5dd177aeb00889",
"musicOnHold":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"You're are being transferred...",
"language":"en",
"voice":{
"name":"Joanna",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":5
}
},
"createdAt":"2023-04-04T10:03:32.729Z",
"updatedAt":"2023-04-06T11:22:18.149Z"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Empty or invalid request payload"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/{conversationId}/hold":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"call-hold-calls"
],
"summary":"Put client on hold",
"description":"Use this method to put your client on hold. More info.",
"operationId":"set-call-on-hold",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Conversation id of the conversation which you want to put on hold.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"SUCCESS",
"message":"Hold action successful."
}
}
}
}
}
},
"400":{
"description":"BAD REQUEST",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"status":"ERROR",
"message":"Hold action failed."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"NOT FOUND",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"Not Found."
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/{conversationId}/unhold":{
"patch":{
"tags":[
"customer-engagement",
"conversations",
"call-hold-calls"
],
"summary":"Put client off hold",
"description":"Use this method to release your client from hold. More info.",
"operationId":"release-call-from-hold",
"parameters":[
{
"name":"conversationId",
"in":"path",
"description":"Conversation id of the conversation which you want to put off hold.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":"{\n \"status\": \"SUCCESS\"\n \"message\": \"Unhold action successful.\"\n}\n"
}
}
}
}
},
"400":{
"description":"BAD REQUEST",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"status":"ERROR",
"message":"Unhold action failed."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"NOT FOUND",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"Not Found."
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/hold-configs-per-queue":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"hold-configuration-calls"
],
"summary":"Get hold configurations",
"description":"Use this endpoint to retrieve multiple hold configurations based on the page number and page size parameters. More info.",
"operationId":"get-multiple-hold-configs",
"parameters":[
{
"name":"pageNumber",
"in":"query",
"description":"Number of the page to show.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"pageSize",
"in":"query",
"description":"Size of a single page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"sortDirection",
"in":"query",
"description":"Type of sorting (ASC or DESC).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"sortBy",
"in":"query",
"description":"Field by which the sorting will be done.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
},
"examples":{
"Successful Response":{
"summary":"Successful Response",
"description":"Successful Response",
"value":{
"elements":[
{
"id":"63a99eb0b8863d4d26678000",
"name":"Hold Config Name1",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1124"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"English",
"voice":{
"name":"Name1",
"gender":"FEMALE"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1125"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb116"
},
"duration":{
"unit":"MINUTES",
"value":2
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
],
"createdAt":"2022-12-10T13:45:00.000Z",
"updatedAt":"2022-12-10T13:45:00.000Z"
},
{
"id":"63a99eb0b8863d4d26678001",
"name":"Hold Config Name2",
"createdAt":"2022-12-12T13:45:00.000Z",
"updatedAt":"2022-12-12T13:45:00.000Z",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1135"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"Spanish",
"voice":{
"name":"Name2",
"gender":"Male"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1132"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb136"
},
"duration":{
"unit":"MINUTES",
"value":4
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
]
}
],
"total":8,
"totalPages":10
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Hold configuration must be applied to at least one queue."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"hold-configuration-calls"
],
"summary":"Create hold configuration",
"description":"Use this endpoint to create a new hold configuration, together with queues it is applied to. More info.",
"operationId":"create-hold-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"63a99eb0b8863d4d26678000",
"name":"Hold Config Name",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1124"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"English",
"voice":{
"name":"Test",
"gender":"FEMALE"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1125"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb116"
},
"duration":{
"unit":[
"SECONDS",
"MINUTES",
"HOURS"
],
"value":2
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
],
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Hold configuration must be applied to at least one queue."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No hold config found with id: 123"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/hold-configs-per-queue/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"hold-configuration-calls"
],
"summary":"Get hold configuration",
"description":"Use this endpoint to get a single hold configuration by its id. More info.",
"operationId":"get-hold-config",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Hold Configuration to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
},
"examples":{
"Successful Response":{
"summary":"Successful Response",
"description":"Successful Response",
"value":{
"id":"63a99eb0b8863d4d26678000",
"name":"Hold Config Name",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1124"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"English",
"voice":{
"name":"Test",
"gender":"FEMALE"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1125"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb116"
},
"duration":{
"unit":[
"SECONDS",
"MINUTES",
"HOURS"
],
"value":2
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
],
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Hold configuration must be applied to at least one queue."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No hold config found with id: 123"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"hold-configuration-calls"
],
"summary":"Update hold configuration",
"description":"Use this endpoint to update an already existing hold configuration. More info.",
"operationId":"update-hold-config",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Hold Configuration being updated.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"63a99eb0b8863d4d26678000",
"name":"Hold Config Name",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1124"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"English",
"voice":{
"name":"Test",
"gender":"FEMALE"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1125"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb116"
},
"duration":{
"unit":[
"SECONDS",
"MINUTES",
"HOURS"
],
"value":2
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
],
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Hold configuration must be applied to at least one queue."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No hold config found with id: 123"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"hold-configuration-calls"
],
"summary":"Delete hold configuration",
"description":"Use this endpoint to delete a single, already existing hold configuration by its id. More info.",
"operationId":"delete-hold-config",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Hold Configuration to be deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful Response":{
"summary":"Successful Response",
"description":"Successful Response",
"value":{
"status":"SUCCESS",
"message":"Hold Configuration deleted."
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Hold configuration must be applied to at least one queue."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"No hold config found with id: 123"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/voice/2/call-timeouts":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"call-timeout-calls"
],
"summary":"Get call timeout",
"description":"Use this method to retrieve call timeout configuration.",
"operationId":"get-conversations-call-timeout",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":30,
"outbound":45
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"call-timeout-calls"
],
"summary":"Update call timeout",
"description":"Use this method to update call timeout configuration. Null field will resolve to default value.",
"operationId":"update-conversations-call-timeout",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"inbound":30,
"outbound":45
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"call-timeout-calls"
],
"summary":"Remove custom call timeout",
"description":"Use this method to remove the custom inbound call timeout configuration.",
"operationId":"remove-conversations-call-timeout",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"DELETED",
"message":"Inbound Call Timeout removed successfully."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-deprecationInformation":{
"deprecation":"2025-03-06T12:00:00.000+0000",
"sunset":"2025-09-06T12:00:00.000+0000",
"successorOperationId":"update-conversations-call-timeout"
},
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/1/working-hours":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Get filtered working hours",
"description":"Use this method to get a list of working hours with pagination and filtering options. Using filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters.",
"operationId":"get-filtered-working-hours",
"parameters":[
{
"name":"name",
"in":"query",
"description":"Optional. Working hours that contain a name case-insensitive.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"enabled",
"in":"query",
"description":"Optional. Working hours enable/disable toggle.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"isDefault",
"in":"query",
"description":"Optional. Default working hours.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"createdAfter",
"in":"query",
"description":"Optional. Filter results created after specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"createdBefore",
"in":"query",
"description":"Optional. Filter results created before specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedAfter",
"in":"query",
"description":"Optional. Filter results updated after specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"updatedBefore",
"in":"query",
"description":"Optional. Filter results updated before specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"limit",
"in":"query",
"description":"Size of the result page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":10,
"maximum":999
}
},
{
"name":"page",
"in":"query",
"description":"Number of the current page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int64",
"default":0
}
},
{
"name":"orderBy",
"in":"query",
"description":"This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursResultPageApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"workingHours":[
{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"name":"My UTC Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false
},
{
"id":"b0292453-3d2f-4242-8667-1c769d8a2cc9",
"timezone":"America/New_York",
"message":"We're out of office, come back another time, thank you!",
"name":"My USA Working Hours",
"enabled":true,
"isDefault":false,
"closeConversations":true
}
],
"pagination":{
"totalItems":0,
"page":0,
"limit":0,
"orderBy":"string"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid page size":{
"summary":"Invalid page size",
"description":"Invalid page size",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Page size has to be bigger or equal to zero!"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"post":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Create working hours",
"description":"Use this method to create new working hours.\nAn auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,\nor a holiday is set for the enabled working hours and a new conversation is created during the holiday.",
"operationId":"create-working-hours",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/working-hours/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Get working hours",
"description":"Use this method to get single working hours.",
"operationId":"get-working-hours",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Working hours Id to get.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"id":"6bfb9b10-caec-4f53-85a9-b87da6afa88f",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Update working hours",
"description":"Use this method to update working hours.",
"operationId":"update-working-hours",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Working hours Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"id":"6bfb9b10-caec-4f53-85a9-b87da6afa88f",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Delete working hours",
"description":"Use this method to delete working hours.",
"operationId":"delete-working-hours",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Working hours id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Working hours has been deleted."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"patch":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Patch working hours",
"description":"Use this method for working hours partial updating.",
"operationId":"patch-working-hours",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Working hours Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"id":"6bfb9b10-caec-4f53-85a9-b87da6afa88f",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/working-hours/{id}/status":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Get working hours status",
"description":"Use this method to get current status of working hours.",
"operationId":"get-working-hours-status",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Working hours Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatusApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"INSIDE_OF_WORKING_HOURS"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/1/working-hours/{workingHoursId}/holiday":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Create working hours holiday",
"description":"Use this method to create a holiday on working hours.\nAn auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,\nor a holiday is set for the enabled working hours and a new conversation is created during the holiday.\nThis method will return a full working hours object with a created holiday in it.",
"operationId":"create-working-hours-holiday",
"parameters":[
{
"name":"workingHoursId",
"in":"path",
"description":"Working hours id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"id":"6bfb9b10-caec-4f53-85a9-b87da6afa88f",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid Id":{
"summary":"Invalid Id",
"description":"Invalid Id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/working-hours/{workingHoursId}/holiday/{id}":{
"delete":{
"tags":[
"customer-engagement",
"conversations",
"working-hours"
],
"summary":"Remove working hours holiday",
"description":"Use this method to remove a holiday from working hours.",
"operationId":"delete-working-hours-holiday",
"parameters":[
{
"name":"workingHoursId",
"in":"path",
"description":"Id of the working hours to delete holiday from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"id",
"in":"path",
"description":"Holiday Id to delete.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"statusCode":"SUCCESS",
"message":"Holiday has been deleted."
}
},
"Error response":{
"summary":"Error response",
"description":"Error response",
"value":{
"statusCode":"ERROR",
"message":"Invalid holidayId '195ac982-d98f-40e8-b9d3-6f11c04afe4a' given! No such entity exists."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse"
},
"examples":{
"Invalid holidayId":{
"summary":"Invalid holidayId",
"description":"Invalid holidayId",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid holidayId '97457D13B1FC79AF3C1A1096AE7E77AB' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/voice/2/tts/options/placeholders/{ttsPurpose}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"tts-options-calls"
],
"summary":"Get supported TTS placeholders for purpose",
"description":"Use this method to retrieve supported TTS placeholders for specified purpose.",
"operationId":"get-conversations-tts-supported-placeholders",
"parameters":[
{
"name":"ttsPurpose",
"in":"path",
"description":"Purpose for which placeholders will be used in text-to-speech.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPurposeApiModel"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.GetPlaceholdersApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":[
{
"type":"POSITION_IN_QUEUE",
"sayAs":"DEFAULT",
"placeholderValue":"{{QUEUE_POSITION_DEFAULT}}",
"placeholderPaddingSize":0,
"requiresSSML":false
},
{
"type":"POSITION_IN_QUEUE",
"sayAs":"ORDINAL",
"placeholderValue":"{{QUEUE_POSITION_ORDINAL}}",
"placeholderPaddingSize":40,
"requiresSSML":true
}
]
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Bad Request":{
"summary":"Bad Request",
"description":"Bad Request",
"value":{
"status":"ERROR",
"message":"Voice not found."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Not Found":{
"summary":"Not Found",
"description":"Not Found",
"value":{
"status":"ERROR",
"message":"Unsupported operation requested"
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
}
},
"/ccaas/voice/2/away-audio-message/{workingHoursConfigId}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"away-audio-messages"
],
"summary":"Get away audio message",
"description":"Use this method to retrieve an away audio message by its working hours configuration id.",
"operationId":"get-conversations-away-audio-message",
"parameters":[
{
"name":"workingHoursConfigId",
"in":"path",
"description":"Id of the working hours configuration whose away audio message needs to be retrieved.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AwayAudioMessageApiModel"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"id",
"workingHoursConfigId":"123",
"audioSource":{
"enabled":false,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Random message",
"language":"en",
"voice":{
"name":"Joanna",
"gender":"female"
},
"speechRate":1.1
},
"fileAudioSource":{
"fileDescriptor":"file-descriptor-id-example"
}
},
"collectables":[
{
"code":"1",
"action":"CALLBACK",
"value":"62a73f05502423205b2630cc"
}
],
"collectDuration":{
"unit":"SECONDS",
"value":15
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Away audio message not found":{
"summary":"Away audio message not found",
"description":"Away audio message not found",
"value":{
"status":"ERROR",
"message":"No record was found for the given workingHoursConfigId: 971382982603232920C7EB5EFD7644689"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"away-audio-messages"
],
"summary":"Delete away audio message",
"description":"Use this method to delete an away audio message by its working hours configuration id.",
"operationId":"delete-conversations-away-audio-message",
"parameters":[
{
"name":"workingHoursConfigId",
"in":"path",
"description":"Id of the working hours configuration whose away audio message needs to be deleted.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"status":"DELETED",
"message":"Away Audio Message deleted."
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse"
},
"examples":{
"Away audio message not found":{
"summary":"Away audio message not found",
"description":"Away audio message not found",
"value":{
"status":"ERROR",
"message":"No record was found for the given workingHoursConfigId: 971382982603232920C7EB5EFD7644689"
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
],
"x-throttling-info":[
{
"type":"token",
"replenishRate":10,
"requestedTokens":1,
"burstCapacity":20
}
]
}
},
"/ccaas/1/web-forms/{id}/submissions":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Submit web form data",
"description":"Use this method to submit a new set of data of the given web form. This will create a new conversation with the channel specified in the web form.",
"operationId":"submit-webform",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Id of the Web Form which will be used to create a conversation.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormSubmissionApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormPostResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"conversationId":"b468c1ec-1997-4e90-add6-b36dfd2b80a3"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/web-forms/{id}":{
"get":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Get web form",
"description":"Use this method to get an existing web form.",
"operationId":"get-webform",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Web Form Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"7646c2ff-916d-46f1-9c53-5273476ed505",
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true,
"createdAt":"2023-12-01T00:00:00.000+00:00",
"updatedAt":"2023-12-01T00:00:00.000+00:00",
"tagIds":[
"2423d4c7-23da-422a-9f15-ca08006051ea",
"2664c7c3-f546-4073-a961-b94aed465ee8"
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage",
"conversations:read"
]
},
"put":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Update web form",
"description":"Use this method to update an existing web form.",
"operationId":"update-webform",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Web Form Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"7646c2ff-916d-46f1-9c53-5273476ed505",
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true,
"createdAt":"2023-12-01T00:00:00.000+00:00",
"updatedAt":"2023-12-01T00:00:00.000+00:00",
"tagIds":[
"2423d4c7-23da-422a-9f15-ca08006051ea",
"2664c7c3-f546-4073-a961-b94aed465ee8"
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid body":{
"summary":"Invalid body",
"description":"Invalid body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"delete":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Delete web form",
"description":"Use this method to delete an existing web form.",
"operationId":"delete-webform",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Web Form Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
},
"patch":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Patch web form",
"description":"Use this method to patch an existing web form.",
"operationId":"patch-webform",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Web Form Id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"7646c2ff-916d-46f1-9c53-5273476ed505",
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true,
"createdAt":"2023-12-01T00:00:00.000+00:00",
"updatedAt":"2023-12-01T00:00:00.000+00:00",
"tagIds":[
"2423d4c7-23da-422a-9f15-ca08006051ea",
"2664c7c3-f546-4073-a961-b94aed465ee8"
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid request body."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Invalid id":{
"summary":"Invalid id",
"description":"Invalid id",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
},
"/ccaas/1/web-forms":{
"post":{
"tags":[
"customer-engagement",
"conversations",
"web-forms"
],
"summary":"Create web form",
"description":"Use this method to create a new web form.",
"operationId":"create-webform",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"description":"Successful response",
"value":{
"id":"7646c2ff-916d-46f1-9c53-5273476ed505",
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true,
"createdAt":"2023-12-01T00:00:00.000+00:00",
"updatedAt":"2023-12-01T00:00:00.000+00:00",
"tagIds":[
"2423d4c7-23da-422a-9f15-ca08006051ea",
"2664c7c3-f546-4073-a961-b94aed465ee8"
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
},
"examples":{
"Web Form name already exists":{
"summary":"Web Form name already exists",
"description":"Web Form name already exists",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Web form with name 'Test WebForm' already exists."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"conversations:manage"
]
}
}
},
"components":{
"schemas":{
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.DailyWorkingHoursApiModel":{
"type":"object",
"description":"List of working hours work days.\nIt must contain all days of the week with 3 parameters each: `startTime`, `endTime` and `enabled`.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"properties":{
"startTime":{
"type":"integer",
"format":"int32",
"description":"Start time of the day in minutes after midnight.",
"maximum":1440,
"minimum":0
},
"endTime":{
"type":"integer",
"format":"int32",
"description":"End time of the day in minutes before midnight.",
"maximum":1440,
"minimum":0
},
"enabled":{
"type":"boolean",
"description":"Daily working hours enable/disable toggle."
}
},
"title":"DailyWorkingHoursApiModel"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel":{
"type":"object",
"description":"List of working hours holidays.",
"example":{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
"properties":{
"id":{
"type":"string",
"description":"Holiday ID.",
"readOnly":true
},
"name":{
"type":"string",
"description":"Holiday name."
},
"startDate":{
"type":"string",
"format":"date-time",
"description":"Start date. Format: yyyy-MM-dd"
},
"endDate":{
"type":"string",
"format":"date-time",
"description":"End date. Format: yyyy-MM-dd"
},
"enabled":{
"type":"boolean",
"description":"Holiday enable/disable toggle."
}
},
"required":[
"name"
],
"title":"HolidaysApiModel"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.Pagination":{
"type":"object",
"properties":{
"totalItems":{
"type":"integer",
"format":"int64",
"readOnly":true
},
"page":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"limit":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"orderBy":{
"type":"string",
"readOnly":true
}
},
"title":"Pagination"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCode":{
"type":"string",
"enum":[
"SUCCESS",
"ERROR"
],
"title":"StatusCode"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse":{
"type":"object",
"properties":{
"statusCode":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCode"
},
"message":{
"type":"string"
}
},
"title":"StatusCodeResponse"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest":{
"type":"object",
"example":{
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
},
"properties":{
"id":{
"type":"string",
"description":"Working hours Id.",
"readOnly":true
},
"timezone":{
"type":"string",
"description":"Timezone in which working hours apply.\n`TZ database name` from [IANA time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
},
"message":{
"type":"string",
"description":"Message to be sent as an auto-reply message to the customer.",
"maxLength":4000,
"minLength":0
},
"workWeek":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.DailyWorkingHoursApiModel"
},
"name":{
"type":"string",
"description":"Working hours name.",
"maxLength":255,
"minLength":0
},
"enabled":{
"type":"boolean",
"description":"Working hours enable/disable toggle."
},
"isDefault":{
"type":"boolean",
"description":"Default working hours."
},
"closeConversations":{
"type":"boolean",
"description":"Close conversation created outside of working hours toggle."
},
"sendAwayMessageEveryOOWHPeriod":{
"type":"boolean"
},
"holidays":{
"type":"array",
"description":"List of working hours holidays.",
"items":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel"
},
"uniqueItems":true
}
},
"required":[
"message",
"name",
"timezone",
"workWeek"
],
"title":"WorkingHoursApiRequest"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse":{
"type":"object",
"example":{
"id":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"timezone":"Etc/UTC",
"message":"We're out of office, come back another time, thank you!",
"workWeek":{
"MONDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"TUESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"WEDNESDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"THURSDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"FRIDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SATURDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
},
"SUNDAY":{
"startTime":0,
"endTime":1440,
"enabled":true
}
},
"name":"My Working Hours",
"enabled":true,
"isDefault":true,
"closeConversations":false,
"holidays":[
{
"id":"aae9b06f-a323-4c9c-b807-7a9e4e015405",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"New Year's Day",
"startDate":"2021-01-01",
"endDate":"2021-01-01",
"enabled":true
},
{
"id":"6bfb9b10-caec-4f53-85a9-b87da6afa88f",
"workingHoursId":"07ad4193-4354-488c-b45f-293dfa4c90fb",
"name":"My Holiday",
"startDate":"2021-06-09",
"endDate":"2021-06-09",
"enabled":false
}
]
},
"properties":{
"id":{
"type":"string",
"description":"Working hours Id.",
"readOnly":true
},
"timezone":{
"type":"string",
"description":"Timezone in which working hours apply.\n`TZ database name` from [IANA time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
},
"message":{
"type":"string",
"description":"Message to be sent as an auto-reply message to the customer."
},
"workWeek":{
"type":"object",
"description":"List of working hours work days.\nIt must contain all days of the week with 3 parameters each: `startTime`, `endTime` and `enabled`.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"properties":{
"startTime":{
"type":"integer",
"format":"int32",
"description":"Start time of the day in minutes after midnight.",
"maximum":1440,
"minimum":0
},
"endTime":{
"type":"integer",
"format":"int32",
"description":"End time of the day in minutes before midnight.",
"maximum":1440,
"minimum":0
},
"enabled":{
"type":"boolean",
"description":"Daily working hours enable/disable toggle."
}
}
},
"name":{
"type":"string",
"description":"Working hours name."
},
"enabled":{
"type":"boolean",
"description":"Working hours enable/disable toggle."
},
"isDefault":{
"type":"boolean",
"description":"Default working hours."
},
"closeConversations":{
"type":"boolean",
"description":"Close conversation created outside of working hours toggle."
},
"sendAwayMessageEveryOOWHPeriod":{
"type":"boolean"
},
"holidays":{
"type":"array",
"description":"List of working hours holidays.",
"items":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel"
},
"uniqueItems":true
}
},
"required":[
"message",
"name",
"timezone"
],
"title":"WorkingHoursApiResponse"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursResultPageApiResponse":{
"type":"object",
"properties":{
"workingHours":{
"type":"array",
"items":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.Pagination"
}
},
"title":"WorkingHoursResultPageApiResponse"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatus":{
"type":"string",
"enum":[
"INSIDE_OF_WORKING_HOURS",
"OUTSIDE_OF_WORKING_HOURS"
],
"title":"WorkingHoursStatus"
},
"25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatusApiResponse":{
"type":"object",
"properties":{
"status":{
"$ref":"#/components/schemas/25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatus"
}
},
"title":"WorkingHoursStatusApiResponse"
},
"30bce31dfbdcb9fa9268f4e4ce1f7ccf05ef063a92c880be9d1b9efcfc2ac71a.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest":{
"type":"object",
"example":{
"displayName":"Angus Young",
"status":"ACTIVE",
"role":"SUPERVISOR",
"enabled":true
},
"properties":{
"displayName":{
"type":"string",
"description":"Agent name to be displayed.",
"maxLength":255,
"minLength":0
},
"status":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
},
"role":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole"
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Agent enabled/disabled toggle."
}
},
"required":[
"displayName",
"role",
"status"
],
"title":"AgentRequest"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse":{
"type":"object",
"example":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"ACTIVE",
"availability":"BUSY",
"role":"SUPERVISOR",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
"properties":{
"id":{
"type":"string",
"description":"Agent ID.",
"readOnly":true
},
"displayName":{
"type":"string",
"description":"Agent name to be displayed.",
"maxLength":255,
"minLength":0
},
"title":{
"type":"string"
},
"status":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
},
"availability":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
},
"role":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole"
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Agent enabled/disabled toggle."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when agent is created.",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when agent is last updated.",
"readOnly":true
}
},
"required":[
"displayName"
],
"title":"AgentResponse"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseResultPage":{
"type":"object",
"example":{
"agents":[
{
"id":"9030551F327704A0F262995A1A4B4596",
"displayName":"Malcolm Young",
"status":"INVISIBLE",
"availability":"AWAY",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T07:45:23.777+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"ACTIVE",
"availability":"BUSY",
"role":"SUPERVISOR",
"enabled":true,
"createdAt":"2019-05-10T07:45:23.777+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
{
"id":"E83E787CF2613450157ADA3476171E3F",
"displayName":"Bon Scott",
"status":"INVISIBLE",
"availability":"BUSY",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T07:45:23.777+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
{
"id":"F66D67327326FCCB027BEAA916B94542",
"displayName":"Phil Rudd",
"status":"ACTIVE",
"availability":"ACTIVE",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T07:45:23.777+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
{
"id":"F66D67327326FCCB027BEAA916B94542",
"displayName":"Brian Johnson",
"status":"ACTIVE",
"availability":"BUSY",
"role":"AGENT",
"enabled":true,
"createdAt":"2019-05-10T07:45:23.777+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000"
},
{
"id":"7E77AB97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Neil Young",
"status":"ACTIVE",
"availability":"ACTIVE",
"role":"AGENT",
"enabled":false,
"createdAt":"2019-03-10T07:45:44.744+0000",
"updatedAt":"2019-03-10T09:33:58.374+0000"
}
],
"pagination":{
"totalItems":6,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"agents":{
"type":"array",
"items":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination"
}
},
"title":"AgentResponseResultPage"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseWithEmail":{
"type":"object",
"example":{
"id":"97457D13B1FC79AF3C1A1096AE7E77AB",
"displayName":"Angus Young",
"status":"ACTIVE",
"availability":"BUSY",
"role":"SUPERVISOR",
"enabled":true,
"createdAt":"2019-05-10T09:53:58.463+0000",
"updatedAt":"2019-05-10T09:53:58.463+0000",
"email":"angus.toung@example.com"
},
"properties":{
"id":{
"type":"string",
"description":"Agent ID.",
"readOnly":true
},
"displayName":{
"type":"string",
"description":"Agent name to be displayed.",
"maxLength":255,
"minLength":0
},
"status":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
},
"availability":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
},
"role":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole"
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Agent enabled/disabled toggle."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when agent is created.",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when agent is last updated.",
"readOnly":true
},
"email":{
"type":"string",
"description":"Agent email address."
}
},
"required":[
"displayName"
],
"title":"AgentResponseWithEmail"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole":{
"type":"string",
"default":"AGENT",
"description":"Agent role.",
"enum":[
"AGENT",
"SUPERVISOR"
],
"title":"AgentRole"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup":{
"type":"string",
"description":"Agent availability.",
"enum":[
"ACTIVE",
"BUSY",
"INVISIBLE",
"AWAY"
],
"title":"AgentStatusGroup"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusRequest":{
"type":"object",
"example":{
"status":"ACTIVE"
},
"properties":{
"status":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup"
}
},
"required":[
"status"
],
"title":"AgentStatusRequest"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot":{
"type":"object",
"example":{
"displayName":"My Whatsapp Bot",
"webhookUrl":"www.webhookurl.com/link1",
"destination":"447492263897",
"channel":"WHATSAPP",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":true,
"sessionTimeoutInSec":120
},
"properties":{
"displayName":{
"type":"string",
"description":"Bot name to be displayed.",
"maxLength":255,
"minLength":0
},
"webhookUrl":{
"type":"string",
"description":"Webhook url the message will be forwarded to.",
"maxLength":2000,
"minLength":0
},
"destination":{
"type":"string",
"description":"Bot destination phone number, FB messenger ID or live chat widget ID.",
"maxLength":255,
"minLength":0
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Bot enable/disable toggle."
},
"messagePersistencePolicy":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy"
},
"channel":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel"
},
"sessionTimeoutInSec":{
"type":"integer",
"format":"int64",
"default":86400,
"description":"Time elapsed from last client message, after which conversation will be closed. If not set, conversation will be closed after 24 hours.",
"maximum":86400,
"minimum":60
},
"webhookHeaders":{
"type":"object",
"additionalProperties":{
"type":"string",
"deprecated":true
},
"deprecated":true
},
"webhookEventUrl":{
"type":"string",
"maxLength":2000,
"minLength":0
},
"webhookEventHeaders":{
"type":"object",
"additionalProperties":{
"type":"string"
}
},
"id":{
"type":"string",
"readOnly":true
}
},
"required":[
"channel",
"destination",
"displayName",
"id"
],
"title":"Bot"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel":{
"type":"object",
"example":{
"displayName":"My Whatsapp Bot",
"webhookUrl":"www.webhookurl.com/link1",
"destination":"447492263897",
"channel":"WHATSAPP",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":true,
"sessionTimeoutInSec":120
},
"properties":{
"id":{
"type":"string",
"readOnly":true
},
"displayName":{
"type":"string",
"description":"Bot name to be displayed.",
"maxLength":255,
"minLength":0
},
"webhookUrl":{
"type":"string",
"description":"Webhook url the message will be forwarded to.",
"maxLength":2000,
"minLength":0
},
"destination":{
"type":"string",
"description":"Bot destination phone number, FB messenger Id or live chat widget Id.",
"maxLength":255,
"minLength":0
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Bot enable/disable toggle."
},
"messagePersistencePolicy":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy"
},
"channel":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel"
},
"sessionTimeoutInSec":{
"type":"integer",
"format":"int64",
"default":86400,
"description":"Time elapsed from last client message, after which conversation will be closed.\nIf not set, conversation will be closed after 24 hours.",
"maximum":86400,
"minimum":60
},
"webhookHeaders":{
"type":"object",
"additionalProperties":{
"type":"string",
"deprecated":true
},
"deprecated":true
},
"webhookEventUrl":{
"type":"string",
"description":"Webhook url on which will be automatically forwarded all events.",
"maxLength":2000,
"minLength":0
},
"webhookEventHeaders":{
"type":"object",
"additionalProperties":{
"type":"string"
}
}
},
"required":[
"channel",
"destination",
"displayName"
],
"title":"BotApiModel"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotResultPage":{
"type":"object",
"example":{
"bots":[
{
"id":"309BB921757DEAC9BE79EC6259B31C8A",
"webhookUrl":"www.webhookurl.com/link1",
"displayName":"My Whatsapp Bot",
"channel":"WHATSAPP",
"destination":"447492263897",
"messagePersistencePolicy":"PERSIST_ALL",
"enabled":true,
"sessionTimeoutInSec":120
},
{
"id":"6988D4642270FD8EF9EA833DCD972BB1",
"webhookUrl":"www.webhookurl.com/link2",
"displayName":"My Secret Bot",
"channel":"WHATSAPP",
"destination":"447492263899",
"messagePersistencePolicy":"PERSIST_NONE",
"enabled":true,
"sessionTimeoutInSec":120
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"bots":{
"type":"array",
"items":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel"
}
},
"pagination":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination"
}
},
"title":"BotResultPage"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel":{
"type":"string",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"UNKNOWN",
"EMAIL",
"LIVE_CHAT",
"UNUSED",
"VOICE",
"VIDEO",
"APPLE_BUSINESS_CHAT",
"LINE",
"GOOGLE_BUSINESS_MESSAGES",
"TELEGRAM",
"CALLS",
"INTERNAL",
"VIBER_BOT",
"FACEBOOK_POST",
"INSTAGRAM_POST",
"TWITTER_POST",
"INSTAGRAM_MESSAGING",
"GOOGLE_PLAY",
"KAKAO_SANGDAM",
"TWITTER_DM",
"WHATSAPP_CALLS",
"VIBER_CALLS",
"OPEN_CHANNEL",
"TIKTOK",
"ZALO"
],
"title":"MessageChannel"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy":{
"type":"string",
"default":"PERSIST_ALL",
"description":"Message persistence policy. If set to PERSIST_NONE, messages exchanged between customers and\nbot will not be persisted to the database nor visible to agents once they take over the conversation.",
"enum":[
"PERSIST_ALL",
"PERSIST_NONE"
],
"title":"MessagePersistencePolicy"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination":{
"type":"object",
"properties":{
"totalItems":{
"type":"integer",
"format":"int64",
"readOnly":true
},
"page":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"limit":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"orderBy":{
"type":"string",
"readOnly":true
}
},
"title":"Pagination"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.QueueAssignRequest":{
"type":"object",
"example":{
"queueId":"1111222233334444AAAA8888FFFF6666"
},
"properties":{
"queueId":{
"type":"string",
"description":"queueId identifier",
"maxLength":255,
"minLength":0
}
},
"required":[
"queueId"
],
"title":"QueueAssignRequest"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCode":{
"type":"string",
"enum":[
"SUCCESS",
"ERROR"
],
"title":"StatusCode"
},
"59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse":{
"type":"object",
"properties":{
"statusCode":{
"$ref":"#/components/schemas/59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCode"
},
"message":{
"type":"string"
}
},
"title":"StatusCodeResponse"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.ConditionalField":{
"type":"object",
"description":"List of fields to present if agent input matches condition value.",
"properties":{
"field":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
},
"isRequired":{
"type":"boolean",
"description":"Is the conditional field required to fill?"
}
},
"title":"ConditionalField"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionBasic":{
"type":"object",
"properties":{
"conversationId":{
"type":"string",
"description":"Conversation id."
},
"formId":{
"type":"string",
"description":"Form id."
},
"fields":{
"type":"array",
"description":"A list of fields with values.",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionFieldBasic"
}
}
},
"title":"DispositionBasic"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionFieldBasic":{
"type":"object",
"description":"A list of fields with values.",
"properties":{
"fieldId":{
"type":"string",
"description":"Field id."
},
"dispositionId":{
"type":"string",
"description":"Disposition id."
},
"dispositionValue":{
"type":"string",
"description":"Value of the field."
}
},
"title":"DispositionFieldBasic"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Field id."
},
"title":{
"type":"string",
"description":"Field title."
},
"type":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType"
},
"regex":{
"type":"string",
"description":"Regular expression. Valid only for REGEX field type."
},
"isEnabled":{
"type":"boolean",
"description":"Is field enabled"
},
"isDefault":{
"type":"boolean"
},
"options":{
"type":"array",
"description":"List of available options.",
"items":{
"type":"string",
"description":"List of available options."
}
},
"createdAt":{
"type":"string"
},
"updatedAt":{
"type":"string"
},
"operators":{
"type":"array",
"description":"List of available operators based on field type.",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldOperator"
}
}
},
"title":"Field"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldCondition":{
"type":"object",
"description":"List of conditions",
"properties":{
"id":{
"type":"string",
"description":"Id of the condition."
},
"value":{
"type":"string",
"description":"Condition value."
},
"fields":{
"type":"array",
"description":"List of fields to present if agent input matches condition value.",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.ConditionalField"
}
}
},
"title":"FieldCondition"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldConditionRequest":{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"value":{
"type":"string"
},
"conditionalFields":{
"type":"array",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormConditionalFieldRequest"
},
"maxItems":2147483647,
"minItems":1
}
},
"required":[
"conditionalFields",
"value"
],
"title":"FieldConditionRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldOperator":{
"type":"string",
"description":"List of available operators based on field type.",
"enum":[
"IS",
"IS_NOT",
"CONTAINS",
"DOESNT_CONTAIN",
"IS_SELECTED",
"NOT_SELECTED",
"IS_EQUAL_TO",
"NOT_EQUAL_TO",
"LESS_THAN",
"GREATER_THAN",
"IS_EQUAL_OR_LESS",
"IS_EQUAL_OR_GREATER",
"BEFORE",
"AFTER",
"BEFORE_OR_ON",
"AFTER_OR_ON"
],
"title":"FieldOperator"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest":{
"type":"object",
"properties":{
"title":{
"type":"string",
"description":"Field title.",
"maxLength":100,
"minLength":0
},
"type":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType"
},
"isEnabled":{
"type":"boolean",
"description":"Is field enabled. Mandatory when updating."
},
"options":{
"type":"array",
"description":"Available field options. Applicable only for DROPDOWN type.",
"items":{
"type":"string",
"description":"Available field options. Applicable only for DROPDOWN type."
}
},
"regex":{
"type":"string",
"description":"Regular expression. Applicable only for REGEX type."
}
},
"required":[
"isEnabled",
"title",
"type"
],
"title":"FieldRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldResultPage":{
"type":"object",
"example":{
"items":[
{
"id":"d85b8e46-f579-482f-b383-22648aae17b5",
"title":"Type",
"type":"DROPDOWN",
"isEnabled":true,
"isDefault":null,
"options":[
"inquiry",
"complaint"
],
"createdAt":"2021-03-30T06:28:10.676028Z",
"updatedAt":"2021-03-30T06:28:10.676029Z",
"operators":[]
},
{
"id":"e130e3f2-c8de-4ba9-a26e-8ac705642832",
"title":"Complaints",
"type":"TEXT",
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:55.755685Z",
"updatedAt":"2021-06-29T10:00:55.755686Z",
"operators":[]
},
{
"id":"ba18fdf8-eacf-4b15-8d4e-71515f5b9bcc",
"title":"Inquiry",
"type":"TEXT",
"isEnabled":true,
"isDefault":null,
"options":[],
"createdAt":"2021-06-29T10:00:33.777564Z",
"updatedAt":"2021-06-29T10:00:33.777565Z",
"operators":[]
}
],
"pagination":{
"totalItems":3,
"page":0,
"limit":10,
"orderBy":{
"property":"id",
"direction":"ASC"
}
}
},
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
}
},
"pagination":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination"
}
},
"title":"FieldResultPage"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType":{
"type":"string",
"description":"Field type.",
"enum":[
"TEXT",
"MULTILINE",
"CHECKBOX",
"DROPDOWN",
"INTNUMBER",
"DECIMALNUMBER",
"REGEX",
"DATE",
"CARD"
],
"title":"FieldType"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Form id."
},
"title":{
"type":"string",
"description":"Form title."
},
"isEnabled":{
"type":"boolean",
"description":"Is form enabled."
},
"isDefault":{
"type":"boolean",
"description":"Is form marked as default one."
},
"fields":{
"type":"array",
"description":"List of fields attached to a form",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormField"
}
},
"createdAt":{
"type":"string"
},
"updatedAt":{
"type":"string"
}
},
"title":"Form"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormConditionalFieldRequest":{
"type":"object",
"properties":{
"fieldId":{
"type":"string"
},
"isRequired":{
"type":"boolean"
}
},
"required":[
"fieldId",
"isRequired"
],
"title":"FormConditionalFieldRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormField":{
"type":"object",
"description":"List of fields attached to a form",
"properties":{
"field":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field"
},
"isRequired":{
"type":"boolean",
"description":"Is a field mandatory"
},
"conditions":{
"type":"array",
"description":"List of conditions",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldCondition"
}
}
},
"title":"FormField"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormFieldRequest":{
"type":"object",
"description":"Fields attached to a form.",
"properties":{
"fieldId":{
"type":"string"
},
"isRequired":{
"type":"boolean"
},
"conditions":{
"type":"array",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldConditionRequest"
}
}
},
"required":[
"fieldId",
"isRequired"
],
"title":"FormFieldRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest":{
"type":"object",
"properties":{
"title":{
"type":"string",
"description":"Form title.",
"maxLength":100,
"minLength":0
},
"isEnabled":{
"type":"boolean",
"description":"Is form enabled. Mandatory when updating."
},
"isDefault":{
"type":"boolean",
"description":"Is form default."
},
"fields":{
"type":"array",
"description":"Fields attached to a form.",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormFieldRequest"
},
"maxItems":2147483647,
"minItems":1
}
},
"required":[
"fields",
"isEnabled",
"title"
],
"title":"FormRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormResultPage":{
"type":"object",
"example":{
"items":[
{
"id":"75f57446-1d65-478a-87ed-22d17dc3d077",
"title":"Granulation",
"isEnabled":true,
"isDefault":false,
"fields":null,
"createdAt":"2021-03-29T14:04:48.468346Z",
"updatedAt":"2021-03-29T14:04:48.468349Z"
},
{
"id":"269757a0-38a6-4226-a8db-cc27930f6a2f",
"title":"Demo form",
"isEnabled":false,
"isDefault":false,
"fields":null,
"createdAt":"2021-04-17T07:54:44.401772Z",
"updatedAt":"2021-04-17T07:54:44.401773Z"
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":{
"property":"id",
"direction":"ASC"
}
}
},
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form"
}
},
"pagination":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination"
}
},
"title":"FormResultPage"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination":{
"type":"object",
"properties":{
"totalItems":{
"type":"integer",
"format":"int64",
"readOnly":true
},
"page":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"limit":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"orderBy":{
"type":"string",
"readOnly":true
}
},
"title":"Pagination"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCode":{
"type":"string",
"enum":[
"SUCCESS",
"ERROR"
],
"title":"StatusCode"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse":{
"type":"object",
"properties":{
"statusCode":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCode"
},
"message":{
"type":"string"
}
},
"title":"StatusCodeResponse"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger":{
"type":"object",
"properties":{
"title":{
"type":"string",
"description":"Trigger title.",
"maxLength":100,
"minLength":0
},
"expression":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Condition which resolves in destination form."
},
"orderIndex":{
"type":"integer",
"format":"int32",
"description":"Trigger order."
},
"isEnabled":{
"type":"boolean",
"description":"Is trigger enabled."
},
"formId":{
"type":"string",
"description":"Destination form."
},
"timesTriggered":{
"type":"integer",
"format":"int32",
"description":"Number of trigger resolution."
}
},
"required":[
"expression",
"formId",
"title"
],
"title":"Trigger"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.TriggerResultPage":{
"type":"object",
"example":{
"items":[
{
"id":"b3695d3c-6415-4bdd-82fc-07f9309933ec",
"title":"AJ Queue",
"expression":{
"$neq":{
"queue":"AJ Queue"
}
},
"orderIndex":5,
"isEnabled":true,
"formId":"75f57446-1d65-478a-87ed-22d17dc3d077",
"timesTriggered":149
},
{
"id":"bef60d38-98fa-4c14-b40e-34918b399964",
"title":"Feedback form triggers",
"expression":{
"$or":[
{
"$eq":{
"queue":"Default queue"
}
},
{
"$and":[
{
"$eq":{
"customer.country":"Croatia"
}
},
{
"$eq":{
"company.name":"AAA Infotek"
}
}
]
}
]
},
"orderIndex":1,
"isEnabled":true,
"formId":"90a91386-6e6d-44da-889f-783705cec020",
"timesTriggered":245
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":{
"property":"id",
"direction":"ASC"
}
}
},
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger"
}
},
"pagination":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination"
}
},
"title":"TriggerResultPage"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionApiRequest":{
"type":"object",
"properties":{
"fields":{
"type":"array",
"description":"List of fields and agent inputs to those fields.",
"items":{
"$ref":"#/components/schemas/9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionFieldApiRequest"
},
"maxItems":2147483647,
"minItems":1
}
},
"required":[
"fields"
],
"title":"UpsertDispositionApiRequest"
},
"9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionFieldApiRequest":{
"type":"object",
"description":"List of fields and agent inputs to those fields.",
"properties":{
"fieldId":{
"type":"string"
},
"value":{
"type":"string",
"maxLength":5000,
"minLength":0
}
},
"required":[
"fieldId",
"value"
],
"title":"UpsertDispositionFieldApiRequest"
},
"ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"ApiRequestError":{
"type":"object",
"properties":{
"serviceException":{
"$ref":"#/components/schemas/ApiRequestErrorDetails"
}
},
"title":"ApiRequestError"
},
"ApiRequestErrorDetails":{
"type":"object",
"properties":{
"messageId":{
"type":"string",
"description":"Identifier of the error."
},
"text":{
"type":"string",
"description":"Detailed error description."
},
"validationErrors":{
"type":"object",
"additionalProperties":{
"type":"array",
"description":"Validation errors.",
"items":{
"type":"string",
"description":"Validation errors."
}
},
"description":"Validation errors."
}
},
"title":"ApiRequestErrorDetails"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel":{
"type":"object",
"example":{
"inbound":true,
"outbound":true,
"autoCompose":false,
"mediaType":"AUDIO_AND_VIDEO",
"videoDownloadPreparation":false,
"enabled":true,
"enabledChangedAt":1622024333000
},
"properties":{
"inbound":{
"type":"boolean",
"description":"Enables inbound call recording. At least one of the parameters 'inbound' or 'outbound' must be set to true. "
},
"outbound":{
"type":"boolean",
"description":"Enables outbound call recording. At least one of the parameters 'inbound' or 'outbound' must be set to true. "
},
"autoCompose":{
"type":"boolean",
"default":false,
"description":"Enables composition of call recordings. If set to true, the call recording will be merged into a single audio or video file."
},
"mediaType":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel"
},
"enabled":{
"type":"boolean",
"default":false
},
"enabledChangedAt":{
"type":"integer",
"format":"int64",
"readOnly":true
}
},
"required":[
"mediaType"
],
"title":"AccountRecordingConfigApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel":{
"type":"object",
"example":{
"wrapUpSeconds":30,
"canExtendWrapUp":true,
"enabled":true
},
"properties":{
"wrapUpSeconds":{
"type":"integer",
"format":"int32",
"description":"Wrap up duration."
},
"canExtendWrapUp":{
"type":"boolean",
"description":"Determines if agents can extend wrap up time."
},
"enabled":{
"type":"boolean",
"description":"Determines if wrap up is enabled for the account."
}
},
"required":[
"canExtendWrapUp",
"enabled",
"wrapUpSeconds"
],
"title":"AccountWrapUpApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Action":{
"type":"string",
"description":"Action type connected to the collectable.",
"enum":[
"CALLBACK",
"RETURN_TO_IVR"
],
"title":"Action"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel":{
"type":"object",
"properties":{
"backgroundBlurSettings":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundBlurSettingsApiModel"
},
"wrapUpSeconds":{
"type":"integer",
"format":"int32",
"description":"Wrap up length in seconds specific to the agent. Null if not set, in which case account wrap up time should be used. More info."
}
},
"title":"AgentConfigApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigWrapUpApiModel":{
"type":"object",
"example":{
"wrapUpSeconds":30
},
"properties":{
"wrapUpSeconds":{
"type":[
"integer",
"null"
],
"format":"int32",
"description":"Wrap up length in seconds specific to the agent. Null if not set, in which case account wrap up time should be used. More info."
}
},
"title":"AgentConfigWrapUpApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel":{
"type":"object",
"example":{
"agentId":"05261D01CC88F5A8C0C7C3A1EF74E430",
"inbound":true,
"outbound":true,
"mediaType":"AUDIO_AND_VIDEO",
"useDefault":true,
"enabled":false,
"enabledChangedAt":1622024333000
},
"properties":{
"agentId":{
"type":"string",
"description":"ID of the agent to which the recording configuration belongs.",
"readOnly":true
},
"inbound":{
"type":"boolean",
"default":false,
"description":"Inbound record call direction enabled. At least one of the parameters 'inbound' or 'outbound' must be set to true. "
},
"outbound":{
"type":"boolean",
"default":false,
"description":"Outbound record call direction enabled. At least one of the parameters 'inbound' or 'outbound' must be set to true. "
},
"mediaType":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel"
},
"useDefault":{
"type":"boolean",
"default":false,
"description":"Use account recording config as default."
},
"enabled":{
"type":"boolean",
"default":false
},
"enabledChangedAt":{
"type":"integer",
"format":"int64",
"readOnly":true
}
},
"required":[
"agentId",
"mediaType"
],
"title":"AgentRecordingConfigApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel":{
"type":"string",
"description":"Specifies whether the audio is from a file source or text-to-speech",
"enum":[
"TTS",
"FILE"
],
"title":"AudioSourceTypeApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AwayAudioMessageApiModel":{
"type":"object",
"example":{
"id":"id",
"workingHoursConfigId":"123",
"audioSource":{
"enabled":false,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Random message",
"language":"en",
"voice":{
"name":"Joanna",
"gender":"female"
},
"speechRate":1.1
},
"fileAudioSource":{
"fileDescriptor":"file-descriptor-id-example"
}
},
"collectables":[
{
"code":"1",
"action":"CALLBACK",
"value":"62a73f05502423205b2630cc"
}
],
"collectDuration":{
"unit":"SECONDS",
"value":15
}
},
"properties":{
"id":{
"type":"string",
"description":"Unique ID of the away audio message.",
"readOnly":true
},
"workingHoursConfigId":{
"type":"string",
"description":"Id of the working hours configuration.",
"readOnly":true
},
"audioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"collectables":{
"type":"array",
"items":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel"
}
},
"collectDuration":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
}
},
"required":[
"audioSource"
],
"title":"AwayAudioMessageApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundBlurSettingsApiModel":{
"type":"object",
"description":"Configuration for the background display while the agent is on a call. More info.",
"properties":{
"mode":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VideoFilterModeApiModel"
},
"fileMetadata":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundFileMetadataApiModel"
}
},
"required":[
"mode"
],
"title":"BackgroundBlurSettingsApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundFileMetadataApiModel":{
"type":"object",
"description":"Background file metadata in case of virtual background.",
"properties":{
"fileId":{
"type":"string",
"description":"Id of specified background image file."
},
"fileName":{
"type":"string",
"description":"Name of specified background image file."
},
"fileSize":{
"type":"integer",
"format":"int64",
"description":"Size in bytes of specified background image file."
},
"fileUrl":{
"type":"string",
"description":"File url of specified background image file."
}
},
"required":[
"fileId",
"fileName",
"fileUrl"
],
"title":"BackgroundFileMetadataApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel":{
"type":"object",
"example":{
"inbound":30,
"outbound":45
},
"properties":{
"inbound":{
"type":"integer",
"format":"int32",
"default":30,
"description":"Inbound call timeout refers to the maximum duration a call rings before an agent answers it.",
"maximum":60,
"minimum":3
},
"outbound":{
"type":"integer",
"format":"int32",
"default":45,
"description":"Outbound call timeout refers to the maximum duration a call rings before customer or external number answers it.",
"maximum":60,
"minimum":3
}
},
"title":"CallTimeoutApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel":{
"type":"object",
"description":"Information for a collectable.",
"properties":{
"code":{
"type":"string",
"description":"Code attached to the collectable.",
"maxLength":36,
"minLength":1
},
"action":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Action"
},
"value":{
"type":"string",
"description":"Collectable value.",
"maxLength":64,
"minLength":1
}
},
"required":[
"action",
"code",
"value"
],
"title":"CollectableApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition":{
"type":"object",
"description":"Defines how the 'condition' field is built, e.g., if 'SENDER', the condition is an object with an array of senders.",
"title":"Condition"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType":{
"type":"string",
"description":"Defines which waiting strategy entity the condition applies to. Once defined, cannot be changed.",
"enum":[
"SENDER",
"QUEUE"
],
"title":"ConditionType"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Direction":{
"type":"string",
"enum":[
"ASC",
"DESC"
],
"title":"Direction"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel":{
"type":"object",
"description":"Duration information.",
"properties":{
"unit":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Unit"
},
"value":{
"type":"integer",
"format":"int32",
"minimum":1
}
},
"required":[
"unit",
"value"
],
"title":"DurationApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel":{
"type":"object",
"description":"File audio source information.",
"properties":{
"fileDescriptor":{
"type":"string",
"description":"File audio source descriptor.",
"maxLength":128,
"minLength":0
}
},
"title":"FileAudioSourceApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel":{
"type":"object",
"description":"File audio source information.",
"properties":{
"enabled":{
"type":"boolean"
},
"useDefault":{
"type":"boolean",
"default":true,
"description":"Use system default music."
},
"fileAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel"
}
},
"title":"FileAudioSourceWithDefaultOptionApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel":{
"type":"object",
"description":"File audio source or TTS audio source information with repeat interval.",
"properties":{
"enabled":{
"type":"boolean"
},
"Audio source type":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel"
},
"ttsAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel"
},
"fileAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel"
},
"repeatInterval":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
}
},
"title":"FileOrTtsAudioSourceWithRepeatIntervalApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.GetPlaceholdersApiResponse":{
"type":"object",
"example":{
"type":"POSITION_IN_QUEUE",
"sayAs":"DEFAULT",
"placeholderValue":"{{QUEUE_POSITION_DEFAULT}}",
"placeholderPaddingSize":20,
"requiresSSML":false
},
"properties":{
"type":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderTypeApiModel"
},
"sayAs":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderSayAsApiModel"
},
"placeholderValue":{
"type":"string",
"description":"Value to be placed in TTS text field which will be resolved in runtime to an actual value. This value is used to identify the placeholder.\n For example, {{QUEUE_POSITION_DEFAULT}} is a placeholder for the position in the queue with DEFAULT sayAs option.\n Here is example Text-to-Speech text: \"You are {{QUEUE_POSITION_DEFAULT}} in the queue.\"\n"
},
"placeholderPaddingSize":{
"type":"integer",
"format":"int32",
"description":"Specifies how many characters will be added by the system in the background to correctly resolve the placeholder.\n This number is added to current TTS text length and counts toward max TTS text length.\n"
},
"requiresSSML":{
"type":"boolean",
"description":"Specifies whether this placeholder requires TTS voice to support SSML."
}
},
"title":"GetPlaceholdersApiResponse"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel":{
"type":"object",
"example":{
"id":"63a99eb0b8863d4d26678000",
"name":"Hold Config Name",
"onHoldMusic":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1124"
}
},
"announcementMessage":{
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"Hello this a text to speech message",
"language":"English",
"voice":{
"name":"Test",
"gender":"FEMALE"
},
"speechRate":1.0,
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb1125"
},
"fileAudioSource":{
"fileDescriptor":"eea6b505-6e67-420a-b1a2-2307fafb116"
},
"duration":{
"unit":[
"SECONDS",
"MINUTES",
"HOURS"
],
"value":2
}
},
"default":false,
"enabled":true,
"queueIds":[
"FD80A6AA8E0DB8A5165276570943D8CF",
"A4BBE5D92667EEAB69860D457E877A59"
],
"createdAt":"2022-12-10T13:45:00.777+0000",
"updatedAt":"2022-12-10T13:45:00.777+0000"
},
"properties":{
"id":{
"type":"string",
"description":"Unique id of the hold configuration.",
"readOnly":true
},
"name":{
"type":"string",
"description":"Hold configuration name.",
"maxLength":128,
"minLength":1
},
"onHoldMusic":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel"
},
"announcementMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel"
},
"createdAt":{
"type":"string",
"example":"2022-12-10T13:45:00.777+0000",
"readOnly":true
},
"updatedAt":{
"type":"string",
"example":"2022-12-10T13:45:00.777+0000",
"readOnly":true
},
"queueIds":{
"type":"array",
"description":"Specifies which queues is the given hold config applied to. Empty list is supported for default config.",
"items":{
"type":"string",
"description":"Specifies which queues is the given hold config applied to. Empty list is supported for default config."
}
},
"enabled":{
"type":"boolean"
},
"default":{
"type":"boolean"
}
},
"required":[
"name",
"queueIds"
],
"title":"HoldConfigWithQueuesApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel":{
"type":"string",
"description":"Specifies whether the recording should be done on audio or both audio and video.",
"enum":[
"AUDIO",
"AUDIO_AND_VIDEO"
],
"title":"MediaTypeApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel":{
"type":"object",
"description":"File audio source information.",
"properties":{
"enabled":{
"type":"boolean"
},
"fileAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel"
}
},
"title":"OptionWithFileAudioSourceApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel":{
"type":"object",
"description":"File audio source or TTS audio source information.",
"properties":{
"enabled":{
"type":"boolean"
},
"Audio source type":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel"
},
"ttsAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel"
},
"fileAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel"
}
},
"title":"OptionWithFileOrTtsAudioSourceApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel":{
"type":"object",
"properties":{
"enabled":{
"type":"boolean"
},
"Audio source type":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel"
},
"ttsAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel"
},
"fileAudioSource":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel"
},
"repeatInterval":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
},
"collectables":{
"type":"array",
"items":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel"
}
},
"collectDuration":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
}
},
"title":"OptionWithPeriodicCollectApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationRequestApiModel":{
"type":"object",
"example":{
"from":"385998779621",
"to":"38761123123",
"agentId":"2010EA93ABC142E812C19F529BCBD22F",
"voiceClientType":"PSTN"
},
"properties":{
"from":{
"type":"string",
"description":"DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint."
},
"to":{
"type":"string",
"description":"Destination number."
},
"agentId":{
"type":"string",
"description":"Id of the agent originating the call."
},
"voiceClientType":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceClientType"
}
},
"required":[
"agentId",
"from",
"to"
],
"title":"OutboundCallConversationRequestApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationResponseApiModel":{
"type":"object",
"example":{
"from":"385998779621",
"to":"38761123333",
"conversationId":"718A037A2FE0D2D5AA2D12A7240ED8C4",
"agentId":"2010EA93ABC142E812C19F529BCBD22F"
},
"properties":{
"from":{
"type":"string",
"description":"DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint."
},
"to":{
"type":"string",
"description":"Destination number."
},
"conversationId":{
"type":"string",
"description":"Id of the created conversation",
"readOnly":true
},
"agentId":{
"type":"string",
"description":"Id of the agent originating the call."
}
},
"required":[
"agentId",
"from",
"to"
],
"title":"OutboundCallConversationResponseApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.PageResponse":{
"type":"object",
"properties":{
"elements":{
"type":"array",
"items":{
"type":"object"
}
},
"total":{
"type":"integer",
"format":"int64"
},
"totalPages":{
"type":"integer",
"format":"int32"
}
},
"title":"PageResponse"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.RecordingMetadataApiModel":{
"type":"object",
"example":{
"elements":[
{
"id":1,
"recordingId":"11f1b111-1111-1111-a111-1111e11f111e",
"conversationId":"11f1b111-1111-1111-a111-1111e11f111a",
"conferenceId":"11f1b111-1111-1111-a111-1111e11f111b",
"callId":"11f1b111-1111-1111-a111-1111e11f111c",
"direction":"INBOUND",
"recordingStatus":"SUCCESSFUL",
"composed":false,
"filename":"11f1b111-1111-1111-a111-1111e11f111a_IDENTITY_20230612155341-11f1b111-1111-1111-a111-1111e11f111e.wav",
"duration":28,
"participantId":"11f1b111-1111-1111-a111-1111e11f111d",
"participantIdentity":"customer1",
"participantName":"Customer 1",
"participantType":"CUSTOMER",
"mediaType":"AUDIO",
"startedAt":1686585221999,
"deletedAt":null,
"deletedBy":null,
"sftpPath":null,
"transferredFrom":null,
"transferredTo":null,
"transferredFromQueue":null,
"transferredToQueue":null
},
{
"id":2,
"recordingId":"52341263-0a22-1111-a1a1-1111bade8581",
"conversationId":"52341263-0a22-1111-a1a1-1111bade8582",
"conferenceId":"52341263-0a22-1111-a1a1-1111bade8583",
"callId":"52341263-0a22-1111-a1a1-1111bade8584",
"direction":"INBOUND",
"recordingStatus":"SUCCESSFUL",
"composed":false,
"filename":"52341263-0a22-1111-a1a1-1111bade8582_IDENTITY_20230612155341-52341263-0a22-1111-a1a1-1111bade8581.wav",
"duration":28,
"participantId":"52341263-0a22-1111-a1a1-1111bade8584",
"participantIdentity":"agent1",
"participantName":"Agent 1",
"participantType":"AGENT",
"mediaType":"AUDIO",
"startedAt":1686585221999,
"deletedAt":null,
"deletedBy":null,
"sftpPath":null,
"transferredFrom":null,
"transferredTo":null,
"transferredFromQueue":null,
"transferredToQueue":null
}
],
"total":2,
"totalPages":1
},
"properties":{
"recordingId":{
"type":"string",
"description":"Unique id of the recorded file."
},
"conversationId":{
"type":"string",
"description":"Conversation id of the recorded file."
},
"conferenceId":{
"type":"string",
"description":"Conference id of the recorded file."
},
"callId":{
"type":"string",
"description":"Call id of the recorded file."
},
"direction":{
"type":"string",
"description":"Call direction of the recorded file."
},
"recordingStatus":{
"type":"string",
"description":"Status of the recorded file."
},
"composed":{
"type":"boolean",
"description":"Flag indicating whether the recorded file is composed."
},
"filename":{
"type":"string",
"description":"Filename of the recorded file."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"Duration of the recorded file in seconds."
},
"participantId":{
"type":"string",
"description":"Unique id of the participant associated with the recorded file."
},
"participantIdentity":{
"type":"string",
"description":"Unique identity of the participant associated with the recorded file."
},
"participantName":{
"type":"string",
"description":"Participant name associated with the recorded file."
},
"participantType":{
"type":"string",
"description":"Participant type associated with the recorded file. Values can be either customer or agent."
},
"mediaType":{
"type":"string",
"description":"Specifies recorded file type. Values can be either audio or audio and video."
},
"startedAt":{
"type":"integer",
"format":"int64",
"description":"Unix timestamp for when the recording started.",
"example":1686585221999
},
"deletedAt":{
"type":"integer",
"format":"int64",
"description":"Unix timestamp for when the recorded file was deleted.",
"example":1686585221999
},
"deletedBy":{
"type":"string",
"description":"Identity of the user who deleted the recorded file."
},
"sftpPath":{
"type":"string",
"description":"Location of the recorded file on the SFTP server."
},
"transferredFrom":{
"type":"string",
"description":"Identity of the user who has transferred the call."
},
"transferredTo":{
"type":"string",
"description":"Identity of the user to whom the call has been transferred."
},
"transferredFromQueue":{
"type":"string",
"description":"Queue id from which the call has been transferred."
},
"transferredToQueue":{
"type":"string",
"description":"Queue id to which the call has been transferred."
}
},
"title":"RecordingMetadataApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Status":{
"type":"string",
"enum":[
"SUCCESS",
"ERROR"
],
"title":"Status"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse":{
"type":"object",
"properties":{
"Status":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Status"
},
"message":{
"type":"string"
}
},
"title":"StatusResponse"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody":{
"type":"object",
"title":"StreamingResponseBody"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel":{
"type":"object",
"example":{
"id":"642bf5f4ff5dd177aeb00889",
"musicOnHold":{
"enabled":true,
"useDefault":false,
"fileAudioSource":{
"fileDescriptor":"f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage":{
"enabled":true,
"audioSourceType":"TTS",
"ttsAudioSource":{
"text":"You're are being transferred...",
"language":"en",
"voice":{
"name":"Joanna",
"gender":"FEMALE"
},
"speechRate":1.0
},
"fileAudioSource":null,
"repeatInterval":{
"unit":"SECONDS",
"value":5
}
},
"createdAt":"2023-04-04T10:03:32.729Z",
"updatedAt":"2023-04-06T11:22:18.149Z"
},
"properties":{
"id":{
"type":"string",
"description":"Unique id of the transfer strategy.",
"readOnly":true
},
"musicOnHold":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel"
},
"announcementMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel"
},
"createdAt":{
"type":"string",
"example":"2023-04-04T10:03:32.729+0000",
"readOnly":true
},
"updatedAt":{
"type":"string",
"example":"2023-04-06T11:22:18.149+0000",
"readOnly":true
}
},
"title":"TransferStrategyApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToAgentRequest":{
"type":"object",
"example":{
"agentId":"3791078D92DF1FA5DE5F703345153GA2"
},
"properties":{
"agentId":{
"type":"string",
"description":"Id of the agent to whom a call should be transferred.",
"example":"3791078D92DF1FA5DE5F703345153GA2"
}
},
"title":"TransferToAgentRequest"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel":{
"type":"object",
"example":{
"tagName":"external_number",
"transferToAnyNumberEnabled":true,
"createdAt":"2022-11-18T09:23:44.033Z",
"updatedAt":"2023-01-24T21:44:31.630Z"
},
"properties":{
"tagName":{
"type":"string",
"example":"external_number",
"maxLength":256,
"minLength":0,
"readOnly":true
},
"transferToAnyNumberEnabled":{
"type":"boolean",
"default":true,
"description":"Enable or disable agents to transfer calls to numbers that are not stored in People"
},
"createdAt":{
"type":"string",
"example":"2022-12-10T13:45:00.777+0000",
"readOnly":true
},
"updatedAt":{
"type":"string",
"example":"2022-12-10T13:45:00.777+0000",
"readOnly":true
}
},
"title":"TransferToExternalConfigApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalRequest":{
"type":"object",
"example":{
"externalNumber":"41792036727",
"from":"41793026834"
},
"properties":{
"externalNumber":{
"type":"string",
"description":"Valid phone number in the E.164 format to which a call should be transferred.",
"example":"41792036727"
},
"from":{
"type":"string",
"description":"Caller identifier. Must be a phone number in the E.164 format",
"example":"41793026834"
}
},
"title":"TransferToExternalRequest"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToQueueRequest":{
"type":"object",
"example":{
"queueId":"FAC58F4117D439CF6F0A1A1A3AEA6123"
},
"properties":{
"queueId":{
"type":"string",
"description":"Id of the queue to which a call should be transferred.",
"example":"FAC58F4117D439CF6F0A1A1A3AEA6123"
}
},
"title":"TransferToQueueRequest"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel":{
"type":"object",
"description":"Text-to-speech audio source information.",
"properties":{
"text":{
"type":"string",
"description":"Text to convert using text-to-speech. This field supports usage of placeholders. Use the following endpoint to find which placeholders are supported: Get supported TTS placeholders for purpose. Placeholders are used to dynamically insert values into the text. For example, you can use placeholders to insert the customer's position in queue as part of announcement message in waiting strategy.",
"maxLength":1400,
"minLength":0
},
"language":{
"type":"string",
"description":"If the message is in text format, the language in which the message is written must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support: Voice Text-To-Speech Languages.",
"maxLength":36,
"minLength":1
},
"isLanguageSelectedManually":{
"type":"boolean",
"description":"This option controls whether automatic language detection will be performed on provided text."
},
"voice":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceApiModel"
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Text-to-speech speech rate.",
"maximum":2.0,
"minimum":0.5
}
},
"required":[
"language",
"speechRate",
"text",
"voice"
],
"title":"TtsAudioSourceApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderSayAsApiModel":{
"type":"string",
"description":"Dictates how resolved value will be spoken when using the placeholder.\n DEFAULT means that there is no control as to how the value will be spoken and it depends on the TTS engine.\n ORDINAL means that the value will be spoken as an ordinal number.\n CARDINAL means that the value will be spoken as a cardinal number.\n",
"enum":[
"DEFAULT",
"ORDINAL",
"CARDINAL",
"DEFAULT",
"ORDINAL",
"CARDINAL"
],
"title":"TtsPlaceholderSayAsApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderTypeApiModel":{
"type":"string",
"description":"Placeholder type. Determines the purpose of the placeholder.",
"enum":[
"POSITION_IN_QUEUE",
"POSITION_IN_QUEUE"
],
"title":"TtsPlaceholderTypeApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPurposeApiModel":{
"type":"string",
"description":"Purpose for which placeholders will be used in text-to-speech.",
"enum":[
"WAITING_STRATEGY_GREETING_MESSAGE",
"WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE",
"WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE",
"WORKING_HOURS_AWAY_MESSAGE",
"TRANSFER_STRATEGY_MESSAGE",
"ON_HOLD_MESSAGE",
"CALLBACK_CONFIRMATION_MESSAGE",
"WAITING_STRATEGY_GREETING_MESSAGE",
"WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE",
"WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE",
"WORKING_HOURS_AWAY_MESSAGE",
"TRANSFER_STRATEGY_MESSAGE",
"ON_HOLD_MESSAGE",
"CALLBACK_CONFIRMATION_MESSAGE"
],
"title":"TtsPurposeApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Unit":{
"type":"string",
"enum":[
"SECONDS",
"MINUTES",
"HOURS"
],
"title":"Unit"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VideoFilterModeApiModel":{
"type":"string",
"description":"Background filter mode.",
"enum":[
"NONE",
"BACKGROUND_BLUR",
"VIRTUAL_BACKGROUND",
"FACE_TRACK"
],
"title":"VideoFilterModeApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceApiModel":{
"type":"object",
"description":"Used to define voice in which text will be synthesized. To get a list of the supported voices for chosen language use Get voices.",
"properties":{
"name":{
"type":"string",
"description":"Name of the voice.",
"maxLength":36,
"minLength":1
},
"gender":{
"type":"string",
"description":"Gender of the voice. Can be MALE or FEMALE.",
"maxLength":36,
"minLength":1
}
},
"required":[
"gender",
"name"
],
"title":"VoiceApiModel"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceClientType":{
"type":"string",
"default":"PSTN",
"description":"Voice client type of the destination number.",
"enum":[
"PSTN",
"WEBRTC",
"WHATSAPP",
"VIBER",
"LIVE_CHAT"
],
"title":"VoiceClientType"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Waiting strategy name.",
"maxLength":128,
"minLength":1
},
"maximumWaitTime":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
},
"greetingMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"musicOnHold":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel"
},
"announcementMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel"
},
"maximumWaitTimeMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"conditionType":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType"
},
"condition":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition"
}
},
"required":[
"condition",
"conditionType",
"maximumWaitTime"
],
"title":"WaitingStrategyApiRequest"
},
"b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique id of the waiting strategy."
},
"name":{
"type":"string",
"description":"Waiting strategy name."
},
"maximumWaitTime":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel"
},
"greetingMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"musicOnHold":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel"
},
"announcementMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel"
},
"callbackConfirmationMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"maximumWaitTimeMessage":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel"
},
"conditionType":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType"
},
"condition":{
"$ref":"#/components/schemas/b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition"
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time at which the waiting strategy was created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when waiting strategy is updated."
}
},
"title":"WaitingStrategyApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AccountConfigurationRequest":{
"type":"object",
"example":{
"webhookUrl":"https://www.url.com/assets/receive/url"
},
"properties":{
"webhookUrl":{
"type":"string",
"description":"Webhook url all inbound messages will be forwarded to.",
"maxLength":255,
"minLength":0
}
},
"title":"AccountConfigurationRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest":{
"type":"object",
"example":{
"tagName":"Tag Name"
},
"properties":{
"tagName":{
"type":"string",
"description":"Tag name identifier.",
"maxLength":100,
"minLength":0
}
},
"required":[
"tagName"
],
"title":"AddTagToConversationApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest":{
"type":"object",
"example":{
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a"
},
"properties":{
"agentId":{
"type":"string",
"description":"Id of the conversation assignee.",
"maxLength":255,
"minLength":0
}
},
"required":[
"agentId"
],
"title":"AssignAgentApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AuthorType":{
"type":"string",
"description":"Indicates if the message was written by the agent, bot, or the system.",
"enum":[
"CUSTOMER",
"AGENT",
"SYSTEM",
"BOT"
],
"title":"AuthorType"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm":{
"type":"string",
"default":"LOAD_BALANCING",
"description":"Queue Auto-assignment algorithm.",
"enum":[
"LOAD_BALANCING",
"ROUND_ROBIN",
"PERFORMANCE_BASED",
"LOAD_BALANCING",
"ROUND_ROBIN",
"PERFORMANCE_BASED"
],
"title":"AutoAssignmentAlgorithm"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType":{
"type":"string",
"description":"Content type",
"enum":[
"TEXT",
"IMAGE",
"LOCATION",
"TEMPLATE",
"AUDIO",
"UNKNOWN",
"VOICE",
"VIDEO",
"DOCUMENT",
"CONTACT",
"VOICE_CALL",
"VIDEO_CALL",
"BUTTON",
"TYPING_INDICATOR",
"LIST_PICKER",
"FILE",
"LIST_PICKER_RESPONSE",
"POSTBACK",
"WA_BUTTON_FEEDBACK",
"SURVEY_REQUEST",
"SURVEY_RESPONSE",
"MEDIA_TEMPLATE",
"FACEBOOK_TEMPLATE",
"PRE_CHAT_FORM",
"LC_QUICK_REPLY",
"TEXT_WITH_BUTTON",
"TEXT_WITH_IMAGE_AND_BUTTON",
"SUGGESTION_RESPONSE",
"ABC_MULTI_TYPE",
"FOLLOW",
"UNFOLLOW",
"CALL",
"EMAIL",
"CARD",
"CAROUSEL",
"TEXT_WITH_SUGGESTION",
"RICH_LINK",
"TIME_PICKER",
"TIME_PICKER_RESPONSE",
"BUTTON_RESPONSE",
"VIBER_BOT_STICKER",
"WHATSAPP_STICKER",
"VIBER_BOT_CAROUSEL",
"VIBER_BOT_EVENT",
"VIBER_BOT_VIDEO",
"VIBER_BOT_FILE",
"URL",
"LC_CAROUSEL",
"INSTAGRAM_STICKER",
"CALL_START",
"CALL_HANGUP",
"CALL_TRANSCRIPT",
"CALL_FILE",
"APPLE_CUSTOM_INTERACTIVE_CONTENT",
"APPLE_AUTH_REQUEST_CONTENT",
"APPLE_PAY_REQUEST_CONTENT",
"APPLE_PAY_RESPONSE",
"AUTHENTICATION_RESPONSE",
"CLOSE_CONVERSATION",
"BUTTON_LIST",
"KAKAO_SANGDAM_SESSION_EXPIRED",
"INSTAGRAM_TEMPLATE",
"SHARE",
"STORY_MENTION",
"CUSTOM_INTERACTIVE_RESPONSE",
"INTERACTIVE",
"INTERACTIVE_LIST_REPLY",
"INTERACTIVE_BUTTON_REPLY",
"LC_FORM_RESPONSE",
"PRODUCT",
"APPLE_QUICK_REPLY_CONTENT",
"QUICK_REPLY",
"WHATSAPP_PRODUCT",
"WHATSAPP_MULTI_PRODUCT",
"WHATSAPP_TEXT_WITH_ADDITIONAL_DATA",
"ORDER",
"TELEGRAM_CONTACT",
"FORM_RESPONSE",
"LINE_TEMPLATE",
"APPLE_FORM_CONTENT",
"LINE_POSTBACK_EVENT",
"LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE",
"LIVE_CHAT_KNOWLEDGE_BASE_SEARCH",
"LINE_STICKER",
"INTERACTIVE_FLOW_REPLY",
"RCS_TEXT",
"RCS_FILE",
"RCS_CARD",
"RCS_CAROUSEL",
"BUNDLE",
"PRIVATE_REPLY_TO_SOCIAL_COMMENT",
"LIVE_CHAT_BUTTON",
"TEXT_WITH_RATING",
"EMPTY",
"JSON",
"ROADSIDE_ASSISTANCE",
"CUSTOM_DATA",
"WHATSAPP_CALL_PERMISSION_REPLY",
"TIKTOK_SHARE_POST",
"TIKTOK_REFERRAL_SHORT_LINK",
"TIKTOK_REFERRAL_AD",
"ZALO_GIF",
"TEXT",
"IMAGE",
"LOCATION",
"TEMPLATE",
"AUDIO",
"VOICE",
"VIDEO",
"DOCUMENT",
"CONTACT",
"VOICE_CALL",
"VIDEO_CALL",
"CALL",
"BUTTON",
"TYPING_INDICATOR",
"LIST_PICKER",
"FILE",
"LIST_PICKER_RESPONSE",
"POSTBACK",
"SURVEY_REQUEST",
"SURVEY_RESPONSE",
"FACEBOOK_TEMPLATE",
"PRE_CHAT_FORM",
"LC_FORM_RESPONSE",
"LC_QUICK_REPLY",
"LC_CAROUSEL",
"LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE",
"LIVE_CHAT_KNOWLEDGE_BASE_SEARCH",
"TEXT_WITH_BUTTON",
"TEXT_WITH_IMAGE_AND_BUTTON",
"ABC_MULTI_TYPE",
"CARD",
"SUGGESTION_RESPONSE",
"CAROUSEL",
"LINE_TEMPLATE",
"TEXT_WITH_SUGGESTION",
"EMAIL",
"RICH_LINK",
"TIME_PICKER",
"TIME_PICKER_RESPONSE",
"BUTTON_RESPONSE",
"WHATSAPP_STICKER",
"VIBER_STICKER",
"INSTAGRAM_STICKER",
"INSTAGRAM_TEMPLATE",
"CALL_FILE",
"CALL_TRANSCRIPT",
"CALL_HANGUP",
"CALL_START",
"ABC_CUSTOM_INTERACTIVE_CONTENT",
"APPLE_PAY_REQUEST_CONTENT",
"QUICK_REPLY",
"APPLE_AUTH_REQUEST_CONTENT",
"APPLE_CUSTOM_INTERACTIVE_CONTENT",
"BUTTON_LIST",
"SHARE",
"INTERACTIVE",
"KAKAO_SANGDAM_SESSION_EXPIRED",
"INTERACTIVE_BUTTON_REPLY",
"INTERACTIVE_LIST_REPLY",
"WHATSAPP_PRODUCT",
"WHATSAPP_MULTI_PRODUCT",
"PRODUCT",
"APPLE_QUICK_REPLY_CONTENT",
"APPLE_FORM_CONTENT",
"ROADSIDE_ASSISTANCE",
"FORM_RESPONSE",
"ORDER",
"LINE_POSTBACK_EVENT",
"INTERACTIVE_FLOW_REPLY",
"RCS_TEXT",
"RCS_FILE",
"RCS_CARD",
"RCS_CAROUSEL",
"PRIVATE_REPLY_TO_SOCIAL_COMMENT",
"CUSTOM_DATA",
"WHATSAPP_CALL_PERMISSION_REPLY"
],
"title":"ContentType"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel":{
"type":"object",
"example":{
"topic":"Topic",
"summary":"Summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a"
},
"properties":{
"id":{
"type":"string",
"description":"Conversation Id.",
"readOnly":true
},
"topic":{
"type":"string",
"description":"Conversation topic.",
"maxLength":1000,
"minLength":0
},
"summary":{
"type":"string",
"description":"Short description of the conversation.",
"maxLength":4000,
"minLength":0
},
"status":{
"type":"string",
"default":"OPEN",
"description":"Conversation status.",
"enum":[
"OPEN",
"WAITING",
"SOLVED",
"CLOSED"
]
},
"priority":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority"
},
"queueId":{
"type":"string",
"description":"Id of the queue conversation belongs to.",
"maxLength":255,
"minLength":0
},
"agentId":{
"type":"string",
"description":"Id of the agent assigned to the conversation.",
"maxLength":255,
"minLength":0
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when conversation is created.",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when conversation is updated.",
"readOnly":true
},
"closedAt":{
"type":"string",
"format":"date-time",
"description":"If conversation is closed, time stamp when is closed.",
"readOnly":true
}
},
"title":"ConversationApiModel"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel":{
"type":"string",
"description":"Communication channel.",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"UNKNOWN",
"EMAIL",
"MULTICHANNEL",
"NO_CHANNEL",
"LIVE_CHAT",
"UNUSED",
"VOICE",
"VIDEO",
"APPLE_BUSINESS_CHAT",
"LINE",
"GOOGLE_BUSINESS_MESSAGES",
"TELEGRAM",
"CALLS",
"INTERNAL",
"FACEBOOK_POST",
"INSTAGRAM_POST",
"TWITTER_POST",
"VIBER_BOT",
"INSTAGRAM_MESSAGING",
"GOOGLE_PLAY",
"KAKAO_SANGDAM",
"TWITTER_DM",
"WHATSAPP_CALLS",
"VIBER_CALLS",
"OPEN_CHANNEL",
"TIKTOK",
"ZALO"
],
"title":"ConversationChannel"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventApiRequest":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Sender Id."
},
"to":{
"type":"string",
"description":"Destination Id."
},
"type":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventType"
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventChannel"
}
},
"required":[
"channel",
"from",
"to",
"type"
],
"title":"ConversationEventApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventChannel":{
"type":"string",
"description":"Channel where the event will be sent.",
"enum":[
"LIVE_CHAT",
"APPLE_BUSINESS_CHAT",
"WHATSAPP"
],
"title":"ConversationEventChannel"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventType":{
"type":"string",
"description":"Event type.",
"enum":[
"TYPING_STARTED",
"TYPING_STOPPED"
],
"title":"ConversationEventType"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority":{
"type":"string",
"default":"NORMAL",
"description":"Conversation priority.",
"enum":[
"URGENT",
"HIGH",
"NORMAL",
"LOW"
],
"title":"ConversationPriority"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage":{
"type":"object",
"example":{
"conversations":[
{
"id":"9542b329-01f4-4593-b7b0-606949389129",
"topic":"First conversation topic",
"summary":"First conversation summary",
"status":"OPEN",
"priority":"NORMAL",
"queueId":null,
"agentId":null,
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"id":"be2de5f9-d049-446b-8c62-098be8b8f624",
"topic":"Second conversation topic",
"summary":"Second conversation summary",
"status":"SOLVED",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"id":"7e40af76-3020-4bf6-942f-27910d33899b",
"topic":"Third conversation topic",
"summary":"Third conversation topic",
"status":"CLOSED",
"priority":"LOW",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"closedAt":"2024-01-03T00:00:00.000+00:00"
}
],
"pagination":{
"totalItems":3,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"conversations":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"ConversationResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationRoutingResultApiResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Conversation Id."
},
"queueId":{
"type":"string",
"description":"Resolved queue Id."
},
"priority":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority"
}
},
"title":"ConversationRoutingResultApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationStatus":{
"type":"string",
"description":"Conversation status.",
"enum":[
"OPEN",
"WAITING",
"SOLVED",
"CLOSED",
"PENDING"
],
"title":"ConversationStatus"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateMessageApiRequest":{
"type":"object",
"properties":{
"channel":{
"type":"string",
"description":"Available communication channels",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"LIVE_CHAT",
"LINE",
"APPLE_BUSINESS_CHAT",
"EMAIL",
"TELEGRAM",
"INSTAGRAM_MESSAGING",
"KAKAO_SANGDAM",
"VIBER_BOT"
]
},
"from":{
"type":"string",
"description":"Sender phone number, email address, FB messenger Id or live chat widget Id."
},
"to":{
"type":"string",
"description":"Destination phone number, email address, FB messenger or live chat user Id."
},
"content":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent"
},
"contentType":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType"
}
},
"required":[
"channel",
"content",
"contentType",
"from",
"to"
],
"title":"CreateMessageApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateNoteApiRequest":{
"type":"object",
"properties":{
"type":{
"type":"string",
"default":"INTERNAL",
"enum":[
"INTERNAL",
"ATTACHMENT"
]
},
"content":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteContent"
},
"agentId":{
"type":"string",
"description":"Agent Id, creator of note.",
"maxLength":255,
"minLength":0
}
},
"required":[
"content"
],
"title":"CreateNoteApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateQueueApiRequest":{
"type":"object",
"example":{
"name":"Spanish Support"
},
"properties":{
"name":{
"type":"string",
"description":"Name of the queue.",
"maxLength":255,
"minLength":0
},
"isAutoAssignmentEnabled":{
"type":"boolean",
"default":false,
"description":"Auto-assignment of the queue."
},
"workingHoursId":{
"type":"string",
"description":"Working hours Id queue belongs to"
},
"externalId":{
"type":"string"
}
},
"required":[
"name"
],
"title":"CreateQueueApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateRuleApiRequest":{
"type":"object",
"example":[
{
"priority":"URGENT",
"queueId":"448bf76d-0047-49a3-93a4-ea8722d6aeaa",
"enabled":true,
"name":"First Rule",
"routeOnlyDuringWorkingHours":true,
"expression":{
"$or":[
{
"$eq":{
"message.channel":"WHATSAPP"
}
},
{
"$eq":{
"message.channel":"LIVE_CHAT"
}
}
]
}
},
{
"priority":"HIGH",
"queueId":"448bf76d-0047-49a3-93a4-ea8722d7aeab",
"enabled":true,
"name":"Second Rule",
"routeOnlyDuringWorkingHours":false,
"expression":{
"$and":[
{
"$eq":{
"message.channel":"TELEGRAM"
}
},
{
"$eq":{
"customer.country":"Croatia"
}
}
]
}
},
{
"priority":"NORMAL",
"queueId":"39b52b7f-db13-4c47-9b6e-de2ba91df62g",
"queueName":"Third Queue",
"enabled":true,
"name":"Third Rule",
"routeOnlyDuringWorkingHours":false,
"expression":{
"$eq":{
"message.channel":"VIBER"
}
}
}
],
"properties":{
"priority":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority"
},
"expression":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Query for logical validation of new messages. See [Routing](https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing) for more info."
},
"queueId":{
"type":"string",
"description":"Queue Id is a destination queue where the new message will be assigned to.",
"maxLength":255,
"minLength":0
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Enabled is a boolean value (TRUE, FALSE), so the rule is engaged or avoided in the routing process. If not provided will be set to default."
},
"name":{
"type":"string",
"description":"Rule name, light description of expression logic.",
"maxLength":255,
"minLength":0
},
"routeOnlyDuringWorkingHours":{
"type":"boolean",
"default":false,
"description":"When set to true, it indicates that the route should only be processed during designated working hours. [Set up working hours](https://www.infobip.com/docs/api/customer-engagement/conversations-api/create-working-hours)"
}
},
"required":[
"expression",
"queueId"
],
"title":"CreateRuleApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest":{
"type":"object",
"example":{
"name":"Tag 1"
},
"properties":{
"name":{
"type":"string",
"description":"Tag name. Numbers, uppercase and lowercase letters, along with '.' and '_' characters are allowed!",
"maxLength":100,
"minLength":0
}
},
"required":[
"name"
],
"title":"CreateTagApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversation":{
"type":"object",
"description":"A pair of linked conversations.",
"example":{
"parentConversation":{
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"topic":"Billing inquiry",
"channel":"WHATSAPP",
"status":"OPEN",
"customerDisplayName":"John Doe"
},
"childConversation":{
"conversationId":"e43bc422-09c9-4591-8b9d-82debcf04e0d",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"topic":"Follow-up",
"channel":"LIVE_CHAT",
"status":"OPEN",
"customerDisplayName":"John Doe"
}
},
"properties":{
"parentConversation":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember"
},
"childConversation":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember"
}
},
"required":[
"childConversation",
"parentConversation"
],
"title":"LinkedConversation"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember":{
"type":"object",
"description":"A conversation that is linked to another conversation.",
"properties":{
"conversationId":{
"type":"string",
"description":"Conversation ID."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time when the conversation was created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time when the conversation was last updated."
},
"agentId":{
"type":"string",
"description":"ID of the assigned agent."
},
"topic":{
"type":"string",
"description":"Conversation topic."
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel"
},
"status":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationStatus"
},
"customerDisplayName":{
"type":"string",
"description":"Display name of the customer."
}
},
"title":"LinkedConversationMember"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversations":{
"type":"object",
"description":"Linked conversations response.",
"properties":{
"linkedConversations":{
"type":"array",
"description":"List of linked conversation pairs.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversation"
}
}
},
"title":"LinkedConversations"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Message Id"
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel"
},
"from":{
"type":"string",
"description":"Sender phone number, email address, FB messenger Id or live chat widget Id."
},
"to":{
"type":"string",
"description":"Destination phone number, email address, FB messenger or live chat user Id."
},
"direction":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection"
},
"conversationId":{
"type":"string",
"description":"Id of the conversation message belongs to."
},
"authorId":{
"type":"string",
"description":"Internal unique ID of the customer or agent, determined by the author type."
},
"authorType":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AuthorType"
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when message is created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when message is updated."
},
"content":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent"
},
"contentType":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType"
}
},
"title":"MessageApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel":{
"type":"string",
"description":"Available communication channels",
"enum":[
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"UNKNOWN",
"EMAIL",
"LIVE_CHAT",
"UNUSED",
"VOICE",
"VIDEO",
"APPLE_BUSINESS_CHAT",
"LINE",
"GOOGLE_BUSINESS_MESSAGES",
"TELEGRAM",
"CALLS",
"INTERNAL",
"VIBER_BOT",
"FACEBOOK_POST",
"INSTAGRAM_POST",
"TWITTER_POST",
"INSTAGRAM_MESSAGING",
"GOOGLE_PLAY",
"KAKAO_SANGDAM",
"TWITTER_DM",
"WHATSAPP_CALLS",
"VIBER_CALLS",
"OPEN_CHANNEL",
"TIKTOK",
"ZALO",
"SMS",
"VIBER",
"FACEBOOK_MESSENGER",
"WHATSAPP",
"RCS",
"LIVE_CHAT",
"LINE",
"APPLE_BUSINESS_CHAT",
"TELEGRAM",
"INSTAGRAM_MESSAGING",
"KAKAO_SANGDAM",
"VIBER_BOT",
"EMAIL"
],
"title":"MessageChannel"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent":{
"type":"object",
"description":"Message content depending on content type.",
"title":"MessageContent"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection":{
"type":"string",
"description":"Message direction",
"enum":[
"INBOUND",
"OUTBOUND",
"INBOUND",
"OUTBOUND"
],
"title":"MessageDirection"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageResultPage":{
"type":"object",
"example":{
"messages":[
{
"id":"c3b94b2f-a3a1-4999-b63b-413800544123",
"from":"447492263899",
"to":"447496389711",
"channel":"SMS",
"direction":"INBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"Customer message content"
}
},
{
"id":"0224bdbc-8693-4ce5-8eb1-c8046d44d09f",
"from":"447492263899",
"to":"447496389711",
"channel":"VIBER",
"direction":"OUTBOUND",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"contentType":"TEXT",
"content":{
"text":"Agent message content"
}
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"messages":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"MessageResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse":{
"type":"object",
"example":{
"agentId":"1367466e-7e5d-40d7-a78a-ace2780ed3dd",
"content":"Sample Note content"
},
"properties":{
"id":{
"type":"string",
"description":"Note Id"
},
"conversationId":{
"type":"string",
"description":"Id of the conversation holding the note."
},
"agentId":{
"type":"string",
"description":"Id of the author agent."
},
"content":{
"type":"string",
"description":"Note content, which can be any text up to 4000 characters."
},
"type":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteType"
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when note is created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when note is updated."
}
},
"title":"NoteApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteContent":{
"type":"object",
"description":"Notes content can be any text.",
"title":"NoteContent"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteResultPage":{
"type":"object",
"example":{
"notes":[
{
"id":"9bdb00a1-70f8-4838-ae4b-58fa3e7c93b4",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"type":"INTERNAL",
"content":"Note content 1",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"id":"10ae8597-029d-4d6b-bf9f-d22c67b4fa42",
"conversationId":"4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
"type":"INTERNAL",
"content":"Note content 2",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"notes":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"NoteResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteType":{
"type":"string",
"enum":[
"INTERNAL",
"AUTH_BIOMETRY_INIT",
"AUTH_BIOMETRY_PENDING",
"AUTH_BIOMETRY_SUCCESS",
"AUTH_BIOMETRY_EXPIRED",
"AUTH_BIOMETRY_CANCEL",
"AUTH_BIOMETRY_FAILED",
"AUTH_AGENT_SUCCESS",
"AUTH_AGENT_EXPIRED",
"AUTH_BOT_SUCCESS",
"AUTH_BOT_EXPIRED",
"JIRA_COMMENT",
"ATTACHMENT",
"INTERNAL",
"ATTACHMENT"
],
"title":"NoteType"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination":{
"type":"object",
"properties":{
"totalItems":{
"type":"integer",
"format":"int64",
"readOnly":true
},
"page":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"limit":{
"type":"integer",
"format":"int32",
"readOnly":true
},
"orderBy":{
"type":"string",
"readOnly":true
}
},
"title":"Pagination"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest":{
"type":"object",
"example":{
"topic":"Topic",
"summary":"Summary",
"status":"OPEN",
"priority":"HIGH",
"queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
"agentId":"c856e230-a8cd-498b-9996-42bbed35029a"
},
"properties":{
"topic":{
"type":"string",
"description":"Conversation topic.",
"maxLength":1000,
"minLength":0
},
"summary":{
"type":"string",
"description":"Short description of the conversation.",
"maxLength":4000,
"minLength":0
},
"status":{
"type":"string",
"description":"Conversation status.",
"enum":[
"OPEN",
"WAITING",
"SOLVED",
"CLOSED"
]
},
"priority":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority"
},
"queueId":{
"type":"string",
"description":"Id of the queue conversation belongs to.",
"maxLength":255,
"minLength":0
},
"agentId":{
"type":"string",
"description":"Id of the agent assigned to the conversation.",
"maxLength":255,
"minLength":0
}
},
"title":"PatchConversationApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel":{
"type":"object",
"example":{
"name":"Spanish Support",
"isAutoAssignmentEnabled":false
},
"properties":{
"id":{
"type":"string",
"readOnly":true
},
"name":{
"type":"string",
"description":"Queue name.",
"maxLength":255,
"minLength":0
},
"enabledAgentsCount":{
"type":"integer",
"format":"int32"
},
"enabledRoutesCount":{
"type":"integer",
"format":"int32"
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"isAutoAssignmentEnabled":{
"type":"boolean",
"default":false,
"description":"Queue Auto-assignment toggle."
},
"autoAssignmentAlgorithm":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm"
},
"isAutoAssignmentOutsideOfWorkingHoursEnabled":{
"type":"boolean",
"default":false,
"description":"Queue Auto-assignment Outside of Working hours toggle"
},
"stickyAgentTimeoutDays":{
"type":"integer",
"format":"int64",
"description":"Number of days since last interaction with the customer."
},
"isStickyAutoAssignmentEnabled":{
"type":"boolean",
"description":"Auto-assignment according to last interaction with the customer."
},
"workingHoursId":{
"type":"string",
"description":"Working hours Id queue belongs to"
},
"isRestricted":{
"type":"boolean",
"default":false,
"description":"Is queue restricted."
},
"isPrivate":{
"type":"boolean",
"default":false,
"description":"Is queue private."
},
"deletedAt":{
"type":"string",
"format":"date-time"
},
"externalId":{
"type":"string"
}
},
"title":"QueueApiModel"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueResultPage":{
"type":"object",
"example":{
"queues":[
{
"id":"a126beb1-f43b-422c-b298-295f65d31e82",
"name":"Queue 1",
"enabledAgentsCount":3,
"enabledRoutesCount":2,
"isAutoAssignmentEnabled":false,
"stickyAgentTimeoutDays":10,
"isStickyAutoAssignmentEnabled":true,
"workingHoursId":null,
"isPrivate":false,
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"deletedAt":null
},
{
"id":"75af6f92-75a6-4364-b293-450281bd21be",
"name":"Queue 2",
"enabledAgentsCount":1,
"enabledRoutesCount":4,
"isAutoAssignmentEnabled":false,
"stickyAgentTimeoutDays":null,
"isStickyAutoAssignmentEnabled":false,
"workingHoursId":null,
"isPrivate":false,
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"deletedAt":null
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"queues":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"QueueResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedCommentsApiResponse":{
"type":"object",
"example":{
"conversationsMessage":{
"id":1,
"channel":"FACEBOOK_POST",
"from":"55555544444433333",
"to":"999990000011111",
"direction":"INBOUND",
"conversationId":"3f8c9a2e-1b6f-4d3a-9f5b-2e4b6c8d9e7f",
"authorId":"7a1d5b4c-8e2f-4c3b-b9a1-5f6d7e8f9a0b",
"authorType":"CUSTOMER",
"createdAt":"2025-01-10T08:51:23.100+00:00",
"updatedAt":"2025-01-10T08:51:23.100+00:00",
"content":{
"text":"Hello!",
"showUrlPreview":null
},
"singleSendMessage":{
"from":{
"id":"55555544444433333",
"type":"SOCIAL_USER"
},
"to":{
"externalId":"999990000011111",
"type":"SOCIAL_PAGE"
},
"content":{
"commentMoContent":{
"text":"Hello!",
"type":"TEXT"
},
"type":"COMMENT"
},
"socialContext":{
"externalId":"999990000011111_123456789123457",
"postId":"987654321987_999990000011112",
"parentId":null,
"permalinkUrl":null,
"extCreated":"2025-01-10T08:51:23.100+00:00",
"username":"John Doe",
"actionType":"ADD"
},
"channel":"FACEBOOK_POST",
"direction":"INBOUND"
},
"contentType":"TEXT"
},
"olderComments":[
{
"id":null,
"channel":"FACEBOOK_POST",
"authorName":"John Doe:123456789",
"direction":"INBOUND",
"conversationId":"a06b6abc-1c8f-4b4f-8600-f4f651418e8f",
"createdAt":"2025-01-09T08:51:23.100+00:00",
"content":{
"text":"Test",
"showUrlPreview":null
},
"singleSendMessage":{
"from":{
"id":"55555544444433333",
"type":"SOCIAL_USER"
},
"to":{
"externalId":"999990000011111",
"type":"SOCIAL_PAGE"
},
"content":{
"commentMoContent":{
"text":"Test",
"type":"TEXT"
},
"type":"COMMENT"
},
"socialContext":{
"externalId":"999990000011111_123456789123456",
"postId":"987654321987_999990000011111",
"parentId":null,
"permalinkUrl":null,
"extCreated":"2025-01-09T08:51:17Z",
"username":"John Doe",
"actionType":"ADD"
},
"channel":"FACEBOOK_POST",
"direction":"INBOUND"
},
"contentType":"TEXT"
}
],
"newerComments":[
{
"id":null,
"channel":"FACEBOOK_POST",
"authorName":"Peter Northrop:8132498432",
"direction":"OUTBOUND",
"conversationId":"e50588de-123b-45c8-9f58-8e3376805646",
"createdAt":"2025-02-18T13:56:10.465+00:00",
"content":{
"socialMentions":[],
"text":"@John Doe OK",
"showUrlPreview":null
},
"singleSendMessage":{
"from":{
"externalId":"999990000011111",
"type":"SOCIAL_PAGE"
},
"to":{
"id":"8132498432",
"type":"SOCIAL_USER"
},
"content":{
"text":"@John Doe OK",
"type":"TEXT"
},
"replyToCommentId":"999990000011111_546621549845623",
"mentions":[],
"channel":"FACEBOOK_POST",
"direction":"OUTBOUND"
},
"contentType":"TEXT"
}
]
},
"properties":{
"conversationsMessage":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse"
},
"olderComments":{
"type":"array",
"description":"Returns up to 50 comments created before the specified inbound comment, at the same level of the conversation.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse"
}
},
"newerComments":{
"type":"array",
"description":"Returns up to 50 comments created after the specified inbound comment, at the same level of the conversation.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse"
}
}
},
"title":"RelatedCommentsApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse":{
"type":"object",
"description":"Returns up to 50 comments created after the specified inbound comment, at the same level of the conversation.",
"properties":{
"id":{
"type":"string",
"description":"Unique ID of the comment."
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel"
},
"authorName":{
"type":"string",
"description":"Facebook or Instagram username."
},
"direction":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection"
},
"conversationId":{
"type":"string",
"description":"ID of the conversation to which the message belongs."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when message was created."
},
"content":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent"
},
"contentType":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType"
}
},
"title":"RelatedMessageApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RoutingRulesResultPage":{
"type":"object",
"example":{
"routes":[
{
"id":"467bbaad-3f50-4c27-9f24-0427aaec611f",
"priority":"URGENT",
"queueId":"448bf76d-0047-49a3-93a4-ea8722d6aeaa",
"queueName":"First Queue",
"enabled":true,
"name":"First Rule",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"order":1,
"routeOnlyDuringWorkingHours":true,
"isPrivate":false,
"expression":{
"$or":[
{
"$eq":{
"message.channel":"WHATSAPP"
}
},
{
"$eq":{
"message.channel":"LIVE_CHAT"
}
}
]
}
},
{
"id":"467bbaad-3f50-4c27-9f24-0427baec611f",
"priority":"HIGH",
"queueId":"448bf76d-0047-49a3-93a4-ea8722d7aeab",
"queueName":"Second Queue",
"enabled":true,
"name":"Second Rule",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"order":2,
"routeOnlyDuringWorkingHours":false,
"isPrivate":false,
"expression":{
"$and":[
{
"$eq":{
"message.channel":"TELEGRAM"
}
},
{
"$eq":{
"customer.country":"Croatia"
}
}
]
}
},
{
"id":"eb7bdb7d-7281-4107-8d7b-80efc8548a38",
"priority":"NORMAL",
"queueId":"39b52b7f-db13-4c47-9b6e-de2ba91df62g",
"queueName":"Third Queue",
"enabled":true,
"name":"Third Rule",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"order":3,
"routeOnlyDuringWorkingHours":false,
"isPrivate":false,
"expression":{
"$eq":{
"message.channel":"VIBER"
}
}
}
],
"pagination":{
"totalItems":3,
"page":0,
"limit":999,
"orderBy":"order:ASC"
}
},
"properties":{
"routes":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RuleApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"RoutingRulesResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RuleApiResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Rule Id."
},
"priority":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority"
},
"expression":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Query for logical validation of new messages. See [Routing](https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing) for more info."
},
"queueId":{
"type":"string",
"description":"Queue Id is a destination queue where the new message will be assigned to."
},
"queueName":{
"type":"string",
"description":"Queue name."
},
"enabled":{
"type":"boolean",
"default":true,
"description":"Enabled is a boolean value (TRUE, FALSE), so the rule is engaged or avoided in the routing process. If not provided will be set to default."
},
"name":{
"type":"string",
"description":"Rule name, light description of expression logic."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when rule is created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when rule is last updated."
},
"order":{
"type":"integer",
"format":"int32",
"description":"Position in order of executing this rule for logical validation new message."
},
"routeOnlyDuringWorkingHours":{
"type":"boolean",
"default":false,
"description":"When set to true, it indicates that the route should only be processed during designated working hours. [Set up working hours](https://www.infobip.com/docs/api/customer-engagement/conversations-api/create-working-hours)"
},
"isPrivate":{
"type":"boolean",
"default":false,
"description":"Is route private."
}
},
"title":"RuleApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCode":{
"type":"string",
"enum":[
"SUCCESS",
"ERROR"
],
"title":"StatusCode"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse":{
"type":"object",
"properties":{
"statusCode":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCode"
},
"message":{
"type":"string"
}
},
"title":"StatusCodeResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagApiResponse":{
"type":"object",
"example":{
"name":"Tag 1"
},
"properties":{
"name":{
"type":"string",
"description":"Tag name. Numbers, uppercase and lowercase letters, along with '.' and '_' characters are allowed!"
},
"id":{
"type":"string",
"readOnly":true
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
}
},
"title":"TagApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagsApiResponse":{
"type":"object",
"example":{
"tags":[
{
"name":"Tag 1",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"name":"Tag 2",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"id:ASC"
}
},
"properties":{
"tags":{
"type":"array",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"TagsApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse":{
"type":"object",
"description":"List of templates.",
"example":{
"id":"c4391685-b21a-4c21-a470-5453e9382752",
"name":"Template name",
"language":"English",
"languageCode":"en",
"channel":"SMS",
"external":false,
"content":"Simple text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"Template tag",
"createdAt":"2024-12-10T00:00:00.000+00:00",
"updatedAt":"2024-12-10T00:00:00.000+00:00"
}
],
"attachments":[]
},
"properties":{
"id":{
"type":"string",
"description":"Template id."
},
"name":{
"type":"string",
"description":"Template name."
},
"language":{
"type":"string",
"description":"Language used when constructing template content."
},
"languageCode":{
"type":"string",
"description":"Language code used when constructing template content."
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel"
},
"external":{
"type":"boolean",
"description":"Boolean flag that indicates whether the template is external, WhatsApp pre-registered, or internal user-defined.\nIf the flag is true, then the template is WhatsApp pre-registered, otherwise, it is user-defined."
},
"contentType":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType"
},
"content":{
"type":"object",
"description":"Template content."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when template was created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when template was updated."
},
"tags":{
"type":"array",
"description":"List of template tags.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateTagApiResponse"
}
},
"attachments":{
"type":"array",
"description":"List of template attachments.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateFileApiResponse"
}
},
"sender":{
"type":"string"
}
},
"title":"TemplateApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateFileApiResponse":{
"type":"object",
"description":"List of template attachments.",
"properties":{
"id":{
"type":"string"
},
"fileName":{
"type":"string"
},
"fileExtension":{
"type":"string"
},
"fileSize":{
"type":"integer",
"format":"int64"
},
"contentType":{
"type":"string"
},
"publicLink":{
"type":"string"
},
"thumbLink":{
"type":"string"
},
"uploadedAt":{
"type":"string",
"format":"date-time"
}
},
"title":"TemplateFileApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateResultPage":{
"type":"object",
"example":{
"templates":[
{
"id":"c4391685-b21a-4c21-a470-5453e9382752",
"name":"First template name",
"language":"English",
"languageCode":"en",
"channel":"SMS",
"external":false,
"content":"Simple English text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"First template tag",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"attachments":[]
},
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"name":"Second template name",
"language":"Spanish",
"languageCode":"es",
"channel":"SMS",
"external":false,
"content":"Simple Spanish text content",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00",
"tags":[
{
"name":"Second template tag",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
}
],
"attachments":[
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"fileName":"Second template file",
"fileExtension":"txt",
"fileSize":1024,
"contentType":"text/plain",
"publicLink":"https://example.com/second-template-file.txt",
"thumbLink":"https://example.com/second-template-file-thumb.png",
"uploadedAt":"2024-01-01T00:00:00.000+00:00"
},
{
"id":"e2fafe40-ea15-49c8-ae9b-aa07131a0096",
"fileName":"Second template image",
"fileExtension":"png",
"fileSize":2048,
"contentType":"image/png",
"publicLink":"https://example.com/second-template-image.png",
"thumbLink":"https://example.com/second-template-image-thumb.png",
"uploadedAt":"2024-01-01T00:00:00.000+00:00"
}
]
}
],
"pagination":{
"totalItems":2,
"page":0,
"limit":10,
"orderBy":"createdAt:DESC"
}
},
"properties":{
"templates":{
"type":"array",
"description":"List of templates.",
"items":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse"
}
},
"pagination":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination"
}
},
"title":"TemplateResultPage"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateTagApiResponse":{
"type":"object",
"description":"List of template tags.",
"example":{
"name":"Template tag",
"createdAt":"2024-01-01T00:00:00.000+00:00",
"updatedAt":"2024-01-01T00:00:00.000+00:00"
},
"properties":{
"id":{
"type":"string",
"description":"Template tag ID."
},
"name":{
"type":"string",
"description":"Template tag name."
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when template tag was created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when template tag was updated."
}
},
"title":"TemplateTagApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.UpdateQueueApiRequest":{
"type":"object",
"example":{
"name":"Spanish Support",
"isAutoAssignmentEnabled":true,
"autoAssignmentAlgorithm":"LOAD_BALANCING",
"isAutoAssignmentOutsideOfWorkingHoursEnabled":false,
"stickyAgentTimeoutDays":7,
"isStickyAutoAssignmentEnabled":true,
"workingHoursId":null,
"isRestricted":false,
"externalId":null
},
"properties":{
"name":{
"type":"string",
"description":"Queue name.",
"maxLength":255,
"minLength":0
},
"isAutoAssignmentEnabled":{
"type":"boolean",
"default":true,
"description":"Queue Auto-assignment toggle."
},
"autoAssignmentAlgorithm":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm"
},
"isAutoAssignmentOutsideOfWorkingHoursEnabled":{
"type":"boolean",
"default":false,
"description":"Queue Auto-assignment Outside of Working hours toggle"
},
"stickyAgentTimeoutDays":{
"type":"integer",
"format":"int64",
"description":"Number of days since last interaction with the customer."
},
"isStickyAutoAssignmentEnabled":{
"type":"boolean",
"description":"Auto-assignment according to last interaction with the customer."
},
"workingHoursId":{
"type":"string",
"description":"Working hours Id queue belongs to"
},
"isRestricted":{
"type":"boolean",
"default":false,
"description":"Is queue restricted."
},
"externalId":{
"type":"string",
"description":"External identifier for the queue."
}
},
"title":"UpdateQueueApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest":{
"type":"object",
"example":{
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true
},
"properties":{
"name":{
"type":"string",
"description":"Web Form name."
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel"
},
"destination":{
"type":"string",
"description":"Web Form destination."
},
"url":{
"type":"string",
"description":"Web Form URL."
},
"enabled":{
"type":"boolean",
"description":"Web Form enable/disable toggle."
},
"tagIds":{
"type":"array",
"description":"List of tag Ids used on the Web Form.",
"items":{
"type":"string",
"description":"List of tag Ids used on the Web Form."
}
}
},
"required":[
"channel",
"destination",
"enabled",
"name"
],
"title":"WebFormApiRequest"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse":{
"type":"object",
"example":{
"id":"7646c2ff-916d-46f1-9c53-5273476ed505",
"name":"Test WebForm",
"channel":"EMAIL",
"destination":"destination@email.test",
"url":"/ccaas/1/web-forms/7646c2ff-916d-46f1-9c53-5273476ed505/post",
"enabled":true,
"createdAt":"2023-11-01T00:00:00.000+00:00",
"updatedAt":"2023-11-01T00:00:00.000+00:00",
"tagIds":[
"2423d4c7-23da-422a-9f15-ca08006051ea",
"2664c7c3-f546-4073-a961-b94aed465ee8"
]
},
"properties":{
"id":{
"type":"string",
"description":"Web Form Id."
},
"name":{
"type":"string",
"description":"Web Form name."
},
"channel":{
"$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel"
},
"destination":{
"type":"string",
"description":"Web Form destination."
},
"url":{
"type":"string",
"description":"Web Form URL."
},
"enabled":{
"type":"boolean",
"description":"Web Form enable/disable toggle."
},
"tagIds":{
"type":"array",
"description":"List of tag Ids used on the Web Form.",
"items":{
"type":"string",
"description":"List of tag Ids used on the Web Form."
}
},
"createdAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when Web Form is created."
},
"updatedAt":{
"type":"string",
"format":"date-time",
"description":"Time stamp when Web Form was updated."
}
},
"title":"WebFormApiResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormPostResponse":{
"type":"object",
"properties":{
"conversationId":{
"type":"string"
}
},
"title":"WebFormPostResponse"
},
"e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormSubmissionApiRequest":{
"type":"object",
"example":{
"from":"from.testmail@email.test",
"subject":"Test Subject",
"cc":[
"cc1@email.test",
"cc2@email.test"
],
"content":"Example text file.",
"attachmentIds":[
"dd68c1ec-1997-4e90-add6-b36dfd2b80a3"
]
},
"properties":{
"from":{
"type":"string",
"description":"Sender of the submission."
},
"subject":{
"type":"string",
"description":"Submission subject."
},
"cc":{
"type":"array",
"description":"List of web form submission carbon copy recipients.",
"items":{
"type":"string",
"description":"List of web form submission carbon copy recipients."
}
},
"content":{
"type":"string",
"description":"Web form submission body content."
},
"attachmentIds":{
"type":"array",
"description":"Web form submission attachment Ids.",
"items":{
"type":"string",
"description":"Web form submission attachment Ids."
}
}
},
"required":[
"content",
"from"
],
"title":"WebFormSubmissionApiRequest"
}
},
"responses":{
"ApiException400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
},
"ApiException401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"UNAUTHORIZED",
"text":"Unauthorized"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n"
}
}
},
"ApiException403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"FORBIDDEN",
"text":"Forbidden"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n"
}
}
},
"ApiException404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n NOT_FOUND\n Not found\n \n \n\n"
}
}
},
"ApiException429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
},
"ApiException500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"GENERAL_ERROR",
"text":"Something went wrong. Please contact support."
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n"
}
}
}
},
"parameters":{},
"examples":{},
"requestBodies":{},
"headers":{},
"securitySchemes":{
"APIKeyHeader":{
"type":"apiKey",
"description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n",
"name":"Authorization",
"in":"header"
},
"Basic":{
"type":"http",
"description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n",
"scheme":"basic"
},
"IBSSOTokenHeader":{
"type":"apiKey",
"description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n",
"name":"Authorization",
"in":"header"
},
"OAuth2":{
"type":"oauth2",
"description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```",
"flows":{
"clientCredentials":{
"tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
"scopes":{}
}
}
}
},
"links":{},
"callbacks":{}
}
}