EVENTS

Events list

"START"

For each call there will be very first event called "START" and the last event called "COMPLETED". These events will be always no matter what is happening with the call. Between them there may be other events or there may be absolutely no events in some cases (for example, if SIP started the call and immediately cancelled his call, so system failed to pass to next relevant event). In short those two events shows that somebody started/finished a call session. The call itself is charaterized by other events (RING, RINGRESULT, READY, JOIN, LEAVE). Read more about attributes.

Outgoing call example
"START" event data example

"RING"

Dialing started. This event will trigger when an incoming call is ringing on any phone number in your TelTel account. This event will also trigger when an outgoing call from your TelTel account is ringing its destination. There may be scenario when multiple RING events are triggered one after another. This may be the case if you let multiple numbers ring simultaneously (it depends on your call flow configuration or autodialer settings). Read more about attributes.

Autodialer call example (ring to multiple operators in parallel)
"RING" event data example

"RINGRESULT"

Dialing ended. This event will trigger when dialing for incoming call is ended on any phone number in your TelTel account. This event will also trigger when dialing for outgoing call is ended from your TelTel account to its destination. Dialing result is indicated in attribute "state". Possible "state" values are ANSWER, BUSY, CANCEL, ABORT and NOANSWER. Read more about attributes.

Incoming call example
"RINGRESULT" event data example

"READY"

This event indicates that communication path is established between the endpoint (SIP or phone) and system (PBX). In simple words it means that SIP or phone is ready to JOIN the conversation (talk) if there is someone who is ready to do the same. In case of autodialer the system can add the party to conversation automatically, even if there is no one who is ready to JOIN a conversation. An example below shows an incoming call and that the phone is ready to JOIN the conversation, but it did not happen because there is just a "playaudio" element in a call flow scheme. After all the party just listened the audio and did not joined the conversation. Read more about attributes.

Incoming call example
"READY" event data example

"JOIN"

Join event will trigger if the party joined the conversation. If you see two JOIN events it means that two parties are in talk with each other. In a case of autodialer the system can add the party to conversation automatically, even if there is no one who is ready to JOIN a conversation. In that case there will be only one party in the conversation and that party will hear the silence until someone else joins the conversation. Read more about attributes.

Outgoing call example
"JOIN" event data example

"LEAVE"

Leave event will trigger if the party left the conversation. If you see two LEAVE events it means that two parties ended the coversation. The very last event "COMPLETED" will show which party was the first who initiated the end of the conversation. Read more about attributes.

Outgoing call example
"LEAVE" event data example

"COMPLETED"

This event indicates that the call session has been ended. The attributes of this event shows useful information about the call. For example, attributes hanged_by and hanged_value shows which party initiated hangup. Attribute is_answered shows whether the call has been answered or not. Attribute audio_url shows the URL to recorded audio if call has been answered. Read more about attributes.

Outgoing call example
"COMPLETED" event data example

Event attributes


General attributes

id
Unique identifier of event.
timestamp
Timestamp in UTC.
accountcode
Account identifier. If you have more than one account in TelTel than this attribute is useful to identify with which account the event is associated.
session_id
Unique identifier of session.
call_id
Unique identifier of call.
direction
Direction of the call.
inbound - incoming call
outbound - outgoing call
type
Type of the call.
standard - standard call
autodialer - call initiated by autodialer
callback - call initiated by callback method vai API (basically used for Click2Call feature)
transfer - transferred call
subtype
Sub-type of the call.
predictive - call initiated by predictive autodialer
contact-callflow - call initiated by contact to callflow autodialer
operator-contact - call initiated by agent to contact autodialer
phase
A call can consist of one phase or several phases that differ from each other in the type of parties involved. This attribute describes which two parties interact in a particular event and who acts as a source (initiator) and who as a destination. The possible types of parties are did (i.e. phone), sip (i.e. SIP device) and local (i.e. system).
localtosip - source (initiator) is system and destination is SIP
localtodid - source (initiator) is system and destination is phone
siptodid - source (initiator) is SIP and destination is phone
didtodid - source (initiator) is phone and destination is phone
didtosip - source (initiator) is phone and destination is SIP
participants
Number of total participants who have already joined the conversation at the time of the event.

"callback" and "autodialer" specific attributes

leg
This attribute is visible in a calls with type = 'callback' or type = 'autodialer'. In those type of calls the system tries to reach the first party for example contact (phone) and if this is reached then system tries to reach the second party - operator (SIP). If both are reached then system connects them together for conversation. Attribute "leg" indicates the type of party with which the system interacts in the given event.
contact - indicates that current event is associated with contact (phone)
operator - indicates that current event is associated with operator (SIP)

"RINGRESULT" specific attributes

state
This attribute is always in the event "RINGRESULT". It indicates the result of the event "RING".
ANSWER - Call is answered. A successful dial. The caller reached the callee.
BUSY - Busy signal. The dial command reached its number but the number is busy.
NOANSWER - No answer. The dial command reached its number, the number rang for too long, then the dial timed out.
CANCEL - Call is cancelled. The dial command reached its number but the caller hung up before the callee picked up.
CONGESTION - This status is usually a sign that the dialled number is not recognised.
CHANUNAVAIL - Channel unavailable. On SIP, peer may not be registered.
DONTCALL - Privacy mode, callee rejected the call.
TORTURE - Privacy mode, callee chose to send caller to torture menu.
INVALIDARGS - Error parsing Dial command arguments.

"READY", "JOIN" and "LEAVE" specific attributes

subject_type
This attribute is always and only in the events "READY", "JOIN" and "LEAVE".
It indicates the type of party to which the specific event relates.
phone - phone
sip - SIP device
subject
This attribute is always and only in the events "READY", "JOIN" and "LEAVE".
It indicates the number (SIP device, phone) of party to which the specific event relates.
subject_user
This attribute is always and only in the events "READY", "JOIN" and "LEAVE" and only if subject_type = "sip".
It indicates the user ID to which the SIP device is assigned.

Data attributes

data
This attribute can be added to event to provide any additional information. This attribute may contain the following sub-keys:
campaign_id
This attribute is added when call type = "autodialer". It shows autodialer campaign ID.
contact_id
This attribute is visible when call type = "autodialer". It shows autodialer contact ID.
callback
This attribute is added when call type = "callback". It contains five attributes which shows how callback should work. This attribute consists of the following sub-keys:
leg_1_phone_number
Number of the first leg.
leg_1_caller_id
Caller ID to show for the first leg.
leg_2_phone_number
Number of the second leg.
leg_2_caller_id
Caller ID to show for the second leg.
trace_id
You can specify this attribute in your API request and then it will be shown in event. It is usefull for tracing.

"COMPLETED" specific attributes

hanged_by
This attribute is always and only in the event "COMPLETED".
It indicates the type of party who initiated hangup.
phone - phone
sip - SIP device
hanged_value
This attribute is always and only in the event "COMPLETED".
It indicates the number (SIP device, phone) of party who initiated hangup.
hanged_user
This attribute is always and only in the event "COMPLETED" and only if hanged_by = "sip".
It indicates the user ID to which the SIP device is assigned.
is_answered
Indicates whether call has been answered or not.
audio_url
If call has been answered then this attribute shows the URL to recorded audio.