Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
On this page
Looking for more inspiration?Visit the

Search Senders resource

Search for senders matching the specified address and channel.

Search Properties

search-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
idstring
required
Not PII

A reference to a Sender.

Example: comms_sender_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_sender_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
displayNamestring or null
required
Not PII

The name associated with the address inventory, such as phone number or email address.

This name might be visible to recipients in certain communications, such as Email, and helps identify the sender.

Note: To update this value, use the appropriate Twilio API for the inventory type. For example, for Senders with the channel email, update displayName using the EmailSenders API.

addressstring
required
Not PII

The Sender’s communication address within a channel, such as a phone number, email address, or device token.

channelenum<string>
required
Not PII

The medium which a unit of communication is transmitted through. These are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model, as well as the model for content of the atomic unit of communication itself.

Possible values:
SMSRCSEMAILWHATSAPPPUSH
statusenum<string>
required
Not PII

The status of a Sender. If a Sender is activated, it is available to send and receive communications. If a Sender is deactivated, it is not available to send or receive communications.

Possible values:
ACTIVATEDDEACTIVATED
tagsTags
required
Not PII

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid(link takes you to an external page). Specify variables with each recipient for personalization.

Max properties: 10
updatedAtstring<date-time>
required
Not PII
createdAtstring<date-time>
required
Not PII

Search Senders

search-senders page anchor

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

Search for senders matching the specified address and channel.

Request body parameters

request-body-parameters page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
addressstring
required
Not PII

The Sender’s communication address within a channel, such as a phone number, email address, or device token.

channelenum<string>
required
Not PII

The medium which a unit of communication is transmitted through. These are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model, as well as the model for content of the atomic unit of communication itself.

Possible values:
SMSRCSEMAILWHATSAPPPUSH
statusenum<string>

Optional

Not PII

The status of a Sender. If a Sender is activated, it is available to send and receive communications. If a Sender is deactivated, it is not available to send or receive communications.

Possible values:
ACTIVATEDDEACTIVATED
pageTokenstring

Optional

Not PII

A page token that represents the start sender of a page

pageSizeinteger

Optional

Not PII

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

Default: 50Example: 50Minimum: 1Maximum: 1000

Responses

responses page anchor
200400404409429500503

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
sendersarray

Optional

paginationPaginationMetadata

Optional

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.
Search SendersLink to code sample: Search Senders
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senders.search({

9
        address: "+14153902337",

10
        channel: "SMS",

11
    });

12
}

13
main();