Тарифи  Послуги  API  Партнерам  Про сервіс  Контакти 
0 (800) 30 7672
Безкоштовно по Україні
 

Інтеграція з сервісом (API)

API дозволяє розсилати повідомлення через ваші проекти і сервіси по протоколах HTTP/HTTPS, SMTP і SMPP. Готові бібліотеки різними мовами програмування підключаються до вашого проекту та допомагають надсилати повідомлення з будь-якого місця за допомогою однієї команди. Для спрощеної авторизації замість пари логін і пароль можна використовувати спеціальний API-ключ.
HTTP/HTTPS SMTP SMPP SOAP OMS SMS-команди Бібліотеки та приклади коду

ВІДПРАВКА ПОВІДОМЛЕНЬ

Відправка SMS-повідомлення

Коментарі в SMS-повідомленнях

Відправка на групу номерів

Відправка HLR-запиту

Відправка e-mail повідомлення

Надсилання голосового повідомлення (дзвінок)

Відправка viber-повідомлення

Відправлення повідомлення в Telegram

Відправлення повідомлення в чат-бот Telegram

Використання префіксів при відправці повідомлень

Керування шаблонами повідомлень

Керування шаблонами операторів

Віртуальна відправка (режим тестування)

Повідомлення про події

УПРАВЛІННЯ РОЗСИЛКАМИ

СТАТУСИ ПОВІДОМЛЕНЬ

ПЕРЕВІРКА СТАНУ БАЛАНСУ

УПРАВЛІННЯ КОНТАКТАМИ

УПРАВЛІННЯ КЛІЄНТАМИ

КЕРУВАННЯ ІМЕНАМИ ВІДПРАВНИКІВ (SENDER ID)

ОТРИМАННЯ ДАНИХ

РІЗНЕ

Контакти та групи. Відповідь сервера та коди помилок

У разі помилки Сервер повертає наступний рядок:
  • ERROR = N (опис)

  • При fmt = 1:
    0,-N

  • При fmt = 2:
    <result>
    <error>опис</error>
    <error_code>N</error_code>
    </result>

  • При fmt = 3:
    {
    "error": "опис",
    "error_code": N
    }
N – номер помилки, може приймати наступні значення:

ЗначенняОпис
1Помилка в параметрах.
2Невірний логін або пароль. Також виникає при спробі відправки повідомлення з IP-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
3Записи не знайдені.
4IP-адреса тимчасово заблокована.
5Помилка виконання операції.
9Спроба відправки більше трьох однакових запитів на операції з групами, контактами або записами "чорного" списку протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді рядка.

При створенні контакту, групи контактів, записи "чорного" списку:
  • при fmt = 0: ID = <id>

  • при fmt = 1: <id>

  • при fmt = 2 (створення контакту, запису "чорного" списку):
    <phone>
    <id>id</id>
    </phone>

  • при fmt = 2 (створення групи):
    <group>
    <id>id</id>
    </group>

  • при fmt = 3:
    {
    "id": <id>
    }

Де <id> - ідентифікатор контакту, групи або запису "чорного" списку, призначений Сервером автоматично.

При зміні або видаленні контакту (групи), видаленні запису "чорного" списку:
  • при fmt = 0,1: OK

  • при fmt = 2: <result>OK</result>

  • при fmt = 3:
    {
    "result": "OK"
    }


При запиті списку контактів:
  • при fmt = 0:
    phone = <phone>, name = <name>, group = <group>, first_name = <first_name>, last_name = <last_name>, middle_name = <middle_name>, birthday = <birthday>, id = <id>, comments = <comments>, tags = <tags>, phone_other = <phone_other>
    ...

  • при fmt = 1:
    <phone>,<name>,<group>,<first_name>,<last_name>,<middle_name>,<birthday>,<id>,<comments>,<tags>,<phone_other>
    ...

  • при fmt = 2:
    <list>
    <contact>
    <phone>phone</phone>
    <name>name</name>
    <group>group</group>
    <first_name>first_name</first_name>
    <last_name>last_name</last_name>
    <middle_name>middle_name</middle_name>
    <birthday>birthday</birthday>
    <id>id</id>
    <comments>comments</comments>
    <tags>tags</tags>
    <phone_other>phone_other</phone_other>
    </contact>
    ...
    </list>

  • при fmt = 3:
    [{
    "phone": "<phone>",
    "name": "<name>",
    "group": <group>,
    "first_name": "<first_name>",
    "last_name": "<last_name>",
    "middle_name": "<middle_name>",
    "birthday": "<birthday>",
    "id": "<id>",
    "comments": "<comments>",
    "tags": "<tags>",
    "phone_other": "<phone_other>"
    },
    ...]

Де:
<phone> – список номерів телефонів через будь-який роздільник. Для e-mail адрес замінюється на <mail>.
<name> – назва контакту.
<group> – ідентифікатор групи, до якої належить контакт.
<first_name> – ім'я.
<last_name> – прізвище.
<middle_name> – по батькові.
<birthday> – дата народження у форматі дд.мм.рррр.
<id> – id контакту, призначений Клієнтом.
<comments> – коментарі.
<tags> – теги (мітки).
<phone_other> - інші номери телефонів. За даними номерами розсилка повідомлень не виконується. Для e-mail адрес замінюється на <mail_other>.

При запиті списку груп:
  • при fmt = 0:
    id = <id>, name = <name>, number = <number>, cnt = <cnt>
    ...

  • при fmt = 1:
    <id>,<name>,<number>,<cnt>
    ...

  • при fmt = 2:
    <list>
    <group>
    <id>id</id>
    <name>name</name>
    <number>number</number>
    <cnt>number</cnt>
    </group>
    ...
    </list>

  • при fmt = 3:
    [{
    "id": <id>,
    "name": "<name>",
    "number": <number>,
    "cnt": "<cnt>"
    },
    ...]

Де:
<id> – ідентифікатор групи, призначений Сервером при створенні.
<name> – назва групи.
<number> – номер групи для розсилок.
<cnt> – кількість контактів у групі.

При запиті елементів "чорного" списку:
  • при fmt = 0:
    id = <id>, phone = <phone>, type = <type>, comment = <comment>
    ...

  • при fmt = 1:
    <id>,<phone>,<type>,<comment>
    ...

  • при fmt = 2:
    <list>
    <record>
    <id>id</id>
    <phone>phone</phone>
    <type>type</type>
    <comment>comment</comment>
    </record>
    ...
    </list>

  • при fmt = 3:
    [{
    "id": <id>,
    "phone": "<phone>",
    "type": <type>,
    "comment": "<comment>"
    },
    ...]

Де:
<id> – ідентифікатор елемента, призначений Сервером при створенні.
<phone> – номер телефону (або <email> при запиті" чорного " списку e-mail).
<type> – тип блокування: 0-всі повідомлення, 1-масові розсилки, 2-поодинокі повідомлення.
<comment> – коментарі.



© 2003–2024 ТОВ " СМСЦЕНТР»
Код ЄДРПОУ 38404962 		support@smsc.ua
Контакти 		Дизайн — Студія Артемія Лебедєва
Інформація про сайт 		SMS-центр для Android Яндекс.Метрика