Sms API
Мы открываем Вам дополнительные возможности с помощью подключения к нашему сервису по Sms API. Вы имеете возможность интегрироваться с нашей платформой и полностью автоматизировать процессы рассылки смс. Для этого в личном кабинете необходимо запросить активацию API.
Отправка сообщения
Пример запроса на рассылку сообщения по 4-м респондентам:Если сообщение было поставлено в очередь успешно будет дан следующий ответ, с указанием id сообщений:
<?xml version="1.0" encoding="UTF-8"?> <request> <auth> <login>380501234567</login> <password>p1a2s3s4</password> </auth> <message> <from>Sender</from> <text>Тестовое сообщение.</text> <recipient>380501234567</recipient> <recipient>380501234569</recipient> <recipient>380677654323</recipient> <recipient>380677654324</recipient> </message> </request>
Если были ошибки:
<?xml version="1.0" encoding="UTF-8"?> <response> <name>Complete</name> <description>4 messages put into queue</description> <sms_id>633217</sms_id> <sms_id>633218</sms_id> <sms_id>633219</sms_id> <sms_id>633220</sms_id> </response>
Коды ошибок:
<?xml version="1.0" encoding="UTF-8"?> <response> <name>Error</name> <description>Код ошибки</description> </response>
- NO_DATA (ошибка данных: не передан XML)
- WRONG_DATA_FORMAT (ошибка формата переданного XML)
- REQUEST_FORMAT (неправильный тип запроса)
- AUTH_DATA (ошибка авторизации: несуществующий пользователь, неправильная пара логин-пароль)
- API_DISABLED (для учетной записи пользователя запрещена работа с API)
- USER_NOT_MODERATED (запрещена отправка сообщений без проверки для учетной записи пользователя)
- INCORRECT_FROM (некорректное имя отправителя)
- INVALID_FROM (несуществующее имя отправителя для данной учетной записи)
- MESSAGE_TOO_LONG (превышена максимальная длина сообщения: 402 для кириллицы, 459 для латиницы)
- NO_MESSAGE (пустое сообщение для оправки)
- MAX_MESSAGES_COUNT (превышено максимальное количество респондентов в одном запросе: 50)
- NOT_ENOUGH_MONEY (недостаточно средств для отправки сообщения респондентам в запросе)
- UNKNOWN_ERROR (неизвестная ошибка)
- INCORRECT_RECIPIENT_ (укажет первый неправильный номер из списка, который нужно исключить и повторно отправить запрос; не отправит смс всем из списка)
Получение статуса сообщения
Пример запроса на получение статуса по id сообщения:Если сообщение найдено будет дан ответ с указанием статуса:
<?xml version="1.0" encoding="UTF-8"?> <request> <auth> <login>380671234567</login> <password>p1a2s3s4</password> </auth> <sms_id>632647</sms_id> </request>
Возможные статусы:
<?xml version="1.0" encoding="UTF-8"?> <response> <name> Status</name> <description>Статус сообщения</description> </response>
- MESSAGE_IS_DELIVERED (сообщение доставлено респонденту)
- MESSAGE_IS_SENT (сообщение отправлено)
- MESSAGE_NOT_DELIVERED (сообщение не доставлено)
- MESSAGE_IN_QUEUE (сообщение поставлено в очередь на отправку)
Коды ошибок:
<?xml version="1.0" encoding="UTF-8"?> <response> <name>Error</name> <description>Код ошибки</description> </response>
- NO_DATA (ошибка данных: не передан XML)
- WRONG_DATA_FORMAT (ошибка формата переданного XML)
- REQUEST_FORMAT (неправильный тип запроса)
- AUTH_DATA (ошибка авторизации: несуществующий пользователь, неправильная пара логин-пароль)
- API_DISABLED (для учетной записи пользователя запрещена работа с API)
- MESSAGE_NOT_EXIST (сообщение с заданным id не существует)
- UNKNOWN_ERROR (неизвестная ошибка)
Получение баланса пользователя
Пример запроса на получение баланса:Ответ:
<?xml version="1.0" encoding="UTF-8"?> <request> <auth> <login>380671234567</login> <password>p1a2s3s4</password> </auth> <balance /> </request>
Если были ошибки:
<?xml version="1.0" encoding="UTF-8"?> <response> <name>Balance</name> <description>Количество средств на счету пользователя</description> <currency>Валюта счета пользователя</currency> </response>
Коды ошибок:
<?xml version="1.0" encoding="UTF-8"?> <response> <name>Error</name> <description>Код ошибки</description> </response>
- NO_DATA (ошибка данных: не передан XML)
- WRONG_DATA_FORMAT (ошибка формата переданного XML)
- REQUEST_FORMAT (неправильный тип запроса)
- AUTH_DATA (ошибка авторизации: несуществующий пользователь, неправильная пара логин-пароль)
- API_DISABLED (для учетной записи пользователя запрещена работа с API)
- UNKNOWN_ERROR (неизвестная ошибка)
Пример кода для отправки запроса и получения ответа в формате XML на языке PHP
<?php
$sUrl = 'https://api.letsads.com';
$sXML = '<?xml version="1.0" encoding="UTF-8"?>
<request>
<auth>
<login>380501234567</login>
<password>p1a2s3s4</password>
</auth>
<balance />
</request>';
$rCurl = curl_init($sUrl);
curl_setopt($rCurl, CURLOPT_HEADER, 0);
curl_setopt($rCurl, CURLOPT_POSTFIELDS, $sXML);
curl_setopt($rCurl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($rCurl, CURLOPT_POST, 1);
$sAnswer = curl_exec($rCurl);
curl_close($rCurl);
Ваше сообщение отправлено. Спасибо.
Отправить еще одно сообщение.