SMS, Viber, VK, E-Mail, «каскад»»

Метод outbox/send нашего API позволяет отправлять как обычные SMS, так и сообщения Viber и VK, «каскадные» сообщения.

Можно применять как GET-, так и POST-запросы.
По умолчанию предполагается, что текст SMS передается в кодировке utf-8. Если ваш текст в кодировке cp1251 (Windows-1251), нужно добавить параметр cp=1251.

Описание обычного GET/POST-запроса

Запросы передаются на адрес:
https://auth.terasms.ru/outbox/send

Пример запроса:
https://auth.terasms.ru/outbox/send?login=terasms&password=12345&target=79017654321&sender=terasms&message=test

Если все параметры верны, то сообщение добавляется в очередь на отправку и возвращается положительное целое число – идентификатор исходящего сообщения или несколько идентификаторов через запятую (если была попытка отправки сообщения на несколько номеров). В противном случае возвращается отрицательное число – код ошибки.

Коды ошибок

Описание параметров

Возможные варианты реализации на языке программирования PHP

> POST auth.terasms.ru/outbox/send/json

{
	"login": "login",
	"password": "secret",
	"target": 71234567890,
	"message": "ку-ку",
	"sender": "terasms.ru"
}

{
  "status": 0,
  "status_description": "OK",
  "message_infos": [
    {
      "msisdn": "78001234567890",
      "id": "566668915",
      "status": 0
    }
  ]
}

> POST auth.terasms.ru/outbox/send/xml

<?xml version="1.0"?>
<request>
    <login>login</login>
    <password>password</password>
    <target>71234567890</target>
    <message>ку-ку</message>
    <sender>terasms.ru</sender>
</request> 

<?xml version="1.0"?>
<response>
    <status>0</status>
    <status_description>OK</status_description>
    <message_infos>
        <message_info>
            <msisdn>71234567890</msisdn>
            <status>0</status>
        </message_info>
    </message_infos>
</response>

Группировка сообщений в рассылки

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

Для этого необходимо создать рассылку, отправив следующий запрос: https://auth.terasms.ru/outbox/add_delivery?login=terasms&password=12345&name=Имя%рассылки

В качестве ответа Вам придёт ID рассылки. В системе будет создана рассылка с именем "Имя рассылки". Если параметр name не указан, то в качестве имени рассылки будет использоваться текущая дата. Вы сможете увидеть свою рассылку в личном кабинете на странице График рассылки. Кроме того, на странице "Отчёты" будет отображена статистика по именованным рассылкам.
Обращаем Ваше внимание на то, что данные по рассылкам в системе обновляются не в режиме реального времени, а в течении 5-10 минут.

Затем при отправке сообщения необходимо добавлять параметр schedule_id со значением, полученным при создании рассылки: https://auth.terasms.ru/outbox/send/?login=terasms&password=12345&target=79017654321&sender=terasms&message=test&schedule_id=1234

Каждое отправленное таким образом сообщение будет добавлено к Вашей рассылке "Имя рассылки"

Отправка нескольких сообщений одним запросом

Для отправки нескольких сообщений одним запросом существует метод msend_json. При использовании метода тело запроса должно быть в формате JSON, ответ также приходит в JSON. Параметры сообщения совпадают с параметрами, используемыми в методе outbox/send. Так же существует параметр sms_id, в котором вы можете указать любой идентификатор сообщения. Этот идентификатор будет присутствовать в ответе платформы вместе с остальной информацией о сообщении.

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

> POST https://auth.terasms.ru/outbox/msend_json
{
	"login": "login",
	"password": "password",
	"smsPackage": [
		{
			"target": 78002223344,
            "sms_id": 1,
			"sender": "terasms.ru",
			"message": "test"
		},
		{
			"target": 78002223345,
            "sms_id": 2,
			"sender": "terasms.ru",
			"message": "test2"
		}
	]
}

Ответ:

[
    {
        "sms_id": 1,
        "message_id": "365214379"
    },
    {
        "sms_id": 2,
        "message_id":"365214380"
    }
]

Получение статусов нескольких сообщений одним запросом

Существует возможность получать статусы нескольких сообщений одним запросом. Метод описан в разделе Получение статусов SMS.