ارسال پیامک

لغو ارسال زمان‌بندی‌شده

پیامی را که با پارامتر date زمان‌بندی شده و هنوز ارسال نشده لغو می‌کند. هزینه پیام لغوشده به اعتبار حساب برمی‌گردد.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/sms/cancel.json
  • فقط پیام‌های زمان‌بندی‌شده (وضعیت 2) قابل لغو هستند.
  • برای شناسه نامعتبر یا متعلق به حساب دیگر، وضعیت 100 برمی‌گردد.

پارامترها

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

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

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/sms/cancel.json" \
  --data-urlencode "messageid=8792343,8792344"

پاسخ

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

فیلدنوعتوضیح
messageid Long شناسه پیام.
status Integer وضعیت پیام پس از لغو؛ 13 یعنی لغو شد.
statustext String شرح وضعیت.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": [
        {
            "messageid": 8792343,
            "status": 13,
            "statustext": "لغو شده"
        },
        {
            "messageid": 8792344,
            "status": 13,
            "statustext": "لغو شده"
        }
    ]
}

خطاهای رایج

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

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