Документация API

Получить токен авторизации (login)

Запрос POST /remote-api/login
Параметры
  • name string [ваш логин от личного кабинета] - обязательное
  • password string [пароль] - обязательное
Ответ
{
  "status":"ok",
  "token":123456789asdfghjkl, // используйте для получения api ключа
}
Возможные ошибки:
{
  "status":"error",
  "message":"Неверные данные или метод запроса"
}
{
  "status":"error",
  "message":"Превышен лимит запросов", //лимит 5 запросов в минуту и 2 минуты пауза при превышении
}

Отправка сообщения для подтверждения телефона (sendPhoneCode)

Запрос POST /remote-api/sendPhoneCode
Параметры
  • token string [токен из первого метода] - обязательное
  • phone string - обязательное
  • Отправка сообщений возможна на номера в формате 375251234567
Ответ
{
  "status":"ok",
  "message":"Смс успешно отправлено"
}
Возможные ошибки:
{
  "status":"error",
  "message":"Данный токен не найден"
}
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}
{
  "status":"error",
  "message":"Некорректный запрос" //убедитесь, что используете POST запрос
}
{
  "status":"error",
  "message":"Превышен лимит запросов" //лимит 5 запросов в час
}

Отправка сообщения для подтверждения телефона (checkPhoneCode)

Запрос POST /remote-api/checkPhoneCode
Параметры
  • token string [токен из первого метода] - обязательное
  • code string - обязательное
Ответ
{
  "status":"ok",
  "message":"Номер успешно подтвержден"
}
Возможные ошибки:
{
  "status":"error",
  "message":"Данный токен не найден"
}
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}
{
  "status":"error",
  "message":"Некорректный запрос" //убедитесь, что используете POST запрос
}
{
  "status":"error",
  "message":"Превышен лимит запросов" //лимит 5 запросов в час
}

Получить api ключ (getApiKey)

Запрос POST /remote-api/getApiKey
Параметры
  • token string [токен из предыдущего метода] - обязательное
Ответ
{
  "status":"ok",
  "api_key":123456789asdfghjkl // используйте для остальных методов в качестве {token}
}
Возможные ошибки:
{
  "status":"error",
  "message":"Данный токен не найден"
}
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}
{
  "status":"error",
  "message":"Некорректный запрос" //убедитесь, что используете POST запрос
}
{
  "status":"error",
  "message":"Превышен лимит запросов" //лимит 5 запросов в минуту и 2 минуты пауза при превышении
}

Получить остаток на балансе (getBalance)

Запрос GET /api/v1/getBalance?token={token}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
Ответ
{
    "status": "OK",
    "currency": "BYN",
    "result": [
        {
            "balance": "18.44100",
            "viber_balance": "9.58000"
        }
    ]
}
Возможные ошибки:
{'error' : 'token is invalid'}

Получить api ключ (getApiKey)

Запрос POST /remote-api/getApiKey
Параметры
  • token string [токен из предыдущего метода] - обязательное
Ответ
{
  "status":"ok",
  "api_key":123456789asdfghjkl // используйте для остальных методов в качестве {token}
}
Возможные ошибки:
{
  "status":"error",
  "message":"Данный токен не найден"
}
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}
{
  "status":"error",
  "message":"Некорректный запрос" //убедитесь, что используете POST запрос
}
{
  "status":"error",
  "message":"Превышен лимит запросов" //лимит 5 запросов в минуту и 2 минуты пауза при превышении
}

Получение категорий для Альфа-имени (getAlphanameCategory)

Запрос GET /api/v1/getAlphanameCategory?token={token}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 2,
            "name": "Авто (все,что касается автомобильной индустрии)"
        },
        {
            "id": 3,
            "name": "Банки/займы"
        },
        ...
    ]
}
Возможные ошибки:
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}

Получение категорий для Альфа-имени (getVibernameCategory)

Запрос GET /api/v1/getVibernameCategory?token={token}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 2,
            "name": "Авто (все,что касается автомобильной индустрии)"
        },
        {
            "id": 3,
            "name": "Банки/займы"
        },
        ...
    ]
}
Возможные ошибки:
{
  "status":"error",
  "message":"Пользователя с таким токеном не найдено"
}

Создание нового Альфа-имени (createAlphaname)

