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?

Service Rate Limits

Service Rate Limits makes it easy to use Twilio's battle-tested rate-limiting services to protect your phone verification deployment. With Service Rate Limits, you can define the keys to meter and limits to enforce when starting phone verifications. Together with Verity's built-in platform protections Service Rate Limits gives you turnkey protection with flexibility.

Prerequisites:

  1. Create a Verification Service

If you are just getting started with Rate Limits in Verify we recommend checking out our guide on Using Verify Service Rate Limits to Protect Your Application before diving into the API.

Rate Limit Properties

Names in PHP format
sid
sid<RK> Not PII

A 34 character string that uniquely identifies this Rate Limit.

serviceSid
sid<VA> Not PII

The SID of the Service the resource is associated with.

accountSid
sid<AC> Not PII

The SID of the Account that created the Rate Limit resource.

uniqueName
string Not PII

Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.

description
string Not PII

Description of this Rate Limit

dateCreated
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

dateUpdated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

url
url Not PII

The URL of this resource.

links
uri_map Not PII

The URLs of related resources.

Create a Rate Limit

post
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits

The Rate Limit represents the key that your application will provide when starting a phone verification request. For example, you may create a rate limit for an end-user IP address to prevent a malicious bot. See the section on Selecting Rate Limit Keys for information on this topic.

Parameters
Names in None format
service_sid
Required
post sid<VA> Not PII

The SID of the Service the resource is associated with.

unique_name
Required
post string Not PII

Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.

description
Optional
post string Not PII

Description of this Rate Limit

Example 1
        
        
        
        

        Fetch a Rate Limit

        get
        https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
        Parameters
        Names in None format
        service_sid
        Required
        get sid<VA> Not PII

        The SID of the Service the resource is associated with.

        sid
        Required
        get sid<RK> Not PII

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

        Example 1
              
              
              
              

              List all Rate Limits

              get
              https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits
              Parameters
              Names in None format
              service_sid
              Required
              get sid<VA> Not PII

              The SID of the Service the resource is associated with.

              Example 1
                    
                    
                    
                    

                    Update a Rate Limit

                    post
                    https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
                    Parameters
                    Names in None format
                    service_sid
                    Required
                    post sid<VA> Not PII

                    The SID of the Service the resource is associated with.

                    sid
                    Required
                    post sid<RK> Not PII

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

                    description
                    Optional
                    post string Not PII

                    Description of this Rate Limit

                    Example 1
                          
                          
                          
                          

                          Delete a Rate Limit

                          delete
                          https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
                          Parameters
                          Names in None format
                          service_sid
                          Required
                          delete sid<VA> Not PII

                          The SID of the Service the resource is associated with.

                          sid
                          Required
                          delete sid<RK> Not PII

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

                          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.