Skip to main content
POST
/
conversation
/
outbound
Start an outbound call
curl --request POST \
  --url https://atoms-api.smallest.ai/api/v1/conversation/outbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "60d0fe4f5311236168a109ca",
  "phoneNumber": "+1234567890",
  "variables": {
    "name": "John",
    "age": 30
  },
  "fromProductId": "60d0fe4f5311236168a109ca"
}
'
{
  "status": true,
  "data": {
    "conversationId": "CALL-XXXXX1234"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
agentId
string
required

The ID of the agent initiating the conversation

Example:

"60d0fe4f5311236168a109ca"

​
phoneNumber
string
required

The phone number to call

Example:

"+1234567890"

​
variables
object

The variables to pass to the conversation

Example:
{ "name": "John", "age": 30 }
​
fromProductId
string

The ID of the product to use for the call (get this from the /product/phone-numbers endpoint)

Example:

"60d0fe4f5311236168a109ca"

Response

Successfully started the outbound conversation

​
status
boolean
Example:

true

​
data
object