Запрос POST /api/v1/createAlphaname
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
  • name string [Имя Альфа-имени] - обязательное
  • yur_name string [Юридическое лицо] - обязательное
  • unp int [Учетный номер плательщика] - обязательное
  • country_id int [Для РБ country_id = 1] - обязательное
  • postcode int [Индекс (Можно узнать на сайте белпочты)] - обязательное
  • city string [Город регистрации] - обязательное
  • address string [Юридический адрес (Если вы ИП, можно указать адрес проживания)] - обязательное
  • name_category_id int [Сфера деятельности компании ID (берется из метода getAlphanameCategory)] - обязательное
  • traffic_type_id int [Тип рассылки: 1 - Сервисная, 2 - Рекламная] - обязательное
  • text_example string [Пример текста рассылки] - обязательное
Ответ
{
    "status": "ok",
    "message": "Альфа-имя {Альфа-имя} успешно добавлено"
}
Возможные ошибки:
{
    "status": "error",
    "message": "Такое альфа-имя уже существует, выберите другое имя"
}
{
    "status": "error",
    "message": "Переданы не все данные"
}
{
    "status": "error",
    "message": "Минимальная длина Юридического имени 10 символов"
}
{
    "status": "error",
    "message": "Номер УНП состоит из 9-10 цифр"
}
{
    "status": "error",
    "message": "The selected alphaname category id is invalid."
}
{
    "status": "error",
    "message": "Параметр postcode должен содержать 6 цифр"
}
{
    "status": "error",
    "message": "Не удалось добавить Альфа-имя, повторите попытку еще раз"
}
{
    "status": "error",
    "message": "Минимальный размер имени - 3 символа, максимальный - 11 символов"
}
{
    "status": "error",
    "message": "В названии Альфа-имени допустимы только латинские буквы и цифры"
}

Получить все доступные Альфа-имена (getAlphanames)

Запрос GET /api/v1/getAlphanames?token={token}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
Ответ
{
  "0":"SaMiS", //id:name
  "888":"Romashka"
}
Возможные ошибки:
{"error":"У вас еще нет зарегистрированных и одобренных Альфаимен. Отправьте запрос на новое Альфаимя через app.sms.by"}

Получить id Альфа-имени по его названию (getAlphanameId)

Запрос GET /api/v1/getAlphanameId?token={token}&name={name}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
  • name string [Альфа-имя, например 'Romashka'] - обязательное
Ответ
{"id":888}
Возможные ошибки:
{"error":"Такого Альфаимени не существует или оно еще не активировано"}

Создание нового Viber-имени (createVibername)

Запрос POST /api/v1/createVibername
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
  • name string [Имя Viber-имени] - обязательное
  • yur_name string [Юридическое лицо] - обязательное
  • unp int [Учетный номер плательщика] - обязательное
  • country_id int [Для РБ country_id = 1] - обязательное
  • postcode int [Индекс (Можно узнать на сайте белпочты)] - обязательное
  • city string [Город регистрации] - обязательное
  • address string [Юридический адрес (Если вы ИП, можно указать адрес проживания)] - обязательное
  • name_category_id int [Сфера деятельности компании ID (берется из метода getVibernameCategory)] - обязательное
  • traffic_type_id int [Тип рассылки: 1 - Сервисная, 2 - Рекламная] - обязательное
  • text_example string [Пример текста рассылки] - обязательное
Ответ
{
    "status": "ok",
    "message": "Viber-имя {Viber-имя} успешно добавлено"
}
Возможные ошибки:
{
    "status": "error",
    "message": "Такое Viber-имя уже существует, выберите другое имя"
}
{
    "status": "error",
    "message": "Переданы не все данные"
}
{
    "status": "error",
    "message": "Минимальная длина Юридического имени 10 символов"
}
{
    "status": "error",
    "message": "Номер УНП состоит из 9-10 цифр"
}
{
    "status": "error",
    "message": "The selected alphaname category id is invalid."
}
{
    "status": "error",
    "message": "Параметр postcode должен содержать 6 цифр"
}
{
    "status": "error",
    "message": "Не удалось добавить Альфа-имя, повторите попытку еще раз"
}
{
    "status": "error",
    "message": "Минимальный размер имени - 3 символа, максимальный - 11 символов"
}
{
    "status": "error",
    "message": "В названии Viber-имени допустимы только латинские буквы и цифры"
}

Получить все доступные Viber-имена (getVibernames)

