Add an inbound message

POST 
/conversations/messages/inbound

Post the necessary fields for the API to add a new inbound message.

Note: Either conversationId or contactId is required

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

typestringrequired
Message Type
Available optionsSMSEmailWhatsAppGMBIGFBCustomWebChatLive_ChatCall
attachmentsstring[]

Array of attachments

messagestring

Message Body

conversationIdstring

Conversation Id

contactIdstring

Contact Id

conversationProviderIdstringrequired

Conversation Provider Id

htmlstring

HTML Body of Email

subjectstring

Subject of the Email

emailFromstring

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

emailTostring

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

emailCcstring[]

List of email address to CC

emailBccstring[]

List of email address to BCC

emailMessageIdstring

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

altIdstring

external mail provider's message id

directionobject
Message direction, if required can be set manually, default is outbound
Default value: outbound
datestring<date-time>

Date of the inbound message

callobject

Phone call dialer and receiver information

Example (auto)

{
  "type": "SMS",
  "attachments": [
    "string"
  ],
  "message": "string",
  "conversationId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "conversationProviderId": "61d6d1f9cdac7612faf80753",
  "html": "string",
  "subject": "string",
  "emailFrom": "[email protected]",
  "emailTo": "string",
  "emailCc": [
    "[email protected]",
    "[email protected]"
  ],
  "emailBcc": [
    "[email protected]",
    "[email protected]"
  ],
  "emailMessageId": "string",
  "altId": "61d6d1f9cdac7612faf80753",
  "direction": [
    "outbound",
    "inbound"
  ],
  "date": "2024-07-29T15:51:28.071Z",
  "call": {
    "to": "+15037081210",
    "from": "+15037081210",
    "status": "completed"
  }
}

application/json

Created the message

application/json

Schema

Schema

successbooleanrequired
conversationIdstringrequired

Conversation ID.

messageIdstringrequired

This is the main Message ID

messagestringrequired
contactIdstring
dateAddedstring<date-time>
emailMessageIdstring

Example (auto)

{
  "success": true,
  "conversationId": "ABC12h2F6uBrIkfXYazb",
  "messageId": "t22c6DQcTDf3MjRhwf77",
  "message": "string",
  "contactId": "string",
  "dateAdded": "2024-07-29T15:51:28.071Z",
  "emailMessageId": "string"
}