قالبهای تایید
جزئیات قالب
یک قالب را با شناسهاش برمیگرداند.
GET
https://api.payamras.ir/v1/YOUR_API_KEY/verify/gettemplate.json
پارامترها
| نام | نوع | توضیح |
|---|---|---|
id
الزامی
|
Integer | شناسه قالب. |
نمونه درخواست
curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/verify/gettemplate.json" \
--data-urlencode "id=1204"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'id' => '1204',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/verify/gettemplate.json?" . 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({
id: "1204",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/verify/gettemplate.json?${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 = {
"id": "1204",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/verify/gettemplate.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
id |
Integer | شناسه قالب. |
name |
String | نام قالب؛ همان مقدار template در verify/lookup. |
smsmessage |
String | متن پیامک قالب. |
callmessage |
String | متن تماس صوتی قالب. |
primarylinenumber |
String | خط ارسال اصلی. |
secondarylinenumber |
String | خط روش جایگزین. |
sendpriority |
String | روش ارسال اصلی: SMS یا Call. |
switchttl |
Integer | دقیقه انتظار قبل از روش جایگزین. |
approvalstatus |
String | وضعیت بررسی قالب، مثلا PendingReview یا Approved. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"id": 1204,
"name": "login",
"smsmessage": "کد ورود شما: %token\nپیامرس",
"callmessage": "",
"primarylinenumber": "10004346",
"secondarylinenumber": "",
"sendpriority": "SMS",
"switchttl": null,
"approvalstatus": "Approved"
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند:
- 424 قالب پیدا نشد.