Search Conversations

GET 
/conversations/search

Returns a list of all conversations matching the search criteria along with the sort and filter options selected.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

contactId string

Contact Id

assignedTo string

User 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.

followers string

User IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values.

mentions string

User Id of the mention. Multiple values are comma separated.

query string

Search paramater as a string

sort string

Sort paramater - asc or desc

Available optionsascdesc

startAfterDate any

Search to begin after the specified date - should contain the sort value of the last document

id string

Id of the conversation

limit number

Limit of conversations - Default is 20

lastMessageType string

Type of the last message in the conversation as a string

Available optionsTYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOK

lastMessageAction string

Action of the last outbound message in the conversation as string.

Available optionsautomatedmanual

lastMessageDirection string

Direction of the last message in the conversation as string.

Available optionsinboundoutbound

status string

The status of the conversation to be filtered - all, read, unread, starred

Available optionsallreadunreadstarredrecents

sortBy string

The sorting of the conversation to be filtered as - manual messages or all messages

Available optionslast_manual_message_datelast_message_datescore_profile

sortScoreProfile string

Id of score profile on which sortBy.ScoreProfile should sort on

scoreProfile string

Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax

scoreProfileMin number

Minimum value for score

scoreProfileMax number

Maximum value for score

application/json

Successfully fetched the conversations

application/json

Schema

Schema

conversationsobject[]required

The list of all conversations found for the given query

totalnumberrequired

Total Number of results found for the given query

Example (auto)

{
  "conversations": [
    {
      "id": "ABCHkzuJQ8ZMd4Te84GK",
      "contactId": "ABCHkzuJQ8ZMd4Te84GK",
      "locationId": "ABCHkzuJQ8ZMd4Te84GK",
      "lastMessageBody": "This is a sample message body",
      "lastMessageType": "TYPE_SMS",
      "type": "TYPE_PHONE",
      "unreadCount": 1,
      "fullName": "John Doe",
      "contactName": "John Doe Company",
      "email": "[email protected]",
      "phone": "+15550001234"
    }
  ],
  "total": 100
}