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://cn.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://cn.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://cn.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://cn.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
}
机器可读的端点文档