Skip to main content
POST
/
api
/
calls
/
sdk
/
initiate
Record an outbound SDK call (browser to phone)
curl --request POST \
  --url https://your-instance.example.com/api/calls/sdk/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "64f0a1b2c3d4e5f6a7b8c9d0",
  "phoneNumber": "+14165550199"
}
'
{
  "success": true,
  "call": {
    "_id": "64f0a1b2c3d4e5f6a7b8cb00",
    "callId": "64f0a1b2c3d4e5f6a7b8cb00",
    "provider": "sinch",
    "direction": "outbound",
    "status": "initiated",
    "from": "+14165550100",
    "to": "+14165550199"
  },
  "message": "Call recorded"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

At least one of contactId or phoneNumber must be provided.

​
contactId
string
required

Contact ObjectId to dial; the contact's phone number is used as the destination.

​
phoneNumber
string

Destination number in E.164; if no contact matches, the call is recorded without one.

Response

Call record created

​
success
enum<boolean>
required
Available options:
true
​
call
object

A Call document. Many fields are provider-specific; clients should be tolerant of additional properties.

Example:
{
  "_id": "64f0a1b2c3d4e5f6a7b8cb00",
  "callId": "64f0a1b2c3d4e5f6a7b8cb00",
  "provider": "sinch",
  "providerCallId": "sinch-call-abc123",
  "direction": "outbound",
  "status": "completed",
  "from": "+14165550100",
  "to": "+14165550199",
  "contactId": "64f0a1b2c3d4e5f6a7b8c9d0",
  "conversationId": "64f0a1b2c3d4e5f6a7b8c9e0",
  "organizationId": "64f0a1b2c3d4e5f6a7b8c9d3",
  "userId": "64f0a1b2c3d4e5f6a7b8c9d4",
  "providerPhoneNumber": "+14165550100",
  "startTime": "2026-05-15T09:10:00.000Z",
  "answerTime": "2026-05-15T09:10:08.000Z",
  "endTime": "2026-05-15T09:12:34.000Z",
  "duration": 154,
  "recordings": [],
  "createdAt": "2026-05-15T09:10:00.000Z",
  "updatedAt": "2026-05-15T09:12:34.000Z"
}
​
message
string