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> Not PIIdate_updated
type: string<DATE TIME RFC 2822> Not PIIA human readable descriptive text that describes the CredentialList, up to 64 characters long.
A 34 character string that uniquely identifies this resource.
subresource_uris
type: object<URI MAP> Not PIIA list of credentials associated with this credential list.
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 Path Parameter
The unique id of the Account that is responsible for this resource.
Request body parameters Required
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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.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 Path Parameter
The unique id of the Account that is responsible for this resource.
Path Parameter
The credential list Sid that uniquely identifies this resource
_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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.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 Path Parameter
The unique id of the Account that is responsible for this resource.
Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.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 Path Parameter
The unique id of the Account that is responsible for this resource.
Path Parameter
The credential list Sid that uniquely identifies this resource
Request body parameters Required
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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.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 Path Parameter
The unique id of the Account that is responsible for this resource.
Path Parameter
The credential list Sid that uniquely identifies this resource
_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
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX').remove();