документи

Надішліть своє перше повідомлення у другій половині дня

Звичайний REST API для надсилання, відстеження та отримання SMS — токен автентифікації, веб-хуки в реальному часі та SDK, без нічого екзотичного для навчання.

Швидкий старт

Три ходи, початок доставлено

Кожна інтеграція — це та сама коротка арка — автентифікація, надсилання, потім відстеження.

01 · АвтентифікуватиТокен: sk_live_9f2a7c10Тип вмісту: application/json ✓

Надсилайте свій ключ доступу як заголовок Token із Content-Type: application/json за кожним запитом.

02 · НадіслатиPOST /external/sms{ msgid: "9f2a7c10", код помилки: 0 }

ПУБЛІКУВАТИ від, до та вміст. Відповідь повертається з повідомленням і кодом помилки негайно.

03 · ТрекGET /report?status=Delivrd200 Добре

Ми ПУБЛІКУЄМО або ОТРИМУЄМО звіт про статус на вашу URL-адресу зворотного виклику в той момент, коли повідомлення досягає остаточного стану.

Надіслати

Один запит тією мовою, якою ви вже користуєтеся

ПУБЛІКУЙТЕ свого відправника, одержувача та вміст із заголовком Token. Відповідь повертається, коли ми її приймаємо.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Прийнято

msgid "9f2a7c10-4b2e-…"

напрямок "mt"

код помилки 0

Зберегти msgid — так ви відстежуєте це повідомлення звідси.

Об'єкт повідомлення

Прочитайте повідомлення зверху вниз

Надсилання, статус і вхідні події повертають ту саму форму — вивчіть це один раз.

01ID повідомлення

ID повідомлення

msgid — карбується в момент створення повідомлення. Це маркер, який ви використовуєте, щоб перевірити його статус пізніше.

02Відправник

Відправник

from — номер телефону або буквено-цифровий ідентифікатор довжиною до 11 символів, незалежно від того, який ідентифікатор бачать ваші одержувачі.

03одержувач

одержувач

кому — номер, на який прямує повідомлення, включаючи код країни.

04Кодування

Кодування

кодування даних — GSM7 вміщує 160 символів на частину; перейдіть на Юнікод, і це зменшиться до 70. Перейдіть, і він об’єднається в додаткові оплачувані частини.

05Напрямок

Напрямок

напрямок — кожне повідомлення mt (ви надіслали його) або mo (ви отримали його), однакова форма в будь-якому випадку.

06Код помилки

Код помилки

код помилки — повертається під час надсилання відповіді та кожного звіту про стан. 0 означає прийнято; все інше говорить вам, що саме пішло не так.

довідка

Одне закінчення, два дієслова

POST для надсилання, GET для перевірки статусу — той самий URL і той самий заголовок маркера в будь-якому випадку.

ПОСТ

Надіслати

Надішліть повідомлення та негайно отримайте повідомлення та код помилки.

Повернення msgid + код помилки
ОТРИМАТИ

Трек

Перегляньте повідомлення, яке ви вже надіслали, щоб перевірити його поточний статус.

Повернення повідомлення + статус
Веб-хуки

Звіти про стан у момент їх виникнення

Встановіть URL-адресу зворотного виклику, і кожна доставка, помилка та вхідна відповідь потраплять туди як GET або POST — опитування не потрібне.

доставленоmsgid 9f2a7c10 · статус Delivrd
вхіднийвідповідь отримана · напрямок мо
не вдалосяmsgid 4c81e2 · Статус Помилка
Ваша кінцева точка200 Добре
Почніть роботу

Отримайте ключ API

Почніть інтеграцію за лічені хвилини за допомогою нашого REST API.

Відповіді на Ваші запитання

Документи для розробників — запитання й відповіді

Передайте свій ключ доступу в заголовку Token кожного запиту — Token: {accessKey} — разом із Content-Type: application/json.

Кожне надсилання повертає msgid. Вкажіть нам URL-адресу зворотного виклику, і ми ОПУБЛІКУЄМО або ОТРИМАЄМО звіт про стан, щойно повідомлення досягне свого кінцевого стану — піддати, зробленої дати та кінцевого коду стану.

mt (mobile terminated) — повідомлення, яке ви надіслали; mo (з мобільного) – це відповідь, яку ви отримали. Обидва використовують однакову форму об’єкта повідомлення.

Повторна спроба доставки виконується відповідно до політики повторних спроб — нічого мовчки не скидається, але кінцева точка, яка ніколи не підтверджує, продовжуватиме отримувати повторні спроби.

160 символів у кодуванні GSM7 або 70 у кодуванні Unicode. Якщо перевищити ліміт, повідомлення об’єднається в кілька частин, кожна з яких оплачується окремо.