GET — Get Events for a Leg

12 min

Description

Retrieve all external events generated for a specific Leg, including lifecycle events and action-level events.

This API is useful for debugging, auditing, and reconstructing the event timeline for a leg.

Method

GET

Endpoint

/v2/accounts/{AccountSID}/legs/{LegSID}/external_events

Full URL

https://cpaas-api.in.exotel.com/v2/accounts/{AccountSID}/legs/{LegSID}/external_events

Authentication

Use Basic Authentication.

Authorization: Basic <BASE64_APIKEY_APITOKEN>

API credentials can be found in my.exotel.com → Developer Settings.

Request Query Parameters

Parameter Name	Mandatory / Optional	Type	Description
event_name	Optional	String	Filters events by a specific event name (e.g., leg_answered, recording_started)

Sample Request

GET /v2/accounts/{AccountSID}/legs/{LegSID}/external_events

Sample Request with Filter

GET /v2/accounts/{AccountSID}/legs/{LegSID}/external_events?event_name=leg_answered

Response

Response Parameters

Parameter Name	Type	Description
sid	string	Unique SID of the leg
event_type	string	Type of event (leg_action_event, leg_lifecycle_event)
account_sid	string	Account SID associated with the leg
external_events	array	List of external event objects

External Event Object

Each item in external_events contains:

Field	Type	Description
endpoint_response	boolean	Whether the event was successfully delivered
error	string	Error message, if delivery failed
date_created	string (ISO-8601)	Event creation timestamp
date_updated	string (ISO-8601)	Event update timestamp
event_info	object	Detailed event metadata

Event Info Object

Field	Type	Description
event_sid	string	Unique SID of the event
event_type	string	Event type (leg_action_event, leg_lifecycle_event)
event_name	string	Name of the event
event_timestamp	object	Timestamp when the event occurred
action_sid	string	Associated action SID
action_custom_parameter	string	Custom parameter passed during action execution
data	object	Event-specific payload

Sample Response

{ "request_id": "ce7b872225b348f09e80115c1ff569a3", "method": "GET", "http_code": 202, "response": { "error_data": null, "data": { "sid": "2q47dakkScvff1IbPdpp7KJSe6j00000", "event_type": "leg_lifecycle_event", "account_sid": "sprinklr2m", "external_events": [ { "endpoint_response": true, "error": "", "date_created": "2024-12-11T09:41:21.98089381Z", "date_updated": "2024-12-11T09:41:22.186124012Z", "event_info": { "event_sid": "2q47dipYPQbEnwgEnNWxrTB6YWb00000", "event_type": "leg_lifecycle_event", "event_name": "channel_created", "event_timestamp": { "seconds": 1733148727, "nanos": 963868626 }, "action_sid": "2pfEO9kg9YCqUJlbGHjYH2GaJa400000", "action_custom_parameter": "START_UNI_STREAM_ACTION_CUSTOM_PARAM", "data": { "account_sid": "sprinklr2m", "caller_id": "08030752501", "contact_uri": "09163816622", "custom_param": "abc", "date_created": "2024-12-11T09:41:21.98089381Z", "date_updated": "2024-12-11T09:41:22.186124012Z", "dc_code": "101", "direction": "outbound", "exophone": "08030752400", "leg_sid": "2q47dakkScvff1IbPdpp7KJSe6j00000", "network_type": "pstn", "nso_code": "a8140aaa-ce40-11ed-9a09-0242ac110003", "start_time": "2024-12-11T09:41:22.186124012Z", "state": "created", "time_limit": 14400 } } } ] } } }

Notes for Developers

Events are returned in chronological order

This API is read-only and does not affect leg execution

Useful for:

Debugging failed actions

Verifying event delivery

Building event-replay or analytics pipelines