The Verification Attempts Summary API is currently in the Public Beta release stage!
Please note that Verification Attempts Summary API currently only supports SMS, WhatsApp, and Voice channels.
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:
You can list, filter, and fetch verification attempts using the Verification Attempts API.
Verification Attempts Summary API currently supports only the SMS, Call & WhatsApp channel.
Verification Attempts Summary API provides a built-in rate limit of 100 requests per minute. If you reach this limit, you will start receiving HTTP 429 "Too Many Requests" responses.
Verification Attempts Summary API has a timeout value of 15 seconds. However, its 99th percentile is within 1 second.
These properties are returned in the JSON response output.
total_convertedtype: integerTotal of attempts made that were confirmed by the end user, according to the provided filters.
total_unconvertedtype: integerTotal of attempts made that were not confirmed by the end user, according to the provided filters.
conversion_rate_percentagetype: numberPercentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.
urltype: string<uri>GET https://verify.twilio.com/v2/Attempts/SummaryReturns a summary of verification attempts that match the selected query parameters.
VerifyServiceSidtype: SID<VA>Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
DateCreatedAftertype: string<date-time>Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
DateCreatedBeforetype: string<date-time>Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
Countrytype: string<iso-country-code>Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
Channeltype: enum<string>Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are SMS, CALL and WHATSAPP
smscallemailwhatsappDestinationPrefixtype: stringFilter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.