وضعیت تحویل
دریافت وضعیت تحویل یک پیامک با شناسهٔ ارسال.
GET
/api/v1/sms/{message_id}/status
وضعیت لحظهای یک پیامک را برمیگرداند. مقدار status یکی از اینهاست:
| مقدار | معنی |
|---|---|
pending |
در صف ارسال |
sent |
تحویل به مخابرات |
delivered |
تحویل به گوشی گیرنده |
failed |
ناموفق |
rejected |
رد شده (فیلتر محتوا یا شماره نامعتبر) |
پارامترها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
message_id |
string (path) | بله | شناسهٔ ارسال که هنگام ارسال دریافت کردهاید. مثال: msg_9f2c1a |
نمونه کد
cURL
curl https://api.irnoti.com/v1/sms/msg_9f2c1a/status \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx"
PHP
<?php
$messageId = 'msg_9f2c1a';
$ch = curl_init("https://api.irnoti.com/v1/sms/{$messageId}/status");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx'],
]);
$status = json_decode(curl_exec($ch), true)['data']['status'] ?? null;
curl_close($ch);
echo $status;