CredentialList Resource
The Credential Lists subresource represents the Credential List instances associated with this Trunk. If an INVITE
is received for a domain with a Credential List, Twilio will challenge the request. Your system will need to authenticate with a username and password. The username and password must be in one of the Credential Lists for the INVITE
to be accepted.
This API will only allow you to list, add, and remove the Credential Lists associated with your Trunk. To create, remove, or list the Credential Lists in your account, check out the Credential List reference docs.
Resource properties
sid
type: SID<CL>
The unique string that we created to identify the CredentialList resource.
Pattern:
^CL[0-9a-fA-F]{32}$
trunk_sid
type: SID<TK>
The SID of the Trunk the credential list in associated with.
Pattern:
^TK[0-9a-fA-F]{32}$
friendly_name
type: string
The string that you assigned to describe the resource.
date_created
type: string<date-time>
date_updated
type: string<date-time>
url
type: string<uri>
The absolute URL of the resource.
POST https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists
URI parameters
TrunkSid
type: SID<TK>
The SID of the Trunk to associate the credential list with.
Pattern:
^TK[0-9a-fA-F]{32}$
Request body parameters
CredentialListSid
type: SID<CL>Required
_13// Download the helper library from https://www.twilio.com/docs/node/install
_13// Find your Account SID and Auth Token at twilio.com/console
_13// and set the environment variables. See http://twil.io/secure
_13const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13const authToken = process.env.TWILIO_AUTH_TOKEN;
_13const client = require('twilio')(accountSid, authToken);
_13client.trunking.v1.trunks('TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13 credentialListSid: 'CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_13 .then(credential_list => console.log(credential_list.sid));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "trunk_sid": "TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2018-05-02T17:29:30Z",
_10 "date_updated": "2018-05-02T17:29:30Z",
_10 "friendly_name": "friendly_name",
_10 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists
URI parameters
TrunkSid
type: SID<TK>
The SID of the Trunk from which to read the credential lists.
Pattern:
^TK[0-9a-fA-F]{32}$
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_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);
_11client.trunking.v1.trunks('TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(credentialsLists => credentialsLists.forEach(c => console.log(c.sid)));
_22 "credential_lists": [
_22 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22 "trunk_sid": "TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22 "date_created": "2018-04-27T22:02:11Z",
_22 "date_updated": "2018-04-27T22:02:11Z",
_22 "friendly_name": "friendly_name",
_22 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22 "url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22 "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists?PageSize=50&Page=0",
_22 "previous_page_url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists?PageSize=50&Page=0",
_22 "url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists?PageSize=50&Page=0",
_22 "next_page_url": "https://trunking.twilio.com/v1/Trunks/TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/CredentialLists?PageSize=50&Page=1",
_22 "key": "credential_lists"
DELETE https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists/{Sid}
URI parameters
TrunkSid
type: SID<TK>
The SID of the Trunk from which to delete the credential list.
Pattern:
^TK[0-9a-fA-F]{32}$
Sid
type: SID<CL>
The unique string that we created to identify the CredentialList resource to delete.
Pattern:
^CL[0-9a-fA-F]{32}$
_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);
_10client.trunking.v1.trunks('TKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .credentialsLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')