Add an external outbound call

POST 
/conversations/messages/outbound

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

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

typestringrequired
Message Type
Available optionsCall
attachmentsstring[]

Array of attachments

conversationIdstring

Conversation Id. Provide either conversationId or contactId.

contactIdstring

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

conversationProviderIdstringrequired

Conversation Provider Id

altIdstring

external mail provider's message id

datestring<date-time>

Date of the outbound message

callobject

Phone call dialer and receiver information

Example (auto)

{
  "type": "Call",
  "attachments": [
    "string"
  ],
  "conversationId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "conversationProviderId": "61d6d1f9cdac7612faf80753",
  "altId": "61d6d1f9cdac7612faf80753",
  "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"
}