Сейчас онлайн  

/v1/notification/

Manages all notification related functions
GET

/v1/notification/get_detail

#
Returns the full non-chat notification payload for a modal or deep link. Chat notifications are intentionally excluded; those belong to the v2 Messages/chat dock flow.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
notificationID int Нет 0 Notification row ID.
getParametersJson string Нет "" Optional validated notification-root context used only while action-button DTOs are generated.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: getParametersJson
ПолеТипОбязательноОписание
getParametersJsonstring (application/json) НетJSON-encoded object; empty string uses an empty object.
getParametersJsonobject (декодированный JSON) Нет
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Нет
Поля ответа
ПолеТипОбязательноОписание
$notification_get_detail_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].Payload ДаOwned notification detail including plain text, recipients summary, tags and actions. The legacy serializer can return false if community access is no longer available.
$.oneOf[0].allOf[1].Payload.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate Да
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].createdDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate Да
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].lastUpdateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime Да
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].readTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].readStatestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].isUnreadboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].bodystring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].bodyPreviewstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].destinationURLstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID Да
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.anyOf[0].messageGroupID.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRawNotificationStructuredTags Да
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTagsarray Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].TextTags[]string Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].textTagsarray Да
$.oneOf[0].allOf[1].Payload.anyOf[0].textTags[]string Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTagsNotificationDatabaseTags Да
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTagsarray Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].rawstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].labelstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].colorstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].linkstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].legacyLinkstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].selectedboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].processedTags[].intelligentTag.anyOf[1].CustomColorstring Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctionsarray Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].namestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].valuenumber Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formattedValuestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].format.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].formatKeystring ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].summaryFunctions[].function = "SUM" Да
$.oneOf[0].allOf[1].Payload.anyOf[0].mediaarray Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].idinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].thumbUrlstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaUrlstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].mediaTypestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].widthinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].heightinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].media[].titlestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummaryobject Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.recipientCountinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAlias.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientAvatar.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStatestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.firstRecipientStateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].recipientSummary.moreCountinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].hasActionButtonsboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtonsarray Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].NotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ActionButtonNamestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Namestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].AdditionalTextstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomInfoIconstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTitlestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmTextstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].ConfirmButtonTextstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].LoadingTextstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].CustomActionParameterstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].BackgroundColorstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].TextColorstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Importancestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].Clickableboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTagsNotificationDatabaseTags Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.anyOf[0].translationobject Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.eligibleboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.statestring ["done","eligible","none"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.cachedboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.contextstring ["chat","notification"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.endpointstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.chatIDinteger Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[0]number Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionConfidence.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.liveTranslationSourceEnabledboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.targetLanguageNamestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.receiverLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLocaleCodestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.senderLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceLanguageDetectionStatusstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.sourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.titlestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.bodystring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalTitlestring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].translation.originalBodystring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeSlug.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.anyOf[0].notificationTypeLabel.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.anyOf[0].defaultPrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].effectivePrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].typePriorityPreferencestring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.anyOf[0].canAdjustPriorityboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].suppressPersistentOverlayboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[0].plainTextBodystring Да
$.oneOf[0].allOf[1].Payload.anyOf[0].hasRecipientsboolean Да
$.oneOf[0].allOf[1].Payload.anyOf[1] = false Да
$.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/notification/get_detail",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "notificationBodyID": 0,
        "createdDate": "synthetic-example",
        "lastUpdateDate": "synthetic-example",
        "readTime": "synthetic-example",
        "readState": "synthetic-example",
        "isUnread": false,
        "title": "synthetic-example",
        "body": "synthetic-example",
        "bodyPreview": "synthetic-example",
        "destinationURL": "synthetic-example",
        "messageGroupID": 0,
        "tagsRaw": [],
        "textTags": [],
        "databaseTags": [],
        "processedTags": [],
        "summaryFunctions": [],
        "media": [],
        "recipientSummary": {
            "recipientCount": 0,
            "firstRecipientUserID": 0,
            "firstRecipientAlias": "synthetic-example",
            "firstRecipientAvatar": "synthetic-example",
            "firstRecipientState": "synthetic-example",
            "firstRecipientStateDate": "synthetic-example",
            "moreCount": 0
        },
        "hasActionButtons": false,
        "actionButtons": [],
        "translation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat",
            "endpoint": "synthetic-example",
            "notificationID": 0,
            "notificationBodyID": 0,
            "chatID": 0,
            "sourceLanguageDetectionConfidence": 0,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "receiverLanguageCode": "synthetic-example",
            "senderLocaleCode": "synthetic-example",
            "senderLanguageCode": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceLanguageDetectionStatus": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "notificationTypeSlug": "synthetic-example",
        "notificationTypeLabel": "synthetic-example",
        "defaultPriority": "default",
        "effectivePriority": "default",
        "typePriorityPreference": "default",
        "canAdjustPriority": false,
        "suppressPersistentOverlay": false,
        "plainTextBody": "synthetic-example",
        "hasRecipients": false
    }
}
Машиночитаемая документация метода
GET

