WebSocket API

ภาพรวม¶

WebSocket API ให้บริการการสื่อสารกับเซิร์ฟเวอร์ Socket เพื่อให้บริการแชท รองรับการเชื่อมต่อของไคลเอนต์เกม การส่งข้อความในช่องต่างๆ

ฟีเจอร์หลักของ WebSocket API มีดังนี้

• การเชื่อมต่อ / ยกเลิกการเชื่อมต่อของลูกค้า
• PING / PONG
• การส่ง / รับข้อความแชท
  • แชทช่อง
  • แชท 1:1
• การกรองผู้ใช้ที่ถูกบล็อก
  • ไม่ส่งข้อความไปยังผู้ใช้ที่ถูกบล็อก
  • ไม่รับข้อความจากผู้ใช้ที่ถูกบล็อก
• การแจ้งเตือนเมื่อเข้าหรือออกจากช่อง

ข้อมูลพื้นฐาน¶

เมื่อใช้ WebSocket API จะมีข้อมูลพื้นฐานที่ต้องทราบโดยทั่วไป

คำศัพท์หลัก¶

• ช่อง: ห้องแชท
• ข้อความช่อง: ข้อความแชทที่ส่งไปยังผู้ใช้ทุกคนในช่องที่เข้าร่วม
• ข้อความ 1:1: ข้อความแชทที่ส่งไปยังผู้ใช้เฉพาะ

ประเภทแพ็กเก็ต¶

ประเภทแพ็กเก็ตที่ส่งและรับกับเซิร์ฟเวอร์ Socket มีดังนี้

กระบวนการเชื่อมต่อ Socket¶

1. ขอให้ส่งคำขอการออกโทเค็นผ่าน API Http ของการแชทจากเซิร์ฟเวอร์เกม ※ โทเค็นที่ออกจะถูกใช้ในการเชื่อมต่อกับเซิร์ฟเวอร์ Socket การแชท

   • ขอ API ออกโทเค็นผู้ใช้ โดยใช้ Hive Certification Key

2. การขอเชื่อมต่อจากเกมไคลเอนต์ไปยังเซิร์ฟเวอร์ Socket

   • การสื่อสารด้วย WebSocket
   • ใช้โทเค็นที่ออกในขั้นตอนที่ 1
   • หากเชื่อมต่อสำเร็จ เซิร์ฟเวอร์ Socket จะส่งข้อมูลด้านล่างกลับ

   {
       "packetType":"RESPONSE_CONNECT",
       "status": 200,
       "message": "OK",
       "body":{
           "sessionId":"005056fffea3fd10-000400fd-00000797-f67881178d98d1cd-64ae9a76"
       }
   }
   

โครงสร้างการสื่อสารด้วยซ็อกเก็ต¶

• JSON รูปแบบของประเภทแพ็คเกจที่เริ่มต้นด้วย 'RESPONSE_'

  {
          "packetType":"ประเภทแพ็คเกจ",
          "status":"รหัสสถานะ",
          "message":"ข้อความสถานะ",
          "body": JSON Object
  }
  

• รูปแบบแพ็กเกจอื่น ๆ

  {
          "packetType":"ประเภทแพ็กเกจ",
          "body":{
                  //ข้อมูล JSON ตาม packetType
          }
  }
  

กรณีที่เซิร์ฟเวอร์ตัดการเชื่อมต่อ WebSocket มีดังนี้

• หากไม่มีการร้องขอใด ๆ จากฝั่งไคลเอนต์เป็นเวลา 1 นาที
• เมื่อไม่ใช่รูปแบบ JSON
• เมื่อค่า status เป็น 401, 403
  • 401 unauthorized
  • 403 forbidden

รหัสการตอบกลับ¶

รหัสสถานะการตอบกลับ

ฟังก์ชัน WebSocket API¶

อธิบายคำขอและการตอบกลับ API ตามฟังก์ชันของ WebSocket API ที่ใช้ในบริการแชท พร้อมตัวอย่างโค้ด

การเชื่อมต่อของลูกค้า¶

พารามิเตอร์คำขอ¶

พารามิเตอร์คำขอ > เนื้อหา¶

เนื้อหาการตอบกลับ¶

เนื้อหาการตอบกลับ > body¶

ตัวอย่างคำขอ¶

