List Senders in a SenderPool

import { TwilioClient } from "twilio-comms";
async function main() {
    const client = new TwilioClient({
        accountId: "YOUR_ACCOUNTID_HERE",
        authToken: "YOUR_AUTHTOKEN_HERE",
    });
    await client.senderPools.listSenders("senderPoolId", {});
}
main();

{
  "senders": [
    {
      "id": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
      "displayName": "Cool Support",
      "address": "support@example.com",
      "channel": "EMAIL",
      "status": "ACTIVATED",
      "tags": {},
      "updatedAt": "2023-09-13T12:00:24Z",
      "createdAt": "2022-08-24T14:15:22Z"
    },
    {
      "id": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
      "displayName": "Cool Support",
      "address": "+14153902337",
      "channel": "SMS",
      "status": "DEACTIVATED",
      "tags": {},
      "updatedAt": "2023-09-13T12:00:24Z",
      "createdAt": "2022-08-24T14:15:22Z"
    },
    {
      "id": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
      "displayName": "limonade_app",
      "address": "limonade_app",
      "channel": "PUSH",
      "status": "ACTIVATED",
      "tags": {},
      "updatedAt": "2023-09-13T12:00:24Z",
      "createdAt": "2022-08-24T14:15:22Z"
    },
    {
      "id": "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
      "displayName": "limonade_eats_app",
      "address": "limonade_eats_app",
      "channel": "PUSH",
      "status": "ACTIVATED",
      "tags": {},
      "updatedAt": "2023-09-13T12:00:24Z",
      "createdAt": "2022-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "next": null,
    "self": "eyJTSyI6IkEjMDFqbmVoYm5xYWZmNDlrazUxZHA1bmN5bXciLCJTSzEiOiJBI2FjdGl2YXRlZCMyMDI1LTAzLTAzVDE3OjM3OjQ3WiMwMWpuZWhibnFhZmY0OWtrNTFkcDVuY3ltdyIsIlBLIjoiQyNBQzYwMzg4ODJiZDY5ZWIyNGM4YzU4ZGI5NjE4NjE3OTE4I0EifQ=="
  }
}

This operation fetches a paginated list of Senders that belong to a SenderPool.

Authentication

AuthorizationBasic

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

AuthorizationBasic

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

Path parameters

senderPoolIdstringRequired

Query parameters

channelenumOptional

Filter to Senders that match a specific channel.

Allowed values:

statusenumOptional

Filter to Senders with the specified status.

Allowed values:

startDatestringOptionalformat: "date-time"

Filter to Senders created after the specified date and time in ISO 8601 format.

endDatestringOptionalformat: "date-time"

Filter to Senders created before the specified date and time in ISO 8601 format.

pageTokenstringOptional

A page token that represents the start Sender of a page

pageSizeintegerOptional1-1000Defaults to 50

Total number of items returned in a single page, the minimum is 1 and maximum is 1000. Default is 50.

Response

senderslist of objects

A list of Senders that belong to the SenderPool.

paginationobject

Metadata for paginated results. This object contains two tokens to navigate through paginated results.

Use next to retrieve the ‘next’ page in the result list.
Use self to retrieve the same page of the result list again.
Supply the token in the pageToken query param.

Errors

400

Bad Request Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error