Запрос GET /api/v1/getVibernames?token={token}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 391,
            "name": "SMS.by"
        },
        {
            "id": 791,
            "name": "example"
        }
    ]
}
Возможные ошибки:
{"status": "error",
    "messages": "У вас еще нет зарегистрированных и одобренных Viber имен. Отправьте запрос на новое Альфаимя через app.sms.by"}

Получить id Viber-имени по его названию (getVibernameId)

Запрос GET /api/v1/getVibernameId?token={token}&name={name}
Параметры
  • token string [api ключ из метода getApiKey] - обязательное
  • name string [Альфа-имя, например 'Example'] - обязательное
Ответ
{
    "status": "OK",
    "result": {
        "id": 392
    }
}
Возможные ошибки:
{"status": "error",
    "messages":"Такого Viber-имени не существует или оно еще не активировано"}

Создание сообщения для массовой отправки (createSMSMessage)

Запрос GET /api/v1/createSmsMessage?token={token}&message={message}&alphaname_id={alphaname_id}&time={time}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message string [сообщение] - обязательное
  • alphaname_id int [ID альфа-имени] - опционально
  • time string [Дата и время отправки] - опционально (Формат даты "2019-05-24 10:22")
Ответ
{
   "status":"ok",
   "parts":1,                  // количество частей в сообщении
   "len":15,                   // длина сообщения
   "message_id":3,             // id сообщения (используется при отправке SMS)
   "alphaname":"system",       // альфа имя (по умолчанию system)
   "time : 1576134000          // Дата отправки в формате unixtime (если time : 0 - отправка сразу после модерации)
}
Возможные ошибки:
{"error":"The same message exists with ID=3"}
В случае дубликата сообщения
{'error' : 'Wrong alphaname. Check it is correct and approved.'}
Неверное альфа-имя
{'error' : 'Message is too long. Allowed size: 1530 chars for 10 sms (160 latin symbols /sms). 670 chars for 10 ciryllic sms, and 70/sms for cyrillic symbols.'}
Сообщение слишком большое
{'error' : 'undefined error'}
Ошибка приложения
{
  "status" : "error",
  "message" : "Не верный формат даты"
}

Проверка статуса сообщения (статуса смс-рассылки в целом) (checkSMSMessageStatus)

Запрос GET /api/v1/checkSMSMessageStatus?token={token}&message_id={message_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message_id (int) [ID сообщения полученный из метода createSmsMessage] обязательное
Ответ
{
    "status":"new", // статус сообщения, отправка СМС возможна только если статус == moderated
    "parts":1, // количество частей в СМС сообщении
    "alphaname":"SYSTEM" // альфа-имя
}
Возможные ошибки:
{'error' => 'incorrect arguments'}
Неправильные аргументы
{'error' => 'not found'}
Сообщение не найдено

Создание Viber сообщения для массовой отправки (createViberMessage)

Запрос POST /api/v1/createViberMessage
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message текс viber сообщение - обязательное
  • vibername_id (int) [ID viber имени из метода getVibernames] - обязательное
  • type (int) [1 - Сервесное сообщение, 2 - Рекламное сообщение] - не обязательно
    (Если параметр "type" не указан, автоматически принимается сообщение как рекламное)
  • time (string) [Время отправки сообщения указывается в формате "2019-05-24 10:00"] - не обязательно
Ответ
{
    "status": "OK",
    "data": {
        "message_id": 402,
        "message_type": "text",
        "vibername": "SMS.by",
        "d_schedule": 1590303600    // Время отправки сообщения (в формате unixtime)
    }
}
Возможные ошибки:
{
    "status": "error",
    "message": "Ошибка запроса, проверьте метод запроса"
}
{
    "status": "error",
    "message": "Сообщение не должно быть пустым"
}
{
    "status": "error",
    "message": "Не верно указан id имени или имя еще не подтверждено"
}
{
    "status": "error",
    "message": "Не верный формат даты"
}

Отправка Viber сообщения (sendViberMessage)

Запрос POST /api/v1/sendViberMessage
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • phone номер телефона для Viber сообщение - обязательное
  • viber_message_id (int) [ID viber сообщения из метода createViberMessage] - обязательное
  • Отправка сообщений возможна на номера в формате 375251234567
Ответ
{
    "status": "OK",
    "result": {
        "viber_id": "408",
        "message_status": "NEW",
        "count_subscribers": 1
    }
}
Возможные ошибки:
{
    "status": "error",
    "message": "Ошибка запроса, проверьте метод запроса"
}
{
    "status": "error",
    "message": "Некорректный номер телефона"
}
{
    "status": "error",
    "message": "Такого id viber сообщения нет"
}
{
    "status": "error",
    "message": "Недостаточно средств, пополните баланс"
}

Отправка одиночного Viber сообщения, (не требует предварительного создания) (sendQuickViberMessage)

Запрос POST /api/v1/sendQuickViberMessage
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • phone номер телефона для Viber сообщение - обязательное
  • vibername_id (int) [ID viber имени из метода getVibernames] - обязательное
  • message (string) текс Viber сообщения - обязательное
  • Отправка сообщений возможна на номера в формате 375251234567
Ответ
{
    "status": "OK",
    "result": {
        "viber_id": 490,
        "message_status": "NEW",
        "count_subscribers": 1
    }
}
Возможные ошибки:
{
    "status": "error",
    "message": "Ошибка запроса, проверьте метод запроса"
}
{
    "status": "error",
    "message": "Сообщение не должно быть пустым"
}
{
    "status": "error",
    "message": "Не верно указан id имени или имя еще не подтверждено"
}
{
    "status": "error",
    "message": "Некорректный номер телефона"
}
{
    "status": "error",
    "message": "Недостаточно средств, пополните баланс"
}

Получить список своих Viber сообщений (getViberMessageList)

Запрос GET /api/v1/getViberMessageList?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 321,
            "message": "text example",
            "d_create": 1582292900
        },
        {
            "id": 334,
            "message": "viber message",
            "d_create": 1582617409
        }
    ]
}
Возможные ошибки:
{
    "status" => "error",
    "message" => "У Вас нет viber сообщений."
}

