Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Verification Attempts Summary


(information)

Info

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:

  1. 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, Call & WhatsApp channel.


Rate limits

rate-limits page anchor

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.


Verification Attempts Summary Response Properties

verification-attempts-summary-response-properties page anchor

These properties are returned in the JSON response output.

Resource properties
total_attemptstype: integerNot PII

Total of attempts made according to the provided filters


total_convertedtype: integerNot PII

Total of attempts made that were confirmed by the end user, according to the provided filters.


total_unconvertedtype: integerNot PII

Total of attempts made that were not confirmed by the end user, according to the provided filters.


conversion_rate_percentagetype: numberNot PII

Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.


urltype: string<URI>Not PII

Get a Verification Attempts Summary

get-a-verification-attempts-summary page anchor
GET https://verify.twilio.com/v2/Attempts/Summary

Returns a summary of verification attempts that match the selected query parameters.

Parameters

fetch-parameters page anchor
URI parameters
VerifyServiceSidtype: SID<VA>Not PII
Query Parameter

Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.


DateCreatedAftertype: string<DATE TIME>Not PII
Query Parameter

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>Not PII
Query Parameter

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>Not PII
Query Parameter

Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.


Channeltype: enum<STRING>Not PII
Query Parameter

Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are SMS, CALL and WHATSAPP

Possible values:
smscallemailwhatsapp

DestinationPrefixtype: stringNot PII
Query Parameter

Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.

Fetch Verification Attempts Summary

fetch-verification-attempts-summary page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.verify.v2.verificationAttemptsSummary()
_10
.fetch()
_10
.then(verification_attempts_summary => console.log(verification_attempts_summary.totalAttempts));

Output

_10
{
_10
"total_attempts": 11,
_10
"total_converted": 9,
_10
"total_unconverted": 2,
_10
"conversion_rate_percentage": 81.818181818,
_10
"url": "https://verify.twilio.com/v2/Attempts/Summary"
_10
}

Fetch Verification Attempts Summary by Verify Service SID

fetch-verification-attempts-summary-by-verify-service-sid page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.verify.v2.verificationAttemptsSummary()
_10
.fetch({verifyServiceSid: 'VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_10
.then(verification_attempts_summary => console.log(verification_attempts_summary.totalAttempts));

Output

_10
{
_10
"total_attempts": 11,
_10
"total_converted": 9,
_10
"total_unconverted": 2,
_10
"conversion_rate_percentage": 81.818181818,
_10
"url": "https://verify.twilio.com/v2/Attempts/Summary"
_10
}

Fetch Verification Attempts Summary by Country

fetch-verification-attempts-summary-by-country page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.verify.v2.verificationAttemptsSummary()
_10
.fetch({country: 'CO'})
_10
.then(verification_attempts_summary => console.log(verification_attempts_summary.totalAttempts));

Output

_10
{
_10
"total_attempts": 11,
_10
"total_converted": 9,
_10
"total_unconverted": 2,
_10
"conversion_rate_percentage": 81.818181818,
_10
"url": "https://verify.twilio.com/v2/Attempts/Summary"
_10
}


Rate this Page: