Reference

Numbers and merchants

Manage outbound phone numbers, merchant records, and phone number blacklists.

Outbound numbers

Outbound numbers are the caller IDs used when placing calls. Each number is associated with a telephony provider and has a status indicating availability.

OutboundNumber Fields

Field	Type	Description
`phone_number`	`string`	E.164 formatted phone number.
`provider`	`string`	Telephony provider: `TWILIO`, `EXOTEL`, or `PLIVO`.
`status`	`string`	Current status: `AVAILABLE`, `IN_USE`, or `DISABLED`.
`channel`	`string`	Channel type (e.g. `voice`).

Create Number

POST /numbers Register a new outbound number.

json

{
  "phone_number": "+14155551234",
  "provider": "TWILIO",
  "status": "AVAILABLE",
  "channel": "voice"
}

List Numbers

GET /numbers List all outbound numbers.

Update Number

PUT /numbers/{id} Update an outbound number.

Delete Number

DELETE /numbers/{id} Delete an outbound number.

In-Use Numbers

Numbers with status IN_USE are currently assigned to active call sessions. Avoid deleting or disabling them mid-call.

Merchants

Merchants represent business entities under a reseller. Templates and leads are scoped to a merchant.

Create Merchant

POST /merchants Create a new merchant.

json

{
  "name": "Acme Corp",
  "reseller_id": "res_001",
  "contact_email": "ops@acme.com"
}

List Merchants

GET /merchants List all merchants.

Update Merchant

PUT /merchants/{id} Update a merchant.

Delete Merchant

DELETE /merchants/{id} Delete a merchant.

Blacklist

The blacklist prevents outbound calls to specific phone numbers. When enforce_blacklist is enabled on a call execution configuration, any lead with a blacklisted number is automatically skipped.

Add to Blacklist

POST /blacklist Add phone numbers to the blacklist.

json

{
  "phone_numbers": ["+919876543210", "+14155559999"]
}

List Blacklisted Numbers

GET /blacklist List all blacklisted numbers.

Remove from Blacklist

DELETE /blacklist Remove phone numbers from the blacklist.

json

{
  "phone_numbers": ["+919876543210"]
}

Error responses

Status	Meaning	Common Cause
`400`	Bad Request	Invalid phone number format or missing required fields.
`404`	Not Found	Resource ID does not exist.
`409`	Conflict	Phone number already exists.

Was this helpful?

Edit on GitHub