One lead with every call made to it

GEThttps://server.heyrik.com/api/v1/campaigns/{id}/contacts/{contactId}

Path parameters

idRequired

Replace {id} in the request URL with the value for this resource.

contactIdRequired

Replace {contactId} in the request URL with the value for this resource.

Headers

AuthorizationstringRequired

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

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 2 properties

contactobject

Explore 8 properties

idstring

Example "cct_9b1e"

phonestring

Example "+919876543210"

statusstring

Example "completed"

outcomestring

Example "completed"

attemptsnumber

Example 1

categorystring

Example "hot"

variablesobject

Explore 2 properties

namestring

Example "Ravi"

order_idstring

Example "AC-8842"

extractedobject

Explore 1 property

callback_requestedstring

Example "yes"

callsarray

Explore 1 example item

[0]object

Explore 7 properties

idstring

Example "call_8eab93e5"

directionstring

Example "outbound"

outcomestring

Example "completed"

duration_secnumber

Example 214

summarystring

Example "Ravi confirmed the order and asked for a callback on Monday."

recording_urlstring

Example "https://example.com/rec.mp3"

transcriptarray

Explore 1 example item

[0]object

Explore 2 properties

rolestring

Example "assistant"

contentstring

Example "Hi Ravi, this is Priya from Acme."

Error reference

GET/campaigns/{id}/contacts/{contactId}

cURL

curl https://server.heyrik.com/api/v1/campaigns/cmp_4a19/contacts/cct_9b1e \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "contact": {
      "id": "cct_9b1e", "phone": "+919876543210", "status": "completed",
      "outcome": "completed", "attempts": 1, "category": "hot",
      "variables": { "name": "Ravi", "order_id": "AC-8842" },
      "extracted": { "callback_requested": "yes" }
    },
    "calls": [
      {
        "id": "call_8eab93e5", "direction": "outbound", "outcome": "completed",
        "duration_sec": 214, "summary": "Ravi confirmed the order and asked for a callback on Monday.",
        "recording_url": "https://example.com/rec.mp3",
        "transcript": [ { "role": "assistant", "content": "Hi Ravi, this is Priya from Acme." } ]
      }
    ]
  }
}

Illustrative examples · No live request is sent