SIP CredentialListMapping Resource
The CredentialListMapping resource represents the CredentialList resources associated with a SIP Domain. A CredentialList resource contains the Credential resources of the users who can access the SIP Domain.
If an INVITE is received for a domain with a credential list mapped to it, we challenge the request and your system must authenticate it with a username and password. To be accepted, the username and password must be in one of the credential lists mapped to the SIP Domain.
Property nameTypePIIDescription
The SID of the Account that created the CredentialListMapping resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
date_createdstring<date-time-rfc-2822>
date_updatedstring<date-time-rfc-2822>
The string that you assigned to describe the resource.
The unique string that that we created to identify the CredentialListMapping resource.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The SID of the Account that will create the resource.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the SIP domain that will contain the new resource.
Pattern: ^SD[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Property nameTypeRequiredPIIDescription
CredentialListSidSID<CL>required The SID of the CredentialList resource to map to the SIP domain.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20async function createSipAuthCallsCredentialListMapping() {
_20 const credentialListMapping = await client.sip
_20 .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20 .auth.calls.credentialListMappings.create({
_20 credentialListSid: "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 console.log(credentialListMapping.accountSid);
_20createSipAuthCallsCredentialListMapping();
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "friendly_name": "friendly_name",
_10 "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The SID of the Account that created the CredentialListMapping resource to fetch.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the SIP domain that contains the resource to fetch.
Pattern: ^SD[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function fetchSipAuthCallsCredentialListMapping() {
_19 const credentialListMapping = await client.sip
_19 .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19 .auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19 console.log(credentialListMapping.accountSid);
_19fetchSipAuthCallsCredentialListMapping();
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10 "friendly_name": "friendly_name",
_10 "sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The SID of the Account that created the CredentialListMapping resources to read.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the SIP domain that contains the resources to read.
Pattern: ^SD[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.
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function listSipAuthCallsCredentialListMapping() {
_18 const credentialListMappings = await client.sip
_18 .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18 .auth.calls.credentialListMappings.list({ limit: 20 });
_18 credentialListMappings.forEach((c) => console.log(c.accountSid));
_18listSipAuthCallsCredentialListMapping();
_11 "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
_11 "previous_page_uri": null,
_11 "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
_11 "next_page_uri": null,
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required The SID of the Account that created the CredentialListMapping resources to delete.
Pattern: ^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the SIP domain that contains the resource to delete.
Pattern: ^SD[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
Pattern: ^CL[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
_17// Download the helper library from https://www.twilio.com/docs/node/install
_17const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17// Find your Account SID and Auth Token at twilio.com/console
_17// and set the environment variables. See http://twil.io/secure
_17const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17const authToken = process.env.TWILIO_AUTH_TOKEN;
_17const client = twilio(accountSid, authToken);
_17async function deleteSipAuthCallsCredentialListMapping() {
_17 .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_17 .auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_17deleteSipAuthCallsCredentialListMapping();