Все методы API
Доступные адреса API, необходимые права ключа и форматы ответов.
Методы
Все пути ниже начинаются с /api/v1. ID подключения, сообщения и файла WAIX — UUID. Имена шаблонов и их язык берите из списка шаблонов.
| Метод | Путь | Право | Назначение |
|---|---|---|---|
| GET | /connections | connections:read | Ваши номера и Connection ID |
| POST | /messages | messages:write | Поставить сообщение в очередь |
| GET | /messages | messages:read | Журнал сообщений |
| GET | /messages/{id} | messages:read | Сообщение и попытки отправки |
| POST | /messages/{id}/retry | messages:write | Повторить неудачную отправку |
| GET | /connections/{id}/templates | templates:read | Шаблоны и статусы модерации |
| POST | /connections/{id}/templates | templates:write | Создать шаблон |
| GET | /connections/{id}/templates/{name} | templates:read | Шаблон на выбранном языке |
| POST | /connections/{id}/templates/preview | templates:read | Проверить подстановки шаблона |
| PATCH / DELETE | /connections/{id}/templates/{name} | templates:write | Изменить шаблон / удалить все языковые версии |
| GET / PUT | /connections/{id}/profile | profile:read / profile:write | Профиль WhatsApp Business |
| POST | /media | media:write | Загрузить файл · multipart/form-data |
| GET | /media | media:read | Ваши медиафайлы |
| GET | /media/{id}/url | media:read | Временная ссылка на файл |
| DELETE | /media/{id} | media:write | Удалить файл |
| GET / PUT | /webhook | webhooks:read / webhooks:write | Адрес и события вебхука |
| POST | /webhook/test | webhooks:write | Отправить тестовое событие |
| POST | /webhook/rotate-secret | webhooks:write | Заменить секрет подписи |
| DELETE | /webhook | webhooks:write | Удалить вебхук |
Форматы
Для JSON передавайте Content-Type: application/json. Успешные ответы с данными обычно имеют оболочку data; удаление файла и вебхука возвращает 204 без JSON. POST /messages и /retry возвращают 202 с data.id и data.status. Ошибки содержат error; дополнительные поля зависят от причины.
Версия API
Текущая версия — v1. Используйте базовый адрес https://waix.kz/api/v1. Версия зафиксирована в адресе: выпуск v2 не переключит ваши запросы автоматически.
Изменения, которые требуют переделки вашей интеграции, будут выпускаться в новой версии. В v1 могут появляться новые методы и необязательные поля; неизвестные поля ответа можно игнорировать. Несуществующая версия возвращает HTTP 404 с кодом API_VERSION_NOT_SUPPORTED.
Старые адреса без версии сохранены для совместимости и привязаны к v1. Для новых интеграций используйте только адреса с /api/v1. В ответах маршрутов версия указана в заголовке X-WAIX-API-Version.
Файл OpenAPI
Импортируйте файл в Postman или другой HTTP-клиент. Сохраните базовый адрес, API-ключ и Connection ID в переменных окружения клиента, чтобы не подставлять их в каждый запрос вручную.