Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

ChannelSenders subresource

(new)

Public Beta

The Services resource is currently available as a Public Beta product. This means that some features for configuring your Messaging Service via the REST API are not yet implemented, and others may be changed before the product is declared Generally Available. Messaging Service Configuration through the Twilio Console(link takes you to an external page) is Generally Available.

Public Beta products are not covered by a Twilio SLA(link takes you to an external page).

The resources for sending Messages with a Messaging Service are Generally Available.

ChannelSenders is subresource of Services and represents a channel sender that is associated with a Messaging Service, such as WhatsApp.

When sending a message with your Messaging Service to a channel destination, Twilio will select a channel sender of that corresponding channel from the service for delivery.

See Twilio Channels: A New Way Reach Customers in Apps They Already Use(link takes you to an external page) for more information on Twilio Channels.

ChannelSender Properties

channelsender-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the ChannelSender resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
messagingServiceSidSID<MG>

Optional

Not PII

The SID of the Service the resource is associated with.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34
sidSID<XE>

Optional

Not PII

The unique string that we created to identify the ChannelSender resource.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34
senderstring

Optional

Not PII

The unique string that identifies the sender e.g whatsapp:+123456XXXX.

senderTypestring

Optional

Not PII

A string value that identifies the sender type e.g WhatsApp, Messenger.

countryCodestring

Optional

Not PII

The 2-character ISO Country Code(link takes you to an external page) of the number.

dateCreatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.

dateUpdatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.

urlstring<uri>

Optional

Not PII

The absolute URL of the ChannelSender resource.

Create a ChannelSender

create-a-channelsender page anchor

POST https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/ChannelSenders

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
messagingServiceSidSID<MG>
required
Not PII

The SID of the Service to create the resource under.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
sidSID<XE>
required
Not PII

The SID of the Channel Sender being added to the Service.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34
Create a ChannelSender for a Messaging ServiceLink to code sample: Create a ChannelSender for a Messaging Service
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function createChannelSender() {

14
  const channelSender = await client.messaging.v1

15
    .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .channelSenders.create({ sid: "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" });

17


18
  console.log(channelSender.accountSid);

19
}

20


21
createChannelSender();

Response

Note about this response
1
{

2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "sender": "whatsapp:+12487960483",

6
  "sender_type": "WhatsApp",

7
  "country_code": "US",

8
  "date_created": "2023-07-30T20:12:31Z",

9
  "date_updated": "2023-07-30T20:12:33Z",

10
  "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
}

Retrieve a ChannelSender

retrieve-a-channelsender page anchor

GET https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
messagingServiceSidSID<MG>
required
Not PII

The SID of the Service to fetch the resource from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34
sidstring
required
Not PII

The SID of the ChannelSender resource to fetch.

Retrieve a ChannelSender from a Messaging ServiceLink to code sample: Retrieve a ChannelSender from a Messaging Service
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function fetchChannelSender() {

14
  const channelSender = await client.messaging.v1

15
    .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .channelSenders("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

17
    .fetch();

18


19
  console.log(channelSender.accountSid);

20
}

21


22
fetchChannelSender();

Response

Note about this response
1
{

2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "sender": "whatsapp:+12487960483",

6
  "sender_type": "WhatsApp",

7
  "country_code": "US",

8
  "date_created": "2023-07-30T20:12:31Z",

9
  "date_updated": "2023-07-30T20:12:33Z",

10
  "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
}

Retrieve a list of ChannelSenders

retrieve-a-list-of-channelsenders page anchor

GET https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/ChannelSenders

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
messagingServiceSidSID<MG>
required
Not PII

The SID of the Service to read the resources from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
pageSizeinteger<int64>

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Retrieve a list of ChannelSenders from a Messaging ServiceLink to code sample: Retrieve a list of ChannelSenders from a Messaging Service
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listChannelSender() {

14
  const channelSenders = await client.messaging.v1

15
    .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .channelSenders.list({ limit: 20 });

17


18
  channelSenders.forEach((c) => console.log(c.accountSid));

19
}

20


21
listChannelSender();

Response

Note about this response
1
{

2
  "meta": {

3
    "page": 0,

4
    "page_size": 20,

5
    "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0",

6
    "previous_page_url": null,

7
    "next_page_url": null,

8
    "key": "senders",

9
    "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0"

10
  },

11
  "senders": [

12
    {

13
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

14
      "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
      "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

16
      "sender": "whatsapp:+12487960483",

17
      "sender_type": "WhatsApp",

18
      "country_code": "US",

19
      "date_created": "2023-07-30T20:12:31Z",

20
      "date_updated": "2023-07-30T20:12:33Z",

21
      "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

22
    },

23
    {

24
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

25
      "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

26
      "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",

27
      "sender": "messenger:104794531907950",

28
      "sender_type": "Messenger",

29
      "country_code": "US",

30
      "date_created": "2023-07-30T20:12:31Z",

31
      "date_updated": "2023-07-30T20:12:33Z",

32
      "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"

33
    },

34
    {

35
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

36
      "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

37
      "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",

38
      "sender": "rcs:ms_dev_ttatqler_agent",

39
      "sender_type": "RCS",

40
      "country_code": "US",

41
      "date_created": "2023-07-30T20:12:31Z",

42
      "date_updated": "2023-07-30T20:12:33Z",

43
      "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac"

44
    }

45
  ]

46
}

Delete a ChannelSender

delete-a-channelsender page anchor

DELETE https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}

Returns "204 NO CONTENT" if the channel sender was successfully removed from the Service.

Path parameters

path-parameters-3 page anchor
Property nameTypeRequiredPIIDescription
messagingServiceSidSID<MG>
required
Not PII

The SID of the Service to delete the resource from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34
sidstring
required
Not PII

The SID of the Channel Sender resource to delete.

Remove a ChannelSender from a Messaging ServiceLink to code sample: Remove a ChannelSender from a Messaging Service
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function deleteChannelSender() {

14
  await client.messaging.v1

15
    .services("MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .channelSenders("XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

17
    .remove();

18
}

19


20
deleteChannelSender();