For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SDKsHelp CenterLog inSign up
    • Overview
  • Getting Started
    • API Mechanics
    • Quickstart
  • Guides
    • Communications API
    • Troubleshooting
    • Events
    • Changelog
  • Comms API Reference
      • GETList Senders
      • GETFetch a Sender
      • POSTSearch Senders
      • POSTResolve Senders
LogoLogo
SDKsHelp CenterLog inSign up
Comms API ReferenceSenders

Resolve Senders

POST
https://comms.twilio.com/v1/Senders/Resolve
POST
/v1/Senders/Resolve
1import { TwilioClient } from "twilio-comms";
2
3async function main() {
4    const client = new TwilioClient({
5        accountId: "YOUR_ACCOUNTID_HERE",
6        authToken: "YOUR_AUTHTOKEN_HERE",
7    });
8    await client.senders.resolve({
9        senderPoolId: "comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
10        recipientAddresses: [
11            {
12                address: "+14155552671",
13                channel: "PHONE",
14            },
15            {
16                address: "+14155552671",
17                channel: "WHATSAPP",
18            },
19            {
20                address: "jane.doe@example.com",
21                channel: "EMAIL",
22            },
23        ],
24        channels: {
25            filterIn: [
26                "SMS",
27                "EMAIL",
28                "WHATSAPP",
29            ],
30            priority: [
31                {
32                    channel: "EMAIL",
33                    priority: 0,
34                },
35                {
36                    channel: "SMS",
37                    priority: 1,
38                },
39                {
40                    channel: "WHATSAPP",
41                    priority: 2,
42                },
43            ],
44        },
45    });
46}
47main();
1{
2  "results": [
3    {
4      "from": {
5        "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
6        "displayName": "Customer Support",
7        "channel": "EMAIL",
8        "address": "support@company.com"
9      },
10      "to": {
11        "address": "jane.doe@example.com",
12        "channel": "EMAIL"
13      },
14      "priority": 0
15    },
16    {
17      "from": {
18        "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
19        "displayName": "Customer Support",
20        "channel": "SMS",
21        "address": "+15035551234"
22      },
23      "to": {
24        "address": "+14155552671",
25        "channel": "PHONE"
26      },
27      "priority": 1
28    },
29    {
30      "from": {
31        "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
32        "displayName": "Customer Support",
33        "channel": "WHATSAPP",
34        "address": "+15035551234"
35      },
36      "to": {
37        "address": "+14155552671",
38        "channel": "WHATSAPP"
39      },
40      "priority": 2
41    }
42  ]
43}
This operation resolves a list of eligible Senders for sending and receiving communications for the given criteria.
Was this page helpful?
Previous

List SenderPools

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

OR
AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Request

This endpoint expects an object.
ResolveSendersFromSenderPoolRequestobjectRequired
OR
ResolveSendersFromAddressesRequestobjectRequired

Response

OK
resultslist of objects

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

Errors

400
Bad Request Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error