Search Conversations
Returns a list of all conversations matching the search criteria along with the sort and filter options selected.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
conversations. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Query Parameters
Location Id
ABCHkzuJQ8ZMd4Te84GKContact Id
9VEmS0si86GW6gXWU89bUser IDs that conversations are assigned to. Multiple IDs can be provided as comma-separated values. Use "unassigned" to fetch conversations not assigned to any user.
ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsikUser IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values.
ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsikUser Id of the mention. Multiple values are comma separated.
ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsikSearch paramater as a string
Search stringSort paramater - asc or desc
ascdescascSearch to begin after the specified date - should contain the sort value of the last document
1600854Id of the conversation
ABCHkzuJQ8ZMd4Te84GKLimit of conversations - Default is 20
20Type of the last message in the conversation as a string
TYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOKTYPE_SMSAction of the last outbound message in the conversation as string.
automatedmanualmanualDirection of the last message in the conversation as string.
inboundoutboundinboundThe status of the conversation to be filtered - all, read, unread, starred
allreadunreadstarredrecentsallThe sorting of the conversation to be filtered as - manual messages or all messages
last_manual_message_datelast_message_datescore_profilelast_message_dateId of score profile on which sortBy.ScoreProfile should sort on
ABCHkzuJQ8ZMd4Te84GKId of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax
ABCHkzuJQ8ZMd4Te84GKMinimum value for score
ABCHkzuJQ8ZMd4Te84GKMaximum value for score
ABCHkzuJQ8ZMd4Te84GKResponse
Successfully fetched the conversations
The list of all conversations found for the given query
Total Number of results found for the given query
100