CAcarecycle
Sandbox

Get live status of a sandbox test call

get/v2/sandbox/calls/{callId}/status

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/sandbox/calls/{callId}/status
  • Auth
    API key in header x-api-key

Path parameters

callIdstring uuid required

GET /v2/sandbox/calls/:callId/status Parameter

Response

GET /v2/sandbox/calls/:callId/status Positive response

status'pending' | 'dialing' | 'ringing' | 'connected' | 'completed' | 'failed' required
dispositionstring nullable required
endedReasonstring nullable required
answeredboolean required
durationMsnumber nullable required
failureDetailstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.