Отправка сообщения с документом

POST

/v1/wa/apps/{appId}/messages

Данный эндпоинт API предназначен для отправки сообщения с документом.

Авторизация

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры

Параметр	Расположение	Тип	Описание	Ограничения
appId	Path	string	Уникальный идентификатор приложения.
phone	Body	string	Номер телефона получателя сообщения в международном формате.
type	Body	string	Тип сообщения.	Возможные значения: DOCUMENT. Подробнее о типах сообщений в разделе: типы сообщений
document	Body	Object	Объект данных сообщения с документом. url - URL документа, caption - подпись к документу.

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

curl -X POST \
  https://space.getloo.ru/api/v1/wa/apps/{appId}/messages \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "79991234567", "type": "DOCUMENT", "document": { "url": "https://example.com/sample-document.pdf", "caption": "Document caption" }}'

{
  "phone": "79991234567",
  "type": "DOCUMENT",
  "document": {
    "url": "https://example.com/sample-document.pdf",
    "caption": "Document caption"
  }
}

Пример ответа

{
  "message": {
    "id": "697a1a6c73a3af4a0c9a1c81"
  }
}

Коды состояния

Код состояния	Описание
201	Запрос успешно выполнен
400	Некорректный запрос (ошибка при валидации)
401	Неавторизованный запрос
403	Доступ запрещён
404	Не найдено
429	Превышен лимит запросов