Events subresource

On this reference page, you'll learn about the properties and parameters of the Events subresource, which details requests sent by Twilio and the corresponding responses from your application. See Related how-to documentation to learn the steps to use the info on this page.

Events is a subresource of Calls. You can access the Call Event resource 15 minutes after a call ends.

Event Properties

Property nameTypeRequiredPIIDescriptionChild properties

endinteger

Optional

Not PII

firstPageUristring<uri>

Optional

Not PII

nextPageUristring<uri>

Optional

Not PII

pageinteger

Optional

Not PII

pageSizeinteger

Optional

Not PII

previousPageUristring<uri>

Optional

Not PII

startinteger

Optional

Not PII

uristring<uri>

Optional

Not PII

eventsarray[object]

Optional

Not PII

Show events properties

`request`

The request property represents the request that Twilio made to your application. It contains the url, method, and parameters.

(information)

Info

The parameters property keys are presented in snake_case format, lower cased and words separated by underscores.

For example, the results from your AddOns will be found under the key add_ons.

`response`

The response property represents what your application sent back to Twilio. It contains date_created, request_duration, response_code, content_type, and response_body.

You can use this information to ensure you are producing the intended Voice TwiML.

Retrieve a list of Events

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json

Path parameters

Property nameTypeRequiredPIIDescription

accountSidSID<AC>

required

Not PII

The unique SID identifier of the Account.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

callSidSID<CA>

required

Not PII

The unique SID identifier of the Call.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Retrieve a list of all events for a call

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listCallEvent() {
11  const events = await client
12    .calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .events.list({ limit: 20 });
14
15  events.forEach((e) => console.log(e.end));
16}
17
18listCallEvent();

Response

1{
2  "events": [
3    {
4      "request": {
5        "method": "POST",
6        "url": "https://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
7        "parameters": {
8          "status_callback_method": "POST",
9          "twiml": "<Response><Say>Hi!</Say></Response>",
10          "trim": "trim-silence",
11          "timeout": "55",
12          "method": "POST",
13          "from": "+987654321",
14          "to": "+123456789",
15          "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16          "machine_detection_timeout": "0"
17        }
18      },
19      "response": {
20        "response_code": 201,
21        "request_duration": 50,
22        "content_type": "application/json",
23        "response_body": "{\"sid\": \"CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}",
24        "date_created": "Tue, 11 Aug 2020 17:44:08 +0000"
25      }
26    }
27  ],
28  "end": 0,
29  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0",
30  "next_page_uri": null,
31  "page": 0,
32  "page_size": 50,
33  "previous_page_uri": null,
34  "start": 0,
35  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json?PageSize=50&Page=0"
36}