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

SipCredentialListMapping properties

account_sid
sid<AC> Not PII

The unique id of the Account that is responsible for 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 for this resource, 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 the Credential resources associated with this CredentialListMapping resource.

uri
uri Not PII

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

Create a SipCredentialListMapping resource

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

The unique id of the Account responsible for this resource.

CredentialListSid
Required
post sid<CL> Not PII

A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.

DomainSid
Required
post sid<SD> Not PII

A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped.

Example 1
Loading Code Sample...
      
      
      
      

      Fetch a SipCredentialListMapping resource

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

      The unique id of the Account responsible for this resource.

      DomainSid
      Required
      get sid<SD> Not PII

      A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch.

      Sid
      Required
      get sid<CL> Not PII

      A 34 character string that uniquely identifies the resource to fetch.

      Example 1
      Loading Code Sample...
          
          
          
          

          Read multiple SipCredentialListMapping resources

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

          The unique id of the Account responsible for this resource.

          DomainSid
          Required
          get sid<SD> Not PII

          A 34 character string that uniquely identifies the SIP Domain that includes the resource to read.

          Example 1
          Loading Code Sample...
              
              
              
              

              Delete a SipCredentialListMapping resource

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

              The unique id of the Account responsible for this resource.

              DomainSid
              Required
              delete sid<SD> Not PII

              A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete.

              Sid
              Required
              delete sid<CL> Not PII

              A 34 character string that uniquely identifies the resource to delete.

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