وضعیت و گزارش ارسال

وضعیت با شناسه محلی

وضعیت پیام را با localid که هنگام ارسال فرستاده‌اید برمی‌گرداند؛ وقتی messageid را ذخیره نکرده‌اید، مثلا پس از قطع ارتباط وسط ارسال.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/statuslocalmessageid.json
  • فقط پیام‌های ۱۲ ساعت اخیر.
  • localid ناموجود وضعیت 100 می‌گیرد.

پارامترها

نامنوعتوضیح
localid الزامی Long شناسه محلی پیام. چند شناسه را با ویرگول جدا کنید.

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/statuslocalmessageid.json" \
  --data-urlencode "localid=450,451"

پاسخ

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

فیلدنوعتوضیح
messageid Long شناسه پیام در پیام‌رس.
localid Long شناسه محلی شما.
status Integer وضعیت پیام.
statustext String شرح وضعیت.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "localid": 450,
            "status": 10,
            "statustext": "رسیده به گیرنده"
        },
        {
            "messageid": 0,
            "localid": 451,
            "status": 100,
            "statustext": "شناسه نامعتبر است"
        }
    ]
}

خطاهای رایج

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

  • 414 تعداد رکوردها از سقف مجاز یک درخواست بیشتر است.