AT AppointmentTrader
サインイン
オンライン中  

/v1/aichat/

Manages AI Chat related functions
GET

/v1/aichat/get

#
Gets messages for a user thread

パラメーター

名前型必須既定値説明
chatName string はい — Name of the chat
isAssistantThread bool いいえ false defines if this is an assistant thread
pageSize int いいえ 50 Defines how many results will be return per request
pageNumber int いいえ 0 Defines which page should be returned
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/aichat/get' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatName={{chatName}}' \
  --data-urlencode 'isAssistantThread={{isAssistantThread}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$aichat_get_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.ATResponseObjectType = "NestedKeyValueList" はい
$.oneOf[0].allOf[1].Payload.ResponseBodyobject はい
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring はい
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray はい
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string いいえ
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object いいえ
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].interfaceMessageIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].interfaceMessageID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].interfaceMessageID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].messageCreatedDatestring はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isAIResponse はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isAIResponse.anyOf[0]DatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isAIResponse.anyOf[0].oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isAIResponse.anyOf[0].oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isAIResponse.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].rolestring ["assistant","user","function"] はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].contentstring はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].richContent はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].richContent.anyOf[0]string はいStored rich-content text; this endpoint does not decode it.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].richContent.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray はい
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]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/aichat/get",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/aichat/get_status

#
Gets messages for a user thread

パラメーター

名前型必須既定値説明
chatName string はい — Name of the chat
リクエスト例（cURL） 
curl --get \
  'https://jp.appointmenttrader.com/v1/aichat/get_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatName={{chatName}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$aichat_get_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].Payloadarray はい
$.oneOf[0].allOf[1].Payload[] いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[0]object いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[0].status = "message_update_available" はい
$.oneOf[0].allOf[1].Payload[].oneOf[0].contentobject はい
$.oneOf[0].allOf[1].Payload[].oneOf[0].content.interfaceMessageIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].oneOf[0].content.interfaceMessageID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload[].oneOf[0].content.interfaceMessageID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload[].oneOf[0].content.continuePolling = false はい
$.oneOf[0].allOf[1].Payload[].oneOf[0].content.contentstring はい
$.oneOf[0].allOf[1].Payload[].oneOf[1]object いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[1].status = "message_update_available" はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].contentobject はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.interfaceMessageIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.interfaceMessageID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.interfaceMessageID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.continuePolling = true はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContentAIChatRichContent はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0]object はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0].htmlstring はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0].positionstring ["top","bottom"] はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0].javascriptstring いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0].uiDescriptionstring いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[0].uniqueIdstring いいえ
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[1]object はい
$.oneOf[0].allOf[1].Payload[].oneOf[1].content.richContent.oneOf[1].errorstring はい
$.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/aichat/get_status",
    "RequestUserAlias": "example-user",
    "Payload": []
}
機械可読のエンドポイントドキュメント
POST

/v1/aichat/set

#
Sends a message to an AI chat

パラメーター

名前型必須既定値説明
message string はい — the body of the user message, no more than 10k characters
chatName string はい — Name of the chat
respondByAssistantID string いいえ "" If respondByAssistantID is empty the message will be processed later.
isWritingRequest bool いいえ false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/aichat/set' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'message={{message}}' \
  --data-urlencode 'chatName={{chatName}}' \
  --data-urlencode 'respondByAssistantID={{respondByAssistantID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$aichat_set_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payload はい
$.oneOf[0].allOf[1].Payload.oneOf[0]object はい
$.oneOf[0].allOf[1].Payload.oneOf[0].responseInterfaceMessageIDDatabaseInteger はいInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.oneOf[0].responseInterfaceMessageID.oneOf[0]integer はい
$.oneOf[0].allOf[1].Payload.oneOf[0].responseInterfaceMessageID.oneOf[1]string はい
$.oneOf[0].allOf[1].Payload.oneOf[1] = true はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/aichat/set",
    "RequestUserAlias": "example-user",
    "Payload": {
        "responseInterfaceMessageID": 0
    }
}
機械可読のエンドポイントドキュメント
POST

/v1/aichat/set_clear

#
Clear chat history

パラメーター

名前型必須既定値説明
chatName string はい — Name of the chat
isWritingRequest bool いいえ false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
リクエスト例（cURL） 
curl --request POST \
  'https://jp.appointmenttrader.com/v1/aichat/set_clear' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatName={{chatName}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$aichat_set_clear_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payload = true はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/aichat/set_clear",
    "RequestUserAlias": "example-user",
    "Payload": true
}
機械可読のエンドポイントドキュメント