ارسال سریع کد اعتبارسنجی
مستندات فنی
ApiReference
نسخه 1.0
فعال
دسته بندی: پیامک / ارسال
API Reference
لیست متدها، ورودیها، خروجیها و نمونه کدها
Post
https://portal.amootsms.com/rest/SendQuickOTP
ارسال سریع کد اعتبارسنجی
SendQuickOTP
از طریق این متد می توانید پیامک با رمز یکبار مصرف را به صورت فوری به شماره انتخابی خود ارسال نمایید ، جهت استفاده از این متد باید یک الگو با متغیر code در پنل کاربری ایجاد نمایید .
این متد به شما امکان میدهد پیامک حاوی رمز یکبار مصرف (OTP) را به صورت فوری به شماره موبایل مورد نظر ارسال کنید. برای استفاده از این متد، ابتدا باید یک الگو با متغیر code در پنل کاربری ایجاد کنید و پس از تایید توسط اپراتور، امکان ارسال فعال میشود.
پارامترها
| نام | نوع | محل | اجباری | آرایه | توضیحات |
|---|---|---|---|---|---|
Token |
String | Header | بله | خیر | توکن ثبت شده در سامانه پیامک آموت |
Mobile |
String | Body | بله | خیر | موبایل دریافت کننده پیامک |
CodeLength |
Int | Body | بله | خیر | طول کد (حداقل 4 رقم و حداکثر 8 رقم) |
OptionalCode |
String | Body | خیر | خیر | رمز یکبار مصرف سفارشی خود اگر خالی باشد رمز یکبار مصرف سمت سرور تولید می شود |
پاسخها
200
خروجی موفق
Schema
{
"MessageText": "خوش امدید: \n کد تایید شما 917649 \nآموت\amootsoft.com\nلغو11",
"SMSPagesCount": 1,
"CampaignID": 12345678,
"Price": 2299,
"Status": "Success",
"Data": {
"Mobile": 09150000000,
"MessageID": 12345678,
"Code": "******",
"Status": "Success"
}
}
نمونه کدها
Curl
cURL
Request
curl -X POST https://portal.amootsms.com/rest/SendQuickOTP \
-H 'Authorization: MyToken' \
-d 'Mobile=09120000000' \
-d 'CodeLength=6' \
-d 'OptionalCode='
CSharp
C#
Request
string Token = "MyToken";
string Mobile = "09120000000";
short CodeLength = 6;
string OptionalCode = ""; // اگر خالی باشد کد سمت سرور تولید میشود
using (var client = new System.Net.WebClient())
{
client.Headers.Add(System.Net.HttpRequestHeader.Authorization, Token);
var data = new System.Collections.Specialized.NameValueCollection()
{
{ "Mobile", Mobile },
{ "CodeLength", CodeLength.ToString() },
{ "OptionalCode", OptionalCode }
};
byte[] bytes = client.UploadValues("https://portal.amootsms.com/rest/SendQuickOTP", data);
string json = System.Text.UTF8Encoding.UTF8.GetString(bytes);
}
Php
PHP
Request
$token = 'MyToken';
$mobile = '09120000000';
$codeLength = 6;
$optionalCode = '';
$ch = curl_init('https://portal.amootsms.com/rest/SendQuickOTP');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: ' . $token));
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'Mobile' => $mobile,
'CodeLength' => $codeLength,
'OptionalCode' => $optionalCode
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);