Documentation Index Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Returns a list of all conversations matching the search criteria along with the sort and filter options selected.
GET https://services.leadconnectorhq.com/conversations/search
Autorizacion Bearer token generado desde el portal Leadway. Ver Autenticacion . Version
string
default: "2021-07-28"
required
Version de la API.
Query parameters locationId
string
default: "ABCHkzuJQ8ZMd4Te84GK"
required
Account Id
contactId
string
default: "9VEmS0si86GW6gXWU89b"
Contact Id
assignedTo
string
default: "ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik"
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
default: "ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik"
User IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values.
mentions
string
default: "ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik"
User Id of the mention. Multiple values are comma separated.
query
string
default: "Search string"
Search paramater as a string
Sort paramater - asc or desc
Search to begin after the specified date - should contain the sort value of the last document
id
string
default: "ABCHkzuJQ8ZMd4Te84GK"
Id of the conversation
Limit of conversations - Default is 20
Type of the last message in the conversation as a string
Action of the last outbound message in the conversation as string.
Direction of the last message in the conversation as string.
The status of the conversation to be filtered - all, read, unread, starred
sortBy
string
default: "last_message_date"
The sorting of the conversation to be filtered as - manual messages or all messages
sortScoreProfile
string
default: "ABCHkzuJQ8ZMd4Te84GK"
Id of score profile on which sortBy.ScoreProfile should sort on
scoreProfile
string
default: "ABCHkzuJQ8ZMd4Te84GK"
Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax
scoreProfileMin
number
default: "ABCHkzuJQ8ZMd4Te84GK"
Minimum value for score
scoreProfileMax
number
default: "ABCHkzuJQ8ZMd4Te84GK"
Maximum value for score
startDate
number
default: "1640995200000"
Start date filter for dateAdded field (Unix timestamp in milliseconds)
endDate
number
default: "1672531199000"
End date filter for dateAdded field (Unix timestamp in milliseconds)
Respuestas
200 - Successfully fetched the conversations
The list of all conversations found for the given query id
string
default: "ABCHkzuJQ8ZMd4Te84GK"
required
Conversation Id
contactId
string
default: "ABCHkzuJQ8ZMd4Te84GK"
required
Contact Id
locationId
string
default: "ABCHkzuJQ8ZMd4Te84GK"
required
Account Id
lastMessageBody
string
default: "This is a sample message body"
required
Content of the most recent message in the conversation
lastMessageType
string
default: "TYPE_SMS"
required
Channel/type of the most recent message (SMS, Email, Call, etc) Posibles valores: ‘TYPE_CALL’, ‘TYPE_SMS’, ‘TYPE_RCS’, ‘TYPE_EMAIL’, ‘TYPE_SMS_REVIEW_REQUEST’, ‘TYPE_WEBCHAT’, ‘TYPE_SMS_NO_SHOW_REQUEST’, ‘TYPE_CAMPAIGN_SMS’, ‘TYPE_CAMPAIGN_CALL’, ‘TYPE_CAMPAIGN_EMAIL’, ‘TYPE_CAMPAIGN_VOICEMAIL’, ‘TYPE_FACEBOOK’, ‘TYPE_CAMPAIGN_FACEBOOK’, ‘TYPE_CAMPAIGN_MANUAL_CALL’, ‘TYPE_CAMPAIGN_MANUAL_SMS’, ‘TYPE_GMB’, ‘TYPE_CAMPAIGN_GMB’, ‘TYPE_REVIEW’, ‘TYPE_INSTAGRAM’, ‘TYPE_WHATSAPP’, ‘TYPE_CUSTOM_SMS’, ‘TYPE_CUSTOM_EMAIL’, ‘TYPE_CUSTOM_PROVIDER_SMS’, ‘TYPE_CUSTOM_PROVIDER_EMAIL’, ‘TYPE_IVR_CALL’, ‘TYPE_ACTIVITY_CONTACT’, ‘TYPE_ACTIVITY_INVOICE’, ‘TYPE_ACTIVITY_PAYMENT’, ‘TYPE_ACTIVITY_OPPORTUNITY’, ‘TYPE_LIVE_CHAT’, ‘TYPE_LIVE_CHAT_INFO_MESSAGE’, ‘TYPE_ACTIVITY_APPOINTMENT’, ‘TYPE_FACEBOOK_COMMENT’, ‘TYPE_INSTAGRAM_COMMENT’, ‘TYPE_CUSTOM_CALL’, ‘TYPE_INTERNAL_COMMENT’, ‘TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG’, ‘TYPE_TIKTOK’, ‘TYPE_TIKTOK_COMMENT’, ‘TYPE_ACTIVITY_WHATSAPP’, ‘TYPE_FORM_SUBMISSION’, ‘TYPE_SMS_REACTION’
type
string
default: "TYPE_PHONE"
required
Primary channel/type of the conversation (Phone, Email, etc) Posibles valores: ‘TYPE_PHONE’, ‘TYPE_EMAIL’, ‘TYPE_FB_MESSENGER’, ‘TYPE_REVIEW’, ‘TYPE_GROUP_SMS’
unreadCount
number
default: "1"
required
Number of unread messages in this conversation
fullName
string
default: "John Doe"
required
Complete name of the contact (first and last name)
contactName
string
default: "John Doe Company"
required
Alternative display name for the contact - used when full name is not available
email
string
default: "johndoe@mailingdomain.com"
required
Primary email address of the contact
phone
string
default: "+15550001234"
required
Primary phone number of the contact
total
number
default: "100"
required
Total Number of results found for the given query
{ "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" : "johndoe@mailingdomain.com" , "phone" : "+15550001234" } ], "total" : 100 }
Ejemplo curl -X GET 'https://services.leadconnectorhq.com/conversations/search' \ -H 'Authorization: Bearer YOUR_TOKEN' \ -H 'Version: 2021-07-28'
