Infobip Customer Engagement API
Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.
Operations 254
Showing the first 250 of 254. The full set is in the contract, and via get_provider_operations.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/people/2/persons
Look up one person or list people profiles · Get a single person or a list of people
#
Ask an LLM
“How do I look up a customer profile in Infobip People by their email or phone?”
“Can I list all people profiles filtered by my own conditions, a page at a time?”
Tell an agent
Find the person profile whose {type} identifier is {identifier}.
List people profiles matching the filter {filter}, {limit} per page.
Ask an LLM
“Can I completely overwrite a person's profile with new data in one request?”
“What happens to fields I leave out when I replace a whole person profile?”
Tell an agent
Overwrite the full profile of the person with {type} identifier {identifier}, setting first name {firstName} and last name {lastName}.
Replace the entire profile of person {identifier} so their city is {city} and country {country}.
Ask an LLM
“How can I add a single new customer profile to People?”
“Can I set custom attributes and tags when creating one new person?”
Tell an agent
Create a new person named {firstName} {lastName}.
Add a new person profile with external ID {externalId} and tags {tags}.
Ask an LLM
“Can I permanently remove a single customer's profile from People?”
“What identifier do I need to delete one person profile?”
Tell an agent destructive · confirm first
Delete the person whose {type} identifier is {identifier}.
Remove person profile {identifier} from People.
Ask an LLM
“Can I change just a few fields on a person profile without resending everything?”
“Is there a partial update that keeps a person's other attributes untouched?”
Tell an agent
Patch person {identifier} so only their preferred language becomes {preferredLanguage}.
Update just the birth date of the person with {type} identifier {identifier} to {birthDate}.
PUT
/people/2/persons/contactInformation
Replace all contact details on a person · Set contact information to person
#
Ask an LLM
“Can I replace every email and mobile number on a person with a fresh set?”
“What happens to existing phone numbers when I set a person's contact information?”
Tell an agent
Replace all emails and phones on person {identifier} with {contactInformation}.
Set the contact information of the person with {type} identifier {identifier} to exactly {contactInformation}.
DELETE
/people/2/persons/contactInformation
Remove specific emails or phones from a person · Delete contact information from person
#
Ask an LLM
“Can I delete one outdated email address from a person without touching the rest?”
“How would I strip a specific mobile number off a customer's profile?”
Tell an agent destructive · confirm first
Remove the contact details {contactInformation} from person {identifier}.
Delete these emails and phones {contactInformation} from the person with {type} ID {identifier}.
PATCH
/people/2/persons/contactInformation
Add emails or phones to a person · Add contact information to person
#
Ask an LLM
“Can I add a second email address to an existing person while keeping the old one?”
“Is it possible to append a new mobile number to someone's profile?”
Tell an agent
Add the contact details {contactInformation} to person {identifier}, keeping existing ones.
Append a new email or phone {contactInformation} to the person with {type} identifier {identifier}.
Ask an LLM
“Can I import up to a thousand new people profiles in a single call?”
“What's the size limit for bulk-creating people?”
Tell an agent
Bulk-create these person profiles: {people}.
Create all of the following people in one batch: {people}.
Ask an LLM
“Can I delete hundreds of people profiles in one request?”
“What is the cap on how many persons a bulk delete can remove?”
Tell an agent destructive · confirm first
Bulk-delete these person profiles: {people}.
Remove all of these people from People in one batch: {people}.
Ask an LLM
“Can I update the attributes of many existing people in one request?”
“Is there a bulk edit for person profiles, and how many can it take?”
Tell an agent
Bulk-update these existing person profiles with the new data: {people}.
Apply these profile changes to many people at once: {people}.
Ask an LLM
“Can I check which of my emails or phone numbers already belong to a person profile?”
“How can I get the internal person IDs for a list of external identities?”
Tell an agent
Match these identities against existing people and return their person IDs: {identities}.
Find which of {identities} already have a profile in People.
Ask an LLM
“Can I merge duplicate profiles that belong to the same customer?”
“Which identifiers are used to decide that two profiles should be merged?”
Tell an agent
Merge these duplicate person profiles into one: {persons}.
Combine the profiles in {persons} that share the same email or external ID.
PUT
/people/3/persons/upsert
Create or fully replace profiles by identifier · Batch full people upsert
#
Ask an LLM
“Can I create people who don't exist yet and completely replace those who do, in one call?”
“What does a full upsert do to fields missing from a matched profile?”
Tell an agent
Fully upsert these person profiles, replacing any that match by external ID, email or phone: {persons}.
Create-or-replace the profiles {persons} in one full upsert batch.
PATCH
/people/3/persons/upsert
Create or partially update profiles by identifier · Batch partial people upsert
#
Ask an LLM
“Can I create missing people and only patch the fields I send on the ones that already exist?”
“Is there an upsert that preserves attributes I don't include?”
Tell an agent
Partially upsert these person profiles, keeping unsent fields on matches: {persons}.
Create-or-patch the profiles {persons}, matching on external ID, email or phone.
GET
/people/2/companies
Look up one company or list companies · Get a single company or a list of companies
#
Ask an LLM
“How do I find a company in People by its domain or name?”
“Can I list all the companies I've stored, with a filter?”
Tell an agent
Get the company named {name}.
Look up the company with domain {domain}.
Ask an LLM
“Can I add a new B2B account as a company in People?”
“What details can I store on a company, like industry, VAT number or account manager?”
Tell an agent
Create a company called {name} in the {industry} industry.
Add a company {name} with domains {domains} and VAT number {vatNumber}.
Ask an LLM
“Can I delete a single company from People by its external ID?”
“Which lookup fields can I use to remove one company?”
Tell an agent destructive · confirm first
Delete the company with ID {id}.
Remove the company whose domain is {domain}.
Ask an LLM
“Can I change a company's customer stage without resending its whole record?”
“Is it possible to replace a company's domains or tags rather than add to them?”
Tell an agent
Update the company with external ID {externalId} so its customer stage is {customerStage}.
Rename company {id} to {name}.
Ask an LLM
“Can I bulk-create a thousand company records in one request?”
“What's the batch limit when importing companies?”
Tell an agent
Bulk-create these companies: {companies}.
Import all of these company records in one batch: {companies}.
Ask an LLM
“Can I bulk-remove a list of companies from People?”
“What is the maximum number of companies one batch delete accepts?”
Tell an agent destructive · confirm first
Bulk-delete these companies: {companies}.
Remove all of these company records in a single batch: {companies}.
Ask an LLM
“Can I update many company records in a single call?”
“Is there a bulk edit for companies, and what's its size cap?”
Tell an agent
Bulk-update these companies with their new details: {companies}.
Apply these changes to many companies at once: {companies}.
DELETE
/people/2/companies/persons
Unlink people from a company · Remove persons from company batch
#
Ask an LLM
“Can I detach several people from the company they're linked to?”
“How many persons can I remove from a company at once?”
Tell an agent destructive · confirm first
Remove the people {people} from the company with ID {id}.
Unlink {people} from the company named {name}.
Ask an LLM
“Can I associate a group of contacts with a company account?”
“What's the limit on adding persons to a company in one go?”
Tell an agent
Add the people {people} to the company with ID {id}.
Link {people} to the company with domain {domain}.
Ask an LLM
“What tags have been created for segmenting people profiles?”
“Can I page through all People tags and get a total count?”
Tell an agent
List all People tags.
Show People tags page {page}, {limit} per page.
Ask an LLM
“Can I create a new tag to label people profiles?”
“Where do I define a tag before assigning it to persons?”
Tell an agent
Create a People tag named {name}.
Add a new profile tag called {name}.
Ask an LLM
“Can I check whether a particular People tag exists?”
“When was a given profile tag created or last modified?”
Tell an agent
Get the People tag {name}.
Show details of the profile tag called {name}.
Ask an LLM
“Can I delete a profile tag I no longer use?”
“Is there a way to remove a People tag entirely?”
Tell an agent destructive · confirm first
Delete the People tag {name}.
Remove the profile tag called {name} for good.
Ask an LLM
“Can I take a tag off many people profiles at once?”
“How many persons can I untag in one batch?”
Tell an agent destructive · confirm first
Remove the tag {name} from these people: {people}.
Strip the profile tag {name} off {people}.
Ask an LLM
“Can I apply one tag to a thousand people profiles in a single call?”
“How do I bulk-tag a group of contacts?”
Tell an agent
Assign the tag {name} to these people: {people}.
Tag {people} with {name}.
Ask an LLM
“Which custom attributes are defined on people profiles?”
“Can I page through all custom profile fields and their data types?”
Tell an agent
List all custom attributes defined in People.
Show custom attributes page {page}, {limit} per page.
Ask an LLM
“Can I add a custom field like loyalty tier to people profiles?”
“What data types can a new custom attribute have?”
Tell an agent
Create a custom attribute {name} with data type {dataType}.
Add a custom profile field called {name} of type {dataType}.
Ask an LLM
“Can I see the definition and data type of one custom attribute?”
“What schema does a particular custom profile field use?”
Tell an agent
Get the custom attribute {name}.
Show the definition of custom field {name}.
Ask an LLM
“Can I remove a custom attribute definition from People?”
“Is it possible to drop a custom profile field I no longer need?”
Tell an agent destructive · confirm first
Delete the custom attribute {name}.
Remove the custom profile field {name}.
POST
/people/2/customAttributes/{name}/append
Append an item to a list-of-objects attribute · Append item to custom attribute
#
Ask an LLM
“Can I add one new object to a person's LIST_OF_OBJECTS custom attribute?”
“How would I push an extra purchase record into a person's list-type field?”
Tell an agent
Append a new item to custom attribute {name} for person {identifier}.
Add an entry to the list-of-objects field {name} on the person with {type} identifier {identifier}.
Ask an LLM
“Can I fetch specific items from a list attribute on a person identified by email or phone?”
“Which items does a person's list attribute hold right now?”
Tell an agent
Get items {itemIds} from list {listName} of the person with {type} identifier {identifier}.
Show the items {itemIds} in list attribute {listName} for person {identifier}.
Ask an LLM
“Can I add new items to a list attribute on a profile looked up by identifier?”
“Does appending to a list attribute return the whole updated list?”
Tell an agent
Append items to list {listName} of the person with {type} identifier {identifier}.
Add new entries to the {listName} list attribute for person {identifier}.
DELETE
/people/3/lists/{listName}/items
Delete items from a person's list attribute · Delete items
#
Ask an LLM
“Can I delete certain entries from a person's list attribute by item ID?”
“What's returned after removing items from a list attribute?”
Tell an agent destructive · confirm first
Delete items {itemIds} from list {listName} of the person with {type} identifier {identifier}.
Remove entries {itemIds} from the {listName} list attribute on person {identifier}.
PUT
/people/3/lists/{listName}/items/{itemId}
Replace one item in a person's list attribute · Replace an item
#
Ask an LLM
“Can I swap out a single item in a list attribute with a completely new version?”
“Is replacing a list item different from patching its fields?”
Tell an agent
Replace item {itemId} in list {listName} for the person with {type} identifier {identifier}.
Fully overwrite list attribute item {itemId} of {listName} on person {identifier}.
PATCH
/people/3/lists/{listName}/items/{itemId}
Update fields of one list attribute item · Update an item
#
Ask an LLM
“Can I change just one field of a list attribute item and keep its other values?”
“What happens to fields I omit when patching a single list item?”
Tell an agent
Update only the sent fields of item {itemId} in list {listName} for the person with {type} identifier {identifier}.
Patch list attribute item {itemId} of {listName} on person {identifier}.
Ask an LLM
“Can I retrieve several list attributes of one profile at once?”
“What are all the items in a person's list-type attributes?”
Tell an agent
Get the list attributes {listNames} of the person with {type} identifier {identifier}.
Show every item in lists {listNames} for person {identifier}.
Ask an LLM
“Can I wipe entire list attributes from a profile in one call?”
“Is there a way to clear several list attributes on one person?”
Tell an agent destructive · confirm first
Delete the list attributes {listNames} from the person with {type} identifier {identifier}.
Clear out lists {listNames} entirely on person {identifier}.
Ask an LLM
“Can I overwrite every item in a person's list attribute with a new set?”
“Does replacing a list attribute drop items I don't resend?”
Tell an agent
Replace all items in list {listName} of the person with {type} identifier {identifier}.
Overwrite the whole {listName} list attribute on person {identifier} with new items.
Ask an LLM
“Can I patch several items of a list attribute while leaving missing items alone?”
“What happens to list items I don't include in a list-level update?”
Tell an agent
Update the sent items and fields of list {listName} for the person with {type} identifier {identifier}.
Patch multiple entries of the {listName} list attribute on person {identifier}, keeping the rest.
GET
/people/2/persons/{personId}/lists/{listName}/items
Get list items by person ID (older endpoint) · Get items
#
Ask an LLM
“Using the older person-ID endpoint, can I read specific items from a person's list?”
“Is there a deprecated way to fetch list items by internal person ID?”
Tell an agent
Using the older person-ID endpoint, get items {itemIds} from list {listName} of person {personId}.
Fetch items {itemIds} of {listName} for internal person ID {personId} via the deprecated API.
POST
/people/2/persons/{personId}/lists/{listName}/items
Add list items by person ID (older endpoint) · Append items
#
Ask an LLM
“Can I still append list items using a person's internal ID on the legacy endpoint?”
“Does the deprecated append-items call return the updated list?”
Tell an agent
Using the older person-ID endpoint, append items to list {listName} of person {personId}.
Add entries to {listName} for internal person ID {personId} via the deprecated API.
DELETE
/people/2/persons/{personId}/lists/{listName}/items
Delete list items by person ID (older endpoint) · Delete items
#
Ask an LLM
“On the legacy person-ID endpoint, can I delete individual list items?”
“Is there a deprecated call that removes list entries by item ID for an internal person ID?”
Tell an agent destructive · confirm first
Using the older person-ID endpoint, delete items {itemIds} from list {listName} of person {personId}.
Remove entries {itemIds} from {listName} for internal person ID {personId} via the deprecated API.
PUT
/people/2/persons/{personId}/lists/{listName}/items/{itemId}
Replace a list item by person ID (older endpoint) · Replace an item
#
Ask an LLM
“Can the legacy person-ID endpoint fully replace one list item?”
“Is there a deprecated way to overwrite a single list entry?”
Tell an agent
Using the older person-ID endpoint, replace item {itemId} in list {listName} of person {personId}.
Overwrite entry {itemId} of {listName} for internal person ID {personId} via the deprecated API.
PATCH
/people/2/persons/{personId}/lists/{listName}/items/{itemId}
Update a list item by person ID (older endpoint) · Update an item
#
Ask an LLM
“On the deprecated person-ID endpoint, can I patch only some fields of a list item?”
“Does the legacy item update preserve fields I leave out?”
Tell an agent
Using the older person-ID endpoint, update the given fields of item {itemId} in list {listName} of person {personId}.
Patch entry {itemId} of {listName} for internal person ID {personId} via the deprecated API, keeping other fields.
GET
/people/2/persons/{personId}/lists
Get a person's lists by person ID (older endpoint) · Get lists
#
Ask an LLM
“Can I read several of a person's lists by internal ID on the legacy endpoint?”
“Is there a deprecated call that returns all items of named lists for a person ID?”
Tell an agent
Using the older person-ID endpoint, get lists {listNames} of person {personId}.
Show all items of {listNames} for internal person ID {personId} via the deprecated API.
DELETE
/people/2/persons/{personId}/lists
Delete a person's lists by person ID (older endpoint) · Delete lists
#
Ask an LLM
“Can the legacy person-ID endpoint delete whole lists from a profile?”
“Is there a deprecated way to drop several list instances for one person?”
Tell an agent destructive · confirm first
Using the older person-ID endpoint, delete lists {listNames} of person {personId}.
Remove the list instances {listNames} for internal person ID {personId} via the deprecated API.
PUT
/people/2/persons/{personId}/lists/{listName}
Replace a person's list by person ID (older endpoint) · Replace a list
#
Ask an LLM
“On the legacy person-ID endpoint, can I replace an entire list?”
“Is there a deprecated call that overwrites all items in one list?”
Tell an agent
Using the older person-ID endpoint, replace list {listName} of person {personId}.
Overwrite all of {listName} for internal person ID {personId} via the deprecated API.
PATCH
/people/2/persons/{personId}/lists/{listName}
Update a person's list by person ID (older endpoint) · Update a list
#
Ask an LLM
“Can the deprecated person-ID endpoint patch several items of a list while preserving the rest?”
“Is there a legacy list-level partial update keyed by person ID?”
Tell an agent
Using the older person-ID endpoint, update the given items of list {listName} of person {personId}.
Patch multiple entries of {listName} for internal person ID {personId} via the deprecated API, preserving others.
GET
/people/2/contactInformation/push/{pushRegId}
Get a push device registration · Get push device registration
#
Ask an LLM
“Can I see the stored data for one mobile push device registration?”
“What device details are kept for a push registration ID?”
Tell an agent
Get push registration {pushRegId} for app code {AppCode}.
Show the device data behind push registration {pushRegId}.
PATCH
/people/2/contactInformation/push/{pushRegId}
Update a push device registration · Update push device registration
#
Ask an LLM
“Can I mark a push device as a person's primary device?”
“Is it possible to update the additional data stored on a push registration?”
Tell an agent
Set push registration {pushRegId} as primary: {isPrimary}.
Update push registration {pushRegId} for application {applicationId} with additional data {additionalData}.
POST
/people/2/contactInformation/push/{pushRegId}/depersonalize
Detach a push device from its person · Depersonalize push instance
#
Ask an LLM
“Can I unlink a mobile device from the person it's attached to so it stops getting their messages?”
“What happens when I depersonalize a push installation?”
Tell an agent
Depersonalize push registration {pushRegId} so it's no longer tied to a person.
Detach device {pushRegId} under app code {AppCode} from its current profile.
POST
/people/2/contactInformation/push/{pushRegId}/personalize
Attach a push device to a person · Personalize push instance
#
Ask an LLM
“Can I link a mobile push installation to a person by their phone, email or external ID?”
“What if the device is already tied to someone else when I personalize it?”
Tell an agent
Personalize push registration {pushRegId} with the identity {identity}.
Attach device {pushRegId} to person {identity}, force-depersonalizing any previous owner ({forceDepersonalize}).
Ask an LLM
“Can I backfill historical customer events from the last month in bulk?”
“How far back can batch-imported People events go?”
Tell an agent
Batch import these People events for multiple persons.
Upload a batch of past customer events from the last 30 days.
POST
/peopleevents/2/persons/{personId}/definitions/{definitionId}/events
Track an event for one person · Send Event
#
Ask an LLM
“How do I record that a specific customer performed an event, like a purchase?”
“Can I automatically create the person if they don't exist when sending an event?”
Tell an agent
Send event {definitionId} for person {personId} identified by {identifierType}.
Track {definitionId} with properties {properties} for {personId} by {identifierType}, create if missing: {createPerson}.
Ask an LLM
“Which event definitions, standard, custom or template, are set up in my account?”
“Can I search event definitions by text or category?”
Tell an agent
List all event definitions in category {category}.
Search event definitions for {searchText}.
Ask an LLM
“Can I define a new custom event type with its own fields?”
“Is it possible to create an event definition from a template?”
Tell an agent
Create a custom event definition {definitionId} titled {title} with fields {fields}.
Create an event definition from template {templateId}.
Ask an LLM
“What fields and data types does one event definition have?”
“Is a particular event definition standard or custom?”
Tell an agent
Get event definition {definitionId}.
Show the fields of the {definitionId} event.
POST
/peopleevents/2/definitions/{definitionId}
Add fields to or retitle an event definition · Update Event Definition
#
Ask an LLM
“Can I add new fields to an existing custom event definition?”
“Are removals allowed when changing an event definition, or only additions?”
Tell an agent
Rename event definition {definitionId} to {title}.
Add fields {fields} to event definition {definitionId}, keeping the title {title}.
Ask an LLM
“Can I export People event data to my own S3 bucket?”
“What time range and credentials does an event export need?”
Tell an agent
Export People events from {startTime} to {endTime} to bucket {bucket} in {region} using role {roleArn}.
Start an event export of definitions {definitionIdList} into {bucket} ({region}) between {startTime} and {endTime} with role {roleArn}.
GET
/peopleevents/1/export/status/{requestId}
Check an event export's status · Check status of event export request
#
Ask an LLM
“Has my People events export finished yet?”
“What's the current state of an event export request?”
Tell an agent
Check the status of event export {requestId}.
Tell me whether export request {requestId} is done.
DELETE
/peopleevents/1/export/{requestId}
Cancel an event export request · Asynchronous cancellation of an event export request
#
Ask an LLM
“Can I stop an event export I already submitted?”
“Is cancelling an event export immediate or asynchronous?”
Tell an agent destructive · confirm first
Cancel event export request {requestId}.
Abort the running People events export {requestId}.
GET
/peopleevents/1/export/definitions
List event definitions usable in exports · Get list of event definitions
#
Ask an LLM
“Which event definitions can I filter an events export by?”
“Where can I get the definition IDs to restrict a data export?”
Tell an agent
List the event definitions available for filtering an export.
Show which custom and standard events I can include in an S3 events export.
Ask an LLM
“What audience segments exist in my account?”
“Can I page and sort through my People segments?”
Tell an agent
List all my segments.
Show segments page {page}, {size} per page, sorted by {sort}.
Ask an LLM
“Can I build a segment of people from a query or events?”
“What do I need to define a new audience segment?”
Tell an agent
Create a segment named {name} with query {query}.
Create segment {name} based on events {events}.
Ask an LLM
“Can I see the definition of one segment?”
“What query does a specific segment use?”
Tell an agent
Get segment {segmentId}.
Show the rules behind segment {segmentId}.
Ask an LLM
“Can I change the conditions of an existing segment?”
“Is it possible to rename a segment?”
Tell an agent
Rename segment {segmentId} to {name}.
Update segment {segmentId} named {name} to use query {query}.
Ask an LLM
“Can I remove a segment I no longer need?”
“Does deleting a segment require its ID?”
Tell an agent destructive · confirm first
Delete segment {segmentId}.
Remove the audience segment {segmentId}.
Ask an LLM
“Who are the people that currently fall into a segment?”
“Can I page through a segment's members?”
Tell an agent
List the persons in segment {segmentId}.
Show members of segment {segmentId}, page {page}.
POST
/moments/1/flows/{campaignId}/participants
Add up to 1000 participants to a flow · Add participants to flow
#
Ask an LLM
“Can I enroll a batch of people into a Moments flow and get a callback when done?”
“How many participants can I add to a flow in one request?”
Tell an agent
Add participants {participants} to flow {campaignId}.
Enroll {participants} into flow {campaignId} and notify {notifyUrl} when processed.
GET
/moments/1/flows/{campaignId}/participants/report
Report on participants added to a flow · Get a report on participants added to flow
#
Ask an LLM
“How can I confirm everyone I added to a flow was actually enrolled?”
“Can I get the result report for a bulk flow enrollment?”
Tell an agent
Get the add-participants report for flow {campaignId}, operation {operationId}.
Show which persons from operation {operationId} made it into flow {campaignId}.
POST
/communication/1/flows/{campaignId}/participants
Add a single person to a flow · Add Person to Flow
#
Ask an LLM
“Can I create or update one person and drop them into a flow in the same call?”
“Is it possible to pass flow variables when adding someone to a flow?”
Tell an agent
Add the person with phone {phone} to flow {campaignId} using data {personData}.
Put {email} into flow {campaignId} with flow variables {flowVariables} and person data {personData}.
DELETE
/communication/1/flows/{campaignId}/participants
Remove a person from a flow · Remove person from flow
#
Ask an LLM
“Can I pull a customer out of a flow they're currently in?”
“Which identifiers can I use to remove someone from a flow?”
Tell an agent destructive · confirm first
Remove the participant with email {email} from flow {campaignId}.
Take phone number {phone} out of flow {campaignId}.
Ask an LLM
“What forms have I built, and which are active?”
“Can I filter my forms by type or status?”
Tell an agent
List all my forms.
Show forms of type {formType} with status {formStatus}.
Ask an LLM
“Can I fetch the definition of a single form by ID?”
“What fields does a particular form contain?”
Tell an agent
Get form {id}.
Show me the structure of form {id}.
Ask an LLM
“How should I count a view when my own page displays an Infobip form?”
“Can I increase a form's view counter so statistics stay accurate?”
Tell an agent
Increment the view count of form {id}.
Record one more view for form {id}.
Ask an LLM
“Can I post a visitor's answers to a form through the API?”
“Is there a way to tag where a form submission came from?”
Tell an agent
Submit this data to form {id}.
Send a submission to form {id} with source {source}.
Ask an LLM
“Can I list open conversations in a given queue?”
“Which conversations were closed within a certain date range?”
Tell an agent
List conversations with status {status} in queue {queueIds}.
Show conversations assigned to agent {agentId} created after {createdAfter}.
Ask an LLM
“Can I open a new customer conversation through the API?”
“Are any fields required when creating a conversation?”
Tell an agent
Create a conversation with topic {topic} and priority {priority}.
Open a new conversation in queue {queueId}.
Ask an LLM
“Can I fetch the current status and assignee of a single conversation?”
“What details does one conversation record include?”
Tell an agent
Get conversation {conversationId}.
Show me the details of conversation {conversationId}.
PUT
/ccaas/1/conversations/{conversationId}
Replace a conversation's details · Update conversation
#
Ask an LLM
“Can I overwrite all editable fields of a conversation at once?”
“Are closed conversations editable?”
Tell an agent
Update conversation {conversationId} with topic {topic}, status {status} and priority {priority}.
Fully replace the details of conversation {conversationId}, setting summary {summary}.
PATCH
/ccaas/1/conversations/{conversationId}
Change selected conversation fields · Patch conversation
#
Ask an LLM
“Can I change only the priority of a conversation?”
“How can I close a conversation by setting its status?”
Tell an agent
Set the priority of conversation {conversationId} to {priority}.
Change just the status of conversation {conversationId} to {status}.
Ask an LLM
“Can I label a conversation with a tag for reporting?”
“Is tagging a conversation useful for routing it?”
Tell an agent
Add tag {tagName} to conversation {conversationId}.
Label conversation {conversationId} as {tagName}.
PUT
/ccaas/1/conversations/{conversationId}/assignee
Assign a conversation to an agent · Change conversation assignment
#
Ask an LLM
“Can I hand a conversation over to a specific agent?”
“How does an agent take over a conversation from a bot?”
Tell an agent
Assign conversation {conversationId} to agent {agentId}.
Reassign {conversationId} so {agentId} takes it over.
DELETE
/ccaas/1/conversations/{conversationId}/assignee
Unassign the agent from a conversation · Unassign conversation agent
#
Ask an LLM
“Can I remove the assigned agent from a conversation without rerouting it?”
“Is there a way to leave a conversation with no assignee?”
Tell an agent destructive · confirm first
Unassign the agent from conversation {conversationId}.
Clear the assignee on {conversationId}.
DELETE
/ccaas/1/conversations/{conversationId}/tags/{tagName}
Remove a tag from a conversation · Remove tag from conversation
#
Ask an LLM
“Can I take a tag off one conversation without deleting the tag itself?”
“Does removing a conversation tag affect other conversations?”
Tell an agent destructive · confirm first
Remove tag {tagName} from conversation {conversationId}.
Untag {conversationId} from {tagName}.
Ask an LLM
“Can I send a conversation back through routing to find a new queue?”
“What happens to the current agent when I reroute a conversation?”
Tell an agent
Route conversation {conversationId} again.
Push {conversationId} back into routing so it gets reassigned.
GET
/ccaas/1/conversations/{conversationId}/simulate-routing
Preview routing for a conversation · Simulate routing result for conversation
#
Ask an LLM
“Which routing rule would currently apply to a conversation, without actually moving it?”
“Can I test my routing setup against a real conversation?”
Tell an agent
Simulate routing for conversation {conversationId}.
Show which queue {conversationId} would land in under current routing rules.
GET
/ccaas/1/conversations/{conversationId}/related-comments
Get social comments related to a conversation · Get related comments
#
Ask an LLM
“Can I see the older and newer social comments around an inbound comment in a conversation?”
“How many related social comments are returned?”
Tell an agent
Get the related social comments for conversation {conversationId}.
Show the comment thread surrounding the inbound comment in {conversationId}.
GET
/ccaas/1/conversations/{conversationId}/links
List conversations linked to a conversation · Get linked conversations
#
Ask an LLM
“Which other conversations are linked to this one?”
“Can I see a customer's related conversation history via links?”
Tell an agent
Get conversations linked to {conversationId}.
List every conversation connected to conversation {conversationId}.
Ask an LLM
“What tags exist for categorizing contact-center conversations?”
“Can I see which tags are on a specific conversation?”
Tell an agent
List conversation tags whose name contains {name}.
Show the tags applied to conversation {conversationId}.
Ask an LLM
“Can I define a new tag for customer intents in the contact center?”
“What does a conversation tag need when I create it?”
Tell an agent
Create a conversation tag named {name}.
Add {name} as a new tag for categorizing conversations.
Ask an LLM
“Can I delete a conversation tag and strip it from every conversation?”
“Is deleting a contact-center tag reversible?”
Tell an agent destructive · confirm first
Delete the conversation tag {tagName} from the account.
Permanently remove tag {tagName} from all conversations.
GET
/ccaas/1/conversations/{conversationId}/messages
List messages in a conversation · Get messages
#
Ask an LLM
“Can I pull the message history of a conversation?”
“How would I get only inbound messages from one channel in a conversation?”
Tell an agent
Get messages in conversation {conversationId}.
Show {direction} messages on channel {channel} in conversation {conversationId}.
POST
/ccaas/1/conversations/{conversationId}/messages
Send a message in a conversation · Create message
#
Ask an LLM
“Can I send an outbound message as part of an existing conversation?”
“Which content types can I post into a conversation?”
Tell an agent
Send {content} from {from} to {to} over {channel} in conversation {conversationId} as {contentType}.
Reply in conversation {conversationId} on channel {channel} to {to} from {from} with {content}.
POST
/ccaas/1/conversations/{conversationId}/events
Send a typing or other event to a conversation · Send a conversation event
#
Ask an LLM
“Can I show the customer a typing indicator in a conversation?”
“What kinds of conversation events can I send, like typing started or stopped?”
Tell an agent
Send a {type} event from {from} to {to} on {channel} in conversation {conversationId}.
Signal typing started in {conversationId} on {channel} from {from} to {to} with event type {type}.
Ask an LLM
“Can I read the internal notes my team left on a conversation?”
“Is there pagination for conversation notes?”
Tell an agent
Get notes on conversation {conversationId}.
List team notes for {conversationId}, page {page}.
POST
/ccaas/1/conversations/{conversationId}/notes
Add an internal note to a conversation · Create note
#
Ask an LLM
“Can I leave an internal note for my team on a customer conversation?”
“Are notes visible to the customer or just agents?”
Tell an agent
Add note {content} to conversation {conversationId}.
Leave an internal note on {conversationId} from agent {agentId}: {content}.
Ask an LLM
“Can I retrieve a single note by its ID?”
“Who wrote a particular note on a conversation?”
Tell an agent
Get note {noteId} from conversation {conversationId}.
Show me note {noteId} on {conversationId}.
Ask an LLM
“Which agents are currently available in my contact center?”
“Can I find agents by email, role or queue?”
Tell an agent
List agents with availability {availability}.
Find the agent with email {email}.
Ask an LLM
“Can I add a new agent to my contact center through the API?”
“What role and status does a new agent need?”
Tell an agent
Create agent {displayName} with role {role} and status {status}.
Add a new {role} called {displayName}, starting with status {status}.
Ask an LLM
“Can I look up one agent's role and status?”
“What details are stored for a contact-center agent?”
Tell an agent
Get agent {agentId}.
Show the profile of agent {agentId}.
Ask an LLM
“Can I change an agent's display name or role?”
“Is it possible to disable an agent account?”
Tell an agent
Update agent {agentId}: name {displayName}, role {role}, status {status}.
Set agent {agentId} enabled to {enabled}, keeping name {displayName}, role {role} and status {status}.
GET
/ccaas/1/agents/{agentId}/conversations
List conversations assigned to an agent · Get agent conversations
#
Ask an LLM
“What conversations is a particular agent working on?”
“Can I page through one agent's assigned conversations?”
Tell an agent
List conversations assigned to agent {agentId}.
Show {agentId}'s conversation workload, page {page}.
Ask an LLM
“Can I set an agent to away or busy programmatically?”
“What statuses can an agent be switched to?”
Tell an agent
Set agent {agentId} status to {status}.
Mark {agentId} as {status}.
Ask an LLM
“Can I put an agent into a specific queue?”
“How do I give an agent access to another queue's conversations?”
Tell an agent
Add agent {agentId} to queue {queueId}.
Put {agentId} into queue {queueId}.
DELETE
/ccaas/1/agents/{agentId}/queues/{queueId}
Remove an agent from a queue · Remove agent from queue
#
Ask an LLM
“Can I take an agent out of a queue without deleting the queue?”
“Does removing an agent from a queue affect the queue itself?”
Tell an agent destructive · confirm first
Remove agent {agentId} from queue {queueId}.
Take {agentId} out of {queueId}.
Ask an LLM
“How do I keep an agent's session marked alive with a heartbeat?”
“Can I ping the contact center to show an agent is still connected?”
Tell an agent
Send a heartbeat for agent {agentId}.
Refresh the heartbeat of {agentId}.
Ask an LLM
“Which queues are set up in my contact center?”
“Can I find the queues a certain agent belongs to?”
Tell an agent
List queues named {name}.
Show queues that agent {agentId} is in.
Ask an LLM
“Can I create a new queue to organize conversations by team?”
“Is it possible to turn on auto-assignment when creating a queue?”
Tell an agent
Create a queue named {name}.
Create queue {name} with auto-assignment {isAutoAssignmentEnabled} and working hours {workingHoursId}.
Ask an LLM
“Can I change a queue's auto-assignment algorithm or sticky-agent timeout?”
“Is it possible to restrict a queue after creating it?”
Tell an agent
Rename queue {queueId} to {name}.
Set queue {queueId} to use auto-assignment algorithm {autoAssignmentAlgorithm}.
Ask an LLM
“Can I remove a queue I no longer need?”
“What do I need to delete a contact-center queue?”
Tell an agent destructive · confirm first
Delete queue {queueId}.
Remove the queue {queueId} from the contact center.
Ask an LLM
“What routing rules decide which queue gets a conversation?”
“Can I see only the enabled routing rules?”
Tell an agent
Show my conversation routing rules.
List routing rules {ruleIds}.
Ask an LLM
“Can I define the full set of routing rules in one call?”
“Does saving routing replace the existing rules?”
Tell an agent
Replace my routing setup with a new set of rules.
Create the conversation routing configuration from scratch.
Ask an LLM
“Can I wipe out my entire routing configuration?”
“Does deleting routing remove every rule inside it?”
Tell an agent destructive · confirm first
Delete my whole routing setup.
Remove all conversation routing rules.
Ask an LLM
“Which external bots are connected to my contact center?”
“Can I page through configured bots?”
Tell an agent
List my connected bots.
Show bots page {page}.
Ask an LLM
“Can I connect my own chatbot to handle conversations via a webhook?”
“What channel and destination does a new bot need?”
Tell an agent
Create bot {displayName} on {channel} for destination {destination} with webhook {webhookUrl}.
Connect a bot named {displayName} to {destination} on {channel}.
Ask an LLM
“Can I see how a connected bot is configured?”
“What webhook does a specific bot use?”
Tell an agent
Get bot {botId}.
Show the configuration of bot {botId}.
Ask an LLM
“Can I change a bot's webhook URL or session timeout?”
“Is it possible to disable a bot without deleting it?”
Tell an agent
Update bot {botId}: name {displayName}, channel {channel}, destination {destination}, webhook {webhookUrl}.
Set a session timeout of {sessionTimeoutInSec} seconds on bot {botId} ({displayName}, {channel}, {destination}).
Ask an LLM
“Can I remove a bot, and what happens to its open conversations?”
“Is there a way to disconnect a bot permanently?”
Tell an agent destructive · confirm first
Delete bot {botId}.
Remove bot {botId} and reroute its open conversations.
Ask an LLM
“Can I read the custom metadata stored on a conversation?”
“What extra data is attached to a conversation?”
Tell an agent
Get metadata for conversation {conversationId}.
Show the custom data stored on {conversationId}.
Ask an LLM
“Can I store my own key-value data on a conversation?”
“Does writing conversation metadata overwrite what's there?”
Tell an agent
Set the metadata of conversation {conversationId}, overwriting existing values.
Replace all custom data on {conversationId}.
DELETE
/ccaas/1/conversations/{conversationId}/metadata
Delete conversation metadata · Delete metadata
#
Ask an LLM
“Can I clear all metadata from a conversation?”
“Is there a way to remove the custom data attached to a conversation?”
Tell an agent destructive · confirm first
Delete metadata from conversation {conversationId}.
Wipe the custom data on {conversationId}.
PATCH
/ccaas/1/conversations/{conversationId}/metadata
Partially update conversation metadata · Patch metadata
#
Ask an LLM
“Can I add one metadata key to a conversation without losing the others?”
“What happens if I patch metadata on a conversation that has none?”
Tell an agent
Merge new metadata keys into conversation {conversationId}.
Partially update the custom data on {conversationId}, creating it if absent.
Ask an LLM
“Which message templates are available for conversations on a given channel?”
“Can I filter templates by language?”
Tell an agent
List templates for channel {channel}.
Show {language} templates with content type {contentType}.
Ask an LLM
“Can I view the content of one template?”
“What does a specific conversation template contain?”
Tell an agent
Get template {templateId}.
Show the body of template {templateId}.
Ask an LLM
“Which agent forms are set up for wrapping up conversations?”
“Can I find the default conversation form?”
Tell an agent
List conversation forms titled {title}.
Show conversation forms that are enabled: {isEnabled}.
Ask an LLM
“Can I build a form agents fill in during a conversation?”
“What does a new conversation form require?”
Tell an agent
Create conversation form {title} with fields {fields}, enabled {isEnabled}.
Build agent form {title} using fields {fields}, enabled {isEnabled}, default {isDefault}.
Ask an LLM
“Can I view one conversation form and its fields?”
“Which fields are on a specific agent form?”
Tell an agent
Get conversation form {id}.
Show the layout of agent form {id}.
Ask an LLM
“Can I change the fields or title of an agent form?”
“Is it possible to disable a conversation form?”
Tell an agent
Update conversation form {id} with title {title}, fields {fields}, enabled {isEnabled}.
Retitle agent form {id} to {title}, keeping fields {fields} and enabled {isEnabled}.
DELETE
/ccaas/2/conversation-forms/forms/{id}
Delete a conversation form · Delete conversation form
#
Ask an LLM
“Can I remove an agent form I don't use?”
“How would I delete a conversation form?”
Tell an agent destructive · confirm first
Delete conversation form {id}.
Remove agent form {id}.
Ask an LLM
“What fields are available to put on agent forms?”
“Can I search form fields by title?”
Tell an agent
List conversation form fields.
Find form fields titled {title}.
Ask an LLM
“Can I add a dropdown or text field for agents to fill in?”
“Is it possible to validate a form field with a regex?”
Tell an agent
Create a form field {title} of type {type}, enabled {isEnabled}.
Add a {type} field {title} with options {options}, enabled {isEnabled}.
Ask an LLM
“Can I see the type and options of one form field?”
“What regex does a given form field use?”
Tell an agent
Get form field {id}.
Show the options on agent form field {id}.
Ask an LLM
“Can I change the options of an existing form field?”
“Is it possible to rename a form field?”
Tell an agent
Update form field {id}: title {title}, type {type}, enabled {isEnabled}.
Set the options of field {id} to {options}, keeping title {title}, type {type}, enabled {isEnabled}.
Ask an LLM
“What happens to agent inputs when I delete a form field?”
“Can I permanently remove a form field?”
Tell an agent destructive · confirm first
Delete form field {id}.
Remove agent form field {id} and its inputs in open conversations.
Ask an LLM
“Which triggers assign forms to conversations?”
“Can I look up form triggers by title?”
Tell an agent
List form triggers.
Find form triggers titled {title}.
Ask an LLM
“Can I automatically attach a form to conversations that match an expression?”
“Where does a new trigger go in the trigger order?”
Tell an agent
Create trigger {title} that assigns form {formId} when {expression}.
Add a form trigger {title} with expression {expression} for form {formId}.
Ask an LLM
“Can I see the expression and form of one trigger?”
“How many times has a trigger fired?”
Tell an agent
Get form trigger {id}.
Show the rule behind trigger {id}.
Ask an LLM
“Can I fully rewrite a form trigger's expression and target form?”
“Does changing a trigger's position shift the others?”
Tell an agent
Update trigger {id} with title {title}, expression {expression}, form {formId}.
Replace trigger {id} and move it to position {orderIndex} ({title}, {expression}, {formId}).
Ask an LLM
“Can I remove a trigger so a form stops being auto-assigned?”
“How do I delete a form trigger?”
Tell an agent destructive · confirm first
Delete form trigger {id}.
Remove trigger {id}.
Ask an LLM
“Can I just reorder or disable one form trigger?”
“Is there a partial update for triggers?”
Tell an agent
Patch trigger {id} to enabled {isEnabled} ({title}, {expression}, {formId}).
Move trigger {id} to order index {orderIndex} via patch, with title {title}, expression {expression}, form {formId}.
GET
/ccaas/2/conversations/{conversationId}/form
Get a conversation's form values · Get dispositions
#
Ask an LLM
“What did the agent fill in on the form for a conversation?”
“Can I read the dispositions recorded on a conversation?”
Tell an agent
Get the form and field values for conversation {conversationId}.
Show dispositions of form {formId} on {conversationId}.
PUT
/ccaas/2/conversations/{conversationId}/form
Set a conversation's form values · Update or insert dispositions
#
Ask an LLM
“Can I record disposition values on a conversation from my own system?”
“Does writing form values overwrite existing dispositions?”
Tell an agent
Set dispositions {fields} on conversation {conversationId}.
Overwrite the form values of {conversationId} with {fields}.
DELETE
/ccaas/2/conversations/{conversationId}/form/{id}
Delete a disposition from a conversation · Delete disposition
#
Ask an LLM
“Can I remove one agent input from a conversation's form?”
“How do I clear a single disposition value?”
Tell an agent destructive · confirm first
Delete disposition {id} from conversation {conversationId}.
Remove field input {id} on {conversationId}.
POST
/ccaas/2/conversations/{conversationId}/form/assign
Assign a form to a conversation · Assign form to conversation
#
Ask an LLM
“Can I manually attach a specific form to a conversation?”
“Which form will agents see on a conversation after I assign one?”
Tell an agent
Assign form {formId} to conversation {conversationId}.
Attach agent form {formId} to {conversationId}.
POST
/ccaas/2/conversations/{conversationId}/form/unassign
Unassign a form from a conversation · Un-assign form from conversation
#
Ask an LLM
“Can I detach the form from a conversation?”
“What does unassigning a conversation form do?”
Tell an agent
Unassign the form from conversation {conversationId}.
Detach the agent form on {conversationId}.
PUT
/ccaas/1/account/configuration
Set the account webhook URL (deprecated) · Update account configuration
#
Ask an LLM
“Can I still set the account-level conversations webhook URL on the deprecated configuration endpoint?”
“When is the conversations account configuration endpoint being removed?”
Tell an agent
Set the account configuration webhook URL to {webhookUrl} using the deprecated endpoint.
Update my conversations account webhook to {webhookUrl}.
Ask an LLM
“What agent-specific settings are configured for one agent?”
“Can I read an agent's individual configuration?”
Tell an agent
Get the configuration for agent {agentId}.
Show the agent-specific settings of {agentId}.
POST
/ccaas/voice/2/outbound-call-conversation
Create an outbound call conversation · Create outbound call conversation
#
Ask an LLM
“Can I create a conversation for an outbound call before the agent dials?”
“What's needed to log an agent's outbound call as a conversation?”
Tell an agent
Create an outbound call conversation from {from} to {to} for agent {agentId}.
Open a call conversation so agent {agentId} can ring {to} from {from}.
Ask an LLM
“Which waiting strategies play music or messages to callers in queue?”
“Can I list waiting strategies for one queue?”
Tell an agent
List all waiting strategies.
Show waiting strategies for queue {queueId}.
Ask an LLM
“Can I set up hold music and a max wait time for callers in a queue?”
“What condition types can a waiting strategy use?”
Tell an agent
Create a waiting strategy with max wait {maximumWaitTime}, condition type {conditionType} and condition {condition}.
Add waiting strategy {name} with greeting {greetingMessage}, max wait {maximumWaitTime}, condition {conditionType} {condition}.
Ask an LLM
“Can I view one waiting strategy's music and messages?”
“How long can callers wait under a given strategy?”
Tell an agent
Get waiting strategy {id}.
Show the settings of waiting strategy {id}.
PUT
/ccaas/voice/2/waiting-strategies/{id}
Update a call waiting strategy · Update waiting strategy
#
Ask an LLM
“Can I change the max wait time on an existing waiting strategy?”
“Is it possible to swap the hold music in a waiting strategy?”
Tell an agent
Update waiting strategy {id} with max wait {maximumWaitTime}, condition type {conditionType}, condition {condition}.
Change the music on hold of strategy {id} to {musicOnHold} ({maximumWaitTime}, {conditionType}, {condition}).
DELETE
/ccaas/voice/2/waiting-strategies/{id}
Delete a call waiting strategy · Delete waiting strategy
#
Ask an LLM
“Can I remove a waiting strategy?”
“How do I delete caller waiting settings by ID?”
Tell an agent destructive · confirm first
Delete waiting strategy {id}.
Remove the caller waiting strategy {id}.
GET
/ccaas/voice/2/account-recording-config
Get account call recording settings · Get account recording configuration
#
Ask an LLM
“Is call recording enabled for my whole contact-center account?”
“What media type does account-wide call recording use?”
Tell an agent
Show the account call recording configuration.
Tell me whether inbound and outbound calls are recorded account-wide.
PUT
/ccaas/voice/2/account-recording-config
Create or update account call recording settings · Update account recording configuration
#
Ask an LLM
“Can I turn account-wide call recording on or off?”
“Can I switch account recording between audio and video?”
Tell an agent
Update account call recording to media type {mediaType}, enabled {enabled}.
Set account recording for inbound {inbound} and outbound {outbound} using {mediaType}.
POST
/ccaas/voice/2/account-recording-config
Create account call recording settings · Create account recording configuration
#
Ask an LLM
“How do I set up call recording for the account for the first time?”
“Can I enable auto-compose when first creating account recording settings?”
Tell an agent
Create an account recording configuration with media type {mediaType}.
Create account-level recording with {mediaType} and auto-compose {autoCompose}.
GET
/ccaas/voice/2/agent-recording-configs
List agent call recording settings · Get agent recording configurations
#
Ask an LLM
“Which agents have their own call recording settings?”
“Can I get the recording configurations for several agents at once?”
Tell an agent
List agent recording configurations.
Show recording settings for agents {agentIds}.
GET
/ccaas/voice/2/agent-recording-configs/{agentId}
Get one agent's call recording settings · Get agent recording configuration
#
Ask an LLM
“Are one particular agent's calls being recorded?”
“Does an agent use the default account recording or their own?”
Tell an agent
Get the recording configuration for agent {agentId}.
Show whether agent {agentId} has call recording on.
PUT
/ccaas/voice/2/agent-recording-configs/{agentId}
Create or update an agent's recording settings · Update agent recording configuration
#
Ask an LLM
“Can I override call recording for one specific agent?”
“Is it possible to make an agent fall back to the account default recording?”
Tell an agent
Update recording for agent {agentId} to media type {mediaType}.
Set agent {agentId} to use the default recording ({useDefault}) with {mediaType}.
POST
/ccaas/voice/2/agent-recording-configs/{agentId}
Create an agent's recording settings · Create agent recording configuration
#
Ask an LLM
“How do I add a first-time recording configuration for one agent?”
“Can I create an agent recording setup covering only inbound calls?”
Tell an agent
Create a recording configuration for agent {agentId} with media type {mediaType}.
Create agent recording for {agentId} with inbound {inbound} and {mediaType}.
Ask an LLM
“Can I find call recordings for a specific conversation?”
“How do I list recordings longer than a certain duration?”
Tell an agent
Find recordings for conversation {conversationId}.
List recordings started between {startedAtFrom} and {startedAtTo}.
GET
/ccaas/voice/2/recording/download/{recordingId}
Download a call recording · Download call recording
#
Ask an LLM
“Can I download the audio file of a call recording?”
“Is it possible to fetch only a byte range of a recording?”
Tell an agent
Download call recording {recordingId}.
Fetch bytes {Range} of recording {recordingId}.
GET
/ccaas/voice/2/account-wrap-up-config
Get account wrap-up settings · Get account wrap up configuration
#
Ask an LLM
“How long do agents stay busy after a call before they're available again?”
“Can agents extend their wrap-up time under the account settings?”
Tell an agent
Show the account wrap-up configuration.
Tell me the account-wide after-call wrap-up time.
PUT
/ccaas/voice/2/account-wrap-up-config
Update account wrap-up settings · Update account wrap up configuration
#
Ask an LLM
“Can I change how many seconds agents get to wrap up after a call?”
“Is it possible to let agents extend wrap-up time?”
Tell an agent
Set account wrap-up to {wrapUpSeconds} seconds, extendable {canExtendWrapUp}, enabled {enabled}.
Disable account after-call wrap-up ({enabled}), with {wrapUpSeconds} seconds and extension {canExtendWrapUp}.
PUT
/ccca/1/agent-configs/{agentId}/wrap-up
Set one agent's wrap-up time · Update agent wrap up configuration
#
Ask an LLM
“Can I give a single agent a different wrap-up time than the account?”
“Where do I configure per-agent after-call wrap-up?”
Tell an agent
Set agent {agentId} wrap-up time to {wrapUpSeconds} seconds.
Configure a custom wrap-up for {agentId}.
PATCH
/ccaas/voice/2/agent/{agentId}/wrap-up-time/add/{seconds}
Extend an agent's current wrap-up · Add agent wrap up time
#
Ask an LLM
“Can I give an agent a few more seconds of wrap-up after this call?”
“Is extending wrap-up time limited to positive numbers?”
Tell an agent
Add {seconds} seconds of wrap-up time for agent {agentId}.
Extend {agentId}'s current wrap-up by {seconds} seconds.
PATCH
/ccaas/voice/2/agent/{agentId}/wrap-up-time/clear
End an agent's wrap-up now · Clear agent wrap up time
#
Ask an LLM
“Can I end an agent's wrap-up early so they're available again?”
“How do I take an agent out of wrapping status?”
Tell an agent
Clear the wrap-up time for agent {agentId}.
End {agentId}'s wrapping status now.
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/agent
Transfer a call to another agent · Transfer call to another agent
#
Ask an LLM
“Can I transfer a live call to a different agent?”
“What happens if the target agent isn't available for a call transfer?”
Tell an agent
Transfer the call in conversation {conversationId} to agent {agentId}.
Hand the call {conversationId} over to agent {agentId}.
GET
/ccaas/voice/2/transfer/queues
List queues available for call transfer · Fetch queues eligible as transfer destination
#
Ask an LLM
“Which queues can I transfer a call to right now?”
“Is a given queue currently active for transfers?”
Tell an agent
List queues eligible as call transfer destinations.
Show transfer-eligible queues with their activity status, page {page}.
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/queue
Transfer a call to another queue · Transfer call to another queue
#
Ask an LLM
“Can I move a caller into a different queue mid-call?”
“Does the target queue need to be within working hours to receive a transfer?”
Tell an agent
Transfer the call in conversation {conversationId} to queue {queueId}.
Move caller {conversationId} to queue {queueId}.
PATCH
/ccaas/voice/2/conversation/{conversationId}/transfer/external-number
Transfer a call to an external number · Transfer call to external number
#
Ask an LLM
“Can an agent forward a call to an outside phone number?”
“Which caller ID is shown when transferring to an external number?”
Tell an agent
Dial out and hand the call in {conversationId} to outside phone {externalNumber}.
Forward call {conversationId} to external number {externalNumber} from {from}.
GET
/ccaas/voice/2/transfer-configs/external-number
Get external-number transfer settings · Get transfer to external number configuration
#
Ask an LLM
“Are agents allowed to transfer calls to any external number?”
“What tag governs external-number transfers?”
Tell an agent
Show the transfer-to-external-number configuration.
Tell me whether transfers to any phone number are enabled.
PUT
/ccaas/voice/2/transfer-configs/external-number
Update external-number transfer settings · Update transfer to external number configuration
#
Ask an LLM
“Can I allow agents to transfer calls to any number?”
“Can I restrict external transfers to numbers under a tag?”
Tell an agent
Enable transfer to any external number: {transferToAnyNumberEnabled}.
Limit external transfers to numbers tagged {tagName}.
GET
/ccaas/voice/2/transfer-configs/transfer-strategy
Get the call transfer strategy · Get transfer strategy
#
Ask an LLM
“What music and announcement do callers hear during a transfer?”
“Can I view my current transfer strategy?”
Tell an agent
Show the call transfer strategy.
Tell me which hold music plays during call transfers.
PUT
/ccaas/voice/2/transfer-configs/transfer-strategy
Update the call transfer strategy · Update transfer strategy
#
Ask an LLM
“Can I change the music played while a call is being transferred?”
“Is it possible to add an announcement during transfers?”
Tell an agent
Set transfer music to {musicOnHold}.
Play announcement {announcementMessage} while transferring calls.
Ask an LLM
“Can an agent put the customer on hold during a call?”
“How is hold triggered for a call conversation?”
Tell an agent
Put the caller in conversation {conversationId} on hold.
Hold call {conversationId}.
Ask an LLM
“How do I resume a call after putting the client on hold?”
“Can I release a customer from hold through the API?”
Tell an agent
Take the caller in conversation {conversationId} off hold.
Resume call {conversationId} from hold.
Ask an LLM
“What hold music setups exist for my queues?”
“Can I page through hold configurations?”
Tell an agent
List hold configurations.
Show hold configurations page {pageNumber}, {pageSize} per page.
POST
/ccaas/voice/2/hold-configs-per-queue
Create a hold configuration for queues · Create hold configuration
#
Ask an LLM
“Can I set custom hold music for certain queues?”
“Which queues does a new hold configuration apply to?”
Tell an agent
Create hold configuration {name} for queues {queueIds}.
Add hold setup {name} with music {onHoldMusic} on queues {queueIds}.
Ask an LLM
“Can I see which queues a hold configuration covers?”
“What announcement is in a given hold setup?”
Tell an agent
Get hold configuration {id}.
Show hold setup {id}.
PUT
/ccaas/voice/2/hold-configs-per-queue/{id}
Update a hold configuration · Update hold configuration
#
Ask an LLM
“Can I change which queues use a hold configuration?”
“Is it possible to make a hold setup the default?”
Tell an agent
Update hold configuration {id} named {name} to cover queues {queueIds}.
Make hold setup {id} ({name}, queues {queueIds}) the default: {default}.
DELETE
/ccaas/voice/2/hold-configs-per-queue/{id}
Delete a hold configuration · Delete hold configuration
#
Ask an LLM
“Can I remove a hold music setup?”
“How do I delete a hold configuration by ID?”
Tell an agent destructive · confirm first
Delete hold configuration {id}.
Remove hold setup {id}.
Ask an LLM
“How long does an inbound call ring before timing out?”
“What are my current call timeout settings?”
Tell an agent
Show the call timeout configuration.
Tell me the inbound and outbound call timeouts.
Ask an LLM
“Can I change how long inbound calls ring before timing out?”
“What happens if I leave a call timeout field empty?”
Tell an agent
Set the inbound call timeout to {inbound}.
Update call timeouts to inbound {inbound} and outbound {outbound}.
Ask an LLM
“Can I revert to the default inbound call timeout?”
“How do I delete a custom call timeout?”
Tell an agent destructive · confirm first
Remove my custom inbound call timeout.
Reset call timeout to the default.
Ask an LLM
“Which working hours schedules exist in my contact center?”
“Can I find the default working hours?”
Tell an agent
List working hours named {name}.
Show working hours schedules that are enabled: {enabled}.
Ask an LLM
“Can I set business hours with an away message for out-of-hours customers?”
“What does a working hours schedule need, like timezone and week layout?”
Tell an agent
Create working hours {name} in {timezone} with week {workWeek} and away message {message}.
Set up business hours {name} ({timezone}, {workWeek}) sending {message} after hours.
Ask an LLM
“Can I view one working hours schedule's timezone and days?”
“What away message does a schedule send?”
Tell an agent
Get working hours {id}.
Show the schedule for working hours {id}.
Ask an LLM
“Can I fully redefine a working hours schedule?”
“Is it possible to change the timezone of a schedule?”
Tell an agent
Update working hours {id} to {name}, {timezone}, week {workWeek}, message {message}.
Replace schedule {id} completely: name {name}, timezone {timezone}, week {workWeek}, away text {message}.
Ask an LLM
“Can I delete a working hours schedule?”
“How do I remove business hours I no longer use?”
Tell an agent destructive · confirm first
Delete working hours {id}.
Remove schedule {id}.
Ask an LLM
“Can I change only the away message on a schedule?”
“Is there a partial update for business hours?”
Tell an agent
Patch working hours {id} with a new away message {message} ({name}, {timezone}, {workWeek}).
Toggle schedule {id} enabled to {enabled} via partial update ({name}, {timezone}, {workWeek}, {message}).
GET
/ccaas/1/working-hours/{id}/status
Check whether working hours are open now · Get working hours status
#
Ask an LLM
“Is my contact center currently within working hours?”
“Can I check the live open or closed status of a schedule?”
Tell an agent
Get the current status of working hours {id}.
Tell me if schedule {id} is open right now.
POST
/ccaas/1/working-hours/{workingHoursId}/holiday
Add a holiday to working hours · Create working hours holiday
#
Ask an LLM
“Can I add a public holiday so customers get the away message that day?”
“What dates does a working hours holiday need?”
Tell an agent
Add holiday {name} from {startDate} to {endDate} to working hours {workingHoursId}.
Create a holiday called {name} on schedule {workingHoursId}.
DELETE
/ccaas/1/working-hours/{workingHoursId}/holiday/{id}
Remove a holiday from working hours · Remove working hours holiday
#
Ask an LLM
“Can I remove a holiday I added to a schedule?”
“How do I delete a working hours holiday?”
Tell an agent destructive · confirm first
Remove holiday {id} from working hours {workingHoursId}.
Delete holiday {id} on schedule {workingHoursId}.
GET
/ccaas/voice/2/tts/options/placeholders/{ttsPurpose}
List supported TTS placeholders · Get supported TTS placeholders for purpose
#
Ask an LLM
“Which placeholders can I use in text-to-speech messages for a given purpose?”
“What dynamic values are supported in voice TTS prompts?”
Tell an agent
List supported TTS placeholders for purpose {ttsPurpose}.
Show which text-to-speech variables work for {ttsPurpose}.
GET
/ccaas/voice/2/away-audio-message/{workingHoursConfigId}
Get the away audio message · Get away audio message
#
Ask an LLM
“What audio message do callers hear outside working hours?”
“Can I retrieve the away voice message tied to a schedule?”
Tell an agent
Get the away audio message for working hours {workingHoursConfigId}.
Show the after-hours voice message on schedule {workingHoursConfigId}.
DELETE
/ccaas/voice/2/away-audio-message/{workingHoursConfigId}
Delete the away audio message · Delete away audio message
#
Ask an LLM
“Can I remove the after-hours audio message from a schedule?”
“How do I delete an away voice message?”
Tell an agent destructive · confirm first
Delete the away audio message for working hours {workingHoursConfigId}.
Remove the after-hours voice message on schedule {workingHoursConfigId}.
Ask an LLM
“Can I post a customer's web form entry so it opens a conversation?”
“Can web form submissions include attachments or CC addresses?”
Tell an agent
Submit web form {id} from {from} with content {content}.
Send a submission to web form {id} from {from}, subject {subject}: {content}.
Ask an LLM
“Can I see how a contact-center web form is configured?”
“Which channel does a web form create conversations on?”
Tell an agent
Get web form {id}.
Show the setup of web form {id}.
Ask an LLM
“Can I fully update a web form's channel and destination?”
“Is it possible to change a web form's URL?”
Tell an agent
Update web form {id}: name {name}, channel {channel}, destination {destination}, enabled {enabled}.
Replace web form {id} with URL {url} ({name}, {channel}, {destination}, {enabled}).
Ask an LLM
“Can I delete a contact-center web form?”
“How would I remove a web form permanently?”
Tell an agent destructive · confirm first
Delete web form {id}.
Remove the web form {id}.
Ask an LLM
“Can I just disable a web form without changing anything else?”
“Is there a patch for web forms?”
Tell an agent
Patch web form {id} to enabled {enabled} ({name}, {channel}, {destination}).
Partially update web form {id} tags to {tagIds} ({name}, {channel}, {destination}, {enabled}).
Ask an LLM
“Can I create a web form that turns submissions into conversations?”
“What channel and destination does a new web form need?”
Tell an agent
Create web form {name} on {channel} to {destination}, enabled {enabled}.
Build a new contact form {name} for {destination} over {channel} with enabled {enabled}.
Ask an LLM
“Can I run a simulated conversation to test my chatbot?”
“What do I need to start a bot test scenario?”
Tell an agent
Start a test of bot {botId} with webhook {webhookUrl}.
Begin a bot simulation for {botId} as sender {sender}, posting results to {webhookUrl}.
Ask an LLM
“How do I end a bot simulation I started?”
“Can I finish a running bot test scenario?”
Tell an agent
Stop bot test {testId}.
End the bot simulation {testId}.
Ask an LLM
“Can I send a fake inbound user message to my bot during a test?”
“How do I simulate what a user types in a bot test?”
Tell an agent
Send {message} to bot test {testId} as user {userDestination}.
Simulate user {userDestination} saying {message} in test {testId}.
GET
/saas/1/{resourceType}/{resourceId}/export
Export a SaaS resource to a file · Export SaaS resource
#
Ask an LLM
“Can I export a resource, like a flow or bot, as a file?”
“Which resource types can be exported from my account?”
Tell an agent
Export {resourceType} {resourceId} as a file.
Download an export of the {resourceType} resource {resourceId}.
Ask an LLM
“Can I import an exported resource file into my account?”
“How do I bring a resource from another account into mine?”
Tell an agent
Import the {resourceType} from file {file}.
Upload {file} as a new {resourceType} resource.
POST
/saas/1/{resourceType}/{resourceId}/share
Share a SaaS resource with other accounts · Share SaaS resource
#
Ask an LLM
“Can I share a resource with other Infobip accounts?”
“How do I copy a resource to several accounts at once?”
Tell an agent
Share {resourceType} {resourceId} with accounts {accounts}.
Send a copy of resource {resourceId} ({resourceType}) to {accounts}.
GET
/saas/1/request/{requestId}/status
Check a resource share request's status · Get SaaS request status
#
Ask an LLM
“Did my resource share request finish?”
“What's the status of a SaaS share request?”
Tell an agent
Get the status of share request {requestId}.
Check whether resource share {requestId} completed.
Ask an LLM
“Which Vocalize voice campaigns do I own?”
“Can I show only active campaigns that already have scores?”
Tell an agent
List my Vocalize campaigns.
Show only my active Vocalize campaigns: {activeOnly}.
Ask an LLM
“Can I launch a voice challenge campaign with start and end dates?”
“What settings can a new Vocalize campaign have, like a keyword?”
Tell an agent
Create Vocalize campaign {name} running from {activeFrom} to {activeUntil}.
Create campaign {name} with keyword {keywordSpec}, active {activeFrom} to {activeUntil}.
Ask an LLM
“Can I view the details of one Vocalize campaign?”
“When does a given voice campaign start and end?”
Tell an agent
Get Vocalize campaign {campaignId}.
Show campaign {campaignId}'s configuration.
Ask an LLM
“Can I delete a voice campaign entirely?”
“How do I remove a Vocalize campaign?”
Tell an agent destructive · confirm first
Delete Vocalize campaign {campaignId}.
Remove voice campaign {campaignId}.
PATCH
/vocalize/2/campaigns/{campaignId}/settings
Update Vocalize campaign limits · Update campaign settings
#
Ask an LLM
“Can I cap how many attempts a user gets per day in a campaign?”
“Is it possible to change the speech-to-text provider for a campaign?”
Tell an agent
Limit campaign {campaignId} to {maxDailyAttemptsPerUser} attempts per user per day.
Set the daily attempt cap of campaign {campaignId} to {maxDailyAttemptsPerCampaign} in total.
GET
/vocalize/2/campaigns/{campaignId}/leaderboard
Get a Vocalize campaign leaderboard · Get campaign leaderboard
#
Ask an LLM
“Who are the top scorers in my voice campaign?”
“Can I see the leaderboard for just one day?”
Tell an agent
Show the leaderboard for campaign {campaignId}.
Get the campaign {campaignId} leaderboard for day {day}.
GET
/vocalize/2/campaigns/{campaignId}/stats
Get Vocalize campaign statistics · Get campaign statistics
#
Ask an LLM
“How many attempts and scores has my voice campaign received?”
“Can I get totals for a Vocalize campaign?”
Tell an agent
Get statistics for campaign {campaignId}.
Show total attempts and scores for Vocalize campaign {campaignId}.
DELETE
/vocalize/2/campaigns/{campaignId}/reset
Wipe all scores from a Vocalize campaign · Delete campaign scores
#
Ask an LLM
“Can I reset a campaign by deleting every score and attempt?”
“Is clearing campaign scores reversible?”
Tell an agent destructive · confirm first
Delete all scores and attempts in campaign {campaignId}.
Reset the leaderboard of campaign {campaignId} to empty.
Ask an LLM
“Can I record a user's audio attempt and score it for a campaign?”
“Does a user's first attempt need a display name?”
Tell an agent
Submit audio {audioUrl} in {languageCode} for user {userId} in campaign {campaignId}.
Record an attempt by {userId} named {name} for campaign {campaignId} using {audioUrl} ({languageCode}).
Ask an LLM
“How is one user doing in a voice campaign?”
“Can I see a single participant's score stats?”
Tell an agent
Get score stats for user {userId} in campaign {campaignId}.
Show how {userId} is scoring in {campaignId}.
Ask an LLM
“Can I full-text search across all my knowledge base content?”
“Which knowledge base content mentions a given phrase?”
Tell an agent
Search the knowledge base for {searchExp}.
Full-text search knowledge content for {searchExp} with filter {filter}.
Ask an LLM
“Can I list knowledge base articles with a certain tag?”
“Which articles are still in draft?”
Tell an agent
List articles tagged {tag}.
Show knowledge base articles with status {status}.
Ask an LLM
“Can I publish a new help article to the knowledge base?”
“What fields does a new article need, like category and tags?”
Tell an agent
Create article {name} in category {categoryId} with content {content}, status {status}, tags {tags} and links {links}.
Write a draft article {name}: {content} ({status}, {categoryId}, {tags}, {links}).
Ask an LLM
“Can I fetch the full content of one article?”
“Can reading an article be counted as a view?”
Tell an agent
Get article {articleId}.
Open article {articleId} with record view {recordView}.
Ask an LLM
“Can I rewrite the content of an existing article?”
“Is it possible to move an article to another category?”
Tell an agent
Update article {articleId}: {name}, {content}, {status}, {categoryId}, {tags}, {links}.
Move article {articleId} to folder {folderId}, keeping {name}, {content}, {status}, {categoryId}, {tags}, {links}.
Ask an LLM
“Can I delete a help article?”
“Is article deletion a hard or soft delete?”
Tell an agent destructive · confirm first
Delete article {articleId}.
Remove knowledge base article {articleId}.
PATCH
/knowledge-base/1/articles/{articleId}/status
Publish or unpublish an article · Update article status
#
Ask an LLM
“Can I switch an article from draft to published?”
“What workflow statuses can an article have?”
Tell an agent
Set article {articleId} status to {status}.
Publish article {articleId} by changing its status to {status}.
GET
/knowledge-base/1/articles/{articleId}/history
List an article's version history · Get article versions
#
Ask an LLM
“Can I see previous versions of a knowledge base article?”
“How far back does an article's history go?”
Tell an agent
Get the version history of article {articleId}.
List past revisions of {articleId}, page {page}.
GET
/knowledge-base/1/articles/{articleId}/comments
List comments on an article · Get article comments
#
Ask an LLM
“What comments have people left on an article?”
“Can I read the discussion on one help article?”
Tell an agent
Get comments on article {articleId}.
Show the discussion under {articleId}.
Ask an LLM
“Can I add a comment to a knowledge base article?”
“Is it possible to leave feedback on an article through the API?”
Tell an agent
Comment {content} on article {articleId}.
Add a comment to {articleId} saying {content}.
PUT
/knowledge-base/1/articles/{articleId}/comments/{commentId}
Edit a comment on an article · Update comment
#
Ask an LLM
“Can I edit a comment I already posted on an article?”
“How do I change the text of an article comment?”
Tell an agent
Change comment {commentId} on article {articleId} to {content}.
Edit my comment {commentId} under {articleId}: {content}.
DELETE
/knowledge-base/1/articles/{articleId}/comments/{commentId}
Delete a comment on an article · Delete comment
#
Ask an LLM
“Who is allowed to delete a comment on an article?”
“Can I remove a comment from an article?”
Tell an agent destructive · confirm first
Delete comment {commentId} on article {articleId}.
Remove comment {commentId} from {articleId}.
Ask an LLM
“What categories organize my knowledge base?”
“Can I find a category by name or scope?”
Tell an agent
List knowledge base categories.
Find categories named {name} with scope {scope}.
Ask an LLM
“Which folders exist inside a knowledge base category?”
“Can I search folders by name?”
Tell an agent
List folders in category {categoryId}.
Find knowledge base folders named {name}.
GET
/knowledge-base/1/content-tree/nodes/categories
List top-level content tree categories · Get content tree categories
#
Ask an LLM
“What are the top-level category nodes of my knowledge base tree?”
“Can I expand the content tree down to a particular node?”
Tell an agent
List top-level content tree categories.
Show the content tree expanded to node {expandedToNodeId}.
POST
/knowledge-base/1/content-tree/nodes
Add a node to the content tree · Create content tree node
#
Ask an LLM
“Can I add a new node to the knowledge base navigation tree?”
“Where in the tree does a new node get placed?”
Tell an agent
Create a {type} node {name} for target {targetId} at position {position}.
Add tree node {name} ({type}) pointing to {targetId}, placed {position}.
POST
/knowledge-base/1/content-tree/nodes/{nodeId}/move
Move a content tree node · Move content tree node
#
Ask an LLM
“Can I reorder nodes in the knowledge base tree?”
“How do I move a node before or after another node?”
Tell an agent
Move node {nodeId} to {position} of node {targetNodeId}.
Reposition tree node {nodeId} {position} {targetNodeId}.
GET
/knowledge-base/1/content-tree/nodes/{nodeId}
List a content tree node's children · Get content tree node
#
Ask an LLM
“What sits directly under a node in the content tree?”
“Can I browse the children of one tree node?”
Tell an agent
Get the children of content tree node {nodeId}.
Show what's under tree node {nodeId}.
PUT
/knowledge-base/1/content-tree/nodes/{nodeId}
Rename a content tree node · Update content tree node
#
Ask an LLM
“Can I rename a node in the content tree?”
“Is there a way to update a tree node's label?”
Tell an agent
Rename content tree node {nodeId} to {name}.
Change tree node {nodeId}'s name to {name}.
DELETE
/knowledge-base/1/content-tree/nodes/{nodeId}
Delete a content tree node · Delete content tree node
#
Ask an LLM
“Does deleting a content tree node also remove its children?”
“Can I remove a branch of the knowledge base tree?”
Tell an agent destructive · confirm first
Delete content tree node {nodeId}.
Remove tree node {nodeId} and everything beneath it.
Ask an LLM
“What tags are used on knowledge base articles?”
“Can I search knowledge base tags by name?”
Tell an agent
List knowledge base tags.
Find knowledge base tags named {name}.
Ask an LLM
“Can I create a new tag for help articles?”
“Are there naming restrictions on knowledge base tags?”
Tell an agent
Create knowledge base tag {name}.
Add an article tag called {name}.
Ask an LLM
“Can I look up one knowledge base tag by ID?”
“What details are stored on an article tag?”
Tell an agent
Get knowledge base tag {tagId}.
Show article tag {tagId}.
Ask an LLM
“Can I rename a knowledge base tag?”
“How do I fix a typo in an article tag?”
Tell an agent
Rename knowledge base tag {tagId} to {name}.
Change article tag {tagId}'s name to {name}.
Documentation
📖
Documentation
https://www.infobip.com/docs/api/platform/2fa
📖
APIReference
https://www.infobip.com/docs/api/platform/2fa
📖
Documentation
https://www.infobip.com/docs/api/platform/account-management
📖
APIReference
https://www.infobip.com/docs/api/platform/account-management
📖
Documentation
https://www.infobip.com/docs/api/ai-hub/ai-assistants
📖
APIReference
https://www.infobip.com/docs/api/ai-hub/ai-assistants
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/answers
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/answers
📖
Documentation
https://www.infobip.com/docs/api/channels/apple-mfb
📖
APIReference
https://www.infobip.com/docs/api/channels/apple-mfb
📖
Documentation
https://www.infobip.com/docs/api/platform/application-entity
📖
APIReference
https://www.infobip.com/docs/api/platform/application-entity
📖
Documentation
https://www.infobip.com/docs/api/platform/billing-usage-api
📖
APIReference
https://www.infobip.com/docs/api/platform/billing-usage-api
📖
Documentation
https://www.infobip.com/docs/api/connectivity/biometrics
📖
APIReference
https://www.infobip.com/docs/api/connectivity/biometrics
📖
Documentation
https://www.infobip.com/docs/api/platform/blocklist
📖
APIReference
https://www.infobip.com/docs/api/platform/blocklist
📖
Documentation
https://www.infobip.com/docs/api/connectivity/camara
📖
APIReference
https://www.infobip.com/docs/api/connectivity/camara
📖
Documentation
https://www.infobip.com/docs/api/platform/catalogs-api
📖
APIReference
https://www.infobip.com/docs/api/platform/catalogs-api
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/common-assets
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/common-assets
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/conversations
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/conversations
📖
Documentation
https://www.infobip.com/docs/api/channels/email
📖
APIReference
https://www.infobip.com/docs/api/channels/email
📖
Documentation
https://www.infobip.com/docs/api/channels/instagram
📖
APIReference
https://www.infobip.com/docs/api/channels/instagram
📖
Documentation
https://www.infobip.com/docs/api/channels/kakao
📖
APIReference
https://www.infobip.com/docs/api/channels/kakao
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/knowledge-base
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/knowledge-base
📖
Documentation
https://www.infobip.com/docs/api/channels/line
📖
APIReference
https://www.infobip.com/docs/api/channels/line
📖
Documentation
https://www.infobip.com/docs/api/channels/live-chat
📖
APIReference
https://www.infobip.com/docs/api/channels/live-chat
📖
Documentation
https://www.infobip.com/docs/api/platform/messages-api
📖
APIReference
https://www.infobip.com/docs/api/platform/messages-api
📖
Documentation
https://www.infobip.com/docs/api/channels/messenger
📖
APIReference
https://www.infobip.com/docs/api/channels/messenger
📖
Documentation
https://www.infobip.com/docs/api/platform/metrics-api
📖
APIReference
https://www.infobip.com/docs/api/platform/metrics-api
📖
Documentation
https://www.infobip.com/docs/api/channels/mms
📖
APIReference
https://www.infobip.com/docs/api/channels/mms
📖
Documentation
https://www.infobip.com/docs/api/channels/mobile-app-messaging
📖
APIReference
https://www.infobip.com/docs/api/channels/mobile-app-messaging
📖
Documentation
https://www.infobip.com/docs/api/connectivity/mobile-identity
📖
APIReference
https://www.infobip.com/docs/api/connectivity/mobile-identity
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/moments
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/moments
📖
Documentation
https://www.infobip.com/docs/api/connectivity/number-activation-state
📖
APIReference
https://www.infobip.com/docs/api/connectivity/number-activation-state
📖
Documentation
https://www.infobip.com/docs/api/connectivity/number-lookup
📖
APIReference
https://www.infobip.com/docs/api/connectivity/number-lookup
📖
Documentation
https://www.infobip.com/docs/api/platform/numbers
📖
APIReference
https://www.infobip.com/docs/api/platform/numbers
📖
Documentation
https://www.infobip.com/docs/api/channels/omni-failover
📖
APIReference
https://www.infobip.com/docs/api/channels/omni-failover
📖
Documentation
https://www.infobip.com/docs/api/channels/open-channel
📖
APIReference
https://www.infobip.com/docs/api/channels/open-channel
📖
Documentation
https://www.infobip.com/docs/api/tools/openapi
📖
APIReference
https://www.infobip.com/docs/api/tools/openapi
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/people
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/people
📖
Documentation
https://www.infobip.com/docs/api/channels/rcs
📖
APIReference
https://www.infobip.com/docs/api/channels/rcs
📖
Documentation
https://www.infobip.com/docs/api/platform/resources
📖
APIReference
https://www.infobip.com/docs/api/platform/resources
📖
Documentation
https://www.infobip.com/docs/api/platform/sending-strategy
📖
APIReference
https://www.infobip.com/docs/api/platform/sending-strategy
📖
Documentation
https://www.infobip.com/docs/api/platform/signals
📖
APIReference
https://www.infobip.com/docs/api/platform/signals
📖
Documentation
https://www.infobip.com/docs/api/channels/sms
📖
APIReference
https://www.infobip.com/docs/api/channels/sms
📖
Documentation
https://www.infobip.com/docs/api/platform/subscriptions-api
📖
APIReference
https://www.infobip.com/docs/api/platform/subscriptions-api
📖
Documentation
https://www.infobip.com/docs/api/channels/tiktok
📖
APIReference
https://www.infobip.com/docs/api/channels/tiktok
📖
Documentation
https://www.infobip.com/docs/api/channels/viber
📖
APIReference
https://www.infobip.com/docs/api/channels/viber
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/vocalize
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/vocalize
📖
Documentation
https://www.infobip.com/docs/api/channels/voice
📖
APIReference
https://www.infobip.com/docs/api/channels/voice
📖
Documentation
https://www.infobip.com/docs/api/channels/webrtc-calls
📖
APIReference
https://www.infobip.com/docs/api/channels/webrtc-calls
📖
Documentation
https://www.infobip.com/docs/api/channels/whatsapp
📖
APIReference
https://www.infobip.com/docs/api/channels/whatsapp
📖
Documentation
https://www.infobip.com/docs/api/channels/zalo
📖
APIReference
https://www.infobip.com/docs/api/channels/zalo
Specifications
Schemas & Data
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c-segment-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c-segment-create-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c-segment-update-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-b979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866-recording-metadata-api-model-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c-iam-person-v2-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/json-schema/infobip-09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed-article-detail-response-schema.json