{
    "packetType": "CONNECT",
    "body":{
        "gameIndex":1,
        "playerId": 1234,
        "loginKey": JWT generated by API server,
                "extraData": Additional information
}

ตัวอย่างการตอบกลับ¶

{
    "packetType":"RESPONSE_CONNECT",
    "status": 200,
    "message":"OK",
    "body":{
        "sessionId":"005056fffea3fd10-000400fd-00000797-f67881178d98d1cd-64ae9a76"
    }
}

การตัดการเชื่อมต่อของไคลเอนต์¶

พารามิเตอร์การร้องขอ¶

พารามิเตอร์การร้องขอ > เนื้อหา¶

• หากไม่ได้กำหนด sessionId จะมีการจัดการการตัดการเชื่อมต่อสำหรับ sessionId ที่กำหนดให้กับ websocket
• หากกำหนด sessionId จะมีการจัดการการตัดการเชื่อมต่อสำหรับค่าดังกล่าว

เนื้อหาการตอบกลับ¶

ตัวอย่างคำขอ¶

• หากไม่ได้ระบุ sessionId

  {
          "packetType":"DISCONNET"
  }
  

• หากระบุ sessionId

  {
          "packetType":"DISCONNECT",
          "body":{
                  "sessionId":"6c2408fffe8c91a8-00002f24-00000032-093b757cdc668383-54b4fbc1"
          }
  }
  

ตัวอย่างการตอบกลับ¶

{
    "packetType": "RESPONSE_DISCONNECT",
    "status": 200,
    "message":"OK"
}

PING / PONG¶

• การร้องขอจะมีผลเฉพาะเมื่อเชื่อมต่อกับเซิร์ฟเวอร์ Socket และเสร็จสิ้นการเชื่อมต่อแล้ว
• หากไม่มีการตอบกลับ PONG จำเป็นต้องเข้าสู่ระบบใหม่

พารามิเตอร์การร้องขอ¶

เนื้อหาการตอบกลับ¶

ตัวอย่างคำขอ¶

{
    "packetType":"PING"   
}

ตัวอย่างการตอบกลับ¶

{
    "packetType": "PONG"   
}

การส่งข้อความช่อง¶

พารามิเตอร์การร้องขอ¶

พารามิเตอร์การร้องขอ > เนื้อหา¶

เนื้อหาการตอบกลับ¶

ตัวอย่างคำขอ¶

{
    "packetType":"CHANNEL_CHAT",
    "body": {
        "gameIndex": 1,
        "from": 1234,
        "to": "open:1",
        "message": "Hello World!",
        "langCode": "en"
    }
}

ตัวอย่างการตอบกลับ¶

{
    "packetType": "RESPONSE_CHANNEL_CHAT",
    "status": 200,
    "message":"OK"
}

การส่งข้อความ 1:1¶

พารามิเตอร์คำขอ¶

พารามิเตอร์การร้องขอ > เนื้อหา¶

เนื้อหาการตอบกลับ¶

เนื้อหาการตอบกลับ > body¶

ตัวอย่างคำขอ¶

{
  "packetType": "DIRECT_CHAT",
  "body": {
    "gameIndex": 1,
    "from": 2222,
    "to": 1234,
    "message": "안녕하세요",
    "langCode": "ko"
  }
}

ตัวอย่างการตอบกลับ¶

{
    "packetType": "RESPONSE_DIRECT_CHAT",
    "status": 200,
    "message":"OK"
}

ข้อความเหตุการณ์เซิร์ฟเวอร์ซ็อกเก็ต¶

เมื่อเกิดเหตุการณ์ จะอธิบายข้อความที่ส่งจาก Server ไปยัง Client

ข้อความนี้เริ่มต้นด้วย packetType เป็น NOTIFY

ข้อความเข้าช่อง¶

เนื้อหา¶

ตัวอย่าง¶

{
  "packetType": "NOTIFY_ENTER_CHANNEL",
  "body": {
    "gameIndex": 1,
    "channelId": "open:10",
    "playerId": 1234,
    "extraData": "abcd",
    "timestamp": "2024-11-12T08:59:59.497Z"
  }
}

ข้อความออกจากช่อง¶

เนื้อหา¶

ตัวอย่าง¶

{
  "packetType": "NOTIFY_EXIT_CHANNEL",
  "body": {
    "gameIndex": 1,
    "channelId": "open:10",
    "playerId": 2222,
    "extraData": "abcd",
    "timestamp": "2024-11-12T09:29:35.872Z"
  }
}

ข้อความลบช่อง¶

เนื้อหา¶

ตัวอย่าง¶

{
  "packetType": "NOTIFY_DELETE_CHANNEL",
  "body": {
    "gameIndex": 1,
    "channelId": "owner:1",
    "timestamp": "2024-11-13T05:06:29.198Z"
  }
}

ข้อความประกาศช่อง¶

เนื้อหา¶

ตัวอย่าง¶

// Announcement to specific channel
{
  "packetType": "NOTIFY_CHANNEL_NOTICE",
  "body": {
    "gameIndex": 1,
    "channelId": "open:10",
    "from": "SYSTEM",
    "message": "Notice message.",
    "timestamp": "2024-11-13T05:06:29.198Z"
  }
}

ข้อความช่อง¶

เนื้อหา¶

ตัวอย่าง¶

{
  "packetType": "NOTIFY_CHANNEL_CHAT",
  "body": {
    "gameIndex": 1,
    "from": 2222,
    "fromExtra": "bbbb",
    "to": "open:10",
    "message": "Hello World!",
    "langCode": "ko",
    "timestamp": "2024-11-13T05:12:18.385Z"
  }
}

1:1 ข้อความ¶

เนื้อหา¶

ตัวอย่าง¶

{
  "packetType": "NOTIFY_DIRECT_CHAT",
  "body": {
    "gameIndex": 1,
    "from": 1234,
    "fromExtra": "abcd",
    "to": 2222,
    "message": "안녕하세요. 1:1 채팅입니다.",
    "langCode": "ko",
    "timestamp": "2024-11-13T05:12:50.060Z"
  }
}