التوثيقAPI v1
أقسام التوثيق

المحادثات والرسائل

أرسل طلبًا واحتفظ بمعرّفه ثم راجع العمل الناتج.

أنشئ محادثة

يتطلّب POST /v1/conversations صلاحية converse ووكيلًا نشطًا يستطيع المفتاح الوصول إليه. الاستجابة 201 وتتضمّن معرّف المحادثة وروابطها. استبدل UUID التوضيحي بمعرّف وكيلك.

curl -X POST "$MUWKL_BASE_URL/v1/conversations" \
  -H "Authorization: Bearer $MUWKL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $CREATE_REQUEST_ID" \
  -d '{
    "agent_id": "00000000-0000-4000-8000-000000000001",
    "subject": "Customer service enquiry",
    "language": "en"
  }'
الحقلالنوعالمعنى
agent_idUUID · requiredالوكيل النشط
subjectstring · 1–200موضوع غير فارغ للمحادثة
language"en" | "ar"الافتراضي en

أرسل رسالة

أرسل الرسالة إلى معرّف المحادثة المسترجع. حدّد client_message_id ثابتًا وbody وlanguage. يجب ألا يكون النص فارغًا وألا يتجاوز 16000 حرف. احتفظ بمعرّف الرسالة نفسه عند إعادة المحاولة.

curl -X POST \
  "$MUWKL_BASE_URL/v1/conversations/$CONVERSATION_ID/messages" \
  -H "Authorization: Bearer $MUWKL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $MESSAGE_REQUEST_ID" \
  -d '{
    "client_message_id": "00000000-0000-4000-8000-000000000002",
    "body": "Can you help me with my request?",
    "language": "en"
  }'

راجع المعالجة والنتائج

استخدم صلاحية read لمراجعة دورات المعالجة. قد تكون حالة الدورة admitted أو sealed أو finalized أو abandoned. راجع المخرجات وحالة العملية على حدة، ولا تعتبر كل حالة نتيجة ناجحة.

curl \
  "$MUWKL_BASE_URL/v1/conversations/$CONVERSATION_ID/turns" \
  -H "Authorization: Bearer $MUWKL_API_KEY"
MethodPath
GET/v1/conversations/{id}
GET/v1/conversations/{id}/messages
GET/v1/conversations/{id}/turns
GET/v1/conversations/{id}/turns/{turn_id}
GET/v1/conversations/{id}/turns/{turn_id}/outputs
GET/v1/conversations/{id}/operations/{operation_id}

تعامل مع الإمكانات غير المتاحة بوضوح

قد تشير البيئة إلى أن الإمكانية غير متاحة إذا لم تُهيّأ المخرجات أو الأدلة أو الإحالة أو التسليم. اعرض هذه الحالة في واجهتك. وعندما تكون العملية unknown، تحقّق من النتيجة المسجّلة قبل محاولة إجراء آخر.