API дозволяє розсилати повідомлення через ваші проекти і сервіси по протоколах HTTP/HTTPS, SMTP і SMPP. Готові бібліотеки різними мовами програмування підключаються до вашого проекту та допомагають надсилати повідомлення з будь-якого місця за допомогою однієї команди. Для спрощеної авторизації замість пари логін і пароль можна використовувати спеціальний API-ключ.
Для перевірки статусу доставки SMS використовуються методи get_status і get_status2.
У методі get_status2 є можливість додавання додаткових параметрів.
$client = new SoapClient ('https://smsc.ua/sys/soap.php?wsdl'); $ret = $client->get_status(array('login'=>'alex', 'psw'=>'123', 'phone'=>'79999999999', 'id'=>'999', 'all'=>'0'));
Серверу передаються наступні параметри:
Параметр
Значення
login
Логін Клієнта.
psw
Пароль Клієнта (можна додати або редагувати на даннійсторінці).
apikey
Спеціальний API-ключ, який використовується для спрощеної авторизації замість пари "логін + пароль" (можна створити на даний сторінка).
phone
Номер телефону.
id
Ідентифікатор повідомлення.
all
0 – (за замовчуванням) отримати статус повідомлення в звичайному форматі.
1 – отримати повну інформацію про відправлене повідомлення.
2 – додати в інформацію про повідомлення дані про оператора і Регіон абонента.
query
Рядок додаткових параметрів (тільки в get_status2),
переданих у форматі: 'параметр1=значення-1&параметр2=значення-2'.
Дата останньої зміни статусу. Формат DD.MM.YYYY HH:mm: ss.
err
Код помилки, якщо повідомлення не може бути доставлене (список).
error
Код помилки, якщо статус не може бути запитаний.
all = 1
send_date
Дата відправки повідомлення (формат DD.MM.YYYY hh:mm:ss).
phone
Номер телефону абонента.
cost
Вартість повідомлення.
sender_id
Ім'я відправника.
status_name
Назва статусу.
message
Текст повідомлення.
sms_cnt
Кількість частин в SMS-повідомленні (або секунд в голосовому повідомленні).
all = 2
operator
Назва оператора абонента.
region
Регіон реєстрації номера абонента.
Код помилки (error) може приймати такі значення:
Значення
Опис
1
Помилка в параметрах.
2
Невірний логін або пароль. Також виникає при спробі відправки повідомлення з IP-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
3
Повідомлення не знайдене.
4
IP-адреса тимчасово заблокована.
9
Спроба відправки більше п'яти запитів на отримання статусу одного і того ж повідомлення протягом хвилини.