Add an inbound message

Post the necessary fields for the API to add a new inbound message. <br />

POST https://services.leadconnectorhq.com/conversations/messages/inbound

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.

Body

string

default:"SMS"

required

Message Type Posibles valores: ‘SMS’, ‘RCS’, ‘Email’, ‘WhatsApp’, ‘GMB’, ‘IG’, ‘FB’, ‘Custom’, ‘WebChat’, ‘Live_Chat’, ‘Call’, ‘IVR_Call’, ‘Campaign_Call’, ‘Campaign_VoiceMail’, ‘TIKTOK’, ‘ALL_IN_ONE_CHAT’, ‘FORM_SUBMISSION’

string[]

Array of attachments

string

Message Body

string

default:"ve9EPM428h8vShlRW1KT"

required

Conversation Id

string

default:"ve9EPM428h8vShlRW1KT"

required

Contact Id

string

default:"61d6d1f9cdac7612faf80753"

required

Conversation Provider Id

string

HTML Body of Email

string

Subject of the Email

string

default:"sender@company.com"

Email address to send from. This field is associated with the contact record and cannot be dynamically changed.

string

Recipient email address. This field is associated with the contact record and cannot be dynamically changed.

string[]

List of email address to CC

string[]

List of email address to BCC

string

Send the email message id for which this email should be threaded. This is for replying to a specific email

string

default:"61d6d1f9cdac7612faf80753"

external mail provider’s message id

object

Message direction, if required can be set manually, default is outbound

string

Date of the inbound message

object

Phone call dialer and receiver information

Respuestas

200 - Created the message

boolean

required

string

default:"ABC12h2F6uBrIkfXYazb"

required

Conversation ID.

string

default:"t22c6DQcTDf3MjRhwf77"

required

This is the main Message ID

string

required

string

{
  "success": true,
  "conversationId": "ABC12h2F6uBrIkfXYazb",
  "messageId": "t22c6DQcTDf3MjRhwf77",
  "message": "string",
  "contactId": "string",
  "dateAdded": "2024-01-15T10:30:00Z",
  "emailMessageId": "string"
}

400 - Bad Request

{}

401 - Unauthorized

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/conversations/messages/inbound' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "SMS",
  "attachments": [
    "string"
  ],
  "message": "string",
  "conversationId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "conversationProviderId": "61d6d1f9cdac7612faf80753",
  "html": "string",
  "subject": "string",
  "emailFrom": "sender@company.com",
  "emailTo": "string",
  "emailCc": [
    "john1@doe.com",
    "john2@doe.com"
  ],
  "emailBcc": [
    "john1@doe.com",
    "john2@doe.com"
  ],
  "emailMessageId": "string",
  "altId": "61d6d1f9cdac7612faf80753",
  "direction": [
    "outbound",
    "inbound"
  ],
  "date": "2024-01-15T10:30:00Z"
}'

const response = await fetch('https://services.leadconnectorhq.com/conversations/messages/inbound', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"type": "SMS", "attachments": ["string"], "message": "string", "conversationId": "ve9EPM428h8vShlRW1KT", "contactId": "ve9EPM428h8vShlRW1KT", "conversationProviderId": "61d6d1f9cdac7612faf80753", "html": "string", "subject": "string", "emailFrom": "sender@company.com", "emailTo": "string", "emailCc": ["john1@doe.com", "john2@doe.com"], "emailBcc": ["john1@doe.com", "john2@doe.com"], "emailMessageId": "string", "altId": "61d6d1f9cdac7612faf80753", "direction": ["outbound", "inbound"], "date": "2024-01-15T10:30:00Z"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/conversations/messages/inbound',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"type": "SMS", "attachments": ["string"], "message": "string", "conversationId": "ve9EPM428h8vShlRW1KT", "contactId": "ve9EPM428h8vShlRW1KT", "conversationProviderId": "61d6d1f9cdac7612faf80753", "html": "string", "subject": "string", "emailFrom": "sender@company.com", "emailTo": "string", "emailCc": ["john1@doe.com", "john2@doe.com"], "emailBcc": ["john1@doe.com", "john2@doe.com"], "emailMessageId": "string", "altId": "61d6d1f9cdac7612faf80753", "direction": ["outbound", "inbound"], "date": "2024-01-15T10:30:00Z"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/conversations/messages/inbound');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'type': 'SMS', 'attachments': ['string'], 'message': 'string', 'conversationId': 've9EPM428h8vShlRW1KT', 'contactId': 've9EPM428h8vShlRW1KT', 'conversationProviderId': '61d6d1f9cdac7612faf80753', 'html': 'string', 'subject': 'string', 'emailFrom': 'sender@company.com', 'emailTo': 'string', 'emailCc': ['john1@doe.com', 'john2@doe.com'], 'emailBcc': ['john1@doe.com', 'john2@doe.com'], 'emailMessageId': 'string', 'altId': '61d6d1f9cdac7612faf80753', 'direction': ['outbound', 'inbound'], 'date': '2024-01-15T10:30:00Z'}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Add an inbound message

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo