Зарегистрироваться
Войти
Протокол интеграции HTTPs (GET) для отправки SMS
ВНИМАНИЕ
Для использования данного вида интеграции Вам необходимоПароль для интеграции задается в настройках пользователя во вкладке Настройки API.
Общие положения
Серверная платформа Stream Telecom и клиент компании (далее ЗАКАЗЧИК) обмениваются HTTPS URL-encoded запросами в соответствии с принципами GET. Параметры запроса включаются в текст запроса в кодировке UTF8.
Обмен данными построен по схеме запрос/ответ с использованием метода GET и не требует постоянного TCP/IP соединения.
Точка доступа
Запросы ЗАКАЗЧИКА должны передаваться на сервер ИСПОЛНИТЕЛЯ по URL:
Для удобства тестирования данного метода, Вы можете скачать библиотеку всех функций на базе Postman и импортировать ее.
Скачать библиотеку функций JSON
Функции
Запрос на получение списка отправителей.
Шлюз:
https://gateway.api.sc/rest/
Запрос (в одну строку)
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&name_deliver=Title&sadr=SMS%20Info&dadr=79999999999&text=Data&callback_url=https://mysite.com/script.php
Пример отправка текста в UTF-8
https://gateway.api.sc/get/?user=login&pwd=password&name_deliver=Title&sadr=SMS%20Info&dadr=79999999999&text=%D1%82%D0%B5%D1%81%D1%82&callback_url=https://mysite.com/script.php
%0a - перенос строки
Пример на php
|
<?php
?> |
|
Наименование поля |
Обязательный |
Описание |
|
user |
Да |
Логин, присвоенный ЗАКАЗЧИКУ. |
|
pwd |
Да |
Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность) |
|
name_deliver |
Нет |
Название рассылки (название присваивается для удобства поиска в статистике) |
|
text |
Да |
Текст сообщения, кодировка UTF-8. |
|
dadr |
Да |
Список номеров получателей, в международном формате: код страны + код
сети + номер телефона. |
|
sadr |
Да |
Имя отправителя. До 11 латинских символов или до 15 цифровых. Примечание: Передаваемое значение в адресе отправителя, должно в точности соответствовать ранее зарегистрированному. Если установлена функция динамической смены адреса, то значение может быть любым. |
|
сallback_url |
Нет |
Адрес скрипта заказчика, на который будут возвращаться POST данные о
статусе доставки смс (сервис активного приема статусов смс) |
|
no_replace |
Нет |
Указывает на необходимость передачи спецсимволов в неизменном виде. Допустимые значения: true, false (false – по умолчанию). |
Ответ
Answer
|
Наименование поля |
Описание |
|
Answer |
В случае успешной отправки запроса, возвращаются идентификаторы отправленных сообщений. Каждое отправленное сообщение имеет свой уникальный идентификатор. В случае отправки некорректного запроса, Вам вернется ошибка. |
Возвращает статус сообщения.
Шлюз:
https://gateway.api.sc/get/
Запрос (в одну строку)
https://gateway.api.sc/get/?user=login&pwd=password&smsid=SMS_ID
Пример на php
|
<?php
?> |
|
Наименование поля |
Описание |
|
user |
Логин, присвоенный ЗАКАЗЧИКУ |
|
pwd |
Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность) |
|
smsid |
Идентификатор отправленного сообщения. |
Ответ
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
?> |
|
Наименование поля |
Описание |
|
user |
Логин, присвоенный ЗАКАЗЧИКУ |
|
pwd |
Пароль для api (задается в личном кабинете во вкладке Настройка > Безопасность) |
|
balance |
Признак запроса баланса |
Ответ
|
Наименование поля |
Описание |
|
Answer |
В случае успешной отправки запрос возвращает остаток средств на балансе в валюте вашего логина. В случае отправки некорректного запроса, Вам вернется ошибка, значение которой можно узнать в списке ошибок |
|
Ошибка |
Описание |
|
Неправильный логин или пароль |
Введен неправильный логин или пароль. |
|
Ваш аккаунт заблокирован |
Ваш аккаунт заблокирован. |
|
Данное направление закрыто для вас |
Введен некорректный номер телефона, либо у Вас закончились деньги по данному направлению. |
|
Нет отправителя |
Не введено имя отправителя. |
|
Нет текста сообщения |
Не введен текст сообщения. |
|
Такого отправителя нет |
Указано неверное имя отправителя. |
|
Укажите номер телефона. |
Не введен номер телефона. |
|
Flood SMS |
Множественная отправка смс на один номер с одинаковым текстом. |
