Overview
The API platform has been organized to help simplify the process of integrating your applications. Before any messages can be sent, an account needs to be properly setup. Besides credentials, an account must have an organization tree setup. Once the organization tree is setup, you are ready to start your integration to send messages.
The first step is to validate or “scrub” phone numbers of your prospective subscribers. This is done by calling the “GetCarrierLookup” method, which will confirm the validity of a mobile number.
Once you have confirmed the validity of phone numbers, you will need to obtain your subscribers’ acquiescence to send them messages. This is established by using the “Request VBT”/”Require VBT” method followed by “Confirm VBT”.
A Brief Introduction to VBT
VBT – acronym for Verification by Text and is a standard process to obtain subscriber acquiescence to receive messages from you. The subscriber has the option to opt-out whenever he wants to stop receiving messages by employing the STOP command.
VBT Methods
There are three methods for VBT – “Request VBT”, “Require VBT” and “Confirm VBT”
– Request VBT has three options to enable a subscription
1. Request VBT by PIN
The platform will send a randomly generated #PIN to the mobile number of the prospective subscriber. This #PIN is then passed to the platform using the “Confirm VBT” method to complete the subscription process.
2. Request VBT by Reserved Word
The platform will send a “Reserved Word” from a pre-defined library (either Y or Agree are presently supported) to the mobile number of the prospective subscriber. The subscriber has to then reply back with the “Reserved Word” to the platform to complete the subscription process.
Once the subscription process is completed, the subscriber will receive the “Compliance Language” that is setup. You are now ready to send your message(s).
3. Request VBT by NONE
The platform will send a “VBT NONE Language” from a pre-defined library to the mobile number of the prospective subscriber.
– Require VBT has three options to enable a subscription
1. Require VBT by PIN
The platform will send a randomly generated #PIN to the mobile number of the prospective subscriber. This #PIN is then passed to the platform using the “Confirm VBT” method to complete the subscription process.
2. Require VBT by Reserved Word
The platform will send a “Reserved Word” from a pre-defined library (either Y or Agree are presently supported) to the mobile number of the prospective subscriber. The subscriber has to then reply back with the “Reserved Word” to the platform to complete the subscription process.
Once the subscription process is completed, the subscriber will receive the “Compliance Language” that is setup. You are now ready to send your message(s).
3. Request VBT by NONE
The platform will send a “VBT NONE Language” from a pre-defined library to the mobile number of the prospective subscriber.
Below is the flow to help you start sending messages.
