List events for an email message
Lists events for a single message sorted oldest first by occurred_at asc, id asc.
The legacy /v2/emails/{id}/events GET route is a backward-compatible alias.
GET
/
email_messages
/
{email_id}
/
events
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.emailMessages.retrieveEvents('email_id');
console.log(response.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.email_messages.retrieve_events(
"email_id",
)
print(response.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.EmailMessages.GetEvents(
context.TODO(),
"email_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailMessages().retrieveEvents("email_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.email_messages.retrieve_events("email_id")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->emailMessages->retrieveEvents(
'email_id',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-messages retrieve-events \
--api-key 'My API Key' \
--email-id email_idcurl --request GET \
--url https://api.telnyx.com/v2/email_messages/{email_id}/events \
--header 'Authorization: Bearer <token>'{
"data": [
{
"type": "queued",
"occurred_at": "2024-01-23T18:10:02.574Z"
}
],
"meta": {
"page_size": 1,
"page_cursor": "string"
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10001",
"title": "Not Found",
"detail": "The requested resource was not found"
}
]
}Authorizations
Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.
Path Parameters
Email message UUID.
Query Parameters
Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.
Required range:
1 <= x <= 100Opaque URL-safe Base64 cursor returned by a previous list response.
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.emailMessages.retrieveEvents('email_id');
console.log(response.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.email_messages.retrieve_events(
"email_id",
)
print(response.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.EmailMessages.GetEvents(
context.TODO(),
"email_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailMessages().retrieveEvents("email_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.email_messages.retrieve_events("email_id")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->emailMessages->retrieveEvents(
'email_id',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-messages retrieve-events \
--api-key 'My API Key' \
--email-id email_idcurl --request GET \
--url https://api.telnyx.com/v2/email_messages/{email_id}/events \
--header 'Authorization: Bearer <token>'{
"data": [
{
"type": "queued",
"occurred_at": "2024-01-23T18:10:02.574Z"
}
],
"meta": {
"page_size": 1,
"page_cursor": "string"
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10001",
"title": "Not Found",
"detail": "The requested resource was not found"
}
]
}