Проверка статуса Viber сообщения (статуса Viber-рассылки в целом) (checkViberMessageStatus)

Запрос GET /api/v1/checkViberMessageStatus?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 321,
            "status": "SENT",
            "d_schedule": 1582292900
        },
        {
            "id": 334,
            "status": "SENT",
            "d_schedule": 1582617409
        }
    ]
}
Возможные ошибки:
{
    "status" => "error",
    "message" => "У Вас нет viber сообщений."
}

Просмотр входящих сообщений viber для id сообщения (getNewIncomingMessagesById)

Запрос GET /api/v1/getNewIncomingMessagesById?token={token}&viber_message_id={viber_message_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • viber_message_id int [Id сообщения из метода (getViberMessageList)] - обязательное
Ответ
{
    "status": "OK",
    "result": [
        {
            "id": 83,
            "receiver_at": "2019-12-09 10:22:14",
            "number_incoming": "375291234567",
            "message_text": "for example",
            "status": "new"
        }
    ]
}
Возможные ошибки:
{
    "status": "error",
    "message": "У Вас нет входящих сообщений"
}
{
    "status": "error",
    "message": "ID viber сообщения обязательно"
}

Просмотр входящих сообщений viber для id сообщения (readResponseStatus)

Запрос POST /api/v1/readResponseStatus
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • Запрос принимает данные типа json в формате { "read": [ { "id": "322" }, { "id": "421" } ] } - обязательное
Ответ
{
    "status": "OK",
    "message": "Данные получены"
}
Возможные ошибки:
{
    "status": "error",
    "message": "Нет данных для работы"
}
{
    "status": "error",
    "message": "Параметры не переданы"
}
{
    "status": "error",
    "message": "Ошибка запроса, проверьте метод запроса"
}

Получить список своих сообщений (getMessagesList)

Запрос GET /api/v1/getMessagesList?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
{
  "result":
    [
      {
        "message_id":1,
        "message":"test message",
        "parts":1,
        "d_create":"2016-07-18 09:17:59",
        "status":"moderated"
      },
      {
        "message_id":2,
        "message":
        "test message 2",
        "parts":1,
        "d_create":"2016-07-18 09:17:59",
        "status":"new"
      }
    ]  
}
Возможные ошибки:
{'error' => 'undefined error'}
Ошибка приложения

Отправка сообщения (sendSMS)

Запрос GET /api/v1/sendSms?token={token}&message_id={message_id}&phone={phone}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message_id int [ID сообщения] - обязательное
  • phone string [номер телефона] - обязательное
  • Отправка сообщений возможна на номера в формате 375251234567
Ответ
{
  "sms_id" : "3213", 
  "status" : "NEW"
}
Возможные ошибки:
{'error' : 'incorrect phone number'}
Неправильный номер телефона
{'error' : 'incorrect arguments'}
Ошибка в количестве или типах параметров
{'error' : 'billing error'}
Ошибка биллинга (например у пользователя нет API тарифного плана)
{'error' : 'message_id not found'}
Рассылка не найдена
{'error' : 'access denied'}
Рассылка не подтверждена администратором
{'error' : 'limit exceeded'}
Исчерпан лимит отправляемых сообщений в пределах тарифа
{'error' : 'undefined error'}
Ошибка приложения

Отправка одиночного сообщения (sendQuickSMS)

Запрос GET /api/v1/sendQuickSms?token={token}&message={message}&phone={phone}&alphaname_id={alphaname_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message string [cообщение] - обязательное
  • phone string [номер телефона] - обязательное
  • alphaname_id int [ID alphaname] - опционально (Если не будет указано, то будет приходить от системного имени))
  • Отправка сообщений возможна на номера в формате 375251234567
Ответ
{
  "sms_id" : "3213", 
  "status" : "NEW"
}
Возможные ошибки:
{'error' : 'Wrong alphaname. Check it is correct and approved.'}
Неверное альфа-имя
{'error' : 'Message is too long. Allowed size: 1530 chars for 10 sms (160 latin symbols /sms). 670 chars for 10 ciryllic sms, and 70/sms for cyrillic symbols.'}
Сообщение слишком большое
{'error' : 'limit exceeded'}
Исчерпан лимит отправляемых сообщений в пределах тарифа
{'error' : 'incorrect phone number'}
Неправильный номер телефона
{'error' : 'incorrect arguments'}
Ошибка в количестве или типах параметров
{'error' : 'billing error'}
Ошибка биллинга (например у пользователя нет API тарифного плана)
{'error' : 'access denied'}
Рассылка не подтверждена администратором
{'error' : 'limit exceeded'}
Исчерпан лимит отправляемых сообщений в пределах тарифа
{'error' : 'undefined error'}
Ошибка приложения

Получить количество оставшихся сообщений (getLimit)

Запрос GET /api/v1/getLimit?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
{
  "limit":1000
}
Возможные ошибки:
{'error' : 'undefined error'}
Ошибка приложения

Проверить статус SMS сообщения (checkSMS)

Запрос GET /api/v1/checkSMS?token={token}&sms_id={sms_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • sms_id int [ID SMS полученное при sendSMS] - обязательное
Ответ
{
  "sms_id":129,
  "delivered":1468841940 // время доставки в unixtime (если 0 сообщение не доставлено)
}
Возможные ошибки:
{'error' : 'incorrect arguments'}
Неправильное количество или типы аргументов
{'error' : 'not found'}
SMS не найдена

Создание объекта PasswordObject (createPasswordObject)

Запрос GET /api/v1/createPasswordObject?token={token}&type_id={type_id}&len={len}
Каждому пользователю доступно не более 20-ти объектов PasswordObject
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • type_id string - обязательное (может принимать следующие значения:
    letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип)
  • len - int длина пароля от 1 до 16
Ответ
{"result":{"password_object_id":8}}
Возможные ошибки:
{"error":"len value must be beetwen 1 and 16"}
{"error":"incorrect argument len"}
{"error":"incorrect argument type_id"}
{"error":"limit is exceeded"}

Редактирование объекта PasswordObject (editPasswordObject)

Запрос GET /api/v1/editPasswordObject?token={token}&id={password_object_id}&type_id={type_id}&len={len}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • id int - обязательное (id объекта возвращаемое из createPasswordObject)
  • type_id string - обязательное (может принимать следующие значения:
    letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип)
  • len - int длина пароля от 1 до 16
Ответ
{"result":"1"}
Возможные ошибки:
{"error":"incorrect argument id"}
{"error":"len value must be beetwen 1 and 16"}
{"error":"incorrect argument len"}
{"error":"incorrect argument type_id"}
{"error":"not found"}

Удаление объекта PasswordObject (deletePasswordObject)

Запрос GET /api/v1/deletePasswordObject?token={token}&id={password_object_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • id int - обязательное (id объекта возвращаемое из createPasswordObject)
Ответ
{"result":"1"}
Возможные ошибки:
{"error":"incorrect argument id"}
{"error":"not found"}

Получить все объекты PasswordObjects (getPasswordObjects)

Запрос GET /api/v1/getPasswordObjects?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
{"result":[{"id":3,"type_id":"both","len":8,"d_create":"2017-01-16 23:38:23"},{"id":4,"type_id":"numbers","len":4,"d_create":"2017-01-16 23:38:23"}]}
Возможные ошибки:
{"error":"not found"}

Получить объект PasswordObject по ID (getPasswordObject)

Запрос GET /api/v1/getPasswordObject?token={token}&id={password_object_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • id int - обязательное (id объекта возвращаемое из createPasswordObject)
Ответ
{"result":{"id":3,"type_id":"both","len":8,"d_create":"2017-01-16 23:41:29"}}
Возможные ошибки:
{"error":"not found"}

Отправить SMS с кодом подтверждения

Запрос GET /api/v1/sendSmsMessageWithCode?token={token}&message={message}&password_object_id={password_object_id}&phone={phone}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • password_object_id int - обязательное (id объекта возвращаемое из createPasswordObject)
  • phone string [номер телефона] - обязательное
  • message string - обязательное (сообщение должно обязательно содержать переменную для подстановки %CODE%)
    Например: message = Ваш пароль: %CODE%
  • alphaname_id int - опционально (смотрите использование Альфа-имен)
Ответ
[{"status":"ok","parts":1,"len":22,"sms_id":35143,"code":"B8REF99K"}]
parts - количество частей в сообщении
len - длина сообщения
sms_id - Смотрите здесь
Возможные ошибки:
{"error":"incorrect phone number"}
{"error":"incorrect message"}
{"error":"%CODE% template not found"}
{"error":"incorrect password_object_id"}
{"error":"password object not found"}
{"error":"alphaname is error"}
{"error":"message is too big"}
{"error":"message_id not found"}
{"error":"access denied"}
{"error":"limit excided"}

Получение всего списка имен смс рассылки (getSmsByList)

Запрос GET /api/v1/getSmsByList?token={token}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
Ответ
[{"id": 1,"name": "Рассылка"},{"id": 2,"name": "contacts"}]                   
Возможные ошибки:
{"error":"access denied"}
Неправильный API ключ
{"error": "У Вас еще нет СМС рассылок"}

Получение id искомого имени рассылки (getSmsByListId)

Запрос GET /api/v1/getSmsByListId?token={token}&name={name}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • name string [Имя рассылки] - обязательное
Ответ
{"id":6903}                  
Возможные ошибки:
{"error":"access denied"}
Неправильный API ключ
{"error": "Такого имени СМС рассылки нет"}

Отправка сообщений выбранному списку (sendSmsList)

Запрос GET /api/v1/sendSmsList?token={token}&message_id={message_id}&list_id={list_id}
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message_id string [ID сообщение из метода (createSmsMessage)] - обязательное
  • list_id string [ID списка с контактами] - обязательное
Ответ
{
  "status": "OK",
  "message": "Сообщения добавлены в очередь на рассылку"
}                  
Возможные ошибки:
{
  "status": "error",
  "message": "В списке нет телефонных номеров"
}
{
  "status": "error",
  "message": "Не верный ID сообщения"
}
{
  "status": "error",
  "message": "Недостаточно средств для рассылки"
}
{
  "status": "error",
  "message": "Произошла ошибка, повторите немного позднее"
}
{
  "status": "error",
  "message": "Не выбран список"
}

Отправка Viber сообщений выбранному списку (sendViberMessageList)

Запрос POST /api/v1/sendViberMessageList
Параметры
  • token string [ваш уникальный api ключ] - обязательное
  • message_id int [ID сообщение из метода (createViberMessage)] - обязательное
  • list_id int [ID списка с контактами] - обязательное
  • vibername_id int [ID viber имени] - обязательное
Ответ
{
    "status": "OK",
    "result": {
        "viber_id": "408",
        "message_status": "NEW",
        "count_subscribers": 2519
    }
}                  
Возможные ошибки:
{
  "status": "error",
  "message": "В списке нет телефонных номеров"
}
{
  "status": "error",
  "message": "Не верный ID сообщения"
}
{
  "status": "error",
  "message": "Недостаточно средств для рассылки"
}
{
  "status": "error",
  "message": "Произошла ошибка, повторите немного позднее"
}
{
  "status": "error",
  "message": "Не выбран список"
}

Общие ошибки для всех методов

Возможные ошибки:
{'error' : 'unsupported method'}
Метод не поддерживается
{'error' : 'token is invalid'}
Недействительный токен