Add an external outbound call

POSThttps://services.leadconnectorhq.com/conversations/messages/outbound
Post the necessary fields for the API to add a new outbound call.
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Body
type
string
required

Message Type

Allowed value:
Call
Example:
Call
attachments
array[string]

Array of attachments

conversationId
string
required

Conversation Id

Example:
ve9EPM428h8vShlRW1KT
conversationProviderId
string
required

Conversation Provider Id

Example:
61d6d1f9cdac7612faf80753
altId
string

external mail provider's message id

Example:
61d6d1f9cdac7612faf80753
date
string<date-time>

Date of the outbound message

call
object

Phone call dialer and receiver information

to
string

Phone number of the receiver

Example:
+15037081210
from
string

Phone number of the dialer

Example:
+15037081210
status
string

Call status

Allowed values:
pendingcompletedansweredbusyno-answerfailedcanceledvoicemail
Example:
completed
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

success
boolean
required
conversationId
string
required

Conversation ID.

Example:
ABC12h2F6uBrIkfXYazb
messageId
string
required

This is the main Message ID

Example:
t22c6DQcTDf3MjRhwf77
message
string
required
contactId
string
dateAdded
string<date-time>
emailMessageId
string

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request