VerifyV2VerificationAttempt

List all the verification attempts for a given Account.

Changed on

List all the verification attempts for a given Account.

get/v2/Attempts

Request

  • Base URL
    https://verify.twilio.com
  • URL
    https://verify.twilio.com/v2/Attempts
  • Auth
    HTTP basic

Query parameters

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

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

ChannelData.Tostring

Destination of a verification. It is phone number in E.164 format.

Countrystring iso-country-code

Filter used to query Verification Attempts sent to the specified destination country.

Channel'sms' | 'call' | 'email' | 'whatsapp' | 'rbm'

A string specifying the communication channel used for the verification attempt.

Filter used to query Verification Attempts by communication channel.

VerifyServiceSidstring

Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.

VerificationSidstring

Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.

Status'converted' | 'unconverted'

A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are CONVERTED and UNCONVERTED.

Filter used to query Verification Attempts by conversion status. Valid values are UNCONVERTED, for attempts that were not converted, and CONVERTED, for attempts that were confirmed.

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

    • breaking

      removed the enum value sna from the query request parameter Channel

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • info

      removed the sna enum value from the // response property for the response status

    • warning

      added the new rbm enum value to the // response property for the response status

    • warning

      added the new sna enum value to the // response property for the response status

    • info

      added the new enum value rbm to the query request parameter Channel

    • info

      added the new enum value sna to the query request parameter Channel