Call a lead now
Calls the lead right away through the first running campaign it belongs to, using that campaign's agent and caller ID. The lead's do-not-call flag, the campaign's daily cap and your concurrent call limit still apply; each refusal has its own error code.
Calls the lead right away through the first running campaign it belongs to, using that campaign's agent and caller ID. The lead's do-not-call flag, the campaign's daily cap and your concurrent call limit still apply; each refusal has its own error code.
X-API-Key<token>Create in the console: Settings → API & webhooks.
lead_id*Lead IdLead ID.
OK
application/json- response
A call was handed to the carrier. Progress arrives on GET /calls/{callId} and webhooks.
call*The call that was placed.
sipResponse?|The carrier's answer to the dial request; fields vary by carrier.
success?SuccessAlways true on a 2xx response.
true[key: string]?anycurl -X POST 'https://api.callmitra.ai/api/v1/leads/string/call-now'{ "call": { "campaignId": "3f6c1b2a-7d4e-4a1b-9c2d-5e6f7a8b9c0d", "campaignName": "December renewals", "id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f", "leadId": "5d2f8a1e-3b4c-4d6e-9f0a-1b2c3d4e5f60", "leadName": "Asha Rao", "phoneNumber": "+919876543210", "phoneNumberId": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e", "status": "initiated" }, "success": true}Update an agent PATCH
Saves the change as the agent's draft; calls keep using the published version until you call publishAgent. Only the `config` keys you send change; a nested object you send (for example `script`) replaces the stored one. Bad values are refused with `parameter_invalid` naming the field.
Call a lead in a campaign now POST
Places the call immediately, outside the dial schedule, with the campaign's agent and numbers. Numbers on do-not-call are never dialed. To call any number without a campaign, use `POST /calls`.