Call Handle: Setup, Alert, Connect, and Disconnect Parameters

The following parameters are shared across the Setup, Alert, Connect, and Disconnect events.

Parameter Name Description
result 0 = Success; <0 = Error Code
result_desc Result description
service_name Service name
channel Channel ID within session
session_id Unique call session ID
call_status Call status value:
  • SETUP = Calling
  • ALERT = Alerting
  • CONNECT = Connected
  • DISCONNECT = Disconnected
calling_party Calling party number
called_party Called party number
redirecting_number Redirecting number
direction 0 = Inbound
1 = Outbound
reference_id Custom reference ID
call_setup_time Call setup time in YYYY-MM-DD hh:mm:ss format
(E.g. 2018-06-22 15:32:08}
call_alert_time Call alert time in YYYY-MM-DD hh:mm:ss format
(E.g. 2018-06-22 15:32:08)
call_connected_time Call connected time in YYYY-MM-DD hh:mm:ss format
(E.g. 2018-06-22 15:32:08)
call_disconnected_time Call disconnected time in YYYY-MM-DD hh:mm:ss format
(E.g. 2018-06-22 15:32:08)
gmt Time zone. For example, 8 for Singapore, 0 for London / GMT
call_cause SIP Status Code defined in RFC 3261 or refer to Call Status Code List
call_connected 1 = Call connected
0 = Call not connected
call_duration Call duration in seconds

Call Handle: DTMF Parameters

The table below lists DTMF parameters and their descriptions.

Parameter Value
service_name Service name
session_id Unique call session id
channel Channel ID within session
call_status Call Status Value:
DTMF = DTMF Input
number the number subscribed to this service
direction 0 = Inbound; 1 = Outbound
dtmf Collection of DTMF value, e.g. 0~9, *, #
referenceid Custom reference ID

Webhook Event Sample

The tabbed example below illustrates how one might implement a call flow for handling automated callbacks.

Handle Callback Event
Example use of Handle Callback

   Setup

Parameter Value
result 0
result_desc Ok
service_name PROGRAMMABLE_CALL
channel 0
session_id 123
call_status SETUP
calling_party 6531234567
called_party 6591234567
redirecting_number
direction 0
reference_id myrefid_123
call_setup_time 2018-06-22 13:28:00
call_alert_time 2018-06-22 13:28:00
call_connected_time
call_disconnected_time
gmt 8
call_cause
call_connected 0
call_duration 0