AT AppointmentTrader
登录
当前在线  

/v1/external_messaging/

External Messaging Channel-neutral outbound messaging control plane. Phase one supports email, with shared identities, billing, events, suppressions, and delivery health designed for future channels such as SMS or WhatsApp.
GET

/v1/external_messaging/get_billing_settings

#
Returns billing settings and the selected default AT funding account.

参数

名称类型必填默认值描述
channel string 否 "all" Billing channel. Use all for the default setting.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_billing_settings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_billing_settings_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.IDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.ID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.CreatedDatestring 否
$.oneOf[0].allOf[1].Payload.LastUpdateDatestring 否
$.oneOf[0].allOf[1].Payload.DeletedDate 否
$.oneOf[0].allOf[1].Payload.DeletedDate.anyOf[0]string 否
$.oneOf[0].allOf[1].Payload.DeletedDate.anyOf[1]null 否
$.oneOf[0].allOf[1].Payload.ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Channelstring 是的
$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID 是的
$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFunding-ATAccounts_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID 否
$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0]DatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0].oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[0].oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.LastSetBy-ATUser_ID.anyOf[1]null 否
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Currencystring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencySymbolstring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Namestring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].Descriptionstring 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimitDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPointsDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimitDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefaultDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalanceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalanceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.DefaultFundingAccount.anyOf[1] = false 是的
$.oneOf[0].allOf[1].Payload.PriceSettingsobject 是的
$.oneOf[0].allOf[1].Payload.PriceSettings.PricePerMessageinteger 是的
$.oneOf[0].allOf[1].Payload.PriceSettings.PriceUnitstring ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.PriceSettings.RateLimitPerHourinteger 是的
$.oneOf[0].allOf[1].Payload.PriceSettings.RecipientLimitPerMessageinteger 是的
$.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/external_messaging/get_billing_settings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATUser_ID": 0,
        "Channel": "synthetic-example",
        "DefaultFunding-ATAccounts_ID": 0,
        "DefaultFundingAccount": {
            "Currency": "synthetic-example",
            "CurrencySymbol": "synthetic-example",
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "Name": "synthetic-example",
            "Description": "synthetic-example",
            "ID": 0,
            "ATUser_ID": 0,
            "CurrencyCreditLimit": 0,
            "PayoutDefaultBasisPoints": 0,
            "PointsCreditLimit": 0,
            "IsATCorporateAccount": 0,
            "IsDefault": 0,
            "IsDepositAccount": 0,
            "CurrencyBalance": 0,
            "PointsBalance": 0
        },
        "PriceSettings": {
            "PricePerMessage": 0,
            "PriceUnit": "USD",
            "RateLimitPerHour": 0,
            "RecipientLimitPerMessage": 0
        }
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_channels

#
Returns supported external messaging channels.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_channels' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_channels_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.channelsarray 是的
$.oneOf[0].allOf[1].Payload.channels[]object 否
$.oneOf[0].allOf[1].Payload.channels[].channel = "email" 是的
$.oneOf[0].allOf[1].Payload.channels[].name = "Email" 是的
$.oneOf[0].allOf[1].Payload.channels[].enabled = true 是的
$.oneOf[0].allOf[1].Payload.channels[].streamsarray 是的
$.oneOf[0].allOf[1].Payload.channels[].streams[]string ["auth","transactional","community","bulk","sandbox"] 否
$.oneOf[0].allOf[1].Payload.priceSettingsobject 是的
$.oneOf[0].allOf[1].Payload.priceSettings.PricePerMessageinteger 是的
$.oneOf[0].allOf[1].Payload.priceSettings.PriceUnitstring ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.priceSettings.RateLimitPerHourinteger 是的
$.oneOf[0].allOf[1].Payload.priceSettings.RecipientLimitPerMessageinteger 是的
$.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/external_messaging/get_channels",
    "RequestUserAlias": "example-user",
    "Payload": {
        "channels": [],
        "priceSettings": {
            "PricePerMessage": 0,
            "PriceUnit": "USD",
            "RateLimitPerHour": 0,
            "RecipientLimitPerMessage": 0
        }
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_delivery_health

#
Returns delivery health counters for the API user.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_delivery_health' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_delivery_health_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.window = "7 days" 是的
$.oneOf[0].allOf[1].Payload.messageCountsobject 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Queuedinteger 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Sendinginteger 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Sentinteger 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Deferredinteger 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Suppressedinteger 是的
$.oneOf[0].allOf[1].Payload.messageCounts.Failedinteger 是的
$.oneOf[0].allOf[1].Payload.identityCounts 是的
$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[0].*integer 否
$.oneOf[0].allOf[1].Payload.identityCounts.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.suppressionCountinteger 是的
$.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/external_messaging/get_delivery_health",
    "RequestUserAlias": "example-user",
    "Payload": {
        "window": "7 days",
        "messageCounts": {
            "Queued": 0,
            "Sending": 0,
            "Sent": 0,
            "Deferred": 0,
            "Suppressed": 0,
            "Failed": 0
        },
        "identityCounts": [],
        "suppressionCount": 0
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_events

#
Returns the event timeline for a message.

参数

名称类型必填默认值描述
messageID string 否 "" Message numeric ID or UUID.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_events' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'messageID={{messageID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_events_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.eventsarray 是的
$.oneOf[0].allOf[1].Payload.events[]object 否
$.oneOf[0].allOf[1].Payload.events[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingMessages_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].Channelstring 是的
$.oneOf[0].allOf[1].Payload.events[].EventTypestring 是的
$.oneOf[0].allOf[1].Payload.events[].Severitystring 是的
$.oneOf[0].allOf[1].Payload.events[].RecipientAddress 是的
$.oneOf[0].allOf[1].Payload.events[].RecipientAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].RecipientAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID 是的
$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].ProviderMessageID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].ATExternalMessagingChannelConfigs_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[0] = null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Channelstring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Scopestring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ATExternalMessagingIdentities_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].RecipientHash.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].SuppressionTypestring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].Reason.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].ExpiresDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].CreatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[2].DeletedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[3]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[3].endpointstring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4].reasonstring 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[4].delayMinutesinteger 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].acceptedboolean 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID.anyOf[0]string 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].providerMessageID.anyOf[1]null 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].statusCodeinteger 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].responseExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[0]string | number | boolean | null 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[1]array 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[1][]ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[2]object 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].response.oneOf[2].*ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[5].errorstring 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerIDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].ledgerID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].priceAmountinteger 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[6].priceUnitstring ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7]object 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[0]string | number | boolean | null 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[1]array 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[1][]ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[2]object 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[7].*.oneOf[2].*ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[8]array 是的
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9]array 是的Provider callback arrays are preserved when supplied.
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][]ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[0]string | number | boolean | null 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[1]array 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[1][]ExternalMessageProviderValue 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[2]object 否
$.oneOf[0].allOf[1].Payload.events[].EventPayload.anyOf[9][].oneOf[2].*ExternalMessageProviderValue 否
$.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/external_messaging/get_events",
    "RequestUserAlias": "example-user",
    "Payload": {
        "events": []
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_identities

#
Returns sender identities owned by the API user.

参数

名称类型必填默认值描述
channel string 否 "email" Channel to list. Phase one supports email.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_identities' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_identities_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.identitiesarray 是的
$.oneOf[0].allOf[1].Payload.identities[]object 否
$.oneOf[0].allOf[1].Payload.identities[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identities[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identities[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identities[].IdentityUUIDstring 是的
$.oneOf[0].allOf[1].Payload.identities[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.identities[].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.identities[].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identities[].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identities[].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identities[].Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.identities[].Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.identities[].Statusstring ["PendingDNS","Verified","Suspended"] 是的
$.oneOf[0].allOf[1].Payload.identities[].Namestring 是的
$.oneOf[0].allOf[1].Payload.identities[].FromName 是的
$.oneOf[0].allOf[1].Payload.identities[].FromName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].FromName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].FromAddress 是的
$.oneOf[0].allOf[1].Payload.identities[].FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].DomainName 是的
$.oneOf[0].allOf[1].Payload.identities[].DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].DomainName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain 是的
$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].ReturnPathDomain.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector 是的
$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].DKIMSelector.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime 是的
$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].DNSLastCheckTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime 是的
$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].LastVerifiedTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias 是的
$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identities[].ATUser_Alias.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/external_messaging/get_identities",
    "RequestUserAlias": "example-user",
    "Payload": {
        "identities": []
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_identity_dns_status

#
Returns expected and last observed DNS state for an identity.

参数

名称类型必填默认值描述
identityID int 否 0 Sender identity ID.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_identity_dns_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'identityID={{identityID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_identity_dns_status_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.identityobject 是的
$.oneOf[0].allOf[1].Payload.identity.IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identity.ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identity.ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identity.CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.identity.LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.identity.DeletedDate 是的
$.oneOf[0].allOf[1].Payload.identity.DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.IdentityUUIDstring 是的
$.oneOf[0].allOf[1].Payload.identity.ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identity.ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identity.ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identity.CreatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.identity.Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.identity.Statusstring ["PendingDNS","Verified","Suspended"] 是的
$.oneOf[0].allOf[1].Payload.identity.Namestring 是的
$.oneOf[0].allOf[1].Payload.identity.FromName 是的
$.oneOf[0].allOf[1].Payload.identity.FromName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.FromName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.FromAddress 是的
$.oneOf[0].allOf[1].Payload.identity.FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.DomainName 是的
$.oneOf[0].allOf[1].Payload.identity.DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DomainName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain 是的
$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.ReturnPathDomain.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMSelector 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMSelector.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMSelector.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPublicKey.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DKIMPrivateKeyEnvironmentKey.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.VerificationToken 是的
$.oneOf[0].allOf[1].Payload.identity.VerificationToken.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.VerificationToken.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][]object 否
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].labelstring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].hoststring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].valuestring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[0][].observedValuestring 否
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.identity.DNSExpectedPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][]object 否
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].labelstring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].hoststring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].valuestring 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[0][].observedValuestring 否
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.DNSLastCheckTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.identity.LastVerifiedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias 是的
$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.identity.ATUser_Alias.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.dnsRecordsarray 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[]object 否
$.oneOf[0].allOf[1].Payload.dnsRecords[].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].labelstring 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].hoststring 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].valuestring 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.dnsRecords[].observedValuestring 否
$.oneOf[0].allOf[1].Payload.lastCheck 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][]object 否
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].labelstring 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].hoststring 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].valuestring 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[0][].observedValuestring 否
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.lastCheck.anyOf[2] = 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/external_messaging/get_identity_dns_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "identity": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "IdentityUUID": "synthetic-example",
            "ATUser_ID": 0,
            "CreatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Status": "PendingDNS",
            "Name": "synthetic-example",
            "FromName": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ReturnPathDomain": "synthetic-example",
            "DKIMSelector": "synthetic-example",
            "DKIMPublicKey": "synthetic-example",
            "DKIMPrivateKeyEnvironmentKey": "synthetic-example",
            "VerificationToken": "synthetic-example",
            "DNSExpectedPayload": [],
            "DNSLastCheckPayload": [],
            "DNSLastCheckTime": "synthetic-example",
            "LastVerifiedTime": "synthetic-example",
            "LastVerifiedBy-ATUser_ID": 0,
            "ATUser_Alias": "synthetic-example"
        },
        "dnsRecords": [],
        "lastCheck": []
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_message

#
Returns a queued/sent message by numeric ID or UUID.

参数

名称类型必填默认值描述
messageID string 否 "" Message numeric ID or UUID.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_message' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'messageID={{messageID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_message_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.messageobject 是的
$.oneOf[0].allOf[1].Payload.message.IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.message.LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.message.DeletedDate 是的
$.oneOf[0].allOf[1].Payload.message.DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.MessageUUIDstring 是的
$.oneOf[0].allOf[1].Payload.message.ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.ImpersonatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.message.Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.message.Modestring ["sandbox","production"] 是的
$.oneOf[0].allOf[1].Payload.message.Statusstring ["Queued","Sending","Sent","Deferred","Suppressed","Failed"] 是的
$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID 是的
$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.ATExternalMessagingIdentities_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID 是的
$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.Funding-ATAccounts_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID 是的
$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.Settlement-ATAccountsLedger_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID 是的
$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.ATAPIAccessLog_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.Subject 是的
$.oneOf[0].allOf[1].Payload.message.Subject.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.Subject.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload 是的
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0].toarray 是的
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[0].to[]string 否
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.message.RecipientsPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0].htmlBodystring 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[0].textBodystring 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.message.ContentPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].Fromstring 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].X-AT-External-Messaging-Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].List-Unsubscribestring 否
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[0].List-Unsubscribe-Post = "List-Unsubscribe=One-Click" 否
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.message.HeadersPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.message.PriceAmountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.PriceAmount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.PriceAmount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.PriceUnit 是的
$.oneOf[0].allOf[1].Payload.message.PriceUnit.anyOf[0]string ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.message.PriceUnit.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.RecipientCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.RecipientCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.RecipientCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.AttemptCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.message.AttemptCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.message.AttemptCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.message.NextAttemptDate 是的
$.oneOf[0].allOf[1].Payload.message.NextAttemptDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.NextAttemptDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.QueuedDate 是的
$.oneOf[0].allOf[1].Payload.message.QueuedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.QueuedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.SentDate 是的
$.oneOf[0].allOf[1].Payload.message.SentDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.SentDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.LastEventDate 是的
$.oneOf[0].allOf[1].Payload.message.LastEventDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.LastEventDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.ProviderMessageID 是的
$.oneOf[0].allOf[1].Payload.message.ProviderMessageID.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.ProviderMessageID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.FailureReason 是的
$.oneOf[0].allOf[1].Payload.message.FailureReason.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.FailureReason.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.FromAddress 是的
$.oneOf[0].allOf[1].Payload.message.FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.DomainName 是的
$.oneOf[0].allOf[1].Payload.message.DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.DomainName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.message.ATUser_Alias 是的
$.oneOf[0].allOf[1].Payload.message.ATUser_Alias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.message.ATUser_Alias.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/external_messaging/get_message",
    "RequestUserAlias": "example-user",
    "Payload": {
        "message": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "MessageUUID": "synthetic-example",
            "ATUser_ID": 0,
            "ImpersonatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Mode": "sandbox",
            "Status": "Queued",
            "ATExternalMessagingIdentities_ID": 0,
            "Funding-ATAccounts_ID": 0,
            "Settlement-ATAccountsLedger_ID": 0,
            "ATAPIAccessLog_ID": 0,
            "Subject": "synthetic-example",
            "RecipientsPayload": {
                "to": []
            },
            "ContentPayload": {
                "htmlBody": "synthetic-example",
                "textBody": "synthetic-example"
            },
            "HeadersPayload": {
                "From": "synthetic-example",
                "X-AT-External-Messaging-Stream": "auth"
            },
            "PriceAmount": 0,
            "PriceUnit": "USD",
            "RecipientCount": 0,
            "AttemptCount": 0,
            "NextAttemptDate": "synthetic-example",
            "QueuedDate": "synthetic-example",
            "SentDate": "synthetic-example",
            "LastEventDate": "synthetic-example",
            "ProviderMessageID": "synthetic-example",
            "FailureReason": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ATUser_Alias": "synthetic-example"
        }
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_messages

#
Returns recent messages for the API user.

参数

名称类型必填默认值描述
channel string 否 "email" Channel filter.
status string 否 "" Optional status filter.
limit int 否 50 Maximum rows to return.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_messages' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'status={{status}}' \
  --data-urlencode 'limit={{limit}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_messages_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.messagesarray 是的
$.oneOf[0].allOf[1].Payload.messages[]object 否
$.oneOf[0].allOf[1].Payload.messages[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.messages[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.messages[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.messages[].MessageUUIDstring 是的
$.oneOf[0].allOf[1].Payload.messages[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.messages[].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.messages[].Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.messages[].Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.messages[].Modestring ["sandbox","production"] 是的
$.oneOf[0].allOf[1].Payload.messages[].Statusstring ["Queued","Sending","Sent","Deferred","Suppressed","Failed"] 是的
$.oneOf[0].allOf[1].Payload.messages[].Subject 是的
$.oneOf[0].allOf[1].Payload.messages[].Subject.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].Subject.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].RecipientCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.messages[].RecipientCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.messages[].RecipientCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.messages[].PriceAmountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.messages[].PriceAmount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.messages[].PriceAmount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.messages[].PriceUnit 是的
$.oneOf[0].allOf[1].Payload.messages[].PriceUnit.anyOf[0]string ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.messages[].PriceUnit.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].AttemptCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.messages[].AttemptCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.messages[].AttemptCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.messages[].QueuedDate 是的
$.oneOf[0].allOf[1].Payload.messages[].QueuedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].QueuedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].SentDate 是的
$.oneOf[0].allOf[1].Payload.messages[].SentDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].SentDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].LastEventDate 是的
$.oneOf[0].allOf[1].Payload.messages[].LastEventDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].LastEventDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID 是的
$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].ProviderMessageID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].FailureReason 是的
$.oneOf[0].allOf[1].Payload.messages[].FailureReason.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].FailureReason.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].FromAddress 是的
$.oneOf[0].allOf[1].Payload.messages[].FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.messages[].DomainName 是的
$.oneOf[0].allOf[1].Payload.messages[].DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.messages[].DomainName.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/external_messaging/get_messages",
    "RequestUserAlias": "example-user",
    "Payload": {
        "messages": []
    }
}
机器可读的端点文档
GET

/v1/external_messaging/get_suppressions

#
Returns active suppressions for the API user.

参数

名称类型必填默认值描述
channel string 否 "email" Channel filter.
limit int 否 50 Maximum rows to return.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/external_messaging/get_suppressions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'limit={{limit}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_get_suppressions_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.suppressionsarray 是的
$.oneOf[0].allOf[1].Payload.suppressions[]object 否
$.oneOf[0].allOf[1].Payload.suppressions[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.suppressions[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.suppressions[].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].Channelstring 是的
$.oneOf[0].allOf[1].Payload.suppressions[].Scopestring 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ATExternalMessagingIdentities_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].RecipientHash.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].SuppressionTypestring 是的
$.oneOf[0].allOf[1].Payload.suppressions[].Reason 是的
$.oneOf[0].allOf[1].Payload.suppressions[].Reason.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].Reason.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].ExpiresDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].CreatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.suppressions[].DeletedBy-ATUser_ID.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/external_messaging/get_suppressions",
    "RequestUserAlias": "example-user",
    "Payload": {
        "suppressions": []
    }
}
机器可读的端点文档
POST

/v1/external_messaging/set_billing_account

#
Sets the default AT account used to pay for accepted production messages.

参数

名称类型必填默认值描述
fundingAccountID int 否 0 AT account ID owned by the API user.
channel string 否 "all" Billing channel. Use all for the default setting.
isWritingRequest bool 否 false Must be true to update billing settings.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/external_messaging/set_billing_account' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_set_billing_account_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.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.BillingSettingsobject 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.IDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.ID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.BillingSettings.ID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.BillingSettings.CreatedDatestring 否
$.oneOf[0].allOf[1].Payload.BillingSettings.LastUpdateDatestring 否
$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate 否
$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate.anyOf[0]string 否
$.oneOf[0].allOf[1].Payload.BillingSettings.DeletedDate.anyOf[1]null 否
$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.Channelstring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFunding-ATAccounts_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID 否
$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0]DatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0].oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[0].oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.BillingSettings.LastSetBy-ATUser_ID.anyOf[1]null 否
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Currencystring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencySymbolstring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Namestring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].Descriptionstring 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimitDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyCreditLimit.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPointsDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PayoutDefaultBasisPoints.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimitDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsCreditLimit.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsATCorporateAccount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefaultDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDefault.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].IsDepositAccount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalanceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].CurrencyBalance.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalanceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[0].PointsBalance.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.DefaultFundingAccount.anyOf[1] = false 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettingsobject 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.PricePerMessageinteger 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.PriceUnitstring ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.RateLimitPerHourinteger 是的
$.oneOf[0].allOf[1].Payload.BillingSettings.PriceSettings.RecipientLimitPerMessageinteger 是的
$.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/external_messaging/set_billing_account",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "BillingSettings": {
            "ATUser_ID": 0,
            "Channel": "synthetic-example",
            "DefaultFunding-ATAccounts_ID": 0,
            "DefaultFundingAccount": {
                "Currency": "synthetic-example",
                "CurrencySymbol": "synthetic-example",
                "CreatedDate": "synthetic-example",
                "LastUpdateDate": "synthetic-example",
                "Name": "synthetic-example",
                "Description": "synthetic-example",
                "ID": 0,
                "ATUser_ID": 0,
                "CurrencyCreditLimit": 0,
                "PayoutDefaultBasisPoints": 0,
                "PointsCreditLimit": 0,
                "IsATCorporateAccount": 0,
                "IsDefault": 0,
                "IsDepositAccount": 0,
                "CurrencyBalance": 0,
                "PointsBalance": 0
            },
            "PriceSettings": {
                "PricePerMessage": 0,
                "PriceUnit": "USD",
                "RateLimitPerHour": 0,
                "RecipientLimitPerMessage": 0
            }
        }
    }
}
机器可读的端点文档
POST

/v1/external_messaging/set_identity

#
Creates an email sender identity and returns the DNS records needed for verification.

参数

名称类型必填默认值描述
channel string 否 "email" Channel to create. Phase one supports email.
fromAddress string 否 "" Sender email address.
fromName string 否 "" Human readable sender name.
name string 否 "" Internal identity label.
stream string 否 "transactional" Email stream: auth, transactional, community, or bulk.
isWritingRequest bool 否 false Must be true to create the identity.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/external_messaging/set_identity' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'fromAddress={{fromAddress}}' \
  --data-urlencode 'fromName={{fromName}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'stream={{stream}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_set_identity_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.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.Identity 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].IdentityUUIDstring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].CreatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Statusstring ["PendingDNS","Verified","Suspended"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].Namestring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DomainName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ReturnPathDomain.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMSelector.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPublicKey.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DKIMPrivateKeyEnvironmentKey.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].VerificationToken.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][]object 否
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].labelstring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].hoststring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].valuestring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[0][].observedValuestring 否
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSExpectedPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][]object 否
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].labelstring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].hoststring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].valuestring 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[0][].observedValuestring 否
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].DNSLastCheckTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedTime.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].LastVerifiedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[0].ATUser_Alias.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Identity.anyOf[1] = false 是的
$.oneOf[0].allOf[1].Payload.DNSRecordsarray 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[]object 否
$.oneOf[0].allOf[1].Payload.DNSRecords[].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].labelstring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].hoststring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].valuestring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].observedValuestring 否
$.oneOf[0].allOf[1].Payload.DKIMPrivateKeyEnvironmentKeystring 是的
$.oneOf[0].allOf[1].Payload.DKIMPrivateKeyOneTimestring 是的
$.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/external_messaging/set_identity",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Identity": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "IdentityUUID": "synthetic-example",
            "ATUser_ID": 0,
            "CreatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Status": "PendingDNS",
            "Name": "synthetic-example",
            "FromName": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ReturnPathDomain": "synthetic-example",
            "DKIMSelector": "synthetic-example",
            "DKIMPublicKey": "synthetic-example",
            "DKIMPrivateKeyEnvironmentKey": "synthetic-example",
            "VerificationToken": "synthetic-example",
            "DNSExpectedPayload": [],
            "DNSLastCheckPayload": [],
            "DNSLastCheckTime": "synthetic-example",
            "LastVerifiedTime": "synthetic-example",
            "LastVerifiedBy-ATUser_ID": 0,
            "ATUser_Alias": "synthetic-example"
        },
        "DNSRecords": [],
        "DKIMPrivateKeyEnvironmentKey": "FAKE_DKIM_ENVIRONMENT_KEY",
        "DKIMPrivateKeyOneTime": "FAKE_PRIVATE_KEY_PLACEHOLDER"
    }
}
机器可读的端点文档
POST

/v1/external_messaging/set_identity_verify_dns

#
Checks DNS records for an email sender identity and marks it verified when required records are present.

参数

名称类型必填默认值描述
identityID int 否 0 Sender identity ID.
isWritingRequest bool 否 false Must be true to record the DNS check.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/external_messaging/set_identity_verify_dns' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'identityID={{identityID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_set_identity_verify_dns_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.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.Statusstring ["PendingDNS","Verified"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecordsarray 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[]object 否
$.oneOf[0].allOf[1].Payload.DNSRecords[].keystring ["ownership","dkim","dmarc","return_path","mta_sts","tls_reporting"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].labelstring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].typestring ["TXT","MX"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].hoststring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].valuestring 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].requiredboolean 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].statusstring ["pending","verified","missing","advisory"] 是的
$.oneOf[0].allOf[1].Payload.DNSRecords[].observedValuestring 否
$.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/external_messaging/set_identity_verify_dns",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Status": "PendingDNS",
        "DNSRecords": []
    }
}
机器可读的端点文档
POST

/v1/external_messaging/set_send

#
Queues an external message. Phase one supports email only. Production email requires a verified sender identity and is charged after the first-party MTA records smtp_accepted. Sandbox messages are free and do not submit to the MTA.

参数

