Download OpenAPI specification:Download
API для отправки сообщений различными каналами
Точка подключения: https://api.imobis.ru/v3
Формат данных: JSON
Кодировка: UTF-8
Authorization: Token xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Content-Type: application/json
API имеет определенные и предсказуемые URL-адреса и использует коды ответов HTTP для обработки ошибок. Формат JSON возвращается всеми ответами API, включая ошибки.
Для аутентификации запросов включите в запрос заголовок Authorization: Token eeed98f8-1089-47de-9c5f-cd1786d1ee91
Методы для отправки сообщений возвращают статус приема в обработку и идентификатор сообщения. Все методы отправки поддерживают параметр daydelivery, который отвечает за доставку сообщений в дневные часы. Время дневных часов можно настроить в Личном кабинете, перейдя в раздел Дополнительные настройки. По умолчанию дневными часами считается период с 9 утра до 8 вечера. Сообщения отправленные до или после дневных часов, при условии наличия параметра daydelivery, начнут доставлять в момент начала нового периода дневных часов. Также все методы отправки поддерживают параметр delivery_date с помощью которого можно задать отложенное время доставки. Параметр delivery_date имеет следующий формат даты и времени Y-m-d H:i:s. Время указывается в UTC и не должно быть больше чем 3 дня от текущего времени.
| Content-Type required | string Example: application/json |
| Authorization required | string Example: Token xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| sender required | string Имя отправителя |
| phone required | string Номер абонента |
| text required | string Текст сообщения |
| ttl | number [ 60 .. 172800 ] Default: 172800 Время жизни сообщения в секундах |
| custom_id | string Пользовательский идентификатор сообщения |
| report | string URL для получения статусов |
| daydelivery | boolean Отправка сообщения в дневные часы |
| delivery_date | string <date-time> Дата и время доставки сообщения |
{- "sender": "imobis.ru",
- "phone": "70000000000",
- "text": "Текст",
- "ttl": 172800,
- "custom_id": "123",
}{- "result": "success",
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}{- "id": "fd698b41-7476-4478-bd1c-d74266f3cc86",
- "custom_id": "123",
- "status": "error",
- "channel": "sms",
- "error": "The text is not matched existing templates"
}| Content-Type required | string Example: application/json |
| Authorization required | string Example: Token xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| sender required | string Имя отправителя |
| phone required | string Номер абонента |
| text | string Текст сообщения |
| image | string URL картинка (рекомендуется 400x400, не более 1 МБ) |
object (Action) | |
| ttl | number [ 60 .. 86400 ] Default: 600 Время жизни сообщения в секундах |
| custom_id | string Пользовательский идентификатор сообщения |
| report | string URL для получения статусов |
| reply | string URL для получения ответов |
| daydelivery | boolean Отправка сообщения в дневные часы |
| delivery_date | string <date-time> Дата и время доставки сообщения |
{- "sender": "imobis",
- "phone": "70000000000",
- "text": "Текст",
- "action": {
- "title": "Кнопка",
- "url": "string"
}, - "ttl": 600,
- "custom_id": "123",
}
{- "result": "success",
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}{- "id": "fd698b41-7476-4478-bd1c-d74266f3cc86",
- "custom_id": "123",
- "status": "error",
- "channel": "sms",
- "error": "The text is not matched existing templates"
}| Content-Type required | string Example: application/json |
| Authorization required | string Example: Token xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| group required | number Идентификатор группы ВК |
| phone required | string Номер абонента |
| text required | string Текст сообщения |
| ttl | number [ 60 .. 86400 ] Default: 600 Время жизни сообщения в секундах |
| custom_id | string Пользовательский идентификатор сообщения |
| report | string URL для получения статусов |
| reply | string URL для получения ответов |
| daydelivery | boolean Отправка сообщения в дневные часы |
| delivery_date | string <date-time> Дата и время доставки сообщения |
{- "group": 5965316,
- "phone": "70000000000",
- "text": "Текст",
- "ttl": 600,
- "custom_id": "123",
}{- "result": "success",
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}{- "id": "fd698b41-7476-4478-bd1c-d74266f3cc86",
- "custom_id": "123",
- "status": "error",
- "channel": "sms",
- "error": "The text is not matched existing templates"
}