Resolve Senders resource

Resolve senders for a list of recipient addresses and channels.

Resolve Properties

Property nameTypeRequiredPIIDescriptionChild properties

fromResolveSendersResponsePairFrom

required

Not PII

The Sender that is eligible to communicate with the recipient endpoint in the to field.

Show from properties

toResolveSendersResponsePairTo

required

Not PII

The recipient endpoint that is reachable by the Sender in the from field.

Show to properties

priorityinteger

required

Not PII

The priority of the result pair, the lower the value, the more preferred the result. This is useful when there are multiple viable options to reach the intended recipient.

Resolve Senders

POST https://comms.twilio.com/v1/Senders/Resolve

Resolve senders for a list of recipient addresses and channels.

Request body parameters

Encoding type:application/json

SchemaExample

Select from possible schemas

Property nameTypeRequiredPIIDescriptionChild properties

senderPoolIdstring

Optional

Not PII

A reference to a SenderPool.

Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}

recipientAddressesarray[CommunicationRecipient]

required

Not PII

A collection of addresses for a single human used to resolve Senders.

Min items: 1Max items: 100

Show recipientAddresses properties

channelsSenderChannelControl

Optional

Not PII

Define controls to filter and prioritize Senders based on their channel.

Show channels properties

Responses

200400409429500503

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultsarray[ResolveSendersResponseResult]

Optional

An array of compatible Sender-Recipient pairs to communicate from and to. Limited to the top 10 highest priority results.

Show results properties

This error indicates that the request content was malformed or ambiguous.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[TwilioError]

Optional

A list of one or more Twilio API errors.

Show errors properties

This error indicates a request conflict with the current state of the target resource. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[TwilioError]

Optional

A list of one or more Twilio API errors.

Show errors properties

This error indicates that you have sent too many requests to the API. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[TwilioError]

Optional

A list of one or more Twilio API errors.

Show errors properties

This error indicates that the Twilio API is experiencing server-side issues. The request should not be retried.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[TwilioError]

Optional

A list of one or more Twilio API errors.

Show errors properties

This error indicates that the Twilio API is temporarily unavailable. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[TwilioError]

Optional

A list of one or more Twilio API errors.

Show errors properties

Resolve Senders

1import { TwilioClient } from "twilio-comms";
2
3async function main() {
4    const client = new TwilioClient({
5        accountId: "TWILIO_ACCOUNT_SID",
6        authToken: "TWILIO_AUTH_TOKEN",
7    });
8    await client.senders.resolve({
9        recipientAddresses: [
10            {
11                address: "+14153902337",
12                channel: "PHONE",
13            },
14            {
15                address: "+14153902337",
16                channel: "WHATSAPP",
17            },
18            {
19                address: "davidpletnjov@example.com",
20                channel: "EMAIL",
21            },
22        ],
23    });
24}
25main();