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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "jsmith@example.com",
"billable": true,
"sent_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"smtp_code": 123,
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "jsmith@example.com",
"billable": true,
"sent_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"smtp_code": 123,
"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"
}
]
}