Calls

Get the timeline of a call

What happened in one call: its legs (the caller, and every forward by the call plan to a number or to the app or web phone of a member), the events per leg in order (started, answered, ended), the outcome the way the portal says it (answered, missed, no_answer, voicemail, assistant, in_progress, failed) and who on your side picked up (answered_by). The id can be any leg of the call that GET /calls lists.

get/calls/{id}/events

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/calls/{id}/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: calls:read)

Path parameters

idstring uuid required

The id of the call.

Response

The timeline.

call_idstring uuid required

The call you asked for.

outcome'answered' | 'missed' | 'no_answer' | 'voicemail' | 'assistant' | 'in_progress' | 'failed' | 'unknown' required

How the call went, the same way the portal says it: answered, missed (inbound and nobody picked up), no_answer (outbound and nobody picked up), voicemail, assistant (the voice AI handled it), in_progress, failed or unknown.

Changes

No recorded changes to this operation across all 1 revision of this API.