Get a single recipient's delivery state
Returns the current delivery state of a single recipient, including status, billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null).
GET
/
email_messages
/
{email_id}
/
recipients
/
{recipient_id}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const EmailRecipient = await client.emailMessages.recipients.retrieve('email_id', 'recipient_id');
console.log(EmailRecipient.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
)
email_recipient = client.email_messages.recipients.retrieve(
"email_id",
"recipient_id",
)
print(email_recipient.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"),
)
recipient, err := client.EmailMessages.Recipients.Get(
context.TODO(),
"email_id",
"recipient_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", recipient.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().recipients().retrieve("email_id", "recipient_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_recipient = telnyx.email_messages.recipients.retrieve("email_id", "recipient_id")
puts(email_recipient)<?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 {
$email_recipient = $client->emailMessages->recipients->retrieve(
'email_id',
'recipient_id',
);
var_dump($email_recipient);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-messages:recipients retrieve \
--api-key 'My API Key' \
--email-id email_id \
--recipient-id recipient_idcurl --request GET \
--url https://api.telnyx.com/v2/email_messages/{email_id}/recipients/{recipient_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "email_recipient",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "example@telnyx.com",
"kind": "to",
"status": "queued",
"billable": false,
"sent_at": "2024-01-23T18:10:02.574Z",
"delivered_at": "2024-01-23T18:10:02.574Z",
"failed_at": "2024-01-23T18:10:02.574Z",
"smtp_code": 0,
"smtp_response": "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.
Recipient UUID.
Response
Recipient delivery state.
Show child attributes
Show child attributes
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 EmailRecipient = await client.emailMessages.recipients.retrieve('email_id', 'recipient_id');
console.log(EmailRecipient.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
)
email_recipient = client.email_messages.recipients.retrieve(
"email_id",
"recipient_id",
)
print(email_recipient.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"),
)
recipient, err := client.EmailMessages.Recipients.Get(
context.TODO(),
"email_id",
"recipient_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", recipient.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().recipients().retrieve("email_id", "recipient_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_recipient = telnyx.email_messages.recipients.retrieve("email_id", "recipient_id")
puts(email_recipient)<?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 {
$email_recipient = $client->emailMessages->recipients->retrieve(
'email_id',
'recipient_id',
);
var_dump($email_recipient);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-messages:recipients retrieve \
--api-key 'My API Key' \
--email-id email_id \
--recipient-id recipient_idcurl --request GET \
--url https://api.telnyx.com/v2/email_messages/{email_id}/recipients/{recipient_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "email_recipient",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "example@telnyx.com",
"kind": "to",
"status": "queued",
"billable": false,
"sent_at": "2024-01-23T18:10:02.574Z",
"delivered_at": "2024-01-23T18:10:02.574Z",
"failed_at": "2024-01-23T18:10:02.574Z",
"smtp_code": 0,
"smtp_response": "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"
}
]
}