POST AI agent ready /v1/webhook/inbox/:id/list

API списка полезной нагрузки Webhook — бесплатный просмотрщик входящих сообщений

Получайте все полезные данные, перехваченные почтовым ящиком веб-перехватчика, включая тело запроса, метку времени и уникальный идентификатор полезных данных. Возвращает до 50 последних полезных данных. Папка «Входящие» должна быть создана через конечную точку /v1/webhook/inbox/create.

Endpoint

Code examples

curl -X POST https://api.botoi.com/v1/webhook/inbox/:id/list \
  -H "Content-Type: application/json" \
  -d '{"id":"a1b2c3d4"}'

When to use this API

Проверьте точную структуру полезных данных, которую отправляет поставщик веб-перехватчиков.

После запуска тестового события перечислите полезные данные входящих сообщений, чтобы увидеть необработанное тело JSON. Используйте это для создания типизированных интерфейсов для вашего обработчика веб-перехватчика, не разгадывая схему.

Убедитесь, что ваш сервер пересылки веб-перехватчиков правильно передает полезные данные.

Если вы маршрутизируете веб-перехватчики через прокси-сервер или очередь, направьте выходные данные прокси-сервера в тестовый почтовый ящик. Сравните перечисленные полезные данные с исходными полезными данными поставщика, чтобы убедиться, что ничего не было изменено.

Создавайте автоматизированные интеграционные тесты для потребителей веб-перехватчиков.

Создайте папку «Входящие» в своем наборе тестов, отправьте смоделированные полезные данные веб-перехватчика, а затем вызовите конечную точку списка, чтобы подтвердить получение полезных данных. Никакие фиктивные серверы не нужны.

Frequently asked questions

Что произойдет, если идентификатор папки «Входящие» не существует или срок его действия истек?

API возвращает ошибку 404 с кодом INBOX_NOT_FOUND. Создайте новый почтовый ящик, если срок действия вашего истек.

Полезные нагрузки возвращаются в хронологическом порядке?

Да. Полезные данные сортируются по временной метке «Receive_at», начиная с самых старых. Включены последние 50 полезных нагрузок.

Могу ли я удалить отдельные полезные данные из почтового ящика?

Нет. Полезные нагрузки не могут быть удалены по отдельности. Срок их действия истекает автоматически вместе с почтовым ящиком через 24 часа.

Возвращает ли эта конечная точка полное тело полезных данных?

Да. Полное тело JSON, отправленное на URL-адрес приема входящих сообщений, сохраняется и возвращается в поле тела каждой записи полезных данных.

Идентификатор папки «Входящие» передается в URL-адресе или в теле запроса?

Идентификатор папки «Входящие» передается по URL-адресу: /v1/webhook/inbox/{id}/list. Тело запроса может быть пустым.

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.