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.


SIP CredentialListMapping properties

sip-credentiallistmapping-properties page anchor
Property nameTypeRequiredDescriptionChild properties
accountSidSID<AC>

Optional

The SID of the Account that created the CredentialListMapping resource.

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

dateCreatedstring<date-time-rfc-2822>

Optional

The date and time in GMT that the resource was created specified in RFC 2822(link takes you to an external page) format.


dateUpdatedstring<date-time-rfc-2822>

Optional

The date and time in GMT that the resource was last updated specified in RFC 2822(link takes you to an external page) format.


friendlyNamestring

Optional

The string that you assigned to describe the resource.


sidSID<CL>

Optional

The unique string that that we created to identify the CredentialListMapping resource.

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

Create a SIP CredentialListMapping resource

create-a-sip-credentiallistmapping-resource page anchor

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

domainSidSID<SD>
required

The SID of the SIP domain that will contain the new resource.

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
credentialListSidSID<CL>
required

The SID of the CredentialList resource to map to the SIP domain.

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Create a SIP CredentialListMapping resourceLink to code sample: Create a SIP CredentialListMapping resource
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function createSipAuthCallsCredentialListMapping() {
11
const credentialListMapping = await client.sip
12
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.auth.calls.credentialListMappings.create({
14
credentialListSid: "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
15
});
16
17
console.log(credentialListMapping.accountSid);
18
}
19
20
createSipAuthCallsCredentialListMapping();

Response

1
{
2
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
4
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
5
"friendly_name": "friendly_name",
6
"sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
7
}

Fetch a SIP CredentialListMapping resource

fetch-a-sip-credentiallistmapping-resource page anchor

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

domainSidSID<SD>
required

The SID of the SIP domain that contains the resource to fetch.

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

sidSID<CL>
required

The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch a SIP CredentialListMapping resourceLink to code sample: Fetch a SIP CredentialListMapping resource
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function fetchSipAuthCallsCredentialListMapping() {
11
const credentialListMapping = await client.sip
12
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14
.fetch();
15
16
console.log(credentialListMapping.accountSid);
17
}
18
19
fetchSipAuthCallsCredentialListMapping();

Response

1
{
2
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
4
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
5
"friendly_name": "friendly_name",
6
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
7
}

Read multiple SIP CredentialListMapping resources

read-multiple-sip-credentiallistmapping-resources page anchor

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

domainSidSID<SD>
required

The SID of the SIP domain that contains the resources to read.

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
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 CredentialListMapping resourcesLink to code sample: Read multiple SIP CredentialListMapping resources
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function listSipAuthCallsCredentialListMapping() {
11
const credentialListMappings = await client.sip
12
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.auth.calls.credentialListMappings.list({ limit: 20 });
14
15
credentialListMappings.forEach((c) => console.log(c.accountSid));
16
}
17
18
listSipAuthCallsCredentialListMapping();

Response

1
{
2
"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
3
"end": 0,
4
"previous_page_uri": null,
5
"contents": [],
6
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
7
"page_size": 50,
8
"start": 0,
9
"next_page_uri": null,
10
"page": 0
11
}

Delete a SIP CredentialListMapping resource

delete-a-sip-credentiallistmapping-resource page anchor

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

domainSidSID<SD>
required

The SID of the SIP domain that contains the resource to delete.

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

sidSID<CL>
required

The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Delete a SIP CredentialListMapping resourceLink to code sample: Delete a SIP CredentialListMapping resource
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function deleteSipAuthCallsCredentialListMapping() {
11
await client.sip
12
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14
.remove();
15
}
16
17
deleteSipAuthCallsCredentialListMapping();