CustomerProfileChannelEndpointAssignment Resource

ChannelEndpointAssignment Properties

Property nameTypeRequiredPIIDescriptionChild properties

sidSID<RA>

Optional

Not PII

The unique string that we created to identify the Item Assignment resource.

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

customerProfileSidSID<BU>

Optional

Not PII

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

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

accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the Item Assignment resource.

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

channelEndpointTypestring

Optional

Not PII

The type of channel endpoint. eg: phone-number

channelEndpointSidSID

Optional

Not PII

The SID of an channel endpoint

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

dateCreatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

urlstring<uri>

Optional

Not PII

The absolute URL of the Identity resource.

Create a new Assigned Item

POST https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments

Path parameters

Property nameTypeRequiredPIIDescription

customerProfileSidSID<BU>

required

Not PII

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

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

channelEndpointTypestring

required

Not PII

The type of channel endpoint. eg: phone-number

channelEndpointSidSID

required

Not PII

The SID of an channel endpoint

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

Create a new Assigned Item

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createCustomerProfileChannelEndpointAssignment() {
14  const customerProfilesChannelEndpointAssignment = await client.trusthub.v1
15    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .customerProfilesChannelEndpointAssignment.create({
17      channelEndpointSid: "ccaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18      channelEndpointType: "ChannelEndpointType",
19    });
20
21  console.log(customerProfilesChannelEndpointAssignment.sid);
22}
23
24createCustomerProfileChannelEndpointAssignment();

Response

1{
2  "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "channel_endpoint_sid": "ccaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "channel_endpoint_type": "ChannelEndpointType",
7  "date_created": "2019-07-31T02:34:41Z",
8  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9}

Fetch specific Assigned Item Instance

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

customerProfileSidSID<BU>

required

Not PII

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

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

sidSID<RA>

required

Not PII

The unique string that we created to identify the resource.

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

Fetch specific Assigned Item Instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function fetchCustomerProfileChannelEndpointAssignment() {
14  const customerProfilesChannelEndpointAssignment = await client.trusthub.v1
15    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .customerProfilesChannelEndpointAssignment(
17      "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18    )
19    .fetch();
20
21  console.log(customerProfilesChannelEndpointAssignment.sid);
22}
23
24fetchCustomerProfileChannelEndpointAssignment();

Response

1{
2  "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "channel_endpoint_type": "phone-number",
7  "date_created": "2019-07-31T02:34:41Z",
8  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
9}

Retrieve a list of all Assigned Items for an account

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments

Path parameters

Property nameTypeRequiredPIIDescription

customerProfileSidSID<BU>

required

Not PII

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

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

Query parameters

Property nameTypeRequiredPIIDescription

channelEndpointSidSID

Optional

Not PII

The SID of an channel endpoint

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

channelEndpointSidsstring

Optional

Not PII

comma separated list of channel endpoint sids

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 all Assigned Items for an account

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listCustomerProfileChannelEndpointAssignment() {
14  const customerProfilesChannelEndpointAssignments = await client.trusthub.v1
15    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .customerProfilesChannelEndpointAssignment.list({ limit: 20 });
17
18  customerProfilesChannelEndpointAssignments.forEach((c) => console.log(c.sid));
19}
20
21listCustomerProfileChannelEndpointAssignment();

Response

1{
2  "results": [],
3  "meta": {
4    "page": 0,
5    "page_size": 50,
6    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0",
7    "previous_page_url": null,
8    "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0",
9    "next_page_url": null,
10    "key": "results"
11  }
12}

Remove an Assignment Item Instance

DELETE https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

customerProfileSidSID<BU>

required

Not PII

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

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

sidSID<RA>

required

Not PII

The unique string that we created to identify the resource.

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

Remove an Assignment Item Instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function deleteCustomerProfileChannelEndpointAssignment() {
14  await client.trusthub.v1
15    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .customerProfilesChannelEndpointAssignment(
17      "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18    )
19    .remove();
20}
21
22deleteCustomerProfileChannelEndpointAssignment();