Skip to main content
MessagesVersion: v3

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

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:conversations/message.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

typestringrequired

Message Type

Available optionsSMSEmailWhatsAppGMBIGFBCustomWebChatLive_ChatCall
Example:SMS
attachmentsstring[]

Array of attachments

messagestring

Message Body

conversationIdstring

Conversation Id

Example:ve9EPM428h8vShlRW1KT
contactIdstring

Contact Id

Example:ve9EPM428h8vShlRW1KT
conversationProviderIdstringrequired

Conversation Provider Id

Example:61d6d1f9cdac7612faf80753
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

Example:61d6d1f9cdac7612faf80753
directionobject

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

Default:outbound
Example:["outbound","inbound"]
datestring<date-time>

Date of the inbound message

callobject

Phone call dialer and receiver information

Response

Created the message

successbooleanrequired
conversationIdstringrequired

Conversation ID.

Example:ABC12h2F6uBrIkfXYazb
messageIdstringrequired

This is the main Message ID

Example:t22c6DQcTDf3MjRhwf77
messagestringrequired
contactIdstring
dateAddedstring<date-time>
emailMessageIdstring