/v1/notification/get_list

#
Returns the most recent notifications for the authenticated user. The result is a single list sorted newest-first. Each item carries a readState ('Created' | 'Pushed' | 'SentViaEmail' | 'Read') and an isUnread boolean so consumers can render new vs. read in one pass. Pagination: pass offset to fetch older pages. MetaInformation.hasMore is true only when another page exists beyond the returned items. Calling this endpoint does NOT mark any notifications as read — use notification/set_readstate for that.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
pageSize int Нет 50 Max results to return (clamped to 1..250)
includeRead bool Нет true If false, returns only unread notifications.
offset int Нет 0 Skip this many results (for lazy/infinite pagination).
tags string Нет "" Optional comma-separated list of tag names to filter by, e.g. "Bids,Action Required". Empty = no filter.
readState string Нет "all" all, unread, or read. all preserves includeRead behavior for older callers.
includeSummary bool Нет false If true, MetaInformation includes selected tags and formatted summary functions for the returned rows.
includeActions bool Нет false If true, each row includes executable action-button DTOs.
includeTags bool Нет true If true, each row includes processed display tags.
appointmentID int Нет 0 Optional appointment database tag filter for transaction-scoped history.
getParametersJson string Нет "" Optional validated notification-root context used only while action-button DTOs are generated.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'includeRead={{includeRead}}' \
  --data-urlencode 'offset={{offset}}' \
  --data-urlencode 'tags={{tags}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'includeSummary={{includeSummary}}' \
  --data-urlencode 'includeActions={{includeActions}}' \
  --data-urlencode 'includeTags={{includeTags}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: getParametersJson
ПолеТипОбязательноОписание
getParametersJsonstring (application/json) НетOptional JSON action-display context. Only overridePayoutMethodDialog=ShowRefundToReviewerDialog is accepted; other input is ignored.
getParametersJsonobject (декодированный JSON) Нет
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Нет
Поля ответа
ПолеТипОбязательноОписание
$notification_get_list_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 ДаNewest-first notifications belonging to the acting user. Does not mark them read. Access filtering can omit inaccessible board notifications after pagination. includeTags=false is overridden when tag filters are present; summary is present only with includeSummary=true.
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Да
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Да
$.oneOf[0].allOf[1].Payload.ResponseBody.Name = "Recent Notifications" Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].lastUpdateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].readStatestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isUnreadboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].titlestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodystring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bodyPreviewstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].destinationURLstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageGroupID.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRawNotificationStructuredTags Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTagsarray Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].TextTags[]string Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTagsNotificationDatabaseTags Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[0]array Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].tagsRaw.anyOf[1].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTagsarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].textTags[]string Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTagsNotificationDatabaseTags Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].databaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTagsarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].rawstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].labelstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].colorstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].linkstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].legacyLinkstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].selectedboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].processedTags[].intelligentTag.anyOf[1].CustomColorstring Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctionsarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].namestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].valuenumber Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formattedValuestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].format.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].formatKeystring ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].summaryFunctions[].function = "SUM" Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].mediaarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].idinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].thumbUrlstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaUrlstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].mediaTypestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].widthinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].heightinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].media[].titlestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummaryobject Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.recipientCountinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAlias.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientAvatar.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStatestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.firstRecipientStateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].recipientSummary.moreCountinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].hasActionButtonsboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtonsarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].NotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ActionButtonNamestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Namestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].AdditionalTextstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomInfoIconstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTitlestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmTextstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].ConfirmButtonTextstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].LoadingTextstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].CustomActionParameterstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].BackgroundColorstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].TextColorstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Importancestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].Clickableboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTagsNotificationDatabaseTags Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].actionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translationobject Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.eligibleboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.statestring ["done","eligible","none"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.cachedboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.contextstring ["chat","notification"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.endpointstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.chatIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[0]number Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionConfidence.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.liveTranslationSourceEnabledboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.targetLanguageNamestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.receiverLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLocaleCodestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.senderLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceLanguageDetectionStatusstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.sourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.titlestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.bodystring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalTitlestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].translation.originalBodystring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeSlug.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].notificationTypeLabel.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].defaultPrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].effectivePrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].typePriorityPreferencestring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].canAdjustPriorityboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].suppressPersistentOverlayboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageSizeinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.offsetinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.readStatestring ["all","unread","read"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeReadboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.includeTagsboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.appointmentIDinteger Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.hasMoreboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTagsarray Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].rawstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].labelstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].colorstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].linkstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].legacyLinkstring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].selectedboolean Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[1]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].ID.anyOf[2]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomIcon.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomViewType.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[0] = false Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].Name.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.selectedTags[].intelligentTag.anyOf[1].CustomColorstring Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summaryarray Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[]object Нет
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].namestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].valuenumber Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formattedValuestring Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].format.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].formatKeystring ["usd","short-usd","abbreviated-usd","abbreviated-usd-accounting","abbreviated-usd-accounting-balance","short-localized-currency-converted-from-usd","abbreviated-localized-currency-converted-from-usd","localized-currency-short","abbreviated-number","short-number","decimal-number","short-decimal-number","short-percentage","decimal-percentage","four-decimal-percentage","default"] Да
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.summary[].function = "SUM" Да
$.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/notification/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "Recent Notifications",
            "KeyValueList": [],
            "KeyValueFieldList": [],
            "MetaInformation": {
                "pageSize": 0,
                "offset": 0,
                "readState": "all",
                "includeRead": false,
                "includeTags": false,
                "appointmentID": 0,
                "hasMore": false,
                "selectedTags": []
            }
        }
    }
}
Машиночитаемая документация метода
GET

/v1/notification/get_preview

#
Returns a compact, authenticated preview for one notification. Used by the ATV2 realtime preview banner after the WebSocket nudge tells the browser which notification row changed. The socket carries only the notification ID; this endpoint re-reads the row under the acting user so notification and chat text never travels on the unauthenticated WebSocket channel. Calling this endpoint does NOT mark the notification as read. requiresExplicitDismiss is true for Overlay Notification or Action Required tags unless the creation-time override was Normal; clients keep those previews until explicitly dismissed or opened.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
notificationID int Нет 0 Notification row ID from the realtime nudge.
includeChatMessage bool Нет false If true and this is a chat notification, includes the persisted chat message DTO.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'includeChatMessage={{includeChatMessage}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_get_preview_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 ДаOwned notification preview. Message is present only when includeChatMessage=true and the row is a chat message with a conversation ID; it is false if message access is unavailable.
$.oneOf[0].allOf[1].Payload.notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.typestring ["chat","notification"] Да
$.oneOf[0].allOf[1].Payload.isUnreadboolean Да
$.oneOf[0].allOf[1].Payload.readStatestring Да
$.oneOf[0].allOf[1].Payload.requiresExplicitDismissboolean Да
$.oneOf[0].allOf[1].Payload.createdDate Да
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.createdDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.createdDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.titlestring Да
$.oneOf[0].allOf[1].Payload.bodyPreviewstring Да
$.oneOf[0].allOf[1].Payload.destinationURLstring Да
$.oneOf[0].allOf[1].Payload.isChatMessageboolean Да
$.oneOf[0].allOf[1].Payload.conversationID Да
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.conversationID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.chatNamestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].eligibleboolean Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].statestring ["done","eligible","none"] Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].cachedboolean Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].context = "chat-name" Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].endpointstring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionStatusstring ["Detected","Pending"] Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageDetectionConfidencenull Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].liveTranslationSourceEnabledboolean Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].targetLanguageNamestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].sourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].bodystring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalTitlestring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[0].originalBodystring Да
$.oneOf[0].allOf[1].Payload.chatNameTranslation.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.participantCountinteger Да
$.oneOf[0].allOf[1].Payload.isUserToUserChatboolean Да
$.oneOf[0].allOf[1].Payload.senderID Да
$.oneOf[0].allOf[1].Payload.senderID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.senderID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.senderAlias Да
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.senderAlias.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.senderAvatar Да
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.senderAvatar.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].idinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].revisioninteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].customerIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].sellerIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].bidIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].transactionIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].urlstring Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean НетTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].buyerIdentityHiddenUntilinteger | null НетLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventTypestring ["","sent","submitted","updated","cancelled"] Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].actorUserIDinteger Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[0].eventTextstring Да
$.oneOf[0].allOf[1].Payload.CustomerSurvey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.isSystemGeneratedboolean Да
$.oneOf[0].allOf[1].Payload.hasMediaboolean Да
$.oneOf[0].allOf[1].Payload.translation Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].eligibleboolean Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].statestring ["done","eligible","none"] Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].cachedboolean Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].contextstring ["chat","notification"] Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].endpointstring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].liveTranslationSourceEnabledboolean Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].targetLanguageNamestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].receiverLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLocaleCodestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].senderLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceLanguageDetectionStatusstring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].sourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].bodystring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalTitlestring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[0].originalBodystring Да
$.oneOf[0].allOf[1].Payload.translation.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.notificationTypeSlug Да
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.notificationTypeSlug.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.notificationTypeLabel Да
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.notificationTypeLabel.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.defaultPrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.effectivePrioritystring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Да
$.oneOf[0].allOf[1].Payload.canAdjustPriorityboolean Да
$.oneOf[0].allOf[1].Payload.suppressPersistentOverlayboolean Да
$.oneOf[0].allOf[1].Payload.Message Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[0] = false Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].NotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CreatedDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAlias.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].SenderAvatar.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Subjectstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Bodystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].DestinationPagestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Mediaarray Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].idinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].thumbUrlstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaUrlstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].mediaTypestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].widthinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].heightinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Media[].titlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtonsarray Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].NotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ActionButtonNamestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Namestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].AdditionalTextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomInfoIconstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTitlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmTextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].ConfirmButtonTextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].LoadingTextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].CustomActionParameterstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].BackgroundColorstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].TextColorstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Importancestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].Clickableboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTagsNotificationDatabaseTags Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[4][]NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ActionButtons[].DatabaseTags.anyOf[1].*.anyOf[5].*NotificationTagValue Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].idinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].revisioninteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].customerIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].sellerIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].bidIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].transactionIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].statusstring ["sent","in_progress","submitted","cancelled"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].urlstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenboolean НетTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].buyerIdentityHiddenUntilinteger | null НетLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventTypestring ["","sent","submitted","updated","cancelled"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].actorUserIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[0].eventTextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CustomerSurvey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Deliveryobject Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.NotificationID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.RecipientCountinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipientsarray Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].NotificationID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].UserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Username.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].Statestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].CreatedDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].LastUpdateDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushSendTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushReceiveTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].PushOpenTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailSendTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].EmailOpenTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].ReadTimeDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceiptsarray Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslationID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LanguageNamestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedTitlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].TranslatedBodystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].SeenContextstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].Modelstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].FirstServedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].LastServedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].TranslationReceipts[].CompletedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenboolean Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Delivery.Recipients[].identityHiddenUntilinteger | null Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetTypestring ["post","chat_message"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].targetIdinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerReactionKeystring ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].viewerHasReactedboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].totalCountinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].countsobject Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.thumbs_upinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.heartinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.money_with_wingsinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.laughinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.wowinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.sadinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].counts.angryinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recentarray Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].userIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].usernamestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionKeystring ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactionEmojistring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].createdDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].lastUpdateDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Reactions.anyOf[1].recent[].reactedDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsSystemGeneratedboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].type = "reaction" Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetType = "chat_message" Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetNotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actorUserIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].actionstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionKeystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].reactionEmojistring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].targetPreviewstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[0]array Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetTypestring ["post","chat_message"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].targetIdinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerReactionKeystring ["","thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].viewerHasReactedboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].totalCountinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].countsobject Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.thumbs_upinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.heartinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.money_with_wingsinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.laughinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.wowinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.sadinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].counts.angryinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recentarray Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[]object Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].userIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].usernamestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionKeystring ["thumbs_up","heart","money_with_wings","laugh","wow","sad","angry"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactionEmojistring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].createdDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].lastUpdateDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[0].summary.anyOf[1].recent[].reactedDateDisplaystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ChatEvent.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].NotificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].SenderAlias.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].Previewstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].HasMediaboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsUnavailableboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsDeletedboolean Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[0].IsSystemGeneratedboolean Нет
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].ReplyContext.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].eligibleboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].statestring ["done","eligible","none"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].cachedboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].contextstring ["chat","notification"] Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].endpointstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].notificationBodyIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[0]number Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionConfidence.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].liveTranslationSourceEnabledboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].targetLanguageNamestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].receiverLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLocaleCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].senderLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageCodestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceLanguageDetectionStatusstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].sourceContentHashstring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].bodystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalTitlestring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[0].originalBodystring Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].translation.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].Versioninteger Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].IsDeletedboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanEditboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].CanDeleteboolean Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Message.anyOf[1].EditDeadline.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/notification/get_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "notificationBodyID": 0,
        "type": "chat",
        "isUnread": false,
        "readState": "synthetic-example",
        "requiresExplicitDismiss": false,
        "createdDate": "synthetic-example",
        "createdDateDisplay": "synthetic-example",
        "title": "synthetic-example",
        "bodyPreview": "synthetic-example",
        "destinationURL": "synthetic-example",
        "isChatMessage": false,
        "conversationID": 0,
        "chatName": "synthetic-example",
        "chatNameTranslation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat-name",
            "endpoint": "synthetic-example",
            "chatID": 0,
            "sourceLanguageDetectionStatus": "Detected",
            "sourceLanguageDetectionConfidence": null,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "participantCount": 0,
        "isUserToUserChat": false,
        "senderID": 0,
        "senderAlias": "synthetic-example",
        "senderAvatar": "synthetic-example",
        "CustomerSurvey": {
            "id": 0,
            "revision": 0,
            "customerID": 0,
            "sellerID": 0,
            "chatID": 0,
            "bidID": 0,
            "transactionID": 0,
            "title": "synthetic-example",
            "status": "sent",
            "submittedDate": "synthetic-example",
            "url": "synthetic-example",
            "eventType": "",
            "actorUserID": 0,
            "eventText": "synthetic-example"
        },
        "isSystemGenerated": false,
        "hasMedia": false,
        "translation": {
            "eligible": false,
            "state": "done",
            "cached": false,
            "context": "chat",
            "endpoint": "synthetic-example",
            "notificationID": 0,
            "notificationBodyID": 0,
            "chatID": 0,
            "sourceLanguageDetectionConfidence": 0,
            "liveTranslationSourceEnabled": false,
            "targetLanguageCode": "synthetic-example",
            "targetLanguageName": "synthetic-example",
            "receiverLanguageCode": "synthetic-example",
            "senderLocaleCode": "synthetic-example",
            "senderLanguageCode": "synthetic-example",
            "sourceLanguageCode": "synthetic-example",
            "sourceLanguageDetectionStatus": "synthetic-example",
            "sourceContentHash": "synthetic-example",
            "title": "synthetic-example",
            "body": "synthetic-example",
            "originalTitle": "synthetic-example",
            "originalBody": "synthetic-example"
        },
        "notificationTypeSlug": "synthetic-example",
        "notificationTypeLabel": "synthetic-example",
        "defaultPriority": "default",
        "effectivePriority": "default",
        "typePriorityPreference": "default",
        "canAdjustPriority": false,
        "suppressPersistentOverlay": false
    }
}
Машиночитаемая документация метода
GET

/v1/notification/get_recipients

#
Returns recipient/read-state information for one non-chat notification. A protected bid customer has null identity fields and identityHidden=true until the saved race closing time.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
notificationID int Нет 0 Notification row ID.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_recipients' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_get_recipients_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.notificationIDinteger Да
$.oneOf[0].allOf[1].Payload.recipientsarray Да
$.oneOf[0].allOf[1].Payload.recipients[]object Нет
$.oneOf[0].allOf[1].Payload.recipients[].UserID Да
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.recipients[].UserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID Да
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[0]integer Да
$.oneOf[0].allOf[1].Payload.recipients[].ATUser_ID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.recipients[].Usernamestring | null Да
$.oneOf[0].allOf[1].Payload.recipients[].Statestring Да
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime Да
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.recipients[].ReadTime.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenboolean Да
$.oneOf[0].allOf[1].Payload.recipients[].identityHiddenUntilinteger | 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/notification/get_recipients",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "recipients": []
    }
}
Машиночитаемая документация метода
GET

/v1/notification/get_type_preferences

#
Returns this user's notification type priority overrides. Overrides affect future messages only.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_type_preferences' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_get_type_preferences_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.preferencesarray Да
$.oneOf[0].allOf[1].Payload.preferences[]object Нет
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeSlugstring Да
$.oneOf[0].allOf[1].Payload.preferences[].notificationTypeLabelstring Да
$.oneOf[0].allOf[1].Payload.preferences[].typePriorityPreferencestring ["default","normal","priority","high"] Да
$.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/notification/get_type_preferences",
    "RequestUserAlias": "example-user",
    "Payload": {
        "preferences": []
    }
}
Машиночитаемая документация метода
GET

/v1/notification/get_web_push_registration

#
Returns whether the current browser session already has a Web Push token. Android PWA clients call this on startup after browser notification permission has already been granted. It lets the app hide the notification enablement banner without exposing the Firebase token.
Пример запроса (cURL)
curl --get \
  'https://ru.appointmenttrader.com/v1/notification/get_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_get_web_push_registration_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 ДаRegistration state for the current browser session. API key alone without that session returns hasSession=false.
$.oneOf[0].allOf[1].Payload.registeredboolean Да
$.oneOf[0].allOf[1].Payload.hasSessionboolean Да
$.oneOf[0].allOf[1].Payload.clientTypestring Да
$.oneOf[0].allOf[1].Payload.lastUpdateDate Да
$.oneOf[0].allOf[1].Payload.lastUpdateDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.lastUpdateDate.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/notification/get_web_push_registration",
    "RequestUserAlias": "example-user",
    "Payload": {
        "registered": false,
        "hasSession": false,
        "clientType": "synthetic-example",
        "lastUpdateDate": "synthetic-example"
    }
}
Машиночитаемая документация метода
POST

/v1/notification/set_action

#
Executes a non-chat notification action button owned by the caller. Preferred clients send actionButtonID from get_detail/get_list. For older notification actions that never created an action row, send notificationID plus actionButtonName; the server re-reads the row and validates the action before execution.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
actionButtonID int Нет 0 ATNotificationIntelligentTagsActionButtons.ID when available.
notificationID int Нет 0 Notification row ID for rowless legacy actions.
actionButtonName string Нет "" ActionButton class name for rowless legacy actions.
getParametersJson string Нет "" Optional JSON object passed to OnConfirm. Legacy SQL escaping is accepted; malformed supplied JSON is rejected before execution.
globalParametersJson string Нет "" Optional JSON object passed to OnConfirm GlobalParameters. Malformed supplied JSON is rejected before execution.
isWritingRequest bool Нет false Required true to execute.
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_action' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'actionButtonID={{actionButtonID}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'actionButtonName={{actionButtonName}}' \
  --data-urlencode 'getParametersJson={{getParametersJson}}' \
  --data-urlencode 'globalParametersJson={{globalParametersJson}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: getParametersJson
ПолеТипОбязательноОписание
getParametersJsonstring (application/json) НетJSON object with action-specific inputs. Fields are used only by the selected action; empty string means no inputs.
getParametersJsonobject (декодированный JSON) Нет
getParametersJson.NoShowFeeAmountnumber НетNo-show fee in USD major units, converted to cents by the action.
getParametersJson.overridePayoutMethodDialog = "ShowRefundToReviewerDialog" Нет
getParametersJson.ReturnReasonstring Нет
getParametersJson.PaymentFeeAmount Нет
getParametersJson.PaymentFeeAmount.anyOf[0]number Нет
getParametersJson.PaymentFeeAmount.anyOf[1]string НетCurrency amount; dollar signs/spaces removed and decimal comma supported.
Параметры: globalParametersJson
ПолеТипОбязательноОписание
globalParametersJsonstring (application/json) НетJSON-encoded object; empty string uses an empty object.
globalParametersJsonobject (декодированный JSON) Нет
globalParametersJson.RefundUserAccountID Нет
globalParametersJson.RefundUserAccountID.anyOf[0]integer Нет
globalParametersJson.RefundUserAccountID.anyOf[1]string Нет
globalParametersJson.ReturnReasonstring Нет
globalParametersJson.PaymentFeeAmount Нет
globalParametersJson.PaymentFeeAmount.anyOf[0]number Нет
globalParametersJson.PaymentFeeAmount.anyOf[1]string Нет
globalParametersJson.RejectReasonstring Нет
globalParametersJson.sponsorshipContractTermsJsonstring Нет
globalParametersJson.sponsorshipContractTermsJsonobject (декодированный JSON) Нет
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.directFirstYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.directSecondYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.directThirdYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent Нет
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.directResidualPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.indirectFirstYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.indirectSecondYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent Нет
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.indirectThirdYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent Нет
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTermsJson.indirectResidualPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTermsJson.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTermsobject Нет
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent Нет
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.directFirstYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent Нет
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.directSecondYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent Нет
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.directThirdYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.directResidualPercent Нет
globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.directResidualPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.DirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent Нет
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.indirectFirstYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-FirstYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent Нет
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.indirectSecondYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-SecondYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent Нет
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.indirectThirdYearPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ThirdYearCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent Нет
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[0]number Нет
globalParametersJson.sponsorshipContractTerms.indirectResidualPercent.anyOf[1]string НетNumeric percentage, localized decimal comma accepted.
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[0]integer Нет
globalParametersJson.sponsorshipContractTerms.IndirectSponsoree-ResidualCommissionBasisPoints.anyOf[1]string НетNumeric basis points; used only when the corresponding percent field is absent.
Поля ответа
ПолеТипОбязательноОписание
$notification_set_action_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 ДаUse an owned actionButtonID, or notificationID plus an advertised actionButtonName. Availability and authorization are rechecked before execution.
$.oneOf[0].allOf[1].Payload.ActionButtonIDinteger Да
$.oneOf[0].allOf[1].Payload.RedirectURLstring Да
$.oneOf[0].allOf[1].Payload.ClientActionstring Да
$.oneOf[0].allOf[1].Payload.OpenChatDock Да
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].ChatIDinteger Да
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Namestring Да
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[0].Layoutstring Да
$.oneOf[0].allOf[1].Payload.OpenChatDock.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.NotificationIDinteger Да
$.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/notification/set_action",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ActionButtonID": 0,
        "RedirectURL": "synthetic-example",
        "ClientAction": "synthetic-example",
        "OpenChatDock": {
            "ChatID": 0,
            "Name": "synthetic-example",
            "Layout": "synthetic-example"
        },
        "NotificationID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/notification/set_all_read

#
Marks every unread non-chat notification for the authenticated user as read. The native v2 notifications dashboard calls this once on open so the page behaves like an inbox visit rather than only marking the first lazy-loaded page. Chat notifications are intentionally excluded; the v2 chat dock owns chat-read timing so merely opening the notifications dashboard does not clear message unread state.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
isWritingRequest bool Нет false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_all_read' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_set_all_read_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.Markedinteger Да
$.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/notification/set_all_read",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Marked": 0
    }
}
Машиночитаемая документация метода
POST

/v1/notification/set_delete

#
Soft-deletes one notification owned by the authenticated user. The notification row remains in ATNotifications for audit/history, but DeletedDate is set so native v2 notification lists and unread counts no longer show it.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
notificationID int Нет 0 Notification row ID.
isWritingRequest bool Нет false Required true to execute.
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_delete' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationID={{notificationID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_set_delete_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.notificationIDinteger Да
$.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/notification/set_delete",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationID": 0,
        "deleted": true
    }
}
Машиночитаемая документация метода
POST

/v1/notification/set_readstate

#
Changes the visibility of the notifications in the ID list In the portal private listings appear in the private section and public in 'Publicly traded listings'

Параметры

ИмяТипОбязательноПо умолчаниюОписание
commaSeperatedNotificationIDList string Да — list of notificationID to be altered
readState string Да — possible values are Created, Pushed, SentViaEmail or Read
isWritingRequest bool Нет false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_readstate' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'commaSeperatedNotificationIDList={{commaSeperatedNotificationIDList}}' \
  --data-urlencode 'readState={{readState}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_set_readstate_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].Payload = 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/notification/set_readstate",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Машиночитаемая документация метода
