Verification Attempts Summary
Verification Attempts Summary API is in Pilot!
This Verify feature is currently in the Pilot maturity stage, which means that:
1. We're actively looking for early-adopter customers to try it out and give feedback. That could be you!
2. You'll need to contact sales to request access to the API.
Lastly, please note that Verification Attempts Summary API currently supports the SMS, Call and WhatsApp channel.
The Verification Attempts Summary API allows you to summarize verification attempts generated by your Verify V2 services.
A verification attempt is a communication attempt with the end user that contains a verification code and uses one of the channels supported by Twilio Verify. A single verification may generate one or more verification attempts.
This API contains one endpoint:
- Get a Verification Attempts Summary: Returns a summary of verification attempts including total conversions and conversion rate percentage
You can list, filter, and fetch verification attempts using the Verification Attempts API.
Verification Attempts Summary API currently supports only the SMS channel.
Rate limits
Verification Attempts Summary API provides a built-in rate limit of 30 requests per minute. If you reach this limit, you will start receiving HTTP 429 "Too Many Requests" responses.
Timeouts
Verification Attempts Summary API has a timeout value of 15 seconds. However, its 99th percentile is within 1 second.
Verification Attempts Summary Response Properties
These properties are returned in the JSON response output.
| Resource Properties in REST API format | |
|---|---|
total_attempts
|
Total of attempts made according to the provided filters |
total_converted
|
Total of attempts made that were confirmed by the end user, according to the provided filters. |
total_unconverted
|
Total of attempts made that were not confirmed by the end user, according to the provided filters. |
conversion_rate_percentage
|
Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. |
url
|
|
Get a Verification Attempts Summary
https://verify.twilio.com/v2/Attempts/Summary
Returns a summary of verification attempts that match the selected query parameters.
Parameters
| Parameters in REST API format | |
|---|---|
verify_service_sid
Optional
|
Filter used to consider only Verification Attempts of the given verify service on the summary aggregation. |
date_created_after
Optional
|
Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in RFC 2822 format. |
date_created_before
Optional
|
Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in RFC 2822 format. |
country
Optional
|
Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation. |
channel
Optional
|
Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are |
destination_prefix
Optional
|
Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format. |
Example 1
Example 2
Example 3
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.
