HumanSoft Notify API Module
ภาพรวม (Overview)
โมดูล HumanSoft Notify ใช้ส่งข้อความแจ้งเตือนจากระบบของคุณเข้า ห้อง HumanSoft Notify ในแอป HumanSoft ข้อความจะแสดงในห้องในนามบอท HumanSoft Notify และสมาชิกในห้องจะได้รับแจ้งเตือนในแอป เหมาะสำหรับประกาศหรือแจ้งเตือนถึงกลุ่มพนักงาน เช่น แจ้งปิดปรับปรุงระบบ
ห้อง HumanSoft Notify คือห้องกลุ่มที่ HR สร้างไว้ในเมนู ตั้งค่า HumanSoft Notify ของระบบ HumanSoft — การสร้างห้อง แก้ไขห้อง และเพิ่มสมาชิก ทำในเมนูนั้นเท่านั้น
สิทธิ์ที่ต้องการ: ทุก Endpoint ในโมดูลนี้ต้องใช้ API Key ที่มีสิทธิ์ การส่งข้อความ HumanSoft Notify (notify:send) หาก API Key ไม่มีสิทธิ์นี้จะได้รับ HTTP 403 ดูรายละเอียดที่ API Permissions
ขั้นตอนการใช้งาน (Workflow)
- ขอรายการห้อง — เรียก List Chatroom ด้วย
employee_codeของผู้ทำรายการ จะได้รายการห้อง HumanSoft Notify ของบริษัท พร้อมchat_tokenของแต่ละห้อง - ส่งข้อความ — เรียก Send Message ด้วย
chat_tokenของห้องที่ต้องการ และข้อความ 1–10 ข้อความ
chat_token เป็นข้อมูลลับของห้อง: ผู้ที่มี chat_token สามารถส่งข้อความเข้าห้องนั้นได้ ให้เก็บรักษาเหมือน API Key — เก็บและเรียก API จากฝั่ง server เท่านั้น ห้ามใส่ไว้ในโค้ดฝั่ง browser หรือแอป และห้ามบันทึกลง log
chat_token ส่งตามที่ได้รับจาก List Chatroom ไม่ต้องเข้ารหัส Base64
API Endpoints
| Operation | Endpoint | Method |
|---|---|---|
| ขอรายการห้อง HumanSoft Notify ของบริษัท | /api/v1/open-apis/hms-notify/list-chatroom | GET |
| ส่งข้อความเข้าห้อง | /api/v1/open-apis/hms-notify/send-message | POST |
ตัวอย่างการใช้งานครบขั้นตอน
ขอรายการห้อง แล้วส่งข้อความเข้าห้องแรก:
cURL
# 1) ขอรายการห้อง HumanSoft Notify ของบริษัท
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"
# 2) ส่งข้อความด้วย chat_token ที่ได้จากขั้นตอนที่ 1 (ไม่ต้อง Base64)
curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/hms-notify/send-message" \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"chat_token": "20251127C4E8A2F6B1D3957E0A6C",
"messages": ["พรุ่งนี้ปิดระบบลงเวลา 22:00 ถึง 23:00 น."]
}'ข้อควรทราบ
- ข้อความแสดงในนามบอท HumanSoft Notify ไม่ใช่ชื่อระบบของคุณ — หากต้องการให้ผู้รับรู้ที่มา ให้ระบุไว้ในเนื้อข้อความ
- ห้องที่ได้จาก List Chatroom เป็นห้องของบริษัทที่ผูกกับ API Key เท่านั้น
- ข้อความที่ส่งแล้วยกเลิกไม่ได้ และระบบไม่ส่งซ้ำให้อัตโนมัติเมื่อส่งไม่สำเร็จ — ดูว่าส่งซ้ำได้หรือไม่จากข้อความ error ใน Send Message
- ข้อความ error ของโมดูลนี้เป็นภาษาอังกฤษเสมอ
- หากต้องการส่งข้อความถึงพนักงานรายคนในห้องแชทของพนักงาน ดู HumanSoft Connect
Related APIs
- API Permissions - รายการสิทธิ์การเข้าถึง
- Employee - ค้นหารหัสพนักงาน (
employee_code)