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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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://ar.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
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا