The Toll-free Verification Object contains the following fields.
The unique identifier for the verification request.
The unique identifier of an existing Plivo profile.
The toll-free number for which verification is being initiated.
The messaging use case(s) for which the toll-free number will be used. This should be set as one or more of the following options:
One use case is mandatory. Multiple use cases can be added as a list of strings.
The explanation of how messaging will be used on the toll-free phone number(s) by your business.
Sample message(s) that your business will send to the end-user/mobile device. Multiple sample messages are allowed.
A valid URL where you submit images explaining details of the opt-in process for the end user. Multiple URLs are allowed as a list of strings.
Note: This URL should align with the details added to the optin_type.
Describes how a user opts into receiving text messages. One of the following exact values should be provided:
-VERBAL must include the sample verbal consent collection and examples in a document linked in the optin_image_url parameter.
-WEB_FORM must include the link to the form in the optin_image_url parameter.
-PAPER_FORM must include a link to the form in the optin_image_url parameter. It can be a scanned image.
-VIA_TEXT must describe the keyword campaign in a document linked in the optin_image_url parameter.
-MOBILE_QR_CODE must include the QR code in a document linked in the optin_image_url parameter.
The sample submitted in the opt-in_image_url parameter should match the opt-in type selection.
An estimate of the monthly volume of messages you will send from the toll-free number. One of the following exact values should be provided:
If your monthly volumes are expected to increase, it is advisable to provide a value that accommodates the projected growth and remains suitable for the next six to eight months.
Any additional information that you would like to include for your own internal reference.
The status of the toll-free verification request.
The reason for toll-free verification rejection.
A valid URL where verification-related callbacks will be sent.
The date when the verification request was created.
The date when the verification request was last modified.