Skip to main content
MessagesVersion: v3

Add an external outbound call

POST/conversations/messages/outbound

Post the necessary fields for the API to add a new outbound call.

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 optionsCall
Example:Call
attachmentsstring[]

Array of attachments

conversationIdstring

Conversation Id. Provide either conversationId or contactId.

Example:ve9EPM428h8vShlRW1KT
contactIdstring

Contact Id. When provided without conversationId, the conversation is resolved or created from this contact.

Example:ve9EPM428h8vShlRW1KT
conversationProviderIdstringrequired

Conversation Provider Id

Example:61d6d1f9cdac7612faf80753
altIdstring

external mail provider's message id

Example:61d6d1f9cdac7612faf80753
datestring<date-time>

Date of the outbound 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