قالبهای تایید
ساخت قالب
قالب جدید پیامک یا تماس تایید میسازد. قالب پس از ساخت در انتظار بررسی میماند و فقط بعد از تایید با verify/lookup قابل استفاده است.
POST
GET
https://api.payamras.ir/v1/YOUR_API_KEY/verify/addtemplate.json
- متن پیامک (textMessage) و متن تماس (voiceMessage) باید %token را داشته باشند.
- نام قالب انگلیسی و بدون فاصله و _ است.
پارامترها
| نام | نوع | توضیح |
|---|---|---|
name
الزامی
|
String | نام قالب؛ انگلیسی، بدون فاصله و _. |
sourceType
الزامی
|
Integer | محل استفاده: 0 وبسایت، 1 اپلیکیشن موبایل. |
sendMethod
الزامی
|
Integer | روش ارسال اصلی: 1 پیامک، 2 تماس صوتی. |
fallBackMethod
اختیاری
|
Integer | روش جایگزین در صورت شکست: 0 پیشفرض سیستم، 1 پیامک، 2 تماس، 3 غیرفعال (پیشفرض). |
textMessage
اختیاری
|
String | متن پیامک. وقتی روش اصلی یا جایگزین پیامک است الزامی است. |
voiceMessage
اختیاری
|
String | متن تماس صوتی. وقتی روش اصلی یا جایگزین تماس است الزامی است. |
primaryLineNumber
اختیاری
|
String | خط ارسال اصلی. |
secondaryLineNumber
اختیاری
|
String | خط روش جایگزین. |
switchTTL
اختیاری
|
Integer | چند دقیقه صبر قبل از رفتن به روش جایگزین (۱ تا ۵). |
sourceName
اختیاری
|
String | نام وبسایت یا اپلیکیشن. |
sourceUrl
اختیاری
|
String | آدرس وبسایت یا صفحه اپلیکیشن. |
نمونه درخواست
curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/verify/addtemplate.json" \
--data-urlencode "name=login" \
--data-urlencode "sourceType=0" \
--data-urlencode "sendMethod=1" \
--data-urlencode "textMessage=کد ورود شما: %token" \
--data-urlencode "sourceName=فروشگاه من" \
--data-urlencode "sourceUrl=https://example.com"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'name' => 'login',
'sourceType' => '0',
'sendMethod' => '1',
'textMessage' => 'کد ورود شما: %token',
'sourceName' => 'فروشگاه من',
'sourceUrl' => 'https://example.com',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/verify/addtemplate.json");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
if ($result['return']['status'] !== 200) {
throw new RuntimeException($result['return']['message']);
}
const apiKey = "YOUR_API_KEY";
const params = new URLSearchParams({
name: "login",
sourceType: "0",
sendMethod: "1",
textMessage: "کد ورود شما: %token",
sourceName: "فروشگاه من",
sourceUrl: "https://example.com",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/verify/addtemplate.json`, {
method: "POST",
body: params,
});
const result = await response.json();
if (result.return.status !== 200) {
throw new Error(result.return.message);
}
import requests
api_key = "YOUR_API_KEY"
params = {
"name": "login",
"sourceType": "0",
"sendMethod": "1",
"textMessage": "کد ورود شما: %token",
"sourceName": "فروشگاه من",
"sourceUrl": "https://example.com",
}
response = requests.post(f"https://api.payamras.ir/v1/{api_key}/verify/addtemplate.json", data=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
templateid |
Integer | شناسه قالب ساختهشده. |
name |
String | نام قالب. |
sendmethod |
Integer | روش ارسال اصلی. |
fallbackmethod |
Integer | روش جایگزین. |
textmessage |
String | متن پیامک. |
voicemessage |
String | متن تماس. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"templateid": 1205,
"name": "login",
"sourcetype": 0,
"sendmethod": 1,
"fallbackmethod": 3,
"primarylinenumber": "",
"secondarylinenumber": "",
"switchttl": null,
"sourceurl": "https://example.com",
"sourcename": "فروشگاه من",
"textmessage": "کد ورود شما: %token",
"voicemessage": ""
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: