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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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
    }
}
기계가 읽을 수 있는 엔드포인트 문서