Протокол интеграции HTTPs (GET) для отправки SMS

ВНИМАНИЕ

Для использования данного вида интеграции Вам необходимо зарегистрироваться на серверной платформе Stream Telecom, либо зарегистрироваться через менеджера компании. При регистрации Вам присваивается логин, и тестовое имя отправителя SMS Info, которое будет автоматически удалено, после того как Вы запросите новое имя.

Пароль для интеграции задается в настройках пользователя во вкладке Настройки API.

Общие положения

Серверная платформа Stream Telecom и клиент компании (далее ЗАКАЗЧИК) обмениваются HTTPS URL-encoded запросами в соответствии с принципами GET. Параметры запроса включаются в текст запроса в кодировке UTF8.
Обмен данными построен по схеме запрос/ответ с использованием метода GET и не требует постоянного TCP/IP соединения.

Точка доступа

Запросы ЗАКАЗЧИКА должны передаваться на сервер ИСПОЛНИТЕЛЯ по URL: http://gateway.api.sc/get/ , а так же шифрованная версия SSL https://gateway.api.sc/get/

Для удобства тестирования данного метода, Вы можете скачать библиотеку всех функций на базе Postman и импортировать ее.
Скачать библиотеку функций JSON

Документация по интеграции Stream Telecom GET.pdf

Функции

Запрос на получение баланса пользователя.

Шлюз:

https://gateway.api.sc/get/


Запрос (в одну строку)

http://gateway.api.sc/rest/Statistic/originator.php?login=userlogin&pass=userpassword


Наименование поля

Описание

login

Логин, присвоенный ЗАКАЗЧИКУ

pass

Пароль для API (задается в личном кабинете во вкладке Настройка > Безопасность)


Ответ

В ответ возвращается список активных имен отправителей

Отправляет сообщение адресатам и возвращает системные идентификаторы сообщений.

Шлюз:

https://gateway.api.sc/get/


Запрос (в одну строку)

https://gateway.api.sc/get/?user=login&pwd=password&sadr=SourceAddress&dadr=DestinationAddresses&text=Data


Пример отправка текста в UTF-8

https://gateway.api.sc/get/?user=login&pwd=password&sadr=SMS%20Info&dadr=79621234567&text=%D1%82%D0%B5%D1%81%D1%82

%0a - перенос строки


Пример на php

<?php

$var = file_get_contents ('http://gateway.api.sc/get/

?user=login&pwd=password&sadr=SourceAddress&dadr=DestinationAddresses&text=Data');

echo $var;

?>


Наименование поля

Описание

login

Логин, присвоенный ЗАКАЗЧИКУ.

password

Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность)

Data

Текст сообщения, кодировка UTF-8.

DestinationAddresses

Список номеров получателей, в международном формате: код страны + код сети + номер телефона.
Пример: 79031234567, номера вводятся через запятую.

SourceAddress

Имя отправителя. До 11 латинских символов или до 15 цифровых. Примечание: Передаваемое значение в адресе отправителя, должно в точности соответствовать ранее зарегистрированному. Если установлена функция динамической смены адреса, то значение может быть любым.


Ответ

Answer

Наименование поля

Описание

Answer

В случае успешной отправки запроса, возвращаются идентификаторы отправленных сообщений. Каждое отправленное сообщение имеет свой уникальный идентификатор.

В случае отправки некорректного запроса, Вам вернется ошибка.

Возвращает статус сообщения.

Шлюз:

https://gateway.api.sc/get/


Запрос (в одну строку)

https://gateway.api.sc/get/?user=login&pwd=password&smsid=SMS_ID


Пример на php

<?php

$var = file_get_contents ('https://gateway.api.sc/get/

?user=login&pwd=password&smsid=SMS_ID');

echo $var;

?>

Наименование поля

Описание

login

Логин, присвоенный ЗАКАЗЧИКУ

password

Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность)

SMS_ID

Идентификатор отправленного сообщения.


Ответ

not_deliver – Не доставлено

deliver – Доставлено

expired – Просрочено

send – Отправлено

Сообщение с таким ID не принималось – Указан некорректный id сообщения

Запрос на получение баланса пользователя.

Шлюз:

https://gateway.api.sc/get/


Запрос (в одну строку)

https://gateway.api.sc/get/?user=login&pwd=password&balance=1


Пример на php

<?php

$var = file_get_contents ('http://gateway.api.sc/get

?user=login&pwd=password&balance=1');

echo $var;

?>

Наименование поля

Описание

login

Логин, присвоенный ЗАКАЗЧИКУ

password

Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность)

balance

Признак запроса баланса


Ответ

Наименование поля

Описание

Answer

В случае успешной отправки запрос возвращает остаток средств на балансе в валюте вашего логина.

В случае отправки некорректного запроса, Вам вернется ошибка, значение которой можно узнать в списке ошибок

Для настройки активного получения статусов отправленных сообщений, Вам потребуется обратиться в техническую поддержку по адресу support@stream-telecom.ru.

После произведения настроек, на скрипт пользователя будут отправляться данные следующего типа:

{"id":"3273115186551386277","status":"deliver","time_change_state":"2019-06-04 17:40:14"}

Параметр

Описание

id

ID сообщения

status

Статус сообщения
deliver - доставлено
not_deliver - недоставлено
expired - просрочено

time_change_state

Время получения статуса сообщения

Ошибка

Описание

Неправильный логин или пароль

Введен неправильный логин или пароль.

Ваш аккаунт заблокирован

Ваш аккаунт заблокирован.

Данное направление закрыто для вас

Введен некорректный номер телефона, либо у Вас закончились деньги по данному направлению.

Нет отправителя

Не введено имя отправителя.

Нет текста сообщения

Не введен текст сообщения.

Такого отправителя нет

Указано неверное имя отправителя.

Укажите номер телефона.

Не введен номер телефона.

Flood SMS

Множественная отправка смс на один номер с одинаковым текстом.