Список сообщений | Agent Inbox

from agent_inbox import Agentinbox
client = Agentinbox(
    api_key="YOUR_API_KEY_HERE",
)
client.inboxes.messages.list(
    inbox_id="inbox_id",
)

{
  "count": 1,
  "messages": [
    {
      "inbox_id": "inbox_id",
      "thread_id": "thread_id",
      "message_id": "message_id",
      "labels": [
        "labels",
        "labels"
      ],
      "timestamp": "2024-01-15T09:30:00Z",
      "from": "from",
      "to": [
        "to",
        "to"
      ],
      "size": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "cc": [
        "cc",
        "cc"
      ],
      "bcc": [
        "bcc",
        "bcc"
      ],
      "subject": "subject",
      "preview": "preview",
      "attachments": [
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        },
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        }
      ],
      "in_reply_to": "in_reply_to",
      "references": [
        "references",
        "references"
      ],
      "headers": {
        "headers": "headers"
      }
    },
    {
      "inbox_id": "inbox_id",
      "thread_id": "thread_id",
      "message_id": "message_id",
      "labels": [
        "labels",
        "labels"
      ],
      "timestamp": "2024-01-15T09:30:00Z",
      "from": "from",
      "to": [
        "to",
        "to"
      ],
      "size": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "cc": [
        "cc",
        "cc"
      ],
      "bcc": [
        "bcc",
        "bcc"
      ],
      "subject": "subject",
      "preview": "preview",
      "attachments": [
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        },
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        }
      ],
      "in_reply_to": "in_reply_to",
      "references": [
        "references",
        "references"
      ],
      "headers": {
        "headers": "headers"
      }
    }
  ],
  "limit": 1,
  "next_page_token": "next_page_token"
}

CLI:

$ agentinbox inboxes:messages list --inbox-id <inbox_id>

**CLI:** ```bash agentinbox inboxes:messages list --inbox-id <inbox_id> ```

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

inbox_idstringRequired

Идентификатор ящика.

Query parameters

limitintegerOptional

Максимальное число возвращаемых элементов.

page_tokenstringOptional

Токен страницы для постраничной выборки.

labelslist of stringsOptional

Метки для фильтрации.

beforedatetimeOptional

Временная метка «раньше чем» для фильтра.

afterdatetimeOptional

Временная метка «позже чем» для фильтра.

ascendingbooleanOptional

Сортировать по времени по возрастанию.

include_spambooleanOptional

Включать спам в результаты.

include_blockedbooleanOptional

Включать заблокированные в результаты.

include_trashbooleanOptional

Включать корзину в результаты.

Response

This endpoint returns an object.

countinteger

Число возвращённых элементов.

messageslist of objects

Упорядочено по timestamp по убыванию.

limitinteger

Максимальное число возвращаемых элементов.

next_page_tokenstring

Токен страницы для постраничной выборки.

Errors

404

Not Found Error