On this page

CustomerProfileChannelEndpointAssignment Resource

CustomerProfileChannelEndpointAssignment Properties

Resource properties

sidtype: SID<RA>

Not PII

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

Pattern:

^RA[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

customer_profile_sidtype: SID<BU>

Not PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

account_sidtype: SID<AC>

Not PII

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

Pattern:

^AC[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

channel_endpoint_typetype: string

Not PII

The type of channel endpoint. eg: phone-number

channel_endpoint_sidtype: SID

Not PII

The SID of an channel endpoint

Pattern:

^[a-zA-Z]{2}[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

date_createdtype: string<date-time>

Not PII

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

urltype: string<uri>

Not PII

The absolute URL of the Identity resource.

Create a new Assigned Item.

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

Parameters

URI parameters

CustomerProfileSidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Request body parameters

ChannelEndpointTypetype: stringRequired

Not PII

The type of channel endpoint. eg: phone-number

ChannelEndpointSidtype: SIDRequired

Not PII

The SID of an channel endpoint

Pattern:

^[a-zA-Z]{2}[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Create a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_14// Download the helper library from https://www.twilio.com/docs/node/install
_14// Find your Account SID and Auth Token at twilio.com/console
_14// and set the environment variables. See http://twil.io/secure
_14const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14const authToken = process.env.TWILIO_AUTH_TOKEN;
_14const client = require('twilio')(accountSid, authToken);
_14
_14client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_14  .customerProfilesChannelEndpointAssignment
_14  .create({
_14     channelEndpointType: 'channel_endpoint_type',
_14     channelEndpointSid: 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_14   })
_14  .then(customer_profiles_channel_endpoint_assignment => console.log(customer_profiles_channel_endpoint_assignment.sid));

Output


_10{
_10  "sid": "RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "channel_endpoint_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "channel_endpoint_type": "phone-number",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments/RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10}

Fetch specific Assigned Item Instance.

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

Parameters

URI parameters

CustomerProfileSidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Sidtype: SID<RA>

Path ParameterNot PII

The unique string that we created to identify the resource.

Pattern:

^RA[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Fetch a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11  .customerProfilesChannelEndpointAssignment('RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11  .fetch()
_11  .then(customer_profiles_channel_endpoint_assignment => console.log(customer_profiles_channel_endpoint_assignment.sid));

Output


_10{
_10  "sid": "RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "channel_endpoint_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10  "channel_endpoint_type": "phone-number",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments/RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10}

Retrieve a list of all Assigned Items for an account.

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

Parameters

URI parameters

CustomerProfileSidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

ChannelEndpointSidtype: SID

Query ParameterNot PII

The SID of an channel endpoint

Pattern:

^[a-zA-Z]{2}[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

ChannelEndpointSidstype: string

Query ParameterNot PII

comma separated list of channel endpoint sids

PageSizetype: integer

Query ParameterNot PII

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

Minimum:

1

Pagetype: integer

Query ParameterNot PII

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

Minimum:

0

PageTokentype: string

Query ParameterNot PII

The page token. This is provided by the API.

List multiple CustomerProfileChannelEndpointAssignments

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11
_11client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11  .customerProfilesChannelEndpointAssignment
_11  .list({limit: 20})
_11  .then(customerProfilesChannelEndpointAssignment => customerProfilesChannelEndpointAssignment.forEach(c => console.log(c.sid)));

Output


_22{
_22  "results": [
_22    {
_22      "sid": "RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22      "customer_profile_sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22      "channel_endpoint_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22      "channel_endpoint_type": "phone-number",
_22      "date_created": "2019-07-31T02:34:41Z",
_22      "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments/RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22    }
_22  ],
_22  "meta": {
_22    "page": 0,
_22    "page_size": 50,
_22    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments?ChannelEndpointSid=PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_22    "previous_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments?ChannelEndpointSid=PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_22    "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments?ChannelEndpointSid=PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_22    "next_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments?ChannelEndpointSid=PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=1",
_22    "key": "results"
_22  }
_22}

Remove an Assignment Item Instance.

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

Parameters

URI parameters

CustomerProfileSidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Sidtype: SID<RA>

Path ParameterNot PII

The unique string that we created to identify the resource.

Pattern:

^RA[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Delete a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10  .customerProfilesChannelEndpointAssignment('RAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10  .remove();