Quickstart

This walks through the common path: add contacts to a list, create an SMS campaign against it, and start sending. Replace as_live_… with your key.

Add a contact to a list

Upsert contacts by phone. The list is created if it doesn’t exist; the response includes its list_id.

curl -X POST https://api.verbose.cx/v1/contacts \
  -H "Authorization: Bearer as_live_…" \
  -H "Content-Type: application/json" \
  -d '{"contacts":[{"phone":"+15551234567","first_name":"Jo"}],"list":"API leads"}'

{ "ok": true, "imported": 1, "skipped": 0, "list_id": "8f3c…" }

Find a sending number

List your numbers and grab an id to send from.

curl https://api.verbose.cx/v1/numbers \
  -H "Authorization: Bearer as_live_…"

Create the campaign

Pass the list_id and a number_id. The campaign is built but not yet sending.

curl -X POST https://api.verbose.cx/v1/campaigns \
  -H "Authorization: Bearer as_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome blast",
    "message": "Hi {{first_name}}, welcome! Reply STOP to opt out.",
    "list_id": "8f3c…",
    "number_id": "1a2b…"
  }'

{ "ok": true, "campaign": { "campaignId": "c_…", "audienceCount": 1, "status": "ready" } }

Start sending

curl -X POST https://api.verbose.cx/v1/campaigns/c_…/start \
  -H "Authorization: Bearer as_live_…"

Send a one-off SMS

Skip campaigns entirely for transactional messages:

curl -X POST https://api.verbose.cx/v1/messages \
  -H "Authorization: Bearer as_live_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+15551234567","body":"Your code is 4821."}'

Pick the sending number with from (a specific number), or let a pool rotate one for you with pool (a DID pool, by name or id). Omit both to use your workspace default pool.

curl -X POST https://api.verbose.cx/v1/messages \
  -H "Authorization: Bearer as_live_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+15551234567","body":"Your code is 4821.","pool":"Transactional"}'

Add a tracked link with destination_url — it’s shortened and click-tracked like a campaign link, and dropped into the message where you put {link} (or appended if you don’t). The response returns the short URL in link.short_url.

curl -X POST https://api.verbose.cx/v1/messages \
  -H "Authorization: Bearer as_live_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+15551234567","body":"Your order shipped! Track it: {link}","destination_url":"https://acme.com/track/order/abc123"}'

Create a voice agent + voice campaign

# 1. Pick a voice
curl https://api.verbose.cx/v1/voices -H "Authorization: Bearer as_live_…"

# 2. Create the agent
curl -X POST https://api.verbose.cx/v1/agents \
  -H "Authorization: Bearer as_live_…" -H "Content-Type: application/json" \
  -d '{"name":"Booking bot","channel":"voice","system_prompt":"You book callbacks for Acme.","greeting":"Hi, this is Acme!","voice_id":"voice_abc"}'

# 3. Create + start a voice campaign (number_id is the caller ID)
curl -X POST https://api.verbose.cx/v1/campaigns \
  -H "Authorization: Bearer as_live_…" -H "Content-Type: application/json" \
  -d '{"type":"voice","name":"Callbacks","list_id":"8f3c…","voice_agent_id":"ag_…","number_id":"1a2b…"}'

Campaign create/start and message send require the platform’s send infrastructure to be online. Reads (contacts, numbers, agents, campaigns) work on their own.

Get started

Guides

Send a one-off SMS

Create a voice agent + voice campaign