Session Chat

Manage chat messages during a session.

Send Chat Message

Send a text message, image, or video during a session.

Endpoint

• Method: POST
• URL: /v1/customer/sessions/{id}/session-chat

Request Headers

Header	Value	Required
Content-Type	multipart/form-data	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Path Parameters

Parameter	Type	Description	Required
id	string	Session ID	Yes

Request Body

Parameter	Type	Description	Required	Validation
message_type	string	Type of message (text, image, or video)	Yes	in:text,image,video
message	string/file	Message content or file	Yes	See validation rules below

Validation Rules

The validation rules for the message parameter depend on the message_type:

• For text:

  • Required
  • String
  • Minimum length: 1 character

• For image:

  • Required
  • File
  • Image format (jpeg, png, jpg, webp)
  • Maximum size: 2MB (2048 KB)

• For video:

  • Required
  • File
  • Video format (mp4, avi, webm, mpeg, quicktime)
  • Maximum size: 10MB (10240 KB)

Success Response

{
    "success": true,
    "message": "تم حفظ البيانات بنجاح",
    "data": {
        "id": "uuid",
        "sender_type": "customer",
        "avatar": "url",
        "message_type": "text",
        "message": "Hello, how can I help you today?",
        "created_at": "02:30 PM"
    },
    "statusCode": 200
}

Error Response

Session Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على الجلسة",
    "data": null,
    "statusCode": 404
}

Validation Error (422)

{
    "success": false,
    "message": "بيانات غير صالحة",
    "data": {
        "message": [
            "حجم الصورة يجب أن لا يتجاوز 2 ميجابايت",
            "نوع الملف غير مدعوم"
        ]
    },
    "statusCode": 422
}

Download Chat Media

Download an image or video from a chat message.

Endpoint

• Method: GET
• URL: /v1/customer/sessions/{id}/session-chat/{chatId}/download

Request Headers

Header	Value	Required
Accept	application/json	Yes
Authorization	Bearer token	Yes

Path Parameters

Parameter	Type	Description	Required
id	string	Session ID	Yes
chatId	string	Chat Message ID	Yes

Success Response

The response will be the media file (image or video) with appropriate content type headers.

Error Response

Session Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على الجلسة",
    "data": null,
    "statusCode": 404
}

Chat Message Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على الرسالة",
    "data": null,
    "statusCode": 404
}

Important Notes

• Chat messages can only be sent during an active session
• Images and videos are stored securely and can be downloaded later
• Messages are displayed in chronological order
• Each message includes:
  • Sender information (customer or coach)
  • Sender's avatar
  • Message type (text, image, or video)
  • Message content
  • Timestamp
• Media files have size and format restrictions to ensure optimal performance