Skip to content Skip to navigation Skip to topbar

Twilio Docs

Programmable Voice

Getting Started with Programmable Voice

No-code quickstart C#/.NET quickstart Java quickstart Node.js quickstart PHP quickstart Python quickstart Ruby quickstart Go quickstart Android SDK quickstart iOS SDK quickstart (Objective-C and Swift)JavaScript SDK quickstarts React Native SDK quickstart

Tutorials

Make outbound phone calls Respond to incoming phone calls Modify calls in progress Record phone calls Create conference calls Gather user input via keypad Retrieve call logs Consume a real-time Media Stream using WebSockets, Python, and Flask Capture a payment during a call Capture a payment during a call (Generic Pay Connector)Build an Interactive Voice Response (IVR) Phone Tree Build an IVR for Screening and Recording Calls Build Warm Transfers with Twilio Build a Rapid Response Kit with Voice Conference and Broadcasting Track your call data Forward calls Encrypt your voice recordings Make and receive phone calls in the browser Build an Automated Survey with Twilio Programmable Voice Route calls to your SIP network with an outbound call Add programmability to your existing SIP network Record a single side of call

Make emergency calls

Overview Emergency telephone numbers

API Reference

Voice API Overview Application Resource

Call Resource

Overview Call Event Resource Real-Time Transcription Resource Stream Resource UserDefinedMessage Resource UserDefinedMessageSubscription Resource

Archived Calls SIPREC

Conference Resource

Overview Conference Participant Resource

Dialing Permissions Resources

Overview DialingPermissions Country Resource DialingPermissions BulkCountryUpdate Resource DialingPermissions HighRiskSpecialPrefix Resource DialingPermissions Settings Resource

Outgoing Caller ID Payment Resource

Queue Resource

Overview Member Resource

Recording Resource

Overview Recording Transcription

TwiML

Overview Changelog

<Connect>

Overview <Room><VirtualAgent>

<Dial>

Overview <Application><Client><Conference><Number><Queue><Sip>

<Enqueue><Gather><Hangup><Leave><Pause>

<Pay>

Overview <Prompt><Parameter>Pay Connectors Generic Pay Connector

<Play><Record><Redirect><Refer><Reject>

<Say>

Overview Text-to-Speech

<Siprec><Stream><Transcription>

Media Streams

Media Streams Overview WebSocket Messages

Voice Conference

Voice Insights

Overview Voice Insights Event Streams Voice Insights REST API

Programmable Voice SIP

Overview SIP Quickstart Use SIP with Twilio Voice Inbound - Sending SIP to Twilio Outbound - Receiving SIP from Twilio SIP Registration Secure Media Emergency Calling for SIP Interfaces Inbound SIP REFER to Twilio Making SIP Calls TwiML™ Voice: <Sip>

SIP API

SIP API Overview SIP Credential Resource SIP CredentialList Resource SIP CredentialListMapping Resource SIP Domain Resource SIP Domain Registration CredentialListMapping Resource SIP IpAccessControlList Resource SIP IpAccessControlListMapping Resource SIP IpAddress Resource Emergency Calling for SIP Interfaces API

Bring Your Own Carrier (BYOC) Trunking

BYOC API

BYOC API Overview ByocTrunk Resource ConnectionPolicy Resource ConnectionPolicyTarget Resource SourceIpMapping Resource IpRecord Resource

Client-Side SDKs

Overview Network Connectivity Requirements Error Codes Voice SDK Call Message Events

Android SDK

Overview Getting Started with the Voice Android SDK Edge Locations Using Twilio Voice side by side with WebRTC - Android Changelog API Docs Voice Android SDK FAQ Best Practices

iOS SDK

Overview Getting Started with the Voice iOS SDK Edge Locations Using Twilio Voice side by side with WebRTC - iOS Changelog Migrating to iOS 13 API Docs Voice iOS SDK FAQ Best Practices

JavaScript SDK

Overview Getting Started Twilio.Call Twilio.Device Twilio.Device.audio Twilio.PreflightTest Edge Locations Changelog API Docs Best Practices Migration Guide (v2.0)Version 1.x Resources

React Native SDK

Overview Getting Started with the Voice React Native SDK Changelog API Docs

Best Practices & Troubleshooting

Answering Machine Detection FAQ & Best Practices Voice IP Migration Schedule Update Voice Media IP Migration Security FAQ Testing Voice Media IP Migration Why doesn't my invoice match what I pull from the call logs?Programmable Voice Product Behavior Changes in non-us1 Home Regions How to Share Information Between Your Applications Protect your account with Voice Dialing Geographic Permissions Troubleshooting Voice Calls Limits Failover Best Practices

SHAKEN/STIR

Trusted Calling with SHAKEN/STIR

