ارسال پیامک
لغو ارسال زمانبندیشده
پیامی را که با پارامتر 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"
<?php
$apiKey = 'YOUR_API_KEY';
$params = [
'messageid' => '8792343,8792344',
];
$ch = curl_init("https://api.payamras.ir/v1/{$apiKey}/sms/cancel.json?" . http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
if ($result['return']['status'] !== 200) {
throw new RuntimeException($result['return']['message']);
}
const apiKey = "YOUR_API_KEY";
const params = new URLSearchParams({
messageid: "8792343,8792344",
});
const response = await fetch(`https://api.payamras.ir/v1/${apiKey}/sms/cancel.json?${params}`);
const result = await response.json();
if (result.return.status !== 200) {
throw new Error(result.return.message);
}
import requests
api_key = "YOUR_API_KEY"
params = {
"messageid": "8792343,8792344",
}
response = requests.get(f"https://api.payamras.ir/v1/{api_key}/sms/cancel.json", params=params)
result = response.json()
if result["return"]["status"] != 200:
raise RuntimeError(result["return"]["message"])
پاسخ
فیلدهای هر ردیف entries:
| فیلد | نوع | توضیح |
|---|---|---|
messageid |
Long | شناسه پیام. |
status |
Integer | وضعیت پیام پس از لغو؛ 13 یعنی لغو شد. |
statustext |
String | شرح وضعیت. |
{
"return": {
"status": 200,
"message": "تایید شد"
},
"entries": [
{
"messageid": 8792343,
"status": 13,
"statustext": "لغو شده"
},
{
"messageid": 8792344,
"status": 13,
"statustext": "لغو شده"
}
]
}
خطاهای رایج
علاوه بر خطاهای عمومی مثل 403 و
418، این متد ممکن است این کدها را در
return.status برگرداند: