Справочник API media

GET

/v1/media/get_ftp_credentials

#

Read the acting account's generated FTP login. Passwords are recoverable only by the app. Send POST with X-AT-Media-Request: 1. Never put credentials in URLs or client storage.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_ftp_credentials' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`media_get_ftp_credentials_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials`		`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].credentialID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label`		`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].username`	`string`	`Да`	Owner FTP username; examples are deliberately fictitious.
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password`		`Да`	Owner FTP password, or null when reset is required. Never use response data as documentation examples.
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].enabled`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].notifyOnImport`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].requiresReset`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_ftp_credentials",
    "RequestUserAlias": "example-user",
    "Payload": {
        "credentials": {
            "credentialID": 1,
            "label": null,
            "username": "SYNTHETIC_USERNAME",
            "password": "SYNTHETIC_PASSWORD",
            "enabled": false,
            "notifyOnImport": false,
            "requiresReset": false
        }
    }
}

Машиночитаемая документация метода

GET

/v1/media/get_ftp_logs

#

Read upload logs through the acting account's FTPS connection. Latest 30 UTC dates, up to 64 KiB of the selected log's tail. Send POST with X-AT-Media-Request: 1. No credentials or owner IDs are accepted.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`logDate`	`string`	`Нет`	`""`	UTC log date, or empty for the latest available log.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_ftp_logs' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'logDate={{logDate}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_get_ftp_logs_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.dates`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.dates[]`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.date`		`Да`
`$.oneOf[0].allOf[1].Payload.date.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.date.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.text`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.truncated`	`boolean`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_ftp_logs",
    "RequestUserAlias": "example-user",
    "Payload": {
        "dates": [
            "2030-01-01"
        ],
        "date": "2030-01-01",
        "text": "Synthetic upload log.",
        "truncated": false
    }
}

Машиночитаемая документация метода

GET

/v1/media/get_labels

#

Private label catalog, including archived labels. Never accepts another account ID.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`afterID`	`int`	`Нет`	`0`	Previous nextID, or zero for the first page.
`search`	`string`	`Нет`	`""`	Optional name search; restart afterID when changing search.
`labelID`	`int`	`Нет`	`0`	Resolve one owned label for an existing selection; zero browses the catalog.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_labels' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'afterID={{afterID}}' \
  --data-urlencode 'search={{search}}' \
  --data-urlencode 'labelID={{labelID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_get_labels_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.labels`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.labels[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.labels[].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.labels[].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.labels[].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.labels[].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.nextID`		`Да`
`$.oneOf[0].allOf[1].Payload.nextID.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.nextID.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_labels",
    "RequestUserAlias": "example-user",
    "Payload": {
        "labels": [],
        "nextID": 0
    }
}

Машиночитаемая документация метода

GET

/v1/media/get_my_media

#

Browse retained media owned by the acting account. Never accepts another account ID.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`search`	`string`	`Нет`	`""`	Filename, title or description search.
`kind`	`string`	`Нет`	`""`	Empty, image, video, audio or document.
`usage`	`string`	`Нет`	`""`	Empty, unattached, post, profile, message, request or preview.
`month`	`string`	`Нет`	`""`	Creation month YYYY-MM, or empty for all dates.
`order`	`string`	`Нет`	`"newest"`	newest or oldest.
`cursor`	`string`	`Нет`	`""`	Opaque continuation returned by the previous page.
`pageSize`	`int`	`Нет`	`60`	Items per page, capped at 100.
`labelID`	`int`	`Нет`	`0`	Owned label ID, including archives; zero means all.
`unlabeled`	`bool`	`Нет`	`false`	Only media without labels; mutually exclusive with labelID.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_my_media' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'search={{search}}' \
  --data-urlencode 'kind={{kind}}' \
  --data-urlencode 'usage={{usage}}' \
  --data-urlencode 'month={{month}}' \
  --data-urlencode 'order={{order}}' \
  --data-urlencode 'cursor={{cursor}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'labelID={{labelID}}' \
  --data-urlencode 'unlabeled={{unlabeled}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_get_my_media_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.items[].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].thumbUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].mediaUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].mediaType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].width`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].height`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].isImage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].isEmbedded`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].kind`	`string ["image","video","audio","document"]`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].createdDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].filename`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].size`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].duration`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].duration.anyOf[0]`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].duration.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].downloadUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].labels`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].labels[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.items[].labels[].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].labels[].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].labels[].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].labels[].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].hasUsage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.nextCursor`		`Да`
`$.oneOf[0].allOf[1].Payload.nextCursor.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.nextCursor.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.lastMediaID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.pageSignature`		`Да`
`$.oneOf[0].allOf[1].Payload.pageSignature.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.pageSignature.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_my_media",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "nextCursor": "synthetic-example",
        "lastMediaID": 0,
        "pageSignature": "synthetic-example"
    }
}

