Every call record carries a status, a direction and a voicemail_left flag. Together they say how a call ended. This page lists the vocabulary, explains the one filter that matches what people mean by "missed", and shows how the portal labels each combination so your reports can say the same thing. F
Every call record says how the call ended in outcome, using the same taxonomy as the Analytics page. Read outcome together with direction: each direction has its own values.
direction | outcome | Meaning |
|---|---|---|
inbound | answered | A person answered. |
inbound | abandoned | The caller hung up before anyone answered: in a menu, while phones rang, or during a closed-hours announcement. |
inbound | system_ended | The system ended the call without a person or a mailbox: closed hours, a menu timeout, a routing failure. |
inbound | voicemail | The call reached a mailbox. |
outbound | connected | The called party answered. |
outbound | no_answer | Nobody answered. |
outbound | cancelled | The caller hung up before an answer. |
internal | answered | A person answered. |
internal | no_answer | Nobody answered. |
internal | cancelled | The caller hung up before an answer. |
internal | voicemail | The call reached a mailbox. |
internal is a call usually between two of your extensions; called says who it was for. A call from another account's phone is never internal: it is inbound for the account it reaches, from an outside party, with its real outcome, and the account that placed it has its own outbound record.
outcome is null only for a call the taxonomy does not classify (an outbound call that ended in a mailbox). Ignore a value you do not know. For requests, paging and errors, see Call history; every field is on List call records.
Filter with outcome (repeat it for several values) and direction:
curl -G https://api.emaktalk.com/api/v2/call_records \
-H "Authorization: Bearer $EMAK_API_KEY" \
--data-urlencode "direction=outbound" \
--data-urlencode "outcome=no_answer" \
--data-urlencode "outcome=cancelled"Missed calls: missed
missedmissed is the Missed group: an inbound call nobody answered, that is outcome abandoned, system_ended or voicemail. It is false for every outbound and internal call. To list missed calls, filter with missed=true rather than listing the outcomes yourself.
curl -G https://api.emaktalk.com/api/v2/call_records \
-H "Authorization: Bearer $EMAK_API_KEY" \
--data-urlencode "missed=true"Mailboxes: voicemail
voicemailvoicemail is set when the call reached a mailbox, in any direction, and null when it reached none.
| Field | Meaning |
|---|---|
left | Whether a message was left. A historical fact: it stays true after the message is deleted. |
mailbox | The mailbox the call reached (id, extension, name), or null when the record does not name it. |
The message itself is read in the voicemail app, not here. Filter with voicemail_left=true or false.
An extension's own outcome: extension_outcome
extension_outcomeWhen you filter by exactly one extension (by its number, alias, exact name or id), each row also carries extension_outcome: that extension's own outcome on the call. With no extension filter, or with several, it is absent.
| The call | extension_outcome |
|---|---|
| A call the extension placed | The call's outcome. |
| An inbound call it rang | answered (it answered), answered_by_colleague (someone else took the call; not missed for this extension), sent_to_voicemail, abandoned, system_ended, rejected (declined), busy, unreachable, forwarded (forwarding sent the call on), unclassified. |
| An inbound call it only received in its mailbox | voicemail. |
| An internal call it received | answered, answered_by_colleague (someone else took it, for example another ring-group member; not missed), voicemail (its mailbox got the call), missed (nobody answered). |
It is absent when it is not computed (an answered internal call whose answerer is not known). Ignore a value you do not know.
curl -G https://api.emaktalk.com/api/v2/call_records \
-H "Authorization: Bearer $EMAK_API_KEY" \
--data-urlencode "extension=101"Fax
A fax is not an outcome: it is a call with type: fax, carrying the outcome of its call like any other. Filter with type=fax, or type=voice to leave faxes out.