名称类型必填默认值描述
channel string 否 "email" Channel. Phase one supports email.
identityID int 否 0 Sender identity ID.
to string 否 "" Comma-separated recipient email addresses.
subject string 否 "" Message subject.
htmlBody string 否 "" HTML body.
textBody string 否 "" Plain text body.
stream string 否 "transactional" Email stream: auth, transactional, community, bulk, or sandbox.
mode string 否 "sandbox" sandbox or production.
fundingAccountID int 否 0 Optional per-message AT funding account override.
isWritingRequest bool 否 false Must be true to queue the message.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/external_messaging/set_send' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'identityID={{identityID}}' \
  --data-urlencode 'to={{to}}' \
  --data-urlencode 'subject={{subject}}' \
  --data-urlencode 'htmlBody={{htmlBody}}' \
  --data-urlencode 'textBody={{textBody}}' \
  --data-urlencode 'stream={{stream}}' \
  --data-urlencode 'mode={{mode}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_set_send_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.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.Message 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DeletedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].MessageUUIDstring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ImpersonatedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Channel = "email" 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Modestring ["sandbox","production"] 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Statusstring ["Queued","Sending","Sent","Deferred","Suppressed","Failed"] 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATExternalMessagingIdentities_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Funding-ATAccounts_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Settlement-ATAccountsLedger_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATAPIAccessLog_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].Subject.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0].toarray 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[0].to[]string 否
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientsPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0].htmlBodystring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[0].textBodystring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ContentPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].Fromstring 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].X-AT-External-Messaging-Streamstring ["auth","transactional","community","bulk","sandbox"] 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].List-Unsubscribestring 否
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[0].List-Unsubscribe-Post = "List-Unsubscribe=One-Click" 否
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[1] = "" 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].HeadersPayload.anyOf[2] = null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceAmount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit.anyOf[0]string ["USD","Traderpoint"] 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].PriceUnit.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].RecipientCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].AttemptCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].NextAttemptDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].QueuedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].SentDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].LastEventDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ProviderMessageID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FailureReason.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].FromAddress.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].DomainName.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Message.anyOf[0].ATUser_Alias.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Message.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/external_messaging/set_send",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "Message": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": "synthetic-example",
            "MessageUUID": "synthetic-example",
            "ATUser_ID": 0,
            "ImpersonatedBy-ATUser_ID": 0,
            "Channel": "email",
            "Stream": "auth",
            "Mode": "sandbox",
            "Status": "Queued",
            "ATExternalMessagingIdentities_ID": 0,
            "Funding-ATAccounts_ID": 0,
            "Settlement-ATAccountsLedger_ID": 0,
            "ATAPIAccessLog_ID": 0,
            "Subject": "synthetic-example",
            "RecipientsPayload": {
                "to": []
            },
            "ContentPayload": {
                "htmlBody": "synthetic-example",
                "textBody": "synthetic-example"
            },
            "HeadersPayload": {
                "From": "synthetic-example",
                "X-AT-External-Messaging-Stream": "auth"
            },
            "PriceAmount": 0,
            "PriceUnit": "USD",
            "RecipientCount": 0,
            "AttemptCount": 0,
            "NextAttemptDate": "synthetic-example",
            "QueuedDate": "synthetic-example",
            "SentDate": "synthetic-example",
            "LastEventDate": "synthetic-example",
            "ProviderMessageID": "synthetic-example",
            "FailureReason": "synthetic-example",
            "FromAddress": "synthetic-example",
            "DomainName": "synthetic-example",
            "ATUser_Alias": "synthetic-example"
        }
    }
}
机器可读的端点文档
POST

/v1/external_messaging/set_suppression

#
Adds a user-level suppression for a recipient.

参数

名称类型必填默认值描述
channel string 否 "email" Channel. Phase one supports email.
recipient string 否 "" Recipient email address.
type string 否 "manual" Suppression type.
reason string 否 "" Operator or application reason.
isWritingRequest bool 否 false Must be true to create the suppression.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/external_messaging/set_suppression' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'channel={{channel}}' \
  --data-urlencode 'recipient={{recipient}}' \
  --data-urlencode 'type={{type}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$external_messaging_set_suppression_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.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.SuppressionIDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.SuppressionID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.SuppressionID.oneOf[1]string 是的
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null 是的
$.oneOf[1].ResponseMessage.oneOf[1]array 是的
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage 否
$.oneOf[1].ResponseMessage.oneOf[2]object 是的
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage 否
$.oneOf[1].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/external_messaging/set_suppression",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Succeeded": true,
        "SuppressionID": 0
    }
}
机器可读的端点文档