オンライン中  

/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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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"
    }
}
機械可読のエンドポイントドキュメント