Загрузить файл и/или поставить кодирование в очередь

POST

/wp-json/wp2/media-converter/v1/encode

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/encode \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "attachment_id": 1, "formats": [ "example" ], "options": {}, "parent_id": 1, "blog_id": 1 }'

Ставит кодирование в очередь: либо attachment_id уже загруженного файла, либо multipart file (+ formats). Ответ 202.

Authorizations

• cookie
• applicationPassword

Request Body

object

attachment_id

ID вложения медиатеки.

integer

formats

Каталог или выбранные форматы кодирования.

Array<string>

options

Не поддерживается в v1 (400 job_options_not_supported). Используйте PATCH /settings.

object

parent_id

ID родителя при создании сайта/термина.

integer

blog_id

ID сайта сети. На одиночном сайте можно не передавать.

integer

Example^generated

{
  "attachment_id": 1,
  "formats": [
    "example"
  ],
  "options": {},
  "parent_id": 1,
  "blog_id": 1
}

object

file

Загружаемый файл (multipart).

string format: binary

formats

Каталог или выбранные форматы кодирования.

string

attachment_id

ID вложения медиатеки.

integer

Responses

202

Media typeapplication/json

object

attachment_id

ID вложения медиатеки.

integer

queue_key

Поле «queue_key», как принимает или отдаёт PHP.

string

formats

Каталог или выбранные форматы кодирования.

Array<string>

status

Статус (сборки, записи, лицензии — по контексту ручки).

string

poll_url

Поле «poll_url», как принимает или отдаёт PHP.

string format: uri

Example^generated

{
  "attachment_id": 1,
  "queue_key": "example",
  "formats": [
    "example"
  ],
  "status": "example",
  "poll_url": "https://example.com"
}

401

Не аутентифицирован. WordPress REST: rest_not_logged_in / rest_forbidden. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Нет права или невалидный REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}