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

جزئیات قالب

یک قالب را با شناسه‌اش برمی‌گرداند.

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"

پاسخ

فیلدهای هر ردیف 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.
response.json
{
    "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 قالب پیدا نشد.