Skip to main content

Who is calling: screen-pop

The number can be in any form: national (0412 345 678) or international (+61412345678). The response contains:
  • the contact, including your external_ref;
  • their open tickets;
  • the last five conversation summaries;
  • the last call.
An unknown number returns 404. Pair it with the call.ringing or call.answered webhook to pop the record as the phone rings.

Keep contacts in step with your CRM

Use your own id for the contact in the URL:
  • Already known by that reference: it’s updated, and attributes merge into the ones it has.
  • New reference, but someone already has the number: that contact takes the reference, so nothing is duplicated.
  • Otherwise: it’s created (201), and contact.created is sent.
  • A number that belongs to a contact with a different reference is refused with 409.

Export calls

  • Formats: CSV with a header row, or format=ndjson for one JSON object per line.
  • At most 31 days per request, streamed oldest first.
  • Columns:
    • the call: call_uuid, direction, the numbers, started_at, answered_at, ended_at, duration_sec, billsec, hangup_cause;
    • who handled it: agent, extension and team;
    • links: contact_id, campaign_id and your reference;
    • whether it was recorded;
    • the charge (sell_amount), which is empty unless the key may see billing.
  • Scope: narrowed like the call list, so a supervisor’s key gets their teams’ calls.