Search Conversations

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

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"ABCHkzuJQ8ZMd4Te84GK"

required

Account Id

string

default:"9VEmS0si86GW6gXWU89b"

Contact Id

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.

string

default:"ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik"

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

string

default:"ABCHkzuJQ8ZMd4Te84GK,fGiae4CHkzoskh8thsik"

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

string

default:"Search string"

Search paramater as a string

string

default:"asc"

Sort paramater - asc or desc

any

default:"1600854"

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

string

default:"ABCHkzuJQ8ZMd4Te84GK"

Id of the conversation

number

default:"20"

Limit of conversations - Default is 20

string

default:"TYPE_SMS"

Type of the last message in the conversation as a string

string

default:"manual"

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

string

default:"inbound"

Direction of the last message in the conversation as string.

string

default:"all"

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

string

default:"last_message_date"

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

string

default:"ABCHkzuJQ8ZMd4Te84GK"

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

string

default:"ABCHkzuJQ8ZMd4Te84GK"

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

number

default:"ABCHkzuJQ8ZMd4Te84GK"

Minimum value for score

number

default:"ABCHkzuJQ8ZMd4Te84GK"

Maximum value for score

number

default:"1640995200000"

Start date filter for dateAdded field (Unix timestamp in milliseconds)

number

default:"1672531199000"

End date filter for dateAdded field (Unix timestamp in milliseconds)

Respuestas

200 - Successfully fetched the conversations

object[]

required

The list of all conversations found for the given query

Show cada item

string

default:"ABCHkzuJQ8ZMd4Te84GK"

required

Conversation Id

string

default:"ABCHkzuJQ8ZMd4Te84GK"

required

Contact Id

string

default:"ABCHkzuJQ8ZMd4Te84GK"

required

Account Id

string

default:"This is a sample message body"

required

Content of the most recent message in the conversation

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’

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’

number

default:"1"

required

Number of unread messages in this conversation

string

default:"John Doe"

required

Complete name of the contact (first and last name)

string

default:"John Doe Company"

required

Alternative display name for the contact - used when full name is not available

string

default:"johndoe@mailingdomain.com"

required

Primary email address of the contact

string

default:"+15550001234"

required

Primary phone number of the contact

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
}

400 - Bad Request

{}

401 - Unauthorized

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/conversations/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/conversations/search', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/conversations/search',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/conversations/search');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo