מדריך API של media | AppointmentTrader

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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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
    }
}

תיעוד נקודת קצה קריא למכונה