Call selected leads with an agent

POSThttps://server.heyrik.com/api/v1/leads/call

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 3

Fields documented for this operation. See the request example for placement and structure.

lead_idsarrayRequired

Leads to dial.

agency_idstringRequired

Agent that speaks.

trunk_idstringRequired

Number to dial from.

Response

No response example is documented for this operation yet.

Error reference

POST/leads/call

cURL

curl -X POST https://server.heyrik.com/api/v1/leads/call \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lead_ids": ["lead_71a4", "lead_8b02"],
    "agency_id": "agc_9f2a1c30",
    "trunk_id": "sip_45723ca5"
  }'

Illustrative examples · No live request is sent