Get a call by id

GET /calls/{id}

Get a call by id

cURL

curl --request GET \
  --url https://api.pineyard.ai/calls/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "referenceId": "<string>",
  "hasOpenIssue": true,
  "contactName": "<string>",
  "contactFields": {},
  "doNotCall": true,
  "doNotCallAt": "<string>",
  "dncSource": "<string>",
  "dncReason": "<string>",
  "agentId": "<string>",
  "agentName": "<string>",
  "source": "<string>",
  "campaignId": "<string>",
  "campaignName": "<string>",
  "campaignSource": "<string>",
  "apiDelivery": {
    "requestId": "<string>",
    "idempotencyKey": "<string>",
    "receivedAt": "<string>",
    "requestTruncated": true,
    "requestBody": null
  },
  "toNumber": "<string>",
  "fromNumber": "<string>",
  "status": "<string>",
  "disposition": "<string>",
  "answeredBy": "<string>",
  "endCallReason": "<string>",
  "hangupCause": "<string>",
  "hangupSource": "<string>",
  "billDurationSeconds": 123,
  "transferredAt": "<string>",
  "transferTarget": "<string>",
  "durationMs": 123,
  "queuedAt": "<string>",
  "initiatedAt": "<string>",
  "answeredAt": "<string>",
  "endedAt": "<string>",
  "transcriptLang": "<string>",
  "summary": "<string>",
  "hasRecording": true,
  "recordingUrl": "<string>",
  "recordingUrlExpires": "<string>",
  "errorMessage": "<string>",
  "creditsUsed": "<string>",
  "billingMode": "PER_60S",
  "pricePerMinuteSnapshotMicroRupees": "<string>",
  "billingIncrementSnapshotSeconds": 123,
  "billsecSeconds": 123,
  "attemptNumber": 123,
  "reengage": {
    "churnEnabled": true,
    "churnDepth": 123,
    "attemptCount": 123,
    "churnMaxAttempts": 123,
    "nextEligibleAt": "<string>",
    "contactStatus": "<string>"
  },
  "outcome": "<string>",
  "dialReason": "<string>",
  "history": [
    {
      "id": "<string>",
      "attemptNumber": 123,
      "dialReason": "<string>",
      "outcome": "<string>",
      "status": "<string>",
      "durationMs": 123,
      "queuedAt": "<string>",
      "campaignId": "<string>",
      "campaignName": "<string>",
      "hasRecording": true
    }
  ],
  "hiddenAt": "<string>",
  "hiddenRefundMicro": "<string>",
  "transcript": null,
  "transcriptTranslation": null,
  "extraction": null
}

Required scope: calls.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

id · string · required

referenceId · string | null · required

hasOpenIssue · boolean · required

contactName · string | null · required

contactFields · object | null · required

Show child attributes

doNotCall · boolean · required

doNotCallAt · string | null · required

dncSource · string | null · required

dncReason · string | null · required

agentId · string | null · required

agentName · string | null · required

source · string · required

campaignId · string | null · required

campaignName · string | null · required

campaignSource · string | null · required

apiDelivery · object | null · required

Show child attributes

toNumber · string · required

fromNumber · string · required

status · string · required

disposition · string | null · required

answeredBy · string | null · required

endCallReason · string | null · required

hangupCause · string | null · required

hangupSource · string | null · required

billDurationSeconds · number | null · required

transferredAt · string | null · required

transferTarget · string | null · required

durationMs · number | null · required

queuedAt · string · required

initiatedAt · string | null · required

answeredAt · string | null · required

endedAt · string | null · required

transcriptLang · string | null · required

summary · string | null · required

hasRecording · boolean · required

recordingUrl · string | null · required

recordingUrlExpires · string | null · required

errorMessage · string | null · required

creditsUsed · string · required

billingMode · enum<string> | null · required

Available options: PER_60S, PER_15S_AFTER_60S

pricePerMinuteSnapshotMicroRupees · string | null · required

billingIncrementSnapshotSeconds · integer | null · required

billsecSeconds · number | null · required

attemptNumber · number | null · required

reengage · object | null · required

Show child attributes

outcome · string | null · required

dialReason · string | null · required

history · object[] · required

Show child attributes

hiddenAt · string | null · required

hiddenRefundMicro · string | null · required

transcript · unknown

transcriptTranslation · unknown

extraction · unknown