Метод для создания SMS-сообщения без отправки. Непосредственно отправка осуществляется с помощью другого метода createCampaign.
Принцип использования
Синтаксис и URL для вызова метода |
createSmsMessage (string sender, string body, int list_id [, string tag,string categories]) |
https://api.unisender.com/ru/api/createSmsMessage?format=json&api_key=KEY&sender=FROM &body=BODY &list_id=X&tag= TAG&categories=CATEGORIES |
Аргументы | |
api_key * | Ключ доступа к API. |
sender * | Имя отправителя от 3 до 11 латинских букв и цифр. Имя необходимо регистрировать в службе поддержки. |
body * | Текст сообщения с возможностью добавлять поля подстановки. |
list_id * | Код списка, по которому будет отправка SMS. Коды всех списков можно получить с помощью вызова getLists. Отправка сообщения возможна только по одному списку. Для отправки по другому списку надо создавать новое сообщение. |
tag | Метка. Если задана, то отправка сообщения будет производиться не по всему списку, а только по тем адресатам, которым присвоена заданная метка. |
Возвращаемое значение |
JSON-объект с одним полем message_id, в котором содержится уникальный код сообщения – целое положительное 31-битное число. Используется для отправки сообщения методом createCampaign.
Пример возвращаемого значения: {"result":{"message_id":356238}} {"error":"invalid sender","code":"invalid_arg","result":""} {"error":"invalid list_id","code":"invalid_arg","result":""} |
Примеры формирования URL-запроса
https://api.unisender.com/ru/api/createSmsMessage?format=json&api_key= KEY&sender=Unisender&body=Test+SMS-message+from+Unisender &list_id=778899&categories=letter list, test, with attachment, unisender
— подготовить новое SMS-сообщение Test SMS-message на все номера списка 778899 с указанием обратного номера Unisender.