SIP Credential Resource
The Credential resource stores usernames and password information.
Each Username
requires a corresponding password that meets the requirements in the Password
parameter's description.
We don't store the passwords you provide in the credential records as cleartext. Instead, they are MD5 hashed in accordance with the digest authentication specification.
Property nameTypePIIDescription
A 34 character string that uniquely identifies this resource.
Pattern: ^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
credential_list_sidSID<CL> The unique id that identifies the credential list that includes this credential.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The username for this credential.
date_createdstring<date-time-rfc-2822>
date_updatedstring<date-time-rfc-2822>
The URI for this resource, relative to https://api.twilio.com
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
CredentialListSidSID<CL>required The unique id that identifies the credential list to include the created credential.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018
)
_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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .create({username: 'username', password: 'password'})
_11 .then(credential => console.log(credential.sid));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_10 "username": "username"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
CredentialListSidSID<CL>required The unique id that identifies the credential list that contains the desired credential.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The unique id that identifies the resource to fetch.
Pattern: ^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(credential => console.log(credential.username));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_10 "username": "1440013725.28"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
CredentialListSidSID<CL>required The unique id that identifies the credential list that contains the desired credentials.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1
Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(credentials => credentials.forEach(c => console.log(c.sid)));
_21 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
_21 "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
_21 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_21 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_21 "username": "1440013725.28"
_21 "first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json?PageSize=50&Page=0",
_21 "next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json?PageSize=50&Page=50",
_21 "previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json?PageSize=50&Page=0",
_21 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json?PageSize=50&Page=0"
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
The update action is used to update a user's password.
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
CredentialListSidSID<CL>required The unique id that identifies the credential list that includes this credential.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The unique id that identifies the resource to update.
Pattern: ^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018
)
_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.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({password: 'password'})
_11 .then(credential => console.log(credential.username));
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_10 "username": "username"
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The unique id of the Account that is responsible for this resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
CredentialListSidSID<CL>required The unique id that identifies the credential list that contains the desired credentials.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The unique id that identifies the resource to delete.
Pattern: ^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_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 .credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')