List Chatroom

API สำหรับขอรายการห้อง HumanSoft Notify ของบริษัท เพื่อนำ chat_token ของห้องไปใช้ส่งข้อความผ่าน Send Message

Endpoint

GET /api/v1/open-apis/hms-notify/list-chatroom

Request Parameters

ส่งเป็น query string เท่านั้น (ไม่รับ request body) — หากรหัสพนักงานมีอักขระพิเศษ ให้ URL-encode ก่อน

Response Format

Success Response (HTTP 200)

{
  "code": 200,
  "message": "Success",
  "payload": [
    {
      "chat_id": "20251127D4573C421639",
      "chat_token": "20251127C4E8A2F6B1D3957E0A6C",
      "chat_image": null,
      "chat_display_name": "แจ้งเตือนฝ่ายบุคคล",
      "chat_member": "2",
      "created_name": "สมชาย",
      "created_surname": "ใจดี",
      "created": "2025-11-27 09:12:30",
      "member_list": [
        { "chat_id": "20251127D4573C421639", "chat_user_id": "20251127A1B2C3D4E5F6", "role": "admin" },
        { "chat_id": "20251127D4573C421639", "chat_user_id": "20251127F6E5D4C3B2A1", "role": "member" }
      ]
    }
  ]
}

ถ้าบริษัทยังไม่มีห้อง HumanSoft Notify จะได้ HTTP 200 พร้อม payload เป็น array ว่าง ([])

Response Fields

Member Fields (member_list[])

Error Response - Validation Failed (HTTP 400)

เกิดเมื่อส่ง employee_code เป็นค่าว่าง

{
  "code": 400,
  "message": "Validation failed",
  "errors": ["'employee_code' query parameter is required"]
}

Error Response - Missing employee_code (HTTP 404)

หากไม่ส่ง parameter employee_code มาเลย API Gateway จะตอบ HTTP 404 ก่อนถึงระบบ HumanSoft (รูปแบบ Response ต่างจากกรณีอื่น)

{
  "statusCode": 404,
  "message": "Resource not found"
}

Error Response - Employee Not Found (HTTP 400)

ไม่พบรหัสพนักงานนี้ในบริษัทที่ผูกกับ API Key

{
  "code": 400,
  "message": "Employee not found with code: EMP001"
}

Error Response - No User Account (HTTP 400)

พนักงานไม่มีบัญชีผู้ใช้ในระบบ HumanSoft — ใช้รหัสพนักงานที่มีบัญชีผู้ใช้ หรือสร้างบัญชีให้พนักงานก่อน

{
  "code": 400,
  "message": "Employee EMP001 has no HumanSoft user account"
}

Error Response - Could Not Load Chat Rooms (HTTP 400)

ดึงรายการห้องไม่สำเร็จ — API นี้ไม่เปลี่ยนแปลงข้อมูล จึงเรียกซ้ำได้ หากยังไม่สำเร็จให้ติดต่อ HumanSoft ตัวเลขในวงเล็บคือรหัสสถานะจากระบบต้นทาง ไม่ใช่ HTTP status ของ Response นี้ (ซึ่งเป็น 400 เสมอ)

{
  "code": 400,
  "message": "Failed to load HumanSoft Notify chat rooms (HTTP 500)"
}

หรือ "Could not connect to HumanSoft. Please try again" เมื่อเชื่อมต่อไม่ได้หรือการเชื่อมต่อหมดเวลา

Validation Rules

Code Examples

curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/hms-notify/list-chatroom?employee_code=EMP001" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

const params = new URLSearchParams({ employee_code: 'EMP001' })
 
const response = await fetch(
  `https://openapi.humansoft.co.th/api/v1/open-apis/hms-notify/list-chatroom?${params}`,
  {
    method: 'GET',
    headers: {
      'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY'
    }
  }
)
const data = await response.json()

import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/hms-notify/list-chatroom"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
params = {
    "employee_code": "EMP001"
}
 
response = requests.get(url, headers=headers, params=params)
result = response.json()

<?php
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/hms-notify/list-chatroom?"
    . http_build_query(["employee_code" => "EMP001"]);
$headers = [
    "Ocp-Apim-Subscription-Key: YOUR_API_KEY"
];
 
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
$response = curl_exec($ch);
curl_close($ch);
 
$result = json_decode($response, true);
?>

Notes

Related APIs

• Send Message - ส่งข้อความเข้าห้องด้วย chat_token จาก API นี้
• HumanSoft Notify Overview - ภาพรวมและขั้นตอนการใช้งาน