POST

/v1/notification/set_type_priority

#
Sets the acting user's priority for future notifications of a registered type. Default removes the override. Existing notifications and pending deliveries retain their creation-time priority.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
notificationTypeSlug string Да — Stable type returned by get_list or get_type_preferences.
priority string Нет "default" default, normal, priority, or high. Normal also prevents persistent overlays.
isWritingRequest bool Нет false Must be true to save; false does not write.
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_type_priority' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'notificationTypeSlug={{notificationTypeSlug}}' \
  --data-urlencode 'priority={{priority}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: priority
ПолеТипОбязательноОписание
prioritystring ["default","normal","priority","high"] Нет
Поля ответа
ПолеТипОбязательноОписание
$notification_set_type_priority_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.notificationTypeSlugstring Да
$.oneOf[0].allOf[1].Payload.typePriorityPreferencestring ["default","normal","priority","high"] Да
$.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/notification/set_type_priority",
    "RequestUserAlias": "example-user",
    "Payload": {
        "notificationTypeSlug": "synthetic-example",
        "typePriorityPreference": "default"
    }
}
Машиночитаемая документация метода
POST

/v1/notification/set_web_push_registration

#
Registers or clears the current browser session's Firebase Web Push token. Android PWA clients call this after the user grants browser notification permission. The token is stored on the current ATUserSession so the existing notification push job can fan out to it alongside native app device tokens.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
registrationToken string Нет "" Firebase Web Push registration token. Empty clears the current Web Push registration unless permission is granted.
permission string Нет "default" Browser Notification.permission value: granted, denied, or default.
isWritingRequest bool Нет false Required true to execute.
Пример запроса (cURL)
curl --request POST \
  'https://ru.appointmenttrader.com/v1/notification/set_web_push_registration' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'registrationToken={{registrationToken}}' \
  --data-urlencode 'permission={{permission}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$notification_set_web_push_registration_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.registeredboolean Да
$.oneOf[0].allOf[1].Payload.permissionstring ["granted","denied","default"] Да
$.oneOf[0].allOf[1].Payload.clientTypestring ["WebPush","Not Specified"] Да
$.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/notification/set_web_push_registration",
    "RequestUserAlias": "example-user",
    "Payload": {
        "registered": false,
        "permission": "granted",
        "clientType": "WebPush"
    }
}
Машиночитаемая документация метода