Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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 25 CredentialList resources.

Each CredentialList resource can contain up to 1,000 unique users.

SipCredentialList properties

account_sid
sid<AC> Not PII

The unique id of the Account that owns this resource.

date_created
date_time<rfc2822> Not PII

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

date_updated
date_time<rfc2822> Not PII

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

friendly_name
string Not PII

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

sid
sid<CL> Not PII

A 34 character string that uniquely identifies this resource.

subresource_uris
uri_map Not PII

A list of credentials associated with this credential list.

uri
uri Not PII

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

Create a SipCredentialList resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
Parameters
AccountSid
Required
post sid<AC> Not PII

The unique id of the Account that is responsible for this resource.

FriendlyName
Required
post string Not PII

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

Example 1
Loading Code Sample...
      
      
      
      

      Fetch a SipCredentialList resource

      get
      https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
      Parameters
      AccountSid
      Required
      get sid<AC> Not PII

      The unique id of the Account that is responsible for this resource.

      Sid
      Required
      get sid<CL> Not PII

      The credential list Sid that uniquely identifies this resource

      Example 1
      Loading Code Sample...
          
          
          
          

          Read multiple SipCredentialList resources

          get
          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
          Parameters
          AccountSid
          Required
          get sid<AC> Not PII

          The unique id of the Account that is responsible for this resource.

          Example 1
          Loading Code Sample...
              
              
              
              

              Update a SipCredentialList resource

              post
              https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
              Parameters
              AccountSid
              Required
              post sid<AC> Not PII

              The unique id of the Account that is responsible for this resource.

              FriendlyName
              Required
              post string Not PII

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

              Sid
              Required
              post sid<CL> Not PII

              The credential list Sid that uniquely identifies this resource

              Example 1
              Loading Code Sample...
                  
                  
                  
                  

                  Delete a SipCredentialList resource

                  delete
                  https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
                  Parameters
                  AccountSid
                  Required
                  delete sid<AC> Not PII

                  The unique id of the Account that is responsible for this resource.

                  Sid
                  Required
                  delete sid<CL> Not PII

                  The credential list Sid that uniquely identifies this resource

                  Example 1
                  Loading Code Sample...
                      
                      
                      
                      

                      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 browsing the Twilio tag on Stack Overflow.

                      Loading Code Sample...