Quickstart
Create a key, start a campaign and read the results.
This walks through the shortest path to a real call: find an agent, give it a contact, dial, and read what happened.
Launching a campaign places real phone calls and uses your balance. Use your own number while you try this out.
Create an API key
In the dashboard, open Settings → API access and create a key with the agents:read,
calls:write, calls:dispatch and calls:read scopes. Copy it: it is shown only once.
Keep it in an environment variable rather than in your code:
export RESONERA_KEY="rsn_live_..."Pick an agent
List your agents and note the id of the one that should make the calls. To create one from
code instead, see Managing agents.
curl https://api.resonera.ai/agents \
-H "X-API-Key: $RESONERA_KEY"Create a campaign
Send the people to call. Put your own record id in extra; it comes back with every result.
curl -X POST https://api.resonera.ai/campaigns/json \
-H "X-API-Key: $RESONERA_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Quickstart",
"agent_id": "AGENT_ID",
"contacts": [
{"phone_number": "+919876543210", "name": "Asha", "extra": {"crm_id": "42"}}
]
}'The campaign is created as a draft. Nothing has been dialed yet.
Launch it
curl -X POST https://api.resonera.ai/campaigns/CAMPAIGN_ID/launch \
-H "X-API-Key: $RESONERA_KEY"Your phone rings within a few seconds.
Read the result
After the call ends, list the campaign's calls. Each one carries its outcome, summary and the
extra you sent.
curl "https://api.resonera.ai/calls?campaign_id=CAMPAIGN_ID" \
-H "X-API-Key: $RESONERA_KEY"For the full conversation, fetch one call: GET /calls/{call_id} returns the transcript.