قالب‌های تایید

ویرایش قالب

یک قالب موجود را ویرایش می‌کند. همه پارامترهای ساخت قالب را دوباره بفرستید؛ قالب پس از ویرایش دوباره در انتظار بررسی می‌ماند.

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"

پاسخ

فیلدهای هر ردیف entries:

فیلدنوعتوضیح
templateid Integer شناسه قالب.
name String نام قالب.
textmessage String متن پیامک.
voicemessage String متن تماس.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": {
        "templateid": 1205,
        "name": "login",
        "sourcetype": 0,
        "sendmethod": 1,
        "fallbackmethod": 3,
        "textmessage": "کد ورود به فروشگاه: %token",
        "voicemessage": ""
    }
}

خطاهای رایج

علاوه بر خطاهای عمومی مثل 403 و 418، این متد ممکن است این کدها را در return.status برگرداند:

  • 424 قالب پیدا نشد.
  • 426 استفاده از این متد به سرویس پیشرفته نیاز دارد.
  • 432 پارامتر %token در متن قالب پیدا نشد.