Infobip Customer Engagement API
Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.
Infobip Customer Engagement API is one of 6 APIs that Infobip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customer Engagement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 254 operations across 153 paths, and defines 407 schemas. It is described by OpenAPI 3.2.0, at version 3.210.0.
Requests are made against the base URL https://api.infobip.com.
254 operations
153 paths
407 schemas
41 DELETE87 GET27 PATCH61 POST38 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Infobip Customer Engagement API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (APIKeyHeader).
It accepts HTTP basic authentication (Basic).
An API key is passed in the header as Authorization (IBSSOTokenHeader).
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.
APIKeyHeader— This is the most secure authorization type and the one with the most flexibility. API keys can be generated by calling the dedicated API method. Furthermore, A…Basic— 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…IBSSOTokenHeader— 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 Infobi…OAuth2— 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 t…
Paths & Operations 254
Across 153 paths, the API surfaces 254 operations — 41 DELETE, 87 GET, 27 PATCH, 61 POST, 38 PUT. Each is listed below with its method, path, parameters, and response codes.
customer-engagement 254
Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.
GET
/people/2/persons
Get a single person or a list of people
PUT
/people/2/persons
Update a person
POST
/people/2/persons
Create a new person
DELETE
/people/2/persons
Delete a person
PATCH
/people/2/persons
Partial person update
PUT
/people/2/persons/contactInformation
Set contact information to person
DELETE
/people/2/persons/contactInformation
Delete contact information from person
PATCH
/people/2/persons/contactInformation
Add contact information to person
POST
/people/2/persons/batch
Batch people create
DELETE
/people/2/persons/batch
Batch people delete
PATCH
/people/2/persons/batch
Batch people update
POST
/people/2/persons/match
Match profiles
POST
/people/3/persons/merge
Batch merge profiles
PUT
/people/3/persons/upsert
Batch full people upsert
PATCH
/people/3/persons/upsert
Batch partial people upsert
GET
/people/2/companies
Get a single company or a list of companies
POST
/people/2/companies
Create a new company
DELETE
/people/2/companies
Delete a company
PATCH
/people/2/companies
Partial company update
POST
/people/2/companies/batch
Batch companies create
DELETE
/people/2/companies/batch
Batch companies delete
PATCH
/people/2/companies/batch
Batch companies update
DELETE
/people/2/companies/persons
Remove persons from company batch
PATCH
/people/2/companies/persons
Add persons to company batch
GET
/people/2/tags
Get list of tags
POST
/people/2/tags
Create a new tag
GET
/people/2/tags/{name}
Get a tag
DELETE
/people/2/tags/{name}
Delete a tag
DELETE
/people/2/tags/{name}/persons
Remove tag from people batch
PATCH
/people/2/tags/{name}/persons
Add tag to people batch
GET
/people/2/customAttributes
Get a list of custom attributes
POST
/people/2/customAttributes
Create a custom attribute
GET
/people/2/customAttributes/{name}
Get a single custom attribute
DELETE
/people/2/customAttributes/{name}
Delete a custom attribute
POST
/people/2/customAttributes/{name}/append
Append item to custom attribute
GET
/people/3/lists/{listName}/items
Get items
POST
/people/3/lists/{listName}/items
Append items
DELETE
/people/3/lists/{listName}/items
Delete items
PUT
/people/3/lists/{listName}/items/{itemId}
Replace an item
PATCH
/people/3/lists/{listName}/items/{itemId}
Update an item
GET
/people/3/lists
Get lists
DELETE
/people/3/lists
Delete lists
PUT
/people/3/lists/{listName}
Replace a list
PATCH
/people/3/lists/{listName}
Update a list
GET
/people/2/persons/{personId}/lists/{listName}/itemsdeprecated
Get items
POST
/people/2/persons/{personId}/lists/{listName}/itemsdeprecated
Append items
DELETE
/people/2/persons/{personId}/lists/{listName}/itemsdeprecated
Delete items
PUT
/people/2/persons/{personId}/lists/{listName}/items/{itemId}deprecated
Replace an item
PATCH
/people/2/persons/{personId}/lists/{listName}/items/{itemId}deprecated
Update an item
GET
/people/2/persons/{personId}/listsdeprecated
Get lists
DELETE
/people/2/persons/{personId}/listsdeprecated
Delete lists
PUT
/people/2/persons/{personId}/lists/{listName}deprecated
Replace a list
PATCH
/people/2/persons/{personId}/lists/{listName}deprecated
Update a list
GET
/people/2/contactInformation/push/{pushRegId}
Get push device registration
PATCH
/people/2/contactInformation/push/{pushRegId}
Update push device registration
POST
/people/2/contactInformation/push/{pushRegId}/depersonalize
Depersonalize push instance
POST
/people/2/contactInformation/push/{pushRegId}/personalize
Personalize push instance
POST
/people/3/events
Batch Send Events
POST
/peopleevents/2/persons/{personId}/definitions/{definitionId}/events
Send Event
GET
/peopleevents/2/definitions
List Event Definitions
POST
/peopleevents/2/definitions
Create Event Definition
GET
/peopleevents/2/definitions/{definitionId}
Get Event Definition
POST
/peopleevents/2/definitions/{definitionId}
Update Event Definition
POST
/peopleevents/1/export
Submit event export request
GET
/peopleevents/1/export/status/{requestId}
Check status of event export request
DELETE
/peopleevents/1/export/{requestId}
Asynchronous cancellation of an event export request
GET
/peopleevents/1/export/definitions
Get list of event definitions
GET
/people/3/segments
Get a list of segments
POST
/people/3/segments
Create a segment
GET
/people/3/segments/{segmentId}
Get a segment
PUT
/people/3/segments/{segmentId}
Update a segment
DELETE
/people/3/segments/{segmentId}
Delete a segment
GET
/people/3/segments/{segmentId}/persons
Get persons in a segment
POST
/moments/1/flows/{campaignId}/participants
Add participants to flow
GET
/moments/1/flows/{campaignId}/participants/report
Get a report on participants added to flow
POST
/communication/1/flows/{campaignId}/participantsdeprecated
Add Person to Flow
DELETE
/communication/1/flows/{campaignId}/participants
Remove person from flow
GET
/forms/1/forms
Get forms
GET
/forms/1/forms/{id}
Get form
POST
/forms/1/forms/{id}/views
Increment form view count
POST
/forms/1/forms/{id}/data
Submit form data
GET
/ccaas/1/conversations
Get conversations
POST
/ccaas/1/conversations
Create conversation
GET
/ccaas/1/conversations/{conversationId}
Get conversation
PUT
/ccaas/1/conversations/{conversationId}
Update conversation
PATCH
/ccaas/1/conversations/{conversationId}
Patch conversation
POST
/ccaas/1/conversations/{conversationId}/tags
Add tag to conversation
PUT
/ccaas/1/conversations/{conversationId}/assignee
Change conversation assignment
DELETE
/ccaas/1/conversations/{conversationId}/assignee
Unassign conversation agent
DELETE
/ccaas/1/conversations/{conversationId}/tags/{tagName}
Remove tag from conversation
POST
/ccaas/1/conversations/{conversationId}/route
Route conversation
GET
/ccaas/1/conversations/{conversationId}/simulate-routing
Simulate routing result for conversation
GET
/ccaas/1/conversations/{conversationId}/related-comments
Get related comments
GET
/ccaas/1/conversations/{conversationId}/links
Get linked conversations
GET
/ccaas/1/tags
Get tags
POST
/ccaas/1/tags
Create tag
DELETE
/ccaas/1/tags/{tagName}
Delete tag
GET
/ccaas/1/conversations/{conversationId}/messages
Get messages
POST
/ccaas/1/conversations/{conversationId}/messages
Create message
POST
/ccaas/1/conversations/{conversationId}/events
Send a conversation event
GET
/ccaas/1/conversations/{conversationId}/notes
Get notes
POST
/ccaas/1/conversations/{conversationId}/notes
Create note
GET
/ccaas/1/conversations/{conversationId}/notes/{noteId}
Get note
GET
/ccaas/1/agents
Get agents
POST
/ccaas/1/agents
Create agent
GET
/ccaas/1/agents/{agentId}
Get agent
PUT
/ccaas/1/agents/{agentId}
Update agent
GET
/ccaas/1/agents/{agentId}/conversations
Get agent conversations
PUT
/ccaas/1/agents/{agentId}/status
Change agents status
POST
/ccaas/1/agents/{agentId}/queues
Add agent to queue
DELETE
/ccaas/1/agents/{agentId}/queues/{queueId}
Remove agent from queue
PUT
/ccaas/1/agents/{agentId}/heartbeat
Set agents heartbeat
GET
/ccaas/1/queues
Get queues
POST
/ccaas/1/queues
Create queue
PUT
/ccaas/1/queues/{queueId}
Update queue
DELETE
/ccaas/1/queues/{queueId}
Delete queue
GET
/ccaas/1/routing
Get routing
PUT
/ccaas/1/routing
Create routing
DELETE
/ccaas/1/routing
Delete routing
GET
/ccaas/1/bots
Get Bots
POST
/ccaas/1/bots
Create bot
GET
/ccaas/1/bots/{botId}
Get bot
PUT
/ccaas/1/bots/{botId}
Update bot
DELETE
/ccaas/1/bots/{botId}
Delete bot
GET
/ccaas/1/conversations/{conversationId}/metadata
Get metadata
PUT
/ccaas/1/conversations/{conversationId}/metadata
Put metadata
DELETE
/ccaas/1/conversations/{conversationId}/metadata
Delete metadata
PATCH
/ccaas/1/conversations/{conversationId}/metadata
Patch metadata
GET
/ccaas/1/templates
Get templates
GET
/ccaas/1/templates/{templateId}
Get template
GET
/ccaas/2/conversation-forms/forms
Get conversation forms
POST
/ccaas/2/conversation-forms/forms
Create conversation form
GET
/ccaas/2/conversation-forms/forms/{id}
Get conversation form
PUT
/ccaas/2/conversation-forms/forms/{id}
Update conversation form
DELETE
/ccaas/2/conversation-forms/forms/{id}
Delete conversation form
GET
/ccaas/2/conversation-forms/fields
Get fields
POST
/ccaas/2/conversation-forms/fields
Create field
GET
/ccaas/2/conversation-forms/fields/{id}
Get field
PUT
/ccaas/2/conversation-forms/fields/{id}
Update field
DELETE
/ccaas/2/conversation-forms/fields/{id}
Delete field
GET
/ccaas/2/conversation-forms/triggers
Get triggers
POST
/ccaas/2/conversation-forms/triggers
Create trigger
GET
/ccaas/2/conversation-forms/triggers/{id}
Get trigger
PUT
/ccaas/2/conversation-forms/triggers/{id}
Update trigger
DELETE
/ccaas/2/conversation-forms/triggers/{id}
Delete trigger
PATCH
/ccaas/2/conversation-forms/triggers/{id}
Patch trigger
GET
/ccaas/2/conversations/{conversationId}/form
Get dispositions
PUT
/ccaas/2/conversations/{conversationId}/form
Update or insert dispositions
DELETE
/ccaas/2/conversations/{conversationId}/form/{id}
Delete disposition
POST
/ccaas/2/conversations/{conversationId}/form/assign
Assign form to conversation
POST
/ccaas/2/conversations/{conversationId}/form/unassign
Un-assign form from conversation
PUT
/ccaas/1/account/configurationdeprecated
Update account configuration
GET
/ccca/1/agent-configs/{agentId}
Get agent configuration
POST
/ccaas/voice/2/outbound-call-conversation
Create outbound call conversation
GET
/ccaas/voice/2/waiting-strategies
Get all waiting strategies
POST
/ccaas/voice/2/waiting-strategies
Create waiting strategy
GET
/ccaas/voice/2/waiting-strategies/{id}
Get waiting strategy
PUT
/ccaas/voice/2/waiting-strategies/{id}
Update waiting strategy
DELETE
/ccaas/voice/2/waiting-strategies/{id}
Delete waiting strategy
GET
/ccaas/voice/2/account-recording-config
Get account recording configuration
PUT
/ccaas/voice/2/account-recording-config
Update account recording configuration
POST
/ccaas/voice/2/account-recording-config
Create account recording configuration
GET
/ccaas/voice/2/agent-recording-configs
Get agent recording configurations
GET
/ccaas/voice/2/agent-recording-configs/{agentId}
Get agent recording configuration
PUT
/ccaas/voice/2/agent-recording-configs/{agentId}
Update agent recording configuration
POST
/ccaas/voice/2/agent-recording-configs/{agentId}
Create agent recording configuration
GET
/ccaas/voice/2/recording/metadata
Get recording metadata
GET
/ccaas/voice/2/recording/download/{recordingId}
Download call recording
GET
/ccaas/voice/2/account-wrap-up-config
Get account wrap up configuration
PUT
/ccaas/voice/2/account-wrap-up-config
Update account wrap up configuration
PUT
/ccca/1/agent-configs/{agentId}/wrap-up
Update agent wrap up configuration
PATCH
/ccaas/voice/2/agent/{agentId}/wrap-up-time/add/{seconds}
Add agent wrap up time
PATCH
/ccaas/voice/2/agent/{agentId}/wrap-up-time/clear
Clear agent wrap up time
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/agent
Transfer call to another agent
GET
/ccaas/voice/2/transfer/queues
Fetch queues eligible as transfer destination
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/queue
Transfer call to another queue
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/external-number
Transfer call to external number
GET
/ccaas/voice/2/transfer-configs/external-number
Get transfer to external number configuration
PUT
/ccaas/voice/2/transfer-configs/external-number
Update transfer to external number configuration
GET
/ccaas/voice/2/transfer-configs/transfer-strategy
Get transfer strategy
PUT
/ccaas/voice/2/transfer-configs/transfer-strategy
Update transfer strategy
PATCH
/ccaas/voice/2/{conversationId}/hold
Put client on hold
PATCH
/ccaas/voice/2/{conversationId}/unhold
Put client off hold
GET
/ccaas/voice/2/hold-configs-per-queue
Get hold configurations
POST
/ccaas/voice/2/hold-configs-per-queue
Create hold configuration
GET
/ccaas/voice/2/hold-configs-per-queue/{id}
Get hold configuration
PUT
/ccaas/voice/2/hold-configs-per-queue/{id}
Update hold configuration
DELETE
/ccaas/voice/2/hold-configs-per-queue/{id}
Delete hold configuration
GET
/ccaas/voice/2/call-timeouts
Get call timeout
PUT
/ccaas/voice/2/call-timeouts
Update call timeout
DELETE
/ccaas/voice/2/call-timeoutsdeprecated
Remove custom call timeout
GET
/ccaas/1/working-hours
Get filtered working hours
POST
/ccaas/1/working-hours
Create working hours
GET
/ccaas/1/working-hours/{id}
Get working hours
PUT
/ccaas/1/working-hours/{id}
Update working hours
DELETE
/ccaas/1/working-hours/{id}
Delete working hours
PATCH
/ccaas/1/working-hours/{id}
Patch working hours
GET
/ccaas/1/working-hours/{id}/status
Get working hours status
POST
/ccaas/1/working-hours/{workingHoursId}/holiday
Create working hours holiday
DELETE
/ccaas/1/working-hours/{workingHoursId}/holiday/{id}
Remove working hours holiday
GET
/ccaas/voice/2/tts/options/placeholders/{ttsPurpose}
Get supported TTS placeholders for purpose
GET
/ccaas/voice/2/away-audio-message/{workingHoursConfigId}
Get away audio message
DELETE
/ccaas/voice/2/away-audio-message/{workingHoursConfigId}
Delete away audio message
POST
/ccaas/1/web-forms/{id}/submissions
Submit web form data
GET
/ccaas/1/web-forms/{id}
Get web form
PUT
/ccaas/1/web-forms/{id}
Update web form
DELETE
/ccaas/1/web-forms/{id}
Delete web form
PATCH
/ccaas/1/web-forms/{id}
Patch web form
POST
/ccaas/1/web-forms
Create web form
POST
/bots/1/testing/start
Start test
POST
/bots/1/testing/{testId}/stop
Stop test
POST
/bots/1/testing/{testId}/send-message
Send message
GET
/saas/1/{resourceType}/{resourceId}/export
Export SaaS resource
POST
/saas/1/{resourceType}/import
Import SaaS resource
POST
/saas/1/{resourceType}/{resourceId}/share
Share SaaS resource
GET
/saas/1/request/{requestId}/status
Get SaaS request status
GET
/vocalize/2/campaigns/me
Get my campaigns
POST
/vocalize/2/campaigns
Create campaign
GET
/vocalize/2/campaigns/{campaignId}
Get campaign
DELETE
/vocalize/2/campaigns/{campaignId}
Delete campaign
PATCH
/vocalize/2/campaigns/{campaignId}/settings
Update campaign settings
GET
/vocalize/2/campaigns/{campaignId}/leaderboard
Get campaign leaderboard
GET
/vocalize/2/campaigns/{campaignId}/stats
Get campaign statistics
DELETE
/vocalize/2/campaigns/{campaignId}/reset
Delete campaign scores
PUT
/vocalize/2/scores
Update score
GET
/vocalize/2/scores/stats
Get user score statistics
POST
/knowledge-base/1/search
Search knowledge base
GET
/knowledge-base/1/articles
Get articles
POST
/knowledge-base/1/articles
Create article
GET
/knowledge-base/1/articles/{articleId}
Get article
PUT
/knowledge-base/1/articles/{articleId}
Update article
DELETE
/knowledge-base/1/articles/{articleId}
Delete article
PATCH
/knowledge-base/1/articles/{articleId}/status
Update article status
GET
/knowledge-base/1/articles/{articleId}/history
Get article versions
GET
/knowledge-base/1/articles/{articleId}/comments
Get article comments
POST
/knowledge-base/1/articles/{articleId}/comments
Create comment
PUT
/knowledge-base/1/articles/{articleId}/comments/{commentId}
Update comment
DELETE
/knowledge-base/1/articles/{articleId}/comments/{commentId}
Delete comment
GET
/knowledge-base/1/categories
Get categories
GET
/knowledge-base/1/folders
Get folders
GET
/knowledge-base/1/content-tree/nodes/categories
Get content tree categories
POST
/knowledge-base/1/content-tree/nodes
Create content tree node
POST
/knowledge-base/1/content-tree/nodes/{nodeId}/move
Move content tree node
GET
/knowledge-base/1/content-tree/nodes/{nodeId}
Get content tree node
PUT
/knowledge-base/1/content-tree/nodes/{nodeId}
Update content tree node
DELETE
/knowledge-base/1/content-tree/nodes/{nodeId}
Delete content tree node
GET
/knowledge-base/1/tags
Get tags
POST
/knowledge-base/1/tags
Create tag
GET
/knowledge-base/1/tags/{tagId}
Get tag
PUT
/knowledge-base/1/tags/{tagId}
Update tag
GET
/knowledge-base/1/attachments/{attachmentId}
Get attachment details
DELETE
/knowledge-base/1/attachments/{attachmentId}
Delete attachment
GET
/knowledge-base/1/attachments/{attachmentId}/linked-article
Get attachment linked article
POST
/knowledge-base/1/attachments
Upload attachment
Schemas 407
The contract defines 407 schemas that model the data the API accepts and returns. The most detailed are 41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema (24 properties), d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3 (24 properties), 09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse (24 properties), 41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema (24 properties). Each schema is shown below with its type and property counts.
8a96177a069f927b552e6f478d6833812472502f930c109564e4f89f3264faaa.ApiException
object
1 property
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCodeResponse
object
2 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionDto
object
Specify in which timespan did the event occur.
5 properties
2 required
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorViolations
object
2 properties
2 required
c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResult
object
3 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamIntegrationsV2
object
Integrations.
1 property
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.SessionInformationExample
object
Details about session.
6 properties
6 required
a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody
object
8 properties
5 required
6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagEntry
object
1 property
a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody
object
3 properties
2 required
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError404
object
5 properties
5 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalConfigApiModel
object
4 properties
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection
string
Sort direction for results.
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType
string
Type of the tree node.
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventFieldType
string
Field data type.
85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestErrorDetails
object
2 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueField
object
Unique identifier of the participant.
3 properties
2 required
85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestError
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource
string
External source of the node, if imported.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateFileApiResponse
object
List of template attachments.
8 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormConditionalFieldRequest
object
2 properties
2 required
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType
string
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.SearchCriteria
object
2 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VideoFilterModeApiModel
string
Background filter mode.
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareRequest
object
1 property
1 required
ApiErrorViolation
object
List of violations that caused the error.
2 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse
object
2 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto
object
List of events that persons should match.
4 properties
2 required
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStatsResponse
object
8 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Unit
string
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotApiModel
object
11 properties
3 required
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCodeResponse
object
2 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationResponseApiModel
object
4 properties
3 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueApiModel
object
16 properties
b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonPushContact
object
4 properties
4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryItemResponse
object
The list of the results for this page.
3 properties
3 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse
object
2 properties
2 required
ApiError
object
5 properties
5 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiResponse
object
9 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPurposeApiModel
string
Purpose for which placeholders will be used in text-to-speech.
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CatalogRecordListItemResponse
object
The list of the results for this page.
11 properties
5 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StatusResponse
object
2 properties
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseResultPage
object
2 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse
object
1 property
1 required
62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AutoAssignmentAlgorithm
string
Queue Auto-assignment algorithm.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationChannel
string
Communication channel.
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.STTModelProvider
string
Speech-to-text model provider options.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormSubmissionApiRequest
object
5 properties
2 required
85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventChannel
string
Channel where the event will be sent.
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.StatusCode
string
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest
object
1 property
1 required
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreReturn
object
13 properties
6 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountRecordingConfigApiModel
object
6 properties
1 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto
object
7 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.HoldConfigWithQueuesApiModel
object
9 properties
2 required
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiRequest
object
10 properties
4 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormResultPage
object
2 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldConditionRequest
object
3 properties
2 required
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest
object
2 properties
f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery
object
4 properties
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRequest
object
4 properties
3 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldType
string
Field type.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsAudioSourceApiModel
object
Text-to-speech audio source information.
5 properties
4 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileOrTtsAudioSourceWithRepeatIntervalApiModel
object
File audio source or TTS audio source information with repeat interval.
5 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType
string
Type of the record.
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.StatusCode
string
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Action
string
Action type connected to the collectable.
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType
string
Push registration id of the instance
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest
object
7 properties
6 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ByUniqueRequestParameters
object
List of identities.
3 properties
2 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.WebhookPersonUniqueFieldType
string
Type of unique ID
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Campaign
object
9 properties
5 required
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponse
object
9 properties
1 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position
string
Position relative to the target node.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteType
string
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithPeriodicCollectApiModel
object
7 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageChannel
string
Available communication channels
a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamIntegrationsV2
object
1 property
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemFieldType
string
Field data type within a List item.
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsResponse
object
1 property
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleVersionDetailResponse
object
The list of the results for this page.
12 properties
12 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCategoryItemResponse
object
2 properties
2 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonV2
object
Person attributes. In case a person with either the specified externalId or contactInformation already exists in the People, the persons will be automatically…
22 properties
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3
string
Type of the person ID.
265dbb28cc1ed1396ae9d1feb97047d1e9ccf99987cba8dbae6c3a765606751c.ApiException
object
1 property
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonGenderV3
string
Person's gender.
f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.PersonsToCompanyEntry
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagsApiResponse
object
2 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility
string
Visibility of the node.
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestStatusResponse
object
3 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceApiModel
object
Used to define voice in which text will be synthesized. To get a list of the supported voices for chosen language use Get voices.
2 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiResponse
object
12 properties
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentRole
string
Agent role.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AudioSourceTypeApiModel
string
Specifies whether the audio is from a file source or text-to-speech
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.HolidaysApiModel
object
List of working hours holidays.
5 properties
1 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamEmailContact
object
A list of person's email addresses. Max 100 emails per person.
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel
object
10 properties
61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPushContactV2
object
5 properties
2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse
object
1 property
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignStatsResponse
object
5 properties
ApiRequestErrorDetails
object
3 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionDto
object
Specify how many times did the event occur.
2 properties
2 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.BotInformationExample
object
Details about bot.
5 properties
5 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormPostResponse
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleLinkDetailResponse
object
List of Articles Or Attachments linked to the article.
3 properties
3 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.QueueResultPage
object
2 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AuthorType
string
Indicates if the message was written by the agent, bot, or the system.
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ValidationRules
object
7 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonPushContact
object
A list of person's web push destinations.
4 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.BadRequestResponse
object
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TagApiResponse
object
4 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AccountWrapUpApiModel
object
3 properties
3 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationV3
object
List of phones, emails and other information how a person can be contacted.
4 properties
2 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleVersionDetailResponse
object
2 properties
2 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest
array
An array of events submitted as a batch request for processing.
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CustomBadRequestResponse
object
Bad request
5 properties
5 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagSimpleResponse
object
Tags assigned to the article.
2 properties
2 required
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationRequest
object
2 properties
1 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicAnswersEventExample
object
6 properties
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicInboundMessage
object
Inbound message.
1 property
bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin
string
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse
object
2 properties
2 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationPriority
string
Conversation priority.
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse
object
1 property
1 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OutboundCallConversationRequestApiModel
object
4 properties
3 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleListItemResponse
object
2 properties
2 required
8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationRoutingResultApiResponse
object
3 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Trigger
object
6 properties
3 required
c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest
object
1 property
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ShareResponse
object
1 property
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse
object
1 property
1 required
0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute
object
5 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionBasic
object
3 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest
object
6 properties
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeRequestDocsSchema
object
1 property
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormType
string
Form type
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamGender
string
Person's gender.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.PageResponse
object
3 properties
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory
string
Event definition category.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.StreamingResponseBody
object
6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest
object
1 property
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldResultPage
object
2 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardEntry
object
4 properties
3 required
0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse
object
5 properties
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertOperationStatusV3
string
Status indicating the type of operation performed on a person profile during upsert
d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery
object
3 properties
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource
object
7 properties
8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResult
object
4 properties
a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody
object
1 property
1 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ContentType
string
Content type
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.BotResultPage
object
2 properties
d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagUpdateRequest
object
1 property
1 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedCommentsApiResponse
object
3 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamOrigin
string
The information which describes the source of the last modification of record.
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult
object
Successful result for a person upsert operation.
3 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3
object
The list of the results for this page.
24 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderSayAsApiModel
string
Dictates how resolved value will be spoken when using the placeholder. DEFAULT means that there is no control as to how the value will be spoken and it depends…
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone
object
1 property
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIErrorResources
object
2 properties
2 required
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatusApiResponse
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageApiResponse
object
12 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationTypeV3
string
Type of the person ID
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.Pagination
object
4 properties
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementOptionDto
object
3 properties
2 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingApiChannel
string
Channel name.
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPhoneContact
object
A list of person's phone numbers. Max 100 numbers per person.
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentLinkedArticleResponse
object
1 property
1 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.EventType
string
The type of the event.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileAudioSourceApiModel
object
File audio source information.
2 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTreeNodeResponse
object
2 properties
2 required
62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteEntry
object
1 property
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceApiModel
object
File audio source information.
1 property
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserIdentity
object
Unique identifiers from this object will be used to find a person to personalize push registration with
3 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamSalesforceV2
object
Salesforce integration.
2 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldOperator
string
List of available operators based on field type.
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionUnits
string
Time units for relative operators.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateNoteApiRequest
object
3 properties
1 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3
object
Error information for failed batch operation items.
4 properties
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstanceSystemData
object
Set of push-specific attributes
14 properties
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.QueueAssignRequest
object
1 property
1 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormRequest
object
4 properties
3 required
f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse
object
5 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateQueueApiRequest
object
4 properties
1 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse
object
A structured response that provides detailed information about validation errors encountered during an API request.
5 properties
3 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchResponse
object
1 property
ApiErrorResource
object
List of available resources to recover from the error.
2 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RelatedMessageApiResponse
object
Returns up to 50 comments created after the specified inbound comment, at the same level of the conversation.
8 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.ConditionalField
object
List of fields to present if agent input matches condition value.
2 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreBase
object
6 properties
4 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateTagApiResponse
object
List of template tags.
4 properties
62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResult
object
3 properties
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse
object
5 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3
object
2 properties
2 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertContactInformationV3DocsSchema
object
List of phones, emails and other information how a person can be contacted.
4 properties
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3Upsert
string
Type of the person ID.
a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody
object
1 property
1 required
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem
string
Operating system type can be Android or iOS
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3
string
Source system that last modified this person record.
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOperator
string
The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix ABS (e.g., AFTERABS, BEFOREABS,…
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Condition
object
Defines how the 'condition' field is built, e.g., if 'SENDER', the condition is an object with an array of senders.
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeContactInformationV3DocsSchema
object
List of phones, emails and other information how a person can be contacted.
4 properties
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionOperation
string
Operation to compare how many times the event has occurred.
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowPersonRequest
object
Contains the data used for person creation (if it does not exist) or partial update (if it exists)
2 properties
1 required
bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamGender
string
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCode
string
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantResult
object
Result of operation for the given participant.
3 properties
2 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipantsReportResponse
object
Summary of processing status for participants in a given operation.
4 properties
3 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse
object
The list of the results for this page.
5 properties
5 required
30bce31dfbdcb9fa9268f4e4ce1f7ccf05ef063a92c880be9d1b9efcfc2ac71a.ApiException
object
1 property
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeSuccessResult
object
Successful result for a person merge operation.
2 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData
object
User who uploaded the file.
3 properties
3 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.PublicOutboundMessage
object
Received testing message.
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse
object
12 properties
8 required
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Pagination
object
4 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.WaitingStrategyApiRequest
object
8 properties
3 required
1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.CDPWebhookReport
object
2 properties
2 required
f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2
object
19 properties
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest
object
1 property
1 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse
object
An object containing specific information about an error.
4 properties
3 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus
string
Workflow status of the article.
ApiException
object
1 property
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationStatus
string
Conversation status.
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmissionType
string
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorDetail
object
Detailed error information for a specific property or field.
3 properties
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField
string
Field by which results should be ordered.
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonTypeV3
string
Person's type, default type is CUSTOMER.
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormField
object
List of fields attached to a form
3 properties
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.ImportResponse
object
1 property
1 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentRecordingConfigApiModel
object
7 properties
2 required
d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResult
object
3 properties
61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPhoneContactV2
object
1 property
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldCondition
object
List of conditions
3 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateTagApiRequest
object
1 property
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCatalogRecordListItemResponse
object
2 properties
2 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadConditionDto
object
Specify the conditions of the event payload.
3 properties
3 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.CommonOttContact
object
A list of person's Kakao Sangdam destinations.
3 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageDirection
string
Message direction
61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamEmailContactV2
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentListItemResponse
object
10 properties
8 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.ConditionType
string
Defines which waiting strategy entity the condition applies to. Once defined, cannot be changed.
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail
object
1 property
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursApiResponse
object
10 properties
3 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateMessageApiRequest
object
5 properties
5 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageResultPage
object
2 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Form
object
7 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.LeaderboardResponse
object
2 properties
2 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto
object
2 properties
2 required
c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse
object
1 property
a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamSalesforceV2
object
2 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToExternalRequest
object
2 properties
62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest
object
1 property
a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2
object
22 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderItemResponse
object
The list of the results for this page.
3 properties
3 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema
object
24 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundBlurSettingsApiModel
object
Configuration for the background display while the agent is on a call. More info .
2 properties
1 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemFieldResource
object
2 properties
2 required
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormStatus
string
Form status
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.PublicIamTypeV2
string
Person's type, default type is CUSTOMER.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventApiRequest
object
4 properties
4 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.OptionWithFileOrTtsAudioSourceApiModel
object
File audio source or TTS audio source information.
4 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationEventType
string
Event type.
b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact
object
3 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageFolderItemResponse
object
2 properties
2 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorCodeV3
string
Error code identifying the type of error that occurred.
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource
object
3 properties
2 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteApiResponse
object
7 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope
string
Content scope of the node.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigWrapUpApiModel
object
1 property
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchAmgModel
object
List of matches.
4 properties
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource
object
5 properties
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance
object
5 properties
2 required
a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.RequestStatus
string
Status of the data export request.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RoutingRulesResultPage
object
2 properties
08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest
object
1 property
1 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AgentConfigApiModel
object
2 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.GetPlaceholdersApiResponse
object
5 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignCreatePayload
object
6 properties
3 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversation
object
A pair of linked conversations.
2 properties
2 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.Pagination
object
4 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateResultPage
object
2 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateArticleStatusRequest
object
1 property
1 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ErrorStatusReason
string
Detailed reason for the REJECTED status: REJECTEDINVALIDCONTACT - Person started to be processed but has been rejected as the contact is not recognized. REJECT…
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiStatusResponse
object
1 property
1 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3
string
Person's gender.
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToAgentRequest
object
1 property
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantStatus
string
Processing status of the participant.
d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteEntry
object
1 property
ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResult
object
3 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.Channel
string
Channel through which the score is submitted, e.g., 'WHATSAPP', 'WEB', etc.
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreResponse
object
2 properties
2 required
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.PagingInfo
object
4 properties
2 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema
object
24 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.FileAudioSourceWithDefaultOptionApiModel
object
File audio source information.
3 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateTreeNodeRequest
object
5 properties
4 required
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessagePersistencePolicy
string
Message persistence policy. If set to PERSISTNONE, messages exchanged between customers and bot will not be persisted to the database nor visible to agents onc…
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.DailyWorkingHoursApiModel
object
List of working hours work days. It must contain all days of the week with 3 parameters each: startTime, endTime and enabled.
3 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.AwayAudioMessageApiModel
object
5 properties
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse
object
7 properties
6 required
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformation
object
3 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TtsPlaceholderTypeApiModel
string
Placeholder type. Determines the purpose of the placeholder.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCode
string
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3
string
Person's type, default type is CUSTOMER.
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationResponse
object
9 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.MoveTreeNodeRequest
object
2 properties
2 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteResultPage
object
2 properties
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartResponse
object
2 properties
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse
object
Response error codes Error ErrorCode HTTP status Bad request 40001 400 Duplicate person 40002 400 Person manipulation failed 40003 400 Person already in flow 4…
2 properties
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.InboundTestingRequest
object
2 properties
2 required
1d16d22c7f4e0b1058057e585daf7edad21174e9b497e154a3270b3a39cc630a.ConversationWebhookReport
object
2 properties
2 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto
object
4 properties
1 required
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadOperator
string
Operator for comparing condition value with payload value.
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.ScoreStats
object
8 properties
2 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FormFieldRequest
object
Fields attached to a form.
3 properties
2 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionApiRequest
object
1 property
1 required
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursStatus
string
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipant
object
Participant to be added to Flow campaign.
3 properties
1 required
25bc6165974db08bf3072efbf58365d643c5a11027c569c8010b72d1e1d5233f.WorkingHoursResultPageApiResponse
object
2 properties
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemResource
object
2 properties
2 required
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemType
string
Schema type for List items.
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType
string
Type of the person ID. Can be one of the above.
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse
object
24 properties
14 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.TriggerResultPage
object
2 properties
d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest
object
1 property
fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionSubcategory
string
Event definition subcategory.
ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse
object
1 property
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.VoiceClientType
string
Voice client type of the destination number.
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.RuleApiResponse
object
12 properties
2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResult
object
4 properties
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.StatusCodeResponse
object
2 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.NoteContent
object
Notes content can be any text.
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignSettings
object
3 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Status
string
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignListResponse
object
1 property
1 required
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.StatusResponse
string
Status of the operation.
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentResponseWithEmail
object
9 properties
1 required
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusGroup
string
Agent availability.
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo
object
Contains information about the page.
4 properties
4 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateTreeNodeRequest
object
1 property
1 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CollectableApiModel
object
Information for a collectable.
3 properties
3 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPersonContactsV2
object
List of phones, emails and other information how a person can be contacted.
13 properties
731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2
object
4 properties
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferStrategyApiModel
object
5 properties
f92ed732784664dca5efb3669b03438e69cca5f33f4420f5b4996e58aa137657.RequestDetailsResponse
object
Details about user request status.
4 properties
2 required
8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse
object
1 property
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.DispositionFieldBasic
object
A list of fields with values.
3 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversationMember
object
A conversation that is linked to another conversation.
8 properties
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormDataPayloadMap
object
Field name and its value
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.BackgroundFileMetadataApiModel
object
Background file metadata in case of virtual background.
4 properties
3 required
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchRequest
object
1 property
1 required
67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType
string
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.Bot
object
11 properties
4 required
3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError
object
1 property
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOccurred
string
Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occu…
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AccountConfigurationRequest
object
1 property
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto
object
4 properties
1 required
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender
string
User gender
61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2
object
18 properties
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.MessageChannel
string
41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3
string
Source system that last modified this person record.
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormDto
object
9 properties
6 required
a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamTypeV2
string
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Pagination
object
4 properties
9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType
string
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.DialogInformation
object
Dialog in which the event occurred.
2 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.Direction
string
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ActionAfterSubmission
object
Action after the submission
2 properties
2 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.UpsertDispositionFieldApiRequest
object
List of fields and agent inputs to those fields.
2 properties
2 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage
object
2 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.WebFormApiRequest
object
6 properties
4 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.MediaTypeApiModel
string
Specifies whether the recording should be done on audio or both audio and video.
59fee77911b10cc32daa4aa3591d8ca0b6f5fe540a80b499aee90c38ff11a187.AgentStatusRequest
object
1 property
1 required
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.Field
object
10 properties
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ComponentType
string
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.TemplateApiResponse
object
List of templates.
13 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.APIError400
object
5 properties
4 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.MessageContent
object
Message content depending on content type.
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.MessageChannel
object
9620629c173fbd1e947e2693ffe57e0c353c3961ef0ef2018c058c14e6f698ab.FieldRequest
object
5 properties
3 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.RecordingMetadataApiModel
object
22 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.LinkedConversations
object
Linked conversations response.
1 property
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.IamPushContactV2
object
List of person's push registrations.
5 properties
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTagListItemResponse
object
2 properties
2 required
b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource
object
3 properties
1 required
082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormElementDto
object
List of form fields
13 properties
1 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleListItemResponse
object
The list of the results for this page.
9 properties
7 required
ApiRequestError
object
1 property
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.TransferToQueueRequest
object
1 property
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo
object
Contains information about the page.
4 properties
4 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.UpdateQueueApiRequest
object
9 properties
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.CreateRuleApiRequest
object
6 properties
2 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderResponse
object
Parent folder of the article.
2 properties
2 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryResponse
object
Parent category of the article.
2 properties
2 required
09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagCreateRequest
object
1 property
1 required
781c309206ee4e50226d2695a75a47d5a1a01fb64cb954c3d350b69d70b039a2.TestingStartRequest
object
3 properties
2 required
f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest
object
1 property
d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto
object
4 properties
1 required
e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest
object
1 property
1 required
900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsRequest
object
Request to add given participants to the Flow campaign.
3 properties
1 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.DurationApiModel
object
Duration information.
2 properties
2 required
b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866.CallTimeoutApiModel
object
2 properties
1e177a7c00f43fb0cfaf8876573312572061d384022066ddec32b06770199719.CampaignResponse
object
9 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Infobip 5
Other APIs Infobip publishes across the network.
Infobip AI Hub API
Infobip Channels API
Infobip Connectivity API
Infobip Platform API
Infobip Tools API
#Customer Engagement
Where this information came from
This is an independent, third-party profile of Infobip Customer Engagement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.