Машиночитаемая документация метода

GET

/v1/media/get_my_media_item

#

Preview one owned file with current permission-checked usage references. Chat usages include chatID only after current chat and message access checks; their URL opens the conversation. File ownership alone never grants access.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`mediaID`	`int`	`Да`	`—`	Owned ATMedia ID.
`afterUsageID`	`int`	`Нет`	`0`	Continuation returned as nextUsageID.
`afterLabelPostID`	`int`	`Нет`	`0`	Dynamic usage continuation, -1 when exhausted.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_my_media_item' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'mediaID={{mediaID}}' \
  --data-urlencode 'afterUsageID={{afterUsageID}}' \
  --data-urlencode 'afterLabelPostID={{afterLabelPostID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_get_my_media_item_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.thumbUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.width`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.height`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isImage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isEmbedded`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.kind`	`string ["image","video","audio","document"]`	`Да`
`$.oneOf[0].allOf[1].Payload.item.createdDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.filename`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.size`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration`		`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[0]`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.item.downloadUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.labels`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.item.labels[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.item.labels[].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.labels[].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.labels[].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.labels[].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.usages`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.usages[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.usages[].type`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.usages[].role`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.usages[].title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.usages[].url`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.usages[].chatID`	`integer`	`Нет`
`$.oneOf[0].allOf[1].Payload.usages[].notificationBodyID`	`integer`	`Нет`
`$.oneOf[0].allOf[1].Payload.usages[].versionId`	`integer`	`Нет`
`$.oneOf[0].allOf[1].Payload.usages[].postId`	`integer`	`Нет`
`$.oneOf[0].allOf[1].Payload.hasUnavailableUsage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.nextUsageID`		`Да`
`$.oneOf[0].allOf[1].Payload.nextUsageID.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.nextUsageID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.nextLabelPostID`		`Да`
`$.oneOf[0].allOf[1].Payload.nextLabelPostID.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.nextLabelPostID.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_my_media_item",
    "RequestUserAlias": "example-user",
    "Payload": {
        "item": {
            "id": 0,
            "thumbUrl": "synthetic-example",
            "mediaUrl": "synthetic-example",
            "mediaType": "synthetic-example",
            "width": 0,
            "height": 0,
            "title": "synthetic-example",
            "isImage": false,
            "isEmbedded": false,
            "kind": "image",
            "createdDate": "synthetic-example",
            "filename": "synthetic-example",
            "size": 0,
            "duration": 0,
            "downloadUrl": "synthetic-example",
            "labels": []
        },
        "usages": [],
        "hasUnavailableUsage": false,
        "nextUsageID": 0,
        "nextLabelPostID": 0
    }
}

Машиночитаемая документация метода

GET

/v1/media/get_my_media_timeline

#

Return creation months for the account's current media filters.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`search`	`string`	`Нет`	`""`	Filename, title or description search.
`kind`	`string`	`Нет`	`""`	Empty, image, video, audio or document.
`usage`	`string`	`Нет`	`""`	Empty, unattached, post, profile, message, request or preview.
`labelID`	`int`	`Нет`	`0`	Owned label ID, including archives; zero means all.
`unlabeled`	`bool`	`Нет`	`false`	Only media without labels; mutually exclusive with labelID.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/media/get_my_media_timeline' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'search={{search}}' \
  --data-urlencode 'kind={{kind}}' \
  --data-urlencode 'usage={{usage}}' \
  --data-urlencode 'labelID={{labelID}}' \
  --data-urlencode 'unlabeled={{unlabeled}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`media_get_my_media_timeline_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.months`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.months[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.months[].month`		`Да`
`$.oneOf[0].allOf[1].Payload.months[].month.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.months[].month.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.months[].count`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.months[].count.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.months[].count.oneOf[1]`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/get_my_media_timeline",
    "RequestUserAlias": "example-user",
    "Payload": {
        "months": []
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_copy_post_photo

#

Copy an accessible post photo into the acting user's media library with a new ID and the same file URLs. Also resolves the acting user's wall for the About Me composer; creates that wall if needed. Does not publish a post or change the profile. POST with X-AT-Media-Request: 1 required.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`postID`	`int`	`Да`	`—`	Accessible source post containing the image.
`mediaID`	`int`	`Да`	`—`	Retained image attached to that post.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_copy_post_photo' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'mediaID={{mediaID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_copy_post_photo_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.thumbUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.width`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.height`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isImage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isEmbedded`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.kind`	`string ["image","video","audio","document"]`	`Да`
`$.oneOf[0].allOf[1].Payload.item.createdDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.filename`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.size`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration`		`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[0]`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.item.downloadUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.boardID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.slug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.city`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.cityGroupCode`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.intent`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.callback`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.count`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.unitLabel`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.createsRegularBoardPost`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.isDefaultRequestBoard`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.isDefaultListingBoard`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.routingEnabled`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.routingDescription`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.selected`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.viewerCanRead`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.viewerCanWrite`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.wallBoard.hasAccessMetadata`	`= true`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_copy_post_photo",
    "RequestUserAlias": "example-user",
    "Payload": {
        "item": {
            "id": 0,
            "thumbUrl": "synthetic-example",
            "mediaUrl": "synthetic-example",
            "mediaType": "synthetic-example",
            "width": 0,
            "height": 0,
            "title": "synthetic-example",
            "isImage": false,
            "isEmbedded": false,
            "kind": "image",
            "createdDate": "synthetic-example",
            "filename": "synthetic-example",
            "size": 0,
            "duration": 0,
            "downloadUrl": "synthetic-example"
        },
        "wallBoard": {
            "id": 0,
            "boardID": 0,
            "slug": "synthetic-example",
            "name": "synthetic-example",
            "city": "synthetic-example",
            "cityGroupCode": "synthetic-example",
            "intent": "synthetic-example",
            "callback": "synthetic-example",
            "count": 0,
            "unitLabel": "synthetic-example",
            "createsRegularBoardPost": false,
            "isDefaultRequestBoard": false,
            "isDefaultListingBoard": false,
            "routingEnabled": false,
            "routingDescription": "synthetic-example",
            "selected": false,
            "viewerCanRead": false,
            "viewerCanWrite": false,
            "hasAccessMetadata": true
        }
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_delete_file

#

Soft-delete a file owned by the acting account by setting ATMedia.DeletedDate. The stored file and reference rows are retained. Deleted media is excluded from My Media, attachment selection and owner downloads. Repeating deletion is safe. POST with X-AT-Media-Request: 1 required; no other account ID is accepted.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`mediaID`	`int`	`Да`	`—`	Owned ATMedia ID.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_delete_file' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'mediaID={{mediaID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_delete_file_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.mediaID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.deleted`	`= true`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_delete_file",
    "RequestUserAlias": "example-user",
    "Payload": {
        "mediaID": 0,
        "deleted": true
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_ftp_credentials

#

Create a random FTP login with six uppercase A-Z letters in each field, or reset it. Reset preserves an existing six-letter uppercase username; legacy names are shortened. The home-directory slug, virtual identity, default label, notification preference and enabled state survive reset. New accounts stay disabled until the FTP server provisions their home directory. Send POST with X-AT-Media-Request: 1. No user ID, username or password is accepted.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`reset`	`bool`	`Нет`	`false`	Replace the password and shorten a legacy username if needed.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_ftp_credentials' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'reset={{reset}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`media_set_ftp_credentials_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials`		`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].credentialID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label`		`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].username`	`string`	`Да`	Owner FTP username; examples are deliberately fictitious.
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password`		`Да`	Owner FTP password, or null when reset is required. Never use response data as documentation examples.
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].password.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].enabled`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].notifyOnImport`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].requiresReset`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.credentials.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_ftp_credentials",
    "RequestUserAlias": "example-user",
    "Payload": {
        "credentials": {
            "credentialID": 1,
            "label": null,
            "username": "SYNTHETIC_USERNAME",
            "password": "SYNTHETIC_PASSWORD",
            "enabled": false,
            "notifyOnImport": false,
            "requiresReset": false
        }
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_ftp_label

#

Set a credential's default label independently of its password. Records upload-time history atomically. POST with X-AT-Media-Request: 1 required. Resetting credentials preserves this setting and upload directory.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`credentialID`	`int`	`Да`	`—`	Owned FTP credential ID.
`labelID`	`int`	`Нет`	`0`	Owned active label ID; zero clears.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_ftp_label' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'credentialID={{credentialID}}' \
  --data-urlencode 'labelID={{labelID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_ftp_label_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentialID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.label`		`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_ftp_label",
    "RequestUserAlias": "example-user",
    "Payload": {
        "credentialID": 0,
        "label": {
            "id": 0,
            "name": "synthetic-example",
            "emoji": "synthetic-example",
            "archived": false
        }
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_ftp_notifications

#

Enable/disable priority alerts for successful FTP imports. Defaults to on for new and existing credentials. Changes apply to future imports, including uploads awaiting delivery. Existing alerts and replayed imports are unchanged. POST with X-AT-Media-Request: 1 required. Does not reset the login or change the default label/directory.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`credentialID`	`int`	`Да`	`—`	Owned FTP credential ID.
`notifyOnImport`	`bool`	`Да`	`—`	Whether successful imports create a priority notification.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_ftp_notifications' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'credentialID={{credentialID}}' \
  --data-urlencode 'notifyOnImport={{notifyOnImport}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_ftp_notifications_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.credentialID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.notifyOnImport`	`boolean`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_ftp_notifications",
    "RequestUserAlias": "example-user",
    "Payload": {
        "credentialID": 0,
        "notifyOnImport": false
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_import_from_url

#

Download one public HTTP(S) media URL into the acting account's My Media library. Accepts JPEG, PNG, GIF, WebP, AVIF, MP4, MOV, WebM and PDF, up to 25 MiB. Send POST with X-AT-Media-Request: 1. Authenticated session or owner API key required. Retry with the same importID and identical parameters to receive the original media. Future FTP delivery adapters can call this endpoint with an owner-authorized API identity and a public HTTPS delivery URL. FTP slugs/passwords alone never authorize imports.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`sourceURL`	`string`	`Да`	`—`	Absolute public media URL. Private-network addresses and credentials are rejected.
`importID`	`string`	`Да`	`—`	Caller-generated stable delivery ID, 8-128 letters, numbers, underscores or hyphens.
`title`	`string`	`Нет`	`""`	Optional media title, up to 250 characters.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_import_from_url' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sourceURL={{sourceURL}}' \
  --data-urlencode 'importID={{importID}}' \
  --data-urlencode 'title={{title}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_import_from_url_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.item.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.thumbUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.mediaType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.width`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.height`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isImage`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.isEmbedded`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.item.kind`	`string ["image","video","audio","document"]`	`Да`
`$.oneOf[0].allOf[1].Payload.item.createdDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.filename`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.item.size`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration`		`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[0]`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.item.duration.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.item.downloadUrl`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.reused`	`boolean`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_import_from_url",
    "RequestUserAlias": "example-user",
    "Payload": {
        "item": {
            "id": 0,
            "thumbUrl": "synthetic-example",
            "mediaUrl": "synthetic-example",
            "mediaType": "synthetic-example",
            "width": 0,
            "height": 0,
            "title": "synthetic-example",
            "isImage": false,
            "isEmbedded": false,
            "kind": "image",
            "createdDate": "synthetic-example",
            "filename": "synthetic-example",
            "size": 0,
            "duration": 0,
            "downloadUrl": "synthetic-example"
        },
        "reused": false
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_label

#

Create or rename an owned label; archived names remain reserved. POST with X-AT-Media-Request: 1.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`name`	`string`	`Да`	`—`	Trimmed label name, 1–100 characters, case-insensitively unique per account.
`labelID`	`int`	`Нет`	`0`	Zero creates a label; otherwise renames without changing its ID.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.
`emoji`	`string`	`Нет`	`null`	One emoji; omitted preserves the existing value.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_label' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'labelID={{labelID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'emoji={{emoji}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_label_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.label`		`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_label",
    "RequestUserAlias": "example-user",
    "Payload": {
        "label": {
            "id": 0,
            "name": "synthetic-example",
            "emoji": "synthetic-example",
            "archived": false
        }
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_label_archived

#

Archive or restore a label. Archiving atomically clears FTP defaults and records history; existing links remain. POST with X-AT-Media-Request: 1 required.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`labelID`	`int`	`Да`	`—`	Owned label ID.
`archived`	`bool`	`Да`	`—`	True archives; false restores.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.
`confirmDetach`	`bool`	`Нет`	`false`	Acknowledge permanent removal from linked posts.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_label_archived' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'labelID={{labelID}}' \
  --data-urlencode 'archived={{archived}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'confirmDetach={{confirmDetach}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_label_archived_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.label`		`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].emoji`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[0].archived`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.label.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_label_archived",
    "RequestUserAlias": "example-user",
    "Payload": {
        "label": {
            "id": 0,
            "name": "synthetic-example",
            "emoji": "synthetic-example",
            "archived": false
        }
    }
}

Машиночитаемая документация метода

POST

/v1/media/set_media_labels

#

Atomically add/remove labels on up to 100 owned, retained media. Unrelated links are preserved. Archived labels may be removed but never manually added. POST with X-AT-Media-Request: 1 required.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`mediaIDs`	`string`	`Да`	`—`	JSON array of 1–100 media IDs.
`labelIDs`	`string`	`Да`	`—`	JSON array of 1–100 owned label IDs.
`remove`	`bool`	`Нет`	`false`	True removes; false adds. Repeating an operation is harmless.
`isWritingRequest`	`bool`	`Нет`	`false`	Explicit write acknowledgement.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/media/set_media_labels' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'mediaIDs={{mediaIDs}}' \
  --data-urlencode 'labelIDs={{labelIDs}}' \
  --data-urlencode 'remove={{remove}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Параметры: mediaIDs

Поле	Тип	Обязательно
`mediaIDs`	`string (application/json)`	`Да`
`mediaIDs`	`array (декодированный JSON)`	`Да`
`mediaIDs[]`	`integer`	`Нет`

Параметры: labelIDs

Поле	Тип	Обязательно
`labelIDs`	`string (application/json)`	`Да`
`labelIDs`	`array (декодированный JSON)`	`Да`
`labelIDs[]`	`integer`	`Нет`

Поля ответа

Поле	Тип	Обязательно
`$`	`media_set_media_labels_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.updated`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

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

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_media_labels",
    "RequestUserAlias": "example-user",
    "Payload": {
        "updated": 0
    }
}

Машиночитаемая документация метода