It is required to create a Plivo profile before you can start the toll-free verification process via API.
POST
https://api.plivo.com/v1/Account/{auth_id}/TollfreeVerification/
Param | Description |
---|---|
profile_uuid stringRequired | The unique identifier of an existing Plivo profile. |
usecase stringRequired | 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 string. |
usecase_summary stringRequired | The explanation of how messaging will be used on this toll-free phone number by your business. To enter multiple summaries, follow one of these best practices: Example 1 |
message_sample stringRequired | Sample message(s) that you will send to the end user/mobile device. To enter multiple samples, follow one of these best practices: Example 1 |
optin_image_url stringRequired | A valid URL where you submit images demonstrating the opt-in process for the end user.
Multiple URLs are allowed as a string. |
optin_type stringRequired | Describes how a user opts into 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. |
volume stringRequired | 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. |
additional_information string | Any additional information related to your website, such as a link to the terms of service page or privacy policy that can clarify the verification request. Example: “Refer to our privacy policy page here: https://www.plivo.com/legal/privacy/. Under the section "privacy" we clearly explain how we collect, store, and process the customer's personal data including their phone number. Under the sub-section ‘Rights over your personal data’, we also explain in detail the rights a customer has over the collected data and how they can exercise those rights.”
|
extra_data string | Any additional information that you would like to pass for your internal references. Example: Internal ticket reference number - 121111
|
number stringRequired | The toll-free number in e.164 format for which verification is being initiated. Only US and Canadian toll-free numbers will be accepted. Only one toll-free number can be provided. |
callback_urlstring | A valid URL where verification-related callbacks will be sent. |
HTTP Response code - 201
{
"api_id": "ffe33a14-81fc-11ee-b92a-0242ac110005",
"message": "created",
"uuid": "4a59de5e-204a-47e8-6973-e713f9a1e0ce"
}