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://ar.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://ar.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://ar.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://ar.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
}
توثيق نقطة النهاية القابل للقراءة آليًا