Документы

Отправьте свое первое сообщение во второй половине дня

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

Быстрый старт

Три хода, начните доставлять

Каждая интеграция представляет собой одну и ту же короткую дугу — аутентификация, отправка, затем отслеживание.

01 · АутентификацияТокен: sk_live_9f2a7c10Тип контента: приложение/json ✓

Отправляйте свой ключ доступа в виде заголовка токена с типом контента: application/json при каждом запросе.

02 · ОтправлятьPOST/внешний/смс{ msgid: "9f2a7c10", код ошибки: 0 }

ОПУБЛИКОВАТЬ от, до и содержание. Ответ немедленно возвращается с msgid и кодом ошибки.

03 · ОтслеживатьGET /report?status=Доставка200 ОК

Мы ОТПРАВЛЯЕМ или ПОЛУЧАЕМ отчет о состоянии на ваш URL-адрес обратного вызова в тот момент, когда сообщение достигает своего окончательного состояния.

Отправлять

Один запрос на языке, который вы уже используете

ОТПРАВЬТЕ отправителя, получателя и контент с заголовком токена. Ответ возвращается в тот момент, когда мы его принимаем.

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 · Принято

мсгид «9f2a7c10-4b2e-…»

направление "метр"

код ошибки 0

Сохраните мсгид — вот как вы отслеживаете это сообщение.

Объект сообщения

Прочитать сообщение сверху вниз

События отправки, статуса и входящие события возвращают одинаковую форму — усвойте ее один раз.

01Идентификатор сообщения

Идентификатор сообщения

msgid — создается в момент создания сообщения. Это дескриптор, который вы используете, чтобы позже проверить его статус.

02Отправитель

Отправитель

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

03Получатель

Получатель

to — номер, на который будет отправлено сообщение, включая код страны.

04Кодирование

Кодирование

кодирование данных — GSM7 умещает 160 символов на часть; переключитесь на Unicode, и это число упадет до 70. Перейдите, и оно объединится в дополнительные оплачиваемые части.

05Направление

Направление

направление — каждое сообщение имеет формат mt (вы его отправили) или mo (вы его получили), в любом случае одна и та же форма.

06Код ошибки

Код ошибки

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

Ссылка

Одна конечная точка, два глагола

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

ПОЧТА

Отправлять

Отправьте сообщение и немедленно получите обратно msgid и код ошибки.

Возврат msgid + код ошибки
ПОЛУЧАТЬ

Отслеживать

Найдите сообщение, которое вы уже отправили, чтобы проверить его текущий статус.

Возврат сообщение + статус
Вебхуки

Отчеты о состоянии в тот момент, когда они происходят

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

доставленныйmsgid 9f2a7c10 · статус доставки
входящийответ получен · направление мес.
неуспешныйmsgid 4c81e2 · статус Ошибка
Ваша конечная точка200 ОК
Начать

Получите свой API-ключ

Начните интеграцию с помощью нашего REST API за считанные минуты.

Ответы на ваши вопросы

Документация для разработчиков — часто задаваемые вопросы

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

Каждая отправка возвращает msgid. Укажите нам URL-адрес обратного вызова, и мы ОТПРАВИМ или ПОЛУЧИМ к нему отчет о состоянии в тот момент, когда сообщение достигнет своего окончательного состояния — включая субдату, Donedate и результирующий код статуса.

mt (мобильное завершение) — отправленное вами сообщение; mo (с мобильного телефона) — это полученный вами ответ. Оба используют одну и ту же форму объекта сообщения.

Доставка повторяется в соответствии с политикой повторных попыток — ничего не отбрасывается автоматически, но конечная точка, которая никогда не подтверждает, будет продолжать получать повторные попытки.

160 символов в кодировке GSM7 или 70 в кодировке Unicode. Если превысить лимит, сообщение будет объединено в несколько частей, каждая из которых оплачивается отдельно.