SHAKEN/STIR Onboarding

Overview Onboarding with Twilio Console Trust Hub REST API - Direct Customers, no Subaccounts Trust Hub REST API - Direct Customers using Subaccounts Trust Hub REST API - ISVs/Resellers with Single, Top-Level Project Trust Hub REST API - ISVs/Resellers using Subaccounts

Interactive Voice Response (IVR)

CNAM

Brand Your Calls Using CNAM

Virtual Agent

Overview Dialogflow CX Onboarding Guide TwiML™ Voice: <VirtualAgent> with Dialogflow CX Connect Virtual Agent (Dialogflow CX) Studio Widget

Messaging
Voice
Serverless
Flex
Studio
All docs...

SDKs
Help

Log in
Sign up

Rate this page:

12345

On this page

SipCredentialList Properties
Create a SIP CredentialList resource

Path parameters
Request body parameters
Fetch a SIP CredentialList resource
Path parameters
Read multiple SIP CredentialList resources
Path parameters
Query parameters
Update a SIP CredentialList resource
Path parameters
Request body parameters
Delete a SIP CredentialList resource
Path parameters

SipCredentialList Properties

Create a SIP CredentialList resource

Path parameters

Request body parameters

Fetch a SIP CredentialList resource

Path parameters

Read multiple SIP CredentialList resources

Path parameters

Query parameters

Update a SIP CredentialList resource

Path parameters

Request body parameters

Delete a SIP CredentialList resource

Path parameters

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.

SipCredentialList Properties

Property nameTypePIIDescription

account_sidSID<AC>

The unique id of the Account that owns this resource.

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

date_createdstring<date-time-rfc-2822>

The date that this resource was created, given as GMT in RFC 2822 format.

date_updatedstring<date-time-rfc-2822>

The date that this resource was last updated, given as GMT in RFC 2822 format.

friendly_namestring

A human readable descriptive text that describes the CredentialList, up to 64 characters long.

sidSID<CL>

A 34 character string that uniquely identifies this resource.

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

subresource_urisobject<uri-map>

A list of credentials associated with this credential list.

uristring

The URI for this resource, relative to https://api.twilio.com.

Create a SIP CredentialList resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.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

Request body parameters

Property nameTypeRequiredPIIDescription

FriendlyNamestringrequired

A human readable descriptive text that describes the CredentialList, up to 64 characters long.

Create a SIP CredentialList resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_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
_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);
_18
_18async function createSipCredentialList() {
_18  const credentialList = await client.sip.credentialLists.create({
_18    friendlyName: "friendly_name",
_18  });
_18
_18  console.log(credentialList.accountSid);
_18}
_18
_18createSipCredentialList();

Output


_11{
_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": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11  "subresource_uris": {
_11    "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
_11  },
_11  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_11}

Fetch a SIP CredentialList resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

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

Fetch a SIP CredentialList resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_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
_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);
_18
_18async function fetchSipCredentialList() {
_18  const credentialList = await client.sip
_18    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18    .fetch();
_18
_18  console.log(credentialList.accountSid);
_18}
_18
_18fetchSipCredentialList();

Output


_11{
_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/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
_11  },
_11  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_11}

Read multiple SIP CredentialList resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple SIP CredentialList resources

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function listSipCredentialList() {
_16  const credentialLists = await client.sip.credentialLists.list({ limit: 20 });
_16
_16  credentialLists.forEach((c) => console.log(c.accountSid));
_16}
_16
_16listSipCredentialList();

Output


_23{
_23  "credential_lists": [
_23    {
_23      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_23      "subresource_uris": {
_23        "credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
_23      },
_23      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_23    }
_23  ],
_23  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0",
_23  "next_page_uri": null,
_23  "start": 0,
_23  "end": 0,
_23  "page": 0,
_23  "page_size": 50,
_23  "previous_page_uri": null,
_23  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0"
_23}

Update a SIP CredentialList resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

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

Request body parameters

Property nameTypeRequiredPIIDescription

FriendlyNamestringrequired

A human readable descriptive text for a CredentialList, up to 64 characters long.

Update a SIP CredentialList resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_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
_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);
_18
_18async function updateSipCredentialList() {
_18  const credentialList = await client.sip
_18    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18    .update({ friendlyName: "friendly_name" });
_18
_18  console.log(credentialList.accountSid);
_18}
_18
_18updateSipCredentialList();

Output


_11{
_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/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
_11  },
_11  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
_11}

Delete a SIP CredentialList resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

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

Delete a SIP CredentialList resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function deleteSipCredentialList() {
_16  await client.sip
_16    .credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_16    .remove();
_16}
_16
_16deleteSipCredentialList();

Rate this page:

12345

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Terms of service

Copyright © 2024 Twilio Inc.