Skip to main content
GET
Returns the current status of a call you started with Create outbound call. Once the status is final, the response also says when the call started and ended, and why it ended.

Which keys work

Use a clinic key from the clinic that owns the call, created by the clinic’s owner or by a Tenant Admin of your partner account. The clinic that owns the call is the one that owns the number you called from.
  • A partner key gets 401 with Organization ID not found in authorization, even if you started the call with it. Use a clinic key, or rely on the callback.
  • A clinic key created by anyone else gets 403 Insufficient permissions.

Headers

string
required
Bearer followed by a clinic API key, for example Bearer sk-....

Path parameters

string
required
The outboundCallId that Create outbound call returned.

Response

string
The call’s ID.
string
The ID of the person called, within this call. The same value Create outbound call returned.
string
Where the call stands:Once a status is final, it doesn’t change. See Statuses for how the end reason sets the status.
object | null
null until the status is final. Then an object with these fields, any of which can be null:
What callDetails holds depends on how the call ended:
  • The call connected (completed): all four fields are filled in.
  • Nobody answered, or the line was busy (no-answer, busy): startedAt and endedAt are the same moment, and duration is 0.
  • The call couldn’t be placed (failed in the first response): all four fields are null.

Checking the status

  • Poll this endpoint until the status is final, or use the callback and call this endpoint once to confirm the result.
  • Don’t poll faster than you need. Requests count toward your rate limit.
  • A call can occasionally stay calling and never reach a final status. If a call is still calling well after it should have ended, treat its result as unknown.

Errors

See Errors for the error format.