Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
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 100 CredentialList resources.

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

SipCredentialList properties

Names in PHP format
accountSid
sid<AC> Not PII

The unique id of the Account that owns this resource.

dateCreated
date_time<rfc2822> Not PII

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

dateUpdated
date_time<rfc2822> Not PII

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

friendlyName
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.

subresourceUris
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 SIP CredentialList resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
Parameters
Names in None format
friendly_name
Required
post string Not PII

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

account_sid
Required
post sid<AC> Not PII

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

Example 1
        
        
        
        

        Fetch a SIP CredentialList resource

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
        Parameters
        Names in None format
        account_sid
        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
              
              
              
              

              Read multiple SIP CredentialList resources

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

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

              Example 1
                    
                    
                    
                    

                    Update a SIP CredentialList resource

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

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

                    sid
                    Required
                    post sid<CL> Not PII

                    The credential list Sid that uniquely identifies this resource

                    friendly_name
                    Required
                    post string Not PII

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

                    Example 1
                          
                          
                          
                          

                          Delete a SIP CredentialList resource

                          delete
                          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
                          Parameters
                          Names in None format
                          account_sid
                          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
                                
                                
                                
                                
                                Rate this page:

                                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.