Возвращает строку — статус отправки SMS-сообщения.
Принцип использования
| Синтаксис и URL для вызова метода |
| checkSms (int | string sms_id) |
| https://api.unisender.com/ru/api/checkSms?format=json&api_key=KEY&sms_id=ID |
| Аргументы |
| api_key * |
Ключ доступа к API. |
| sms_id * |
Код сообщения, возвращённый методом sendSms.
Пример:
sms_id=2376678.79092020303
sms_id=3123
|
| Возвращаемое значение |
| JSON-объект с единственным строковым полем status, принимающим одно из значений, описанных ниже. В будущем вероятно появление новых значений, но будет соблюдаться принцип: если статус начинается с err_ – значит, доставка не удалась. Если с ok_ – то доставка ещё идёт или удачно завершена. Исключение – статус 'not_sent'. |
| not_sent |
Сообщение пока не отправлено, ждёт отправки. Статус будет изменён после отправки. |
| ok_sent |
Сообщение отправлено, но статус доставки пока неизвестен. Статус временный и может измениться. |
| ok_delivered |
Сообщение доставлено. Статус окончательный. |
| err_src_invalid |
Доставка невозможна, отправитель задан неправильно. Статус окончательный. |
| err_dest_invalid |
Доставка невозможна, указан неправильный номер. Статус окончательный. |
| err_skip_letter |
Доставка невозможна, т.к. во время отправки был изменён статус телефона, либо телефон был удалён из списка, либо письмо было удалено. Статус окончательный. |
| err_not_allowed |
Доставка невозможна, этот оператор связи не обслуживается. Статус окончательный. |
| err_delivery_failed |
Доставка не удалась - обычно по причине указания формально правильного, но несуществующего номера или из-за выключенного телефона. Статус окончательный. |
| err_lost |
Сообщение было утеряно, отправитель должен переотправить сообщение самостоятельно, т.к. оригинал не сохранился. Статус окончательный. |
| err_internal |
внутренний сбой. Необходима переотправка сообщения. Статус окончательный. |
Примеры возвращаемого значения:
{"result":{"status":"ok_delivered"}}
{"error":"AK100313-05 [invalid sms id]","code":"unspecified","result":""}
|
