СМС API

Обзор

SMS Local SMS API позволяет вам тестировать отправку SMS-сообщений в любое место назначения через REST API. Каждое сообщение идентифицируется уникальным случайным идентификатором, чтобы пользователи всегда могли проверить статус сообщения, используя заданную конечную точку. SMS Local SMS API использует HTTP-глаголы и структуру конечной точки RESTful с ключом доступа (токеном), который используется в качестве авторизации API. Полезные данные запроса и ответа форматируются как JSON с использованием кодировки UTF-8 и URL-кодированных значений.

Конечная точка API

Все URL-адреса, упомянутые в SMS Локальная документация API CPaaS SMS имеет базовый URL:

https:// {secure.smslocal.com} /api/service/enterprise-service/external/sms

Доступные HTTP-методы 

SMS Local API использует HTTP-глаголы, чтобы понять, хотите ли вы прочитать (GET) или создать (POST) объект.

POST {протокол}:// {secure.smslocal.com} /api/service/enterprise-service/external/sms ПОЛУЧИТЬ {протокол}:// {secure.smslocal.com} /api/service/enterprise-service/external/sms

Параметры аутентификации

Параметр	Описание
Токены	При вызове нашего API отправьте свой ключ доступа с типом аутентификации Token (пример: Token: {accessKey}). Обязательно.
Content-Type	Установить в application/json

Пример аутентификации:

завиток -X POST https://test-cpaas.enabld.tech/api/service/enterprise-service/external/sms -H
Токены: 7К1аСейджлЕ5ФУф0

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

Атрибуты	Тип	Описание
мсгид	UUID	Уникальный случайный идентификатор, который создается на платформе поставщика услуг и возвращается при создании объекта.
С	строка	Отправитель сообщения. Это может быть номер телефона (включая код страны) или буквенно-цифровая строка. В случае буквенно-цифровой строки максимальная длина составляет 11 символов.
в	Int	Номер получателя
содержание	string	Содержание СМС-сообщения
кодирование данных	Int	Примечание: использование Unicode ограничит максимальное количество символов до 70 вместо 160. Если размер символов в сообщении превышает ограничение, сообщения будут объединены, в результате чего за сообщения будет взиматься отдельная плата.
Отправить	Дата и время	Дата и время создания сообщения в формате RFC3339 (Ym-dTH:i:sP)
направление	string	Сообщает, отправлено или получено сообщение. mt: отправлено с мобильного (отправлено на мобильный) mo: отправлено с мобильного (получено с мобильного)
код ошибки	Int	Код ошибки сообщения

Пример объекта сообщения (SMS)

{“мсгид“:”jsauGFsyuadssaiu”,
от":"новый",
в“:”373795846855”,
направление“:”мт”,
содержание“:”Это тестовое сообщение”,
«кодирование данных»: «0»,
отправитьВкл“:”2022-12-29T15:10:00+02:00”,
«код ошибки»:»200″}

Отправить смс

SMS Local Программируемый SMS API позволяет вам программно отправлять SMS-сообщения из вашего веб-приложения. Сначала вам нужно создать новый объект сообщения. SMS Local возвращает созданный объект сообщения с каждым запросом. Отправьте свое первое SMS-сообщение с помощью этого примера запроса.

Пример запроса

curl –расположение –запрос POST https://test-cpaas.enabld.tech/api/service/enterprise-service/external/sms
-заголовок Content-Type: приложение/json –заголовок
Токены: 7К1аСейджлЕ5ФУф0
данные{“от”:”новый”, “до”:”373795846855″,”содержание”:”Это тестовое сообщение.«}

Пример ответа

мсгид“: “d0skeudgeh2l”, “код ошибки“: “200”

Отчет о состоянии обработки

Отчеты о состоянии — это запросы HTTP GET или POST, которые отправляются на вашу платформу. Запросы содержат информацию о состоянии сообщения, которое вы отправили через наш API. Отчеты о состоянии предоставляются только для SMS-сообщений, у которых есть ссылка, определенная при отправке сообщения, и URL-адрес отчета о состоянии устанавливается как URL-адрес отчета при отправке сообщения или настраивается в их учетной записи как конечная точка обратного вызова.

Атрибуты	Тип	Описание
мсгид	string	Идентификатор сообщения, присвоенный сообщению системой CPaaS при первоначальной отправке.
получатель	Int	MSISDN получателя.
статус	целочисленный \| нулевой	Код ошибки, описывающий сбой (необязательно, null, если недоступно). Он может содержать код ошибки, специфичный для сети, или код ошибки SMSC для попытки доставки сообщения.
Код ошибки статуса	string	Содержание СМС-сообщения
субдата	Дата и время	Время и дата отправки сообщения. В случае сообщения, которое было заменено, это дата замены исходного сообщения. Формат следующий: ГГММДДччмм
donedate	Дата и время	Время и дата, когда сообщение достигло своего конечного состояния. Формат такой же, как и для даты отправки.
кодирование данных	string	Кодировка сообщения. Возможные значения: GSM7, Unicode.
смсчасть	Int	Указывает, что SMS является частью длинного сообщения.
smsidentifier	Int	Номер части длинного SMS.

Режимы секции мощности

Платформа Enterprise должна ответить заголовком HTTP 200 OK. Если платформа не получает заголовок 200 OK, она попытается доставить квитанцию еще раз (согласно политике STFW).

Пример запроса

ПОЛУЧИТЬ http://secure.smslocal.com/ report?msgid=gstafd4saftghsad& recipient=373798756364& status=Delivrd&statusDatetime=2017-09-01T10:00:05+00:00&datacoding=Gsm7

Пример ответа

200 OK