Use the following URL to generate and send a PIN to your user:.
/v2/request
Key | Example | Description | Required |
---|---|---|---|
access-token | ABCDEFG12345 | You can find your API key in your account | Required |
to | 09xxxxxxx | john@website.com | The mobile phone number or email address to verify. | Required |
brand_name | ABCD Company | To identify your company or application name in the SMS body. | Required |
channel | auto | sms | email | sms for Mobile Phone Verification, email for Email Verification and auto will be automatically detect whether Email or SMS. | |
code_length | 4 | The length of the verification code. The default code length is 4. | |
ttl | 300 | Lifetime of the verification code in seconds. The valid minimal value 60 and maximum is 3,600 seconds. | |
sender_name | ABCD | Use this field to specify the sender name for your message. This must be at least 3 characters in length but no longer than 11 alphanumeric characters or 13 numeric characters. Note: SenderID is subjected to approval. | |
template | {brand_name} အတွက် သင်၏အတည်ပြုရန်ကုဒ်နံပါတ်မှာ {code} ဖြစ်ပါတယ် | Use This field to customize your message template. {brand_name} = The brand name, {code} = OTP Code |
https://verify.smspoh.com/api/v2/request?access-token=ABCDEFG12345&to=09xxxxxxx&channel=sms&brand_name=ABCD+Company&code_length=4&sender_name=ABCD&template={brand_name}
အတွက် အတည်ပြုရန်ကုဒ်နံပါတ်မှာ {code} ဖြစ်ပါတယ်
https://verify.smspoh.com/api/v2/request?access-token=ABCDEFG12345&to=john@website.com&channel=email&brand_name=ABCD+Company&code_length=4&sender_name=ABCD&template={brand_name}
အတွက် အတည်ပြုရန်ကုဒ်နံပါတ်မှာ {code} ဖြစ်ပါတယ်
{ "status": true, "request_id": 211348, "channel": "EMAIL", "to": "john@website.com", "created_at": "2022-05-10 14:07:58", "expire_at": "2022-05-10 14:12:58" }
status | boolean |
---|---|
request_id | integer | The unique ID to verify request.
|
to | string The mobile phone number or email to verify.
|