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

فهرست قالب‌ها

قالب‌های پیامک تایید حساب را، صفحه به صفحه، با وضعیت تایید هر کدام برمی‌گرداند.

GET
https://api.payamras.ir/v1/YOUR_API_KEY/verify/templatelist.json
  • هر صفحه حداکثر ۲۰۰ قالب.

پارامترها

نامنوعتوضیح
page اختیاری Integer شماره صفحه؛ پیش‌فرض ۱.

نمونه درخواست

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/verify/templatelist.json" \
  --data-urlencode "page=1"

پاسخ

فیلدهای هر ردیف 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"
        }
    ],
    "metadata": {
        "totalcount": 1,
        "currentpage": 1,
        "totalpages": 1,
        "pagesize": 200
    }
}

خطاهای رایج

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

  • 426 استفاده از این متد به سرویس پیشرفته نیاز دارد.