AT AppointmentTrader
サインイン
オンライン中  

/v1/media/

The signed-in account's private lifetime media library and reusable picker.
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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.credentials はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].credentialIDinteger はい
$.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].idinteger はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].namestring はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].emojistring はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].archivedboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].usernamestring はい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].enabledboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].notifyOnImportboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].requiresResetboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.datesarray はい
$.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.textstring はい
$.oneOf[0].allOf[1].Payload.truncatedboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.labelsarray はい
$.oneOf[0].allOf[1].Payload.labels[]object いいえ
$.oneOf[0].allOf[1].Payload.labels[].idinteger はい
$.oneOf[0].allOf[1].Payload.labels[].namestring はい
$.oneOf[0].allOf[1].Payload.labels[].emojistring はい
$.oneOf[0].allOf[1].Payload.labels[].archivedboolean はい
$.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].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.itemsarray はい
$.oneOf[0].allOf[1].Payload.items[]object いいえ
$.oneOf[0].allOf[1].Payload.items[].idinteger はい
$.oneOf[0].allOf[1].Payload.items[].thumbUrlstring はい
$.oneOf[0].allOf[1].Payload.items[].mediaUrlstring はい
$.oneOf[0].allOf[1].Payload.items[].mediaTypestring はい
$.oneOf[0].allOf[1].Payload.items[].widthinteger はい
$.oneOf[0].allOf[1].Payload.items[].heightinteger はい
$.oneOf[0].allOf[1].Payload.items[].titlestring はい
$.oneOf[0].allOf[1].Payload.items[].isImageboolean はい
$.oneOf[0].allOf[1].Payload.items[].isEmbeddedboolean はい
$.oneOf[0].allOf[1].Payload.items[].kindstring ["image","video","audio","document"] はい
$.oneOf[0].allOf[1].Payload.items[].createdDatestring はい
$.oneOf[0].allOf[1].Payload.items[].filenamestring はい
$.oneOf[0].allOf[1].Payload.items[].sizeinteger はい
$.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[].downloadUrlstring はい
$.oneOf[0].allOf[1].Payload.items[].labelsarray はい
$.oneOf[0].allOf[1].Payload.items[].labels[]object いいえ
$.oneOf[0].allOf[1].Payload.items[].labels[].idinteger はい
$.oneOf[0].allOf[1].Payload.items[].labels[].namestring はい
$.oneOf[0].allOf[1].Payload.items[].labels[].emojistring はい
$.oneOf[0].allOf[1].Payload.items[].labels[].archivedboolean はい
$.oneOf[0].allOf[1].Payload.items[].hasUsageboolean はい
$.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.lastMediaIDinteger はい
$.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].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.itemobject はい
$.oneOf[0].allOf[1].Payload.item.idinteger はい
$.oneOf[0].allOf[1].Payload.item.thumbUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaTypestring はい
$.oneOf[0].allOf[1].Payload.item.widthinteger はい
$.oneOf[0].allOf[1].Payload.item.heightinteger はい
$.oneOf[0].allOf[1].Payload.item.titlestring はい
$.oneOf[0].allOf[1].Payload.item.isImageboolean はい
$.oneOf[0].allOf[1].Payload.item.isEmbeddedboolean はい
$.oneOf[0].allOf[1].Payload.item.kindstring ["image","video","audio","document"] はい
$.oneOf[0].allOf[1].Payload.item.createdDatestring はい
$.oneOf[0].allOf[1].Payload.item.filenamestring はい
$.oneOf[0].allOf[1].Payload.item.sizeinteger はい
$.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.downloadUrlstring はい
$.oneOf[0].allOf[1].Payload.item.labelsarray はい
$.oneOf[0].allOf[1].Payload.item.labels[]object いいえ
$.oneOf[0].allOf[1].Payload.item.labels[].idinteger はい
$.oneOf[0].allOf[1].Payload.item.labels[].namestring はい
$.oneOf[0].allOf[1].Payload.item.labels[].emojistring はい
$.oneOf[0].allOf[1].Payload.item.labels[].archivedboolean はい
$.oneOf[0].allOf[1].Payload.usagesarray はい
$.oneOf[0].allOf[1].Payload.usages[]object いいえ
$.oneOf[0].allOf[1].Payload.usages[].typestring はい
$.oneOf[0].allOf[1].Payload.usages[].rolestring はい
$.oneOf[0].allOf[1].Payload.usages[].titlestring はい
$.oneOf[0].allOf[1].Payload.usages[].urlstring はい
$.oneOf[0].allOf[1].Payload.usages[].chatIDinteger いいえ
$.oneOf[0].allOf[1].Payload.usages[].notificationBodyIDinteger いいえ
$.oneOf[0].allOf[1].Payload.usages[].versionIdinteger いいえ
$.oneOf[0].allOf[1].Payload.usages[].postIdinteger いいえ
$.oneOf[0].allOf[1].Payload.hasUnavailableUsageboolean はい
$.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].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.monthsarray はい
$.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[].countDatabaseInteger はい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].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.itemobject はい
$.oneOf[0].allOf[1].Payload.item.idinteger はい
$.oneOf[0].allOf[1].Payload.item.thumbUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaTypestring はい
$.oneOf[0].allOf[1].Payload.item.widthinteger はい
$.oneOf[0].allOf[1].Payload.item.heightinteger はい
$.oneOf[0].allOf[1].Payload.item.titlestring はい
$.oneOf[0].allOf[1].Payload.item.isImageboolean はい
$.oneOf[0].allOf[1].Payload.item.isEmbeddedboolean はい
$.oneOf[0].allOf[1].Payload.item.kindstring ["image","video","audio","document"] はい
$.oneOf[0].allOf[1].Payload.item.createdDatestring はい
$.oneOf[0].allOf[1].Payload.item.filenamestring はい
$.oneOf[0].allOf[1].Payload.item.sizeinteger はい
$.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.downloadUrlstring はい
$.oneOf[0].allOf[1].Payload.wallBoardobject はい
$.oneOf[0].allOf[1].Payload.wallBoard.idinteger はい
$.oneOf[0].allOf[1].Payload.wallBoard.boardIDinteger はい
$.oneOf[0].allOf[1].Payload.wallBoard.slugstring はい
$.oneOf[0].allOf[1].Payload.wallBoard.namestring はい
$.oneOf[0].allOf[1].Payload.wallBoard.citystring はい
$.oneOf[0].allOf[1].Payload.wallBoard.cityGroupCodestring はい
$.oneOf[0].allOf[1].Payload.wallBoard.intentstring はい
$.oneOf[0].allOf[1].Payload.wallBoard.callbackstring はい
$.oneOf[0].allOf[1].Payload.wallBoard.countinteger はい
$.oneOf[0].allOf[1].Payload.wallBoard.unitLabelstring はい
$.oneOf[0].allOf[1].Payload.wallBoard.createsRegularBoardPostboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.isDefaultRequestBoardboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.isDefaultListingBoardboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.routingEnabledboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.routingDescriptionstring はい
$.oneOf[0].allOf[1].Payload.wallBoard.selectedboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.viewerCanReadboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.viewerCanWriteboolean はい
$.oneOf[0].allOf[1].Payload.wallBoard.hasAccessMetadata = true はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.mediaIDinteger はい
$.oneOf[0].allOf[1].Payload.deleted = true はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.credentials はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].credentialIDinteger はい
$.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].idinteger はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].namestring はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].emojistring はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[0].archivedboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].label.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].usernamestring はい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].enabledboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].notifyOnImportboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[0].requiresResetboolean はい
$.oneOf[0].allOf[1].Payload.credentials.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.credentialIDinteger はい
$.oneOf[0].allOf[1].Payload.label はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].idinteger はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].namestring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].emojistring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].archivedboolean はい
$.oneOf[0].allOf[1].Payload.label.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.credentialIDinteger はい
$.oneOf[0].allOf[1].Payload.notifyOnImportboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.itemobject はい
$.oneOf[0].allOf[1].Payload.item.idinteger はい
$.oneOf[0].allOf[1].Payload.item.thumbUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaUrlstring はい
$.oneOf[0].allOf[1].Payload.item.mediaTypestring はい
$.oneOf[0].allOf[1].Payload.item.widthinteger はい
$.oneOf[0].allOf[1].Payload.item.heightinteger はい
$.oneOf[0].allOf[1].Payload.item.titlestring はい
$.oneOf[0].allOf[1].Payload.item.isImageboolean はい
$.oneOf[0].allOf[1].Payload.item.isEmbeddedboolean はい
$.oneOf[0].allOf[1].Payload.item.kindstring ["image","video","audio","document"] はい
$.oneOf[0].allOf[1].Payload.item.createdDatestring はい
$.oneOf[0].allOf[1].Payload.item.filenamestring はい
$.oneOf[0].allOf[1].Payload.item.sizeinteger はい
$.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.downloadUrlstring はい
$.oneOf[0].allOf[1].Payload.reusedboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.label はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].idinteger はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].namestring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].emojistring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].archivedboolean はい
$.oneOf[0].allOf[1].Payload.label.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.label はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].idinteger はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].namestring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].emojistring はい
$.oneOf[0].allOf[1].Payload.label.anyOf[0].archivedboolean はい
$.oneOf[0].allOf[1].Payload.label.anyOf[1]null はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "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://jp.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
フィールド型必須説明
mediaIDsstring (application/json) はい
mediaIDsarray (デコードされたJSON) はい
mediaIDs[]integer いいえ
パラメーター: labelIDs
フィールド型必須説明
labelIDsstring (application/json) はい
labelIDsarray (デコードされたJSON) はい
labelIDs[]integer いいえ
レスポンスフィールド
フィールド型必須説明
$media_set_media_labels_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.updatedinteger はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.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].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/media/set_media_labels",
    "RequestUserAlias": "example-user",
    "Payload": {
        "updated": 0
    }
}
機械可読のエンドポイントドキュメント