Документация по API системы Imobis. Для работы с API необходим ключ, который можно получить в личном кабинете Imobis в разделе Токены -> Создать токен. Используйте токен в заголовке для авторизации HTTP запросов к системе Imobis. Подробнее о получении доступа к API и генерации токенов - см. нашу статью в базе знаний.

Для аутентификации запросов включите в запрос заголовок Authorization: Token xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Режим песочницы — это удобный и безопасный способ тестировать Imobis перед запуском в боевом режиме. Вы сможете отправлять запросы и получать статусы, но без отправки реальных сообщений. Для активации необходимо зайти в личный кабинет Imobis (app.imobis.ru) и в верхнем правом меню переключиться в "режим песочницы", в случае успеха внизу появится баннер о том, что вы находитесь в режиме песочницы. Далее для работы с API создайте ключ, перейдя в раздел Токены-> Создать токен и перенаправьте все запросы на домен песочницы (https://sandbox.imobis.ru).

Для получения определенного статуса сообщений необходимо использовать номер в специальном формате. Формат номера (CRXYZNNNNNN): код страны (C), одна произвольнная цифра (R), код статуса, который вы хотите получить, для каждого из трех каналов (X - SMS, Y - Viber, Z - VK), далее (N) произвольные цифры для соответствия формату номера. Пример: +79165123456. В примере, сначала указан код страны (+7), потом одна произвольнная цифра (9), затем три кода статусов по каналам (1 - SMS, 6 - Viber, 5 - VK), далее произвольные цифры (123456) для соответствия формату номера. Песочница поддерживает номера следующих стран: Россия (+7), Финляндия (+358), США/Канада (+1).

Коды статусов сообщений

Методы для отправки сообщений возвращают статус приема в обработку и идентификатор сообщения. Все методы отправки поддерживают параметр daydelivery, который отвечает за доставку сообщений в дневные часы. Время дневных часов можно настроить в Личном кабинете, перейдя в раздел Дополнительные настройки. По умолчанию дневными часами считается период с 9 утра до 8 вечера. Сообщения отправленные до или после дневных часов, при условии наличия параметра daydelivery, начнут доставлять в момент начала нового периода дневных часов. Также все методы отправки поддерживают параметр delivery_date с помощью которого можно задать отложенное время доставки. Параметр delivery_date имеет следующий формат даты и времени Y-m-d H:i:s. Время указывается в UTC и не должно быть больше чем 3 дня от текущего времени.

Ошибки возникающие в момент выполнения запроса на отправку сообщения.

Описание ошибок

Для того, чтобы получить статус сообщения нужно в запросе на его отправку указать URL вашего обработчика в параметре report. На указанный URL будет выслан запрос методом POST. В случае, если параметр report не был указан, статус сообщения можно отследить в Личном кабинете.

Основные статусы

Для того, чтобы получать ошибки при отправке сообщения нужно в запросе на его отправку указать URL вашего обработчика в параметре report. На указанный URL будет выслан запрос методом POST. В случае, если параметр report не был указан, ошибки при отправке сообщения можно отследить в Личном кабинете.

Описание ошибок

Некоторые каналы (например, Viber) позволяют абонентам отправлять ответы на сообщения. В данном разделе описано как вы можете настроить получение этих ответов в свою систему.Для того, чтобы пользователь мог что-то ответить/написать вам через Viber, нужно, чтобы у вашего имени отправителя, зарегистрированного в Viber, поддерживалась опция 2-way - поддержка входящих/исходящих сообщений (узнать подключена ли опция для вашего имени, можно у представителя Imobis).

Указывайте адрес вашего ресурса в параметре reply при отправке сообщения, куда мы перенаправим ответ пользователя.

При отправке сообщения в параметре reply нужно указать url обработчика на который будет отправлен запрос.

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

Вариант 1

Использование служебных конструкций указывающих на тип переменных прямо в параметре text.

Виды служебных конструкций

Пример: Заказ %d подтвержден. Благодарим за выбор сервиса %w+

Исходя из примера предполагается, что в тексте сообщения вместо переменной %d придет набор цифр и/или спецсимволов, а вместо переменной $w+ любая последовательность букв, цифр или спецсимволов, причем внутри значения могут быть разделены пробелом.

Совет. Если вы заранее не знаете какой вид служебной конструкции использовать в тексте шаблона, выбирайте универсальный вариант %w+.

Вариант 2

Совместное использование параметров text и fields для указания переменных и их типов. При использовании данного варианта имена переменных обрамляются знаками {{ перед и }} после, а их тип указывается в параметре fields. Это решение удобно, когда важно пользовательское наименование переменной.

Пример: Здравствуйте, {{name}}. Благодарим за регистрацию в сервисе {{service}}

Сразу видно где какое значение будет передаваться. При этом для передачи вида служебной конструкции используется параметр fields. Именно в нем должна содержаться информация о типах переменных.

{ "text": "Здравствуйте, {{name}}. Благодарим за регистрацию в сервисе {{service}}", "fields": [ { "name": "name", "type": "%w+" }, { "name": "service", "type": "%w+" } ] }

03.12.2021

• Добавлены методы для работы с шаблонами: Список шаблонов, Создание шаблона, Обновление шаблона, Удаление шаблона.