ACADEMY - My Learning DOCS & GUIDESAPIPARTNERS FAQ
Dev Guide
indigitall

Get contact center conversations

get
https://api.indigitall.com/v2/chat//contactCenter/conversation

Retrieve conversations for the contact center of a given application.
Optionally filter by specific agent IDs or closed status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Application's ID

Query Params
integer
1 to 100
Defaults to 50

Limit the number of conversations returned

integer
≥ 0
Defaults to 0

Page number

boolean
Defaults to false

Returns the number of conversations that match the specified filter criteria.
If set to true, the response will include the count property.
If set to false, the response will only include the data property.

string
enum

Filter conversations by their closed status.
If set to active, only active (not closed) conversations are returned.
If set to closed, only closed conversations are returned.
If not provided, conversations of all statuses are returned.

Allowed:
string

Filter conversations by agent IDs.

Provide a comma-separated list of agent IDs to filter conversations assigned to specific agents.

If not provided, conversations from all agents are returned.

It's mandatory to encode URI components - e.g., "1,2,3" becomes "1%2C2%2C3".

date-time

Filter conversations by the date of their last message.

It's mandatory to encode URI components - e.g., "2024-01-01T00:00:00Z" becomes "2024-01-01T00%3A00%3A00Z".

date-time

Filter conversations by the date of their last message.

It's mandatory to encode URI components - e.g., "2024-12-31T23:59:59Z" becomes "2024-12-31T23%3A59%3A59Z".

string
enum
Defaults to lastMessage-desc

Order conversations by the last message.

  • lastMessage-asc: Order by last message ID ascending (oldest first)
  • lastMessage-desc: Order by last message ID descending (newest first)

If not provided, defaults to lastMessage-desc.

Allowed:
string

Search conversations by contact name or contact code.

  • For contact name: performs a flexible search (case-insensitive and accent-insensitive).
  • For contact code: if the search term has 5 or fewer characters, searches by the first characters of the contact code.
    If the search term has more than 5 characters, performs an exact match on the contact code.
boolean
Defaults to false

When true, excludes conversations where the contact's webUserId matches the requesting agent's ID.
This allows agents to filter out conversations they initiated as contacts themselves.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?