メニュー

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?

Verifications

Twilio's new Verify API is currently available as a Public Beta product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Public Beta products are not covered by a Twilio SLA.

The Verification Resource represents a verification request. This will trigger a communication to the end user through the specified channel (e.g. SMS).

必要なもの:

  1. Create a Verification Service

Verification Response Properties

These fields are returned in the output JSON response. The type SID<XX> is a unique ID starting with the letters XX.

Names in Node.js format
sid
sid<VE> Not PII

The unique string that we created to identify the Verification resource.

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 Verification resource.

to
phone_number Not PII

The phone number being verified. Must be in E.164 format.

channel
enum:channel Not PII

The verification method to use. Can be: sms or call.

status
文字列 Not PII

The status of the verification. Can be: pending, approved, denied, or expired.

valid
boolean Not PII

Whether the verification was successful.

lookup
オブジェクト Not PII

Information about the phone number being verified.

amount
文字列 Not PII

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

payee
文字列 Not PII

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

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 absolute URL of the Verification resource.

Start New Verification

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

These are the available input parameters for starting a verification. The type SID<XX> is a unique ID starting with the letters XX.

パラメーター
Names in None format
service_sid
必須
post sid<VA> Not PII

The SID of the verification Service to create the resource under.

to
必須
post 文字列 Not PII

The phone number to verify.

channel
必須
post 文字列 Not PII

The verification method to use. Can be: sms or call.

custom_message
オプション
post 文字列 Not PII

The text of a custom message to use for the verification.

send_digits
オプション
post 文字列 Not PII

The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of sendDigits.

locale
オプション
post 文字列 Not PII

The locale to use for the verification SMS or call. Can be: af, ar, ca, cs, da, de, el, en, es, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nb, nl, pl, pt, pr-BR, ro, ru, sv, th, tl, tr, vi, zh, zh-CN, or zh-HK.

custom_code
オプション
post 文字列 Not PII

A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.

amount
オプション
post 文字列 Not PII

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

payee
オプション
post 文字列 Not PII

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

        
        
        
        
        Rate this page:

        ヘルプが必要ですか?

        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.