SIP CredentialList Resource
SIP CredentialList resources contain the credentials of the users who are allowed to reach your SIP Domain. We only allow traffic from users who have their credentials in the credential list.
For information about the individual Credential resources in the list, such as to create, list, read, update, or delete individual credentials, see the Credential Resource.
After you create a CredentialList resource, you will need to map it to your SIP domain for it to take effect. You can map a CredentialList to more than one SIP domain.
Your Account can have up to 100 CredentialList resources.
Each CredentialList resource can contain up to 1,000 unique users.
Resource properties
date_created
type: string<date-time-rfc-2822>
date_updated
type: string<date-time-rfc-2822>
friendly_name
type: string
A human readable descriptive text that describes the CredentialList, up to 64 characters long.
sid
type: SID<CL>
A 34 character string that uniquely identifies this resource.
Pattern:
^CL[0-9a-fA-F]{32}$
subresource_uris
type: object<uri-map>
A list of credentials associated with this credential list.
uri
type: string
The URI for this resource, relative to https://api.twilio.com
.
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
URI parameters
AccountSid
type: SID<AC>
The unique id of the Account that is responsible for this resource.
Pattern:
^AC[0-9a-fA-F]{32}$
Request body parameters
FriendlyName
type: stringRequired
A human readable descriptive text that describes the CredentialList, up to 64 characters long.
_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.sip.credentialLists
_10 .create({friendlyName: 'friendly_name'})
_10 .then(credential_list => console.log(credential_list.sid));
_11 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "friendly_name": "friendly_name",
_11 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "subresource_uris": {
_11 "credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
URI parameters
AccountSid
type: SID<AC>
The unique id of the Account that is responsible for this resource.
Pattern:
^AC[0-9a-fA-F]{32}$
Sid
type: SID<CL>
The credential list Sid that uniquely identifies this resource
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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(credential_list => console.log(credential_list.friendlyName));
_11 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "friendly_name": "Low Rises",
_11 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "subresource_uris": {
_11 "credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
URI parameters
AccountSid
type: SID<AC>
The unique id of the Account that is responsible for this resource.
Pattern:
^AC[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.
_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.sip.credentialLists
_10 .then(credentialLists => credentialLists.forEach(c => console.log(c.sid)));
_23 "credential_lists": [
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_23 "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_23 "friendly_name": "Low Rises",
_23 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "subresource_uris": {
_23 "credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_23 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=0",
_23 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=50",
_23 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=0",
_23 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=0"
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
URI parameters
AccountSid
type: SID<AC>
The unique id of the Account that is responsible for this resource.
Pattern:
^AC[0-9a-fA-F]{32}$
Sid
type: SID<CL>
The credential list Sid that uniquely identifies this resource
Pattern:
^CL[0-9a-fA-F]{32}$
Request body parameters
FriendlyName
type: stringRequired
A human readable descriptive text for a CredentialList, up to 64 characters long.
_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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .update({friendlyName: 'friendly_name'})
_10 .then(credential_list => console.log(credential_list.friendlyName));
_11 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11 "friendly_name": "friendly_name",
_11 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11 "subresource_uris": {
_11 "credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
URI parameters
AccountSid
type: SID<AC>
The unique id of the Account that is responsible for this resource.
Pattern:
^AC[0-9a-fA-F]{32}$
Sid
type: SID<CL>
The credential list Sid that uniquely identifies this resource
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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').remove();