Skip to main content

Calls & Telephony

Placing and managing live calls, phone-number inventory, Twilio provisioning, and the call terminal. All /api endpoints require a valid Bearer JWT and are scoped to the token's project_id.

Calls​

MethodPathDescription
POST/api/calls/initiateInitiate an outbound call.
POST/api/calls/{activity_id}/hangupHang up an in-progress call.
POST/api/manual-callInitiate a manual (agent-dialed) call.
POST/api/twilio-tokenMint a Twilio client token for browser calling.

Terminal​

MethodPathDescription
GET/api/terminal/calls/scheduledList scheduled calls.
GET/api/terminal/calls/ongoingList ongoing calls.
GET/api/terminal/calls/endedList ended calls.

Phone numbers​

MethodPathDescription
GET/api/phone-numbersList the project's phone numbers.
GET/api/phone-numbers/{id}Fetch a phone number.
POST/api/phone-numbersAdd a phone number.
PUT/api/phone-numbers/{id}Update a phone number.
DELETE/api/phone-numbers/{id}Remove a phone number.
POST/api/phone-numbers/bulkBulk-add phone numbers.

Twilio provisioning​

MethodPathDescription
POST/api/twilio/fetch-numbersFetch numbers from the connected Twilio account.
POST/api/twilio/available-numbersSearch Twilio for purchasable numbers.
POST/api/twilio/purchase-numberPurchase a Twilio number.
POST/api/twilio/release-numberRelease a Twilio number.
POST/api/twilio/provision-for-projectProvision Twilio resources for the project.
GET/api/twilio/addressesList Twilio regulatory addresses.
GET/api/twilio/bundlesList Twilio regulatory bundles.