قالبهای تایید
ویرایش قالب
یک قالب موجود را ویرایش میکند. همه پارامترهای ساخت قالب را دوباره بفرستید؛ قالب پس از ویرایش دوباره در انتظار بررسی میماند.
POST
GET
https://api.payamras.ir/v1/YOUR_API_KEY/verify/updatetemplate.json
پارامترها
| نام | نوع | توضیح |
|---|---|---|
templateId
الزامی
|
Integer | شناسه قالب. |
name
الزامی
|
String | نام قالب. |
sourceType
الزامی
|
Integer | 0 وبسایت، 1 اپلیکیشن موبایل. |
sendMethod
الزامی
|
Integer | 1 پیامک، 2 تماس صوتی. |
fallBackMethod
اختیاری
|
Integer | 0 پیشفرض سیستم، 1 پیامک، 2 تماس، 3 غیرفعال. |
textMessage
اختیاری
|
String | متن پیامک؛ با %token. |
voiceMessage
اختیاری
|
String | متن تماس؛ با %token. |
primaryLineNumber
اختیاری
|
String | خط ارسال اصلی. |
secondaryLineNumber
اختیاری
|
String | خط روش جایگزین. |
switchTTL
اختیاری
|
Integer | دقیقه انتظار قبل از روش جایگزین (۱ تا ۵). |
sourceName
اختیاری
|
String | نام وبسایت یا اپلیکیشن. |
sourceUrl
اختیاری
|
String | آدرس وبسایت یا صفحه اپلیکیشن. |
نمونه درخواست
curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/verify/updatetemplate.json" \
--data-urlencode "templateId=1205" \
--data-urlencode "name=login" \
--data-urlencode "sourceType=0" \
--data-urlencode "sendMethod=1" \
--data-urlencode "textMessage=کد ورود به فروشگاه: %token"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'templateId' => '1205',
'name' => 'login',
'sourceType' => '0',
'sendMethod' => '1',
'textMessage' => 'کد ورود به فروشگاه: %token',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/verify/updatetemplate.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({
templateId: "1205",
name: "login",
sourceType: "0",
sendMethod: "1",
textMessage: "کد ورود به فروشگاه: %token",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/verify/updatetemplate.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 = {
"templateId": "1205",
"name": "login",
"sourceType": "0",
"sendMethod": "1",
"textMessage": "کد ورود به فروشگاه: %token",
}
response = requests.post(f"https://api.payamras.ir/v1/{api_key}/verify/updatetemplate.json", data=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
templateid |
Integer | شناسه قالب. |
name |
String | نام قالب. |
textmessage |
String | متن پیامک. |
voicemessage |
String | متن تماس. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": {
"templateid": 1205,
"name": "login",
"sourcetype": 0,
"sendmethod": 1,
"fallbackmethod": 3,
"textmessage": "کد ورود به فروشگاه: %token",
"voicemessage": ""
}
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: