Просмотреть список правил

Возвращает список правил обработки писем.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на чтение правил обработки почты для домена. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Request

GET

https://api360.yandex.net/admin/v1/org/{orgId}/mail/routing/rules

Path parameters

Name

Description

orgId

Type: integer

Идентификатор организации.

Responses

200 OK

200 OK — запрос выполнен успешно.

Body

application/json

{
  "rules": [
    {
      "terminal": true,
      "condition": null,
      "actions": [
        null
      ]
    }
  ]
}

Name

Description

rules

Type: adminv1Rule[]

Список правил обработки писем.

Example

[
  {
    "terminal": true,
    "condition": null,
    "actions": [
      null
    ]
  }
]

adminv1Rule

Name	Description
actions	Type: unknown[] JSON-описание (массив) действий, которые необходимо выполнить при срабатывании правила. [ ... ] Example `[ null ]`
condition	Type: unknown JSON-описание условия (составного условия), задающее критерий соответствия письма текущему правилу. Example: `null`
terminal	Type: boolean Флаг-признак необходимости прекратить применение последующих правил при срабатывании данного.

Example

{
  "terminal": true,
  "condition": null,
  "actions": [
    null
  ]
}

400 Bad Request

400 Bad Request — некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

401 Unauthorized — пользователь не авторизован.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

403 Forbidden — у пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

404 Not Found — запрашиваемый ресурс не найден.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

500 Internal Server Error — внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

Была ли статья полезна?

Обзор

Задать список правил