Skip to content Skip to navigation Skip to topbar

SIP Credential Resource

On this reference page, you'll learn about the properties, parameters, and methods available for the SIP Credential resource. See Related how-to documentation to learn the steps to use the info on this page.

The Credential resource stores usernames and password information.

Username and Password

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.

SIP Credential properties

Property nameTypeRequiredPIIDescriptionChild properties

endinteger

Optional

firstPageUristring<uri>

Optional

nextPageUristring<uri>

Optional

pageinteger

Optional

pageSizeinteger

Optional

previousPageUristring<uri>

Optional

startinteger

Optional

uristring<uri>

Optional

credentialsarray[object]

Optional

Show credentials properties

Create a SIP Credential resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json

Path parameters

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: 34Max 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: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

usernamestring

required

PII MTL: 30 days

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.

passwordstring

required

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)

Create a SIP Credential resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createSipCredential() {
14  const credential = await client.sip
15    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .credentials.create({
17      password: "password",
18      username: "username",
19    });
20
21  console.log(credential.sid);
22}
23
24createSipCredential();

Response

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4  "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
5  "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
6  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
8  "username": "username"
9}

Fetch a SIP Credential resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json

Path parameters

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: 34Max 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: 34Max length: 34

sidSID<CR>

required

The unique id that identifies the resource to fetch.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a SIP Credential resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function fetchSipCredential() {
14  const credential = await client.sip
15    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .credentials("CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
17    .fetch();
18
19  console.log(credential.sid);
20}
21
22fetchSipCredential();

Response

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4  "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
5  "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
6  "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
8  "username": "1440013725.28"
9}

Read multiple SIP Credential resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json

Path parameters

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: 34Max 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: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

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

Minimum: 1Maximum: 1000

pageinteger

Optional

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

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

Read multiple SIP Credential resources

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listSipCredential() {
14  const credentials = await client.sip
15    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .credentials.list({ limit: 20 });
17
18  credentials.forEach((c) => console.log(c.end));
19}
20
21listSipCredential();

Response

1{
2  "credentials": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
7      "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
8      "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
10      "username": "1440013725.28"
11    }
12  ],
13  "end": 0,
14  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0",
15  "next_page_uri": null,
16  "page": 0,
17  "page_size": 50,
18  "previous_page_uri": null,
19  "start": 0,
20  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0"
21}

Update a SIP Credential resource

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.

Path parameters

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: 34Max 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: 34Max length: 34

sidSID<CR>

required

The unique id that identifies the resource to update.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

passwordstring

Optional

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)

Update a SIP Credential resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function updateSipCredential() {
14  const credential = await client.sip
15    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .credentials("CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
17    .update({ password: "password" });
18
19  console.log(credential.sid);
20}
21
22updateSipCredential();

Response

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "credential_list_sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4  "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
5  "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
6  "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
8  "username": "username"
9}

Delete a SIP Credential resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json

Path parameters

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: 34Max 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: 34Max length: 34

sidSID<CR>

required

The unique id that identifies the resource to delete.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a SIP Credential resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function deleteSipCredential() {
14  await client.sip
15    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .credentials("CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
17    .remove();
18}
19
20deleteSipCredential();