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. writeAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Body
typestringrequired
Message Type
Available options
CallExample:
Callattachmentsstring[]
Array of attachments
conversationIdstring
Conversation Id. Provide either conversationId or contactId.
Example:
ve9EPM428h8vShlRW1KTcontactIdstring
Contact Id. When provided without conversationId, the conversation is resolved or created from this contact.
Example:
ve9EPM428h8vShlRW1KTconversationProviderIdstringrequired
Conversation Provider Id
Example:
61d6d1f9cdac7612faf80753altIdstring
external mail provider's message id
Example:
61d6d1f9cdac7612faf80753datestring<date-time>
Date of the outbound message
callobject
Phone call dialer and receiver information
Response
Created the message
successbooleanrequired
conversationIdstringrequired
Conversation ID.
Example:
ABC12h2F6uBrIkfXYazbmessageIdstringrequired
This is the main Message ID
Example:
t22c6DQcTDf3MjRhwf77messagestringrequired
contactIdstring
dateAddedstring<date-time>
emailMessageIdstring