Voice Gateway Events¶
During the call, the following voice events are recorded in the payload:
Event | Description |
---|---|
ANSWERING_MACHINE_DETECTION | The call was initiated and the answering machine detection process started. |
CALL_COMPLETED | The call was terminated by the AI Agent or by the user. |
CALL_CREATED | The user created a call. |
CALL_FAILED | The call was terminated. |
CALL_IN_PROGRESS | The call is in progress once the call has been successfully established. This event is only available, when the event is activated in the Voice Gateway Endpoint. |
CALL_RECONNECTED | The call was reconnected due to network problems. |
RECOGNIZED_SPEECH | The user's answer was recognized by the AI Agent. |
RECOGNIZED_DTMF | The DTMF code was recognized by the AI Agent. |
TRANSFER_DIAL_ERROR | The call transfer using the Dial method failed due to various reasons, like unreachable destination or network issues. |
TRANSFER_DIAL_SUCCESS | The call transfer using the Dial method succeeded with the new phone line established to the destination. |
TRANSFER_REFER_ERROR | The call transfer using the Refer method failed, possibly due to an unavailable or rejecting destination. |
TRANSFER_REFER_SUCCESS | The call transfer using the Refer method succeeded, with the call responsibility passed to another destination. |
USER_BUSY | The user (caller) was busy and unable to answer the call or engage in the desired action. |
USER_INPUT_TIMEOUT | The AI Agent terminated the call because the user did not respond. |
NO_ANSWER | The recipient of the call does not answer. |
You can collect event data for further analysis in Insights. To collect this data, you can access Voice Gateway events in the Output Transformer and the input.data.event
Input object, except for the CALL_COMPLETED
event. You can't access CALL_COMPLETED
in input.data.event
since the Input object's content is deleted after CALL_COMPLETED
occurs. Alternatively, you can register the CALL_COMPLETED
events by enabling the CALL_COMPLETED
toggle in the Call Events section of the Voice Gateway Endpoint configuration.
The Output Transformer is executed after processing the flow. For example, if you receive the CALL_COMPLETED
event, write some metrics in the transformer via HTTP request.
You can also use a Lookup Node with the Call Event Status type for reusing these events, streamlining call handling and improving efficiency.