Get messages by conversation id

Get messages by conversation id.

GET https://services.leadconnectorhq.com/conversations/{conversationId}/messages

Autorización

Authorization

string

required

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

Version

string

default:"2021-07-28"

required

Versión de la API.

Path parameters

conversationId

string

default:"tDtDnQdgm2LXpyiqYvZ6"

required

Conversation ID as string

Query parameters

lastMessageId

string

default:"tDtDnQdgm2LXpyiqYvZ6"

Message ID of the last message in the list as a string

limit

number

default:"20"

Number of messages to be fetched from the conversation. Default limit is 20

type

string

default:"TYPE_SMS,TYPE_CALL"

Types of message to fetched separated with comma

Respuestas

200 - List of messages for the conversation id of the given type.

lastMessageId

string

default:"p1mRSHeLDhAms5q0LMr4"

required

Id of the last message in the messages array

boolean

default:"True"

required

Next page value true indicates only 20 message is in the response. Rest of the messages are in the next page. Please use the lastMessageId value in the query to get the next page messages

messages

object[]

required

Array of messages

Show cada item

string

default:"ve9EPM428h8vShlRW1KT"

required

type

number

default:"1"

required

messageType

string

default:"SMS"

required

Type of the message as a string 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’

locationId

string

default:"ve9EPM428h8vShlRW1KT"

required

contactId

string

default:"ve9EPM428h8vShlRW1KT"

required

conversationId

string

default:"ve9EPM428h8vShlRW1KT"

required

dateAdded

string

default:"2024-03-27T18:13:49.000Z"

required

body

string

default:"Hi there"

direction

string

required

Posibles valores: ‘inbound’, ‘outbound’

status

string

Posibles valores: ‘connected’, ‘delivered’, ‘failed’, ‘opened’, ‘pending’, ‘read’, ‘scheduled’, ‘sent’, ‘undelivered’, ‘clicked’, ‘opt_out’, ‘queued’

contentType

string

default:"text/plain"

required

attachments

string[]

An array of attachment URLs. Attachments will be empty for Call and Voicemails, type 1 and 10. Please use get call recording API to fetch call recording and voicemails.

meta

object

Show propiedades

callDuration

string

default:"120"

Call duration in seconds

callStatus

string

default:"completed"

Call status - can be pending, completed, answered, busy, no-answer, failed, canceled, or voicemail Posibles valores: ‘pending’, ‘completed’, ‘answered’, ‘busy’, ‘no-answer’, ‘failed’, ‘canceled’, ‘voicemail’

object

meta will contain email, for message type 3 (email). messageIds is list of all email message ids under the message thread

source

string

Message source Posibles valores: ‘workflow’, ‘bulk_actions’, ‘campaign’, ‘api’, ‘app’

userId

string

default:"ve9EPM428kjkvShlRW1KT"

User Id

conversationProviderId

string

default:"ve9EPM428kjkvShlRW1KT"

Conversation Provider Id

Chat Widget Id

{
  "lastMessageId": "p1mRSHeLDhAms5q0LMr4",
  "nextPage": true,
  "messages": [
    {
      "id": "ve9EPM428h8vShlRW1KT",
      "type": 1,
      "messageType": "SMS",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "contactId": "ve9EPM428h8vShlRW1KT",
      "conversationId": "ve9EPM428h8vShlRW1KT",
      "dateAdded": "2024-03-27T18:13:49.000Z",
      "body": "Hi there",
      "direction": "inbound",
      "status": "connected",
      "contentType": "text/plain",
      "attachments": [
        "string"
      ],
      "meta": {
        "callDuration": 120,
        "callStatus": "completed",
        "email": {
          "email": {
            "messageIds": [
              "ve9EPM428kjkvShlRW1KT",
              "ve9EPs1028kjkvShlRW1KT"
            ]
          }
        }
      },
      "source": "workflow",
      "userId": "ve9EPM428kjkvShlRW1KT",
      "conversationProviderId": "ve9EPM428kjkvShlRW1KT",
      "chatWidgetId": "67b0cc8cf14b19d85ace7s35"
    }
  ]
}

400 - Bad Request

{}

401 - Unauthorized

{}

Ejemplo

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

const response = await fetch('https://services.leadconnectorhq.com/conversations/YOUR_conversationId/messages', {
  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/YOUR_conversationId/messages',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/conversations/YOUR_conversationId/messages');
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);

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo