HTTP API

ภาพรวม¶

เรามีบริการแชทผ่าน HTTP ซึ่งประกอบด้วย Channel API, User API, และ Message API เป็นหลัก

• API ช่อง
  • API ดึงรายชื่อช่องทั้งหมด
  • API ดึงข้อมูลช่อง
  • API ดึงข้อมูลผู้เข้าร่วมช่อง
  • API สร้างช่อง
  • API ลบช่อง
  • API เข้าร่วมช่อง
  • API ออกจากช่อง
• API ผู้ใช้
  • API ออกโทเค็นผู้ใช้
  • API ดึงข้อมูลช่องที่ผู้ใช้เข้าร่วม
  • API ดึงข้อมูลรายการบล็อกผู้ใช้
  • API บล็อกผู้ใช้
  • API ยกเลิกบล็อกผู้ใช้
• API ข้อความ
  • API ส่งข้อความประกาศช่อง
  • API ส่งข้อความประกาศผู้ใช้
  • API ส่งข้อความกำหนดเองช่อง
  • API ส่งข้อความกำหนดเองผู้ใช้
  • API ดึงข้อความช่อง

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

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

การเตรียมพจนานุกรม¶

ในการใช้ HTTP API คุณต้องเตรียมรายการต่อไปนี้

• Hive คีย์รับรอง: โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API
  • สามารถตรวจสอบได้ใน Hive Console > App Center > Project Management > Game Details > Basic Information
• ดัชนีเกม: ดัชนีของเกมที่สร้างขึ้นใน Hive Console > App Center > Project Management

ประเภทช่องทาง¶

ประเภทช่องทางที่ใช้เมื่อส่ง API HTTP มีดังนี้

URL การร้องขอ¶

หัวข้อทั่วไป¶

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

• รหัสการตอบสนอง API

• รหัสข้อผิดพลาดที่ละเอียด (400, 403)

คุณสมบัติของ Channel API¶

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

ดึงรายการช่องทั้งหมด¶

กำลังดึงรายการช่องที่สร้างขึ้นในปัจจุบัน

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์ส่วนหัว¶

พารามิเตอร์การค้นหา¶

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

เนื้อหาการตอบกลับ > ข้อมูล¶

เนื้อหาของร่างตอบกลับ > ข้อมูล > เนื้อหา¶

เนื้อหาการตอบกลับ > ข้อมูล > หน้า¶

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

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels?type=PUBLIC&sort=regTime&order=DESC&size=10&page=1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "content": [
      {
        "channelId": "open:12345",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "오픈 채팅방",
        "memberCount": 2,
        "maxMemberCount": 50,
        "chatHistoryAllowed": true,
        "regTime": "2024-12-30T15:01:01.004Z",
        "regTimeMillis": 1731306364351
      },
      /// ... channel info
    ],
    "page": {
      "size": 10,
      "currentPage": 1,
      "totalElements": 100,
      "totalPages": 10
    }
  }
}

การค้นหาช่อง¶

กำลังดึงรายละเอียดช่องทาง

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

ร่างการตอบกลับ > ข้อมูล¶

เนื้อหาการตอบกลับ > ข้อมูล > ข้อมูล¶

เนื้อหาการตอบกลับ > ข้อมูล > สมาชิก¶

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

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "info": {
      "channelId": "open:12345",
      "type": "PUBLIC",
      "gameIndex": 1,
      "owner": "SYSTEM",
      "channelName": "오픈채팅방",
      "memberCount": 2,
      "maxMemberCount": 50,
      "chatHistoryAllowed": true,
      "regTime": "2024-12-30T15:01:01.004Z",
      "regTimeMillis": 1731306364351
    },
    "members": [
      {
        "playerId": 1,
        "connectedTime": "2024-11-25T06:22:06.604Z",
        "connectedTimeMillis": 1739328218507
      },
      {
        "playerId": 2,
        "connectedTime": "2024-11-25T06:22:16.233Z",
        "connectedTimeMillis": 1731306364351
      }
    ]
  }
}

การสอบถามสมาชิกช่อง¶

กำลังดึงข้อมูลผู้เข้าร่วมช่องทาง

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

เนื้อหาการตอบกลับ > ข้อมูล¶

ร่างการตอบกลับ > ข้อมูล > สมาชิก¶

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

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345/members' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "members": [
      {
        "playerId": 1,
        "connectedTime": "2024-11-25T06:22:06.604Z",
        "connectedTimeMillis": 1739328218507
      },
      {
        "playerId": 2,
        "connectedTime": "2024-11-25T06:22:16.233Z",
        "connectedTimeMillis": 1731306364351
      }
    ]
  }
}

สร้างช่อง¶

กำลังสร้างช่องใหม่

เมื่อคุณป้อน playerId ในเนื้อหาคำขอ ผู้ใช้ที่ตรงกับ playerId จะกลายเป็นเจ้าของช่องที่กำลังสร้างอยู่ ผู้ใช้คนนี้จะเข้าช่องที่พวกเขาสร้างขึ้น ในทางกลับกัน หากไม่ป้อน playerId ในเนื้อหาคำขอ SYSTEM ที่ถูกสร้างขึ้นจะกลายเป็นเจ้าของช่อง

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวข้อ¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอสร้างช่องทาง

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/channel' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data'{
    "channelId": "open:12345",
    "playerId": 1000,
    "channelName": "오픈 채팅방",
    "maxMemberCount": 100,
    "type": "PUBLIC",
    "chatHistoryAllowed": true
}'

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

{
    "code": 0,
    "message": "Success."
}

ลบช่อง¶

กำลังลบช่องทาง.

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวข้อ¶

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

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

curl --request DELETE 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

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

{
    "code": 0,
    "message": "Success."
}

เข้าสู่ช่อง¶

กำลังเพิ่มผู้ใช้เข้าสู่ช่องทาง.

จำนวนช่องสูงสุดที่สามารถกรอกได้คือ 10 ช่องต่อผู้ใช้

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวข้อ¶

เนื้อหาคำขอ¶

นี่คือข้อมูลที่จำเป็นเมื่อขอเข้าช่องทาง

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

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

curl --request POST 'https://api-chat.withhive.com/api/v1/games/1/channels/guild:12345/enter' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data '{
    "playerId": 1001,
    "password": "guildPass123"
}'

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

{
    "code": 0,
    "message": "Success."
}

ช่องทางออก¶

กำลังลบผู้ใช้ที่เข้าร่วมช่อง ช่องจะยังคงอยู่แม้เจ้าของช่องจะออกไป ช่องที่ไม่มีผู้เข้าร่วมซึ่งเจ้าของช่องไม่ใช่ SYSTEM จะถูกลบเป็นระยะ ๆ

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวข้อ¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอออกจากช่องทาง

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

ตัวอย่างการร้องขอ¶

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/channels/guild:12345/exit' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data '{
    "playerId": 1001
}'

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

{
    "code": 0,
    "message": "Success."
}

ฟีเจอร์ API ของผู้ใช้¶

นี่อธิบายเกี่ยวกับคำขอและการตอบสนอง API สำหรับ API ผู้ใช้ที่ใช้ในบริการแชท พร้อมกับตัวอย่างโค้ด

การออกโทเค็นผู้ใช้¶

การออกโทเค็นการตรวจสอบสิทธิ์สำหรับการเชื่อมต่อกับเซิร์ฟเวอร์ซ็อกเก็ต

เชื่อมต่อกับที่อยู่เซิร์ฟเวอร์ Socket ที่ส่งคืนผ่านโทเค็นที่ออกให้

URL ขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

เนื้อหาการตอบกลับ > ข้อมูล¶

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

curl  --request POST 'https://api-chat.withhive.com/api/v1/games/1/users/1001/token' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' 

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "gameIndex": 1,
    "socketAddress": "wss://test-socket-chat.withhive.com/ws",
    "token": "eyJhbGciOiJIUzI1NiJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg"
  }
}

การสอบถามช่องทางการมีส่วนร่วมของผู้ใช้¶

ดึงรายการช่องที่ผู้ใช้เข้าร่วมอยู่

URL คำขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

เนื้อหาการตอบกลับ > ข้อมูล¶

เนื้อหาการตอบกลับ > ข้อมูล > ช่องทาง¶

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

curl --request GET 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/channels' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' 

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "gameIndex": 1,
    "playerId": 1001,
    "channels": [
      {
        "channelId": "guild:12345",
        "type": "GROUP",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "길드 채팅방",
        "memberCount": 1,
        "maxMemberCount": 50,
        "chatHistoryAllowed": true,
        "regTime": "2023-12-19T15:01:01.004Z",
        "regTimeMillis": 1731306364351
      },
      {
        "channelId": "open:67890",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "SYSTEM",
        "channelName": "오픈 채팅방",
        "memberCount": 2,
        "maxMemberCount": 100,
        "chatHistoryAllowed": true,
        "regTime": "2023-12-20T10:15:30.123Z",
        "regTimeMillis": 1731302348750
      }
      // ... 채널
    ]
  }
}

การดึงรายการบล็อกผู้ใช้¶

กำลังดึงรายการผู้ใช้ที่ถูกบล็อกโดยผู้ใช้

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

เนื้อหาการตอบกลับ > ข้อมูล¶

เนื้อหาการตอบกลับ > ข้อมูล > ผู้ใช้ที่ถูกบล็อก¶

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

curl  --request GET 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/blocks' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' 

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "gameIndex": 1,
    "playerId": 1001,
    "blockedUsers": [
      {
        "blockedPlayerId": 1002,
        "blockedTime": "2023-12-20T10:15:30.123Z",
        "blockedTimeMillis": 1739329550811
      },
      {
        "blockedPlayerId": 1003,
        "blockedTime": "2023-12-21T08:45:12.456Z",
        "blockedTimeMillis": 1739329553137
      },
      // ... 차단 목록
    ]
  }
}

User block¶

การบล็อกผู้ใช้อื่น นี่คือฟีเจอร์ที่จำกัดการส่งและรับข้อความแบบเรียลไทม์

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/block/1002' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' 

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

{
  "code": 0,
  "message": "Success."
}

ปลดบล็อกผู้ใช้¶

การปลดบล็อกผู้ใช้ที่ถูกบล็อก

URL คำขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์ส่วนหัว¶

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

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

curl --request DELETE 'https://sandbox-api-chat.withhive.com/api/v1/games/1/users/1001/block/1002' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg'

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

{
  "code": 0,
  "message": "Success."
}

คุณสมบัติของ Message API¶

นี่คือ API สำหรับการส่งข้อความแจ้งเตือนหรือข้อความที่กำหนดเอง หรือสำหรับการดึงประวัติข้อความจากช่องทางเฉพาะ

ข้อความแจ้งเตือนช่องที่ส่ง¶

ส่งข้อความประกาศไปยังช่องเฉพาะหรือทุกช่อง

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์ส่วนหัว¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอส่งข้อความแจ้งเตือน

Channelid¶

หากไม่มี channelId พารามิเตอร์ Path gameIndex จะส่งข้อความไปยังช่องทั้งหมดที่มีอยู่ในแอป

รหัสภาษา¶

หาก langCode ไม่มีอยู่ ข้อความจะถูกส่งไปยังผู้ใช้ทั้งหมดโดยไม่คำนึงถึงภาษา

หากมี langCode ผู้ใช้ที่ได้รับข้อความจะเปลี่ยนแปลงไปตามค่าของฟิลด์นั้น ตัวอย่างเช่น หาก langCode เป็น en ข้อความการแจ้งเตือนจะถูกส่งไปยัง ผู้ใช้ที่ Request body langCode เป็น en เมื่อเชื่อมต่อกับไคลเอนต์

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/notice' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' \
--header 'Content-Type: application/json' \
--data '{
    "channelId": "open:12345",
    "langCode": "en",
    "message": "서버 점검이 있습니다. 잠시 후 다시 접속해 주세요."
}'

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

{
    "code": 0,
    "message": "Success."
}

ข้อความแจ้งเตือนผู้ใช้กำลังส่ง¶

กำลังส่งข้อความแจ้งเตือนไปยังผู้ใช้

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอส่งข้อความแจ้งเตือน

รหัสภาษา¶

หากไม่มี langCode มันจะส่งข้อความไปยังผู้ใช้ playerId โดยไม่คำนึงถึงภาษา

หากมี langCode ข้อความการแจ้งเตือนผู้ใช้จะถูกส่งเฉพาะเมื่อ langCode ในร่างคำขอ API ตรงกับ langCode ในร่างคำขอเมื่อไคลเอนต์เชื่อมต่อ ตัวอย่างเช่น หากผู้ใช้ที่มี playerId=1111 เชื่อมต่อกับไคลเอนต์แชทด้วย langCode=en และ API การส่งข้อความการแจ้งเตือนผู้ใช้ถูกเรียกด้วย playerId=1111, langCode=ja ข้อความการแจ้งเตือนจะไม่ถูกส่งไปยังผู้ใช้นี้

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/notice/users/123123' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' \
--header 'Content-Type: application/json' \
--data '{
    "langCode": "en",
    "message": "123123 님에게 보내는 공지 메시지입니다."
}'

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

{
    "code": 0,
    "message": "Success."
}

ส่งข้อความที่กำหนดเองไปยังช่อง¶

ส่งข้อความที่กำหนดเองไปยังผู้ใช้ทั้งหมดที่เข้าร่วมช่อง

URL การร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอส่งข้อความที่กำหนดเอง

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/custom-message/channels/public:123' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' \
--header 'Content-Type: application/json' \
--data '{
    "message": "커스텀 메시지입니다."
}'

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

{
    "code": 0,
    "message": "Success."
}

ส่งข้อความที่กำหนดเองให้ผู้ใช้¶

ส่งข้อความที่กำหนดเองไปยังผู้ใช้

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

เนื้อหาคำขอ¶

นี่คือข้อมูลการส่งที่จำเป็นเมื่อขอส่งข้อความที่กำหนดเอง

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

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/custom-message/users' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYW1lSW5kZXgiOjEsInBsYXllcklkIjoxLCJpYXQiOjE3MzI1MTcyMzUsImV4cCI6MTczMjUyMDgzNX0.lm5eFqEuSPjsKZUItpTQvFy_2oWrMMJ_J0MPH9VFtNg' \
--header 'Content-Type: application/json' \
--data '{
    "playerIds": [
        123123
    ],
    "message": "커스텀 메시지입니다."
}'

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

{
    "code": 0,
    "message": "Success."
}

การดึงประวัติข้อความช่อง¶

กำลังดึงประวัติข้อความช่อง ประวัติข้อความช่องจะถูกจัดเตรียมด้วยการแบ่งหน้าตามเคอร์เซอร์ และสามารถดึงประวัติข้อความช่องจาก 30 วันที่ผ่านมาเท่านั้น API นี้สามารถใช้ได้ก็ต่อเมื่อ ตัวเลือกในการดูประวัติการสนทนาก่อนหน้านี้เปิดใช้งานในการตั้งค่าช่อง ประวัติข้อความช่องที่ได้รับในคำตอบ API อาจรวมถึงข้อความที่ผ่านมาจาก ผู้ใช้ที่ถูกบล็อก

การแบ่งหน้า: ขนาดและดัชนี¶

ให้การแบ่งหน้าโดยใช้พารามิเตอร์การค้นหา index ไม่มีค่าดีฟอลต์สำหรับ index และหากมีการส่งคำขอโดยไม่มี index จะส่งคืนข้อความแชทตั้งแต่ข้อความล่าสุดไปจนถึง size ที่ระบุ

ตัวอย่างเช่น หากคุณเรียก API ด้วย size=5 โดยไม่มี index มันจะส่งคืนประวัติการแชท 5 รายการล่าสุดและ nextIndex (เช่น ค่าที่เหมือนกับ 68009c30780e4f2d9830d8a0) ที่ช่วยให้คุณสามารถรับประวัติถัดไปได้

หลังจากเรียก API อีกครั้งด้วย index=68009c30780e4f2d9830d8a0 และ size=5 มันจะส่งคืนบันทึกการสนทนา 5 รายการที่เกิดขึ้นหลังจากประวัติการสนทนาครั้งสุดท้ายที่ส่งคืนก่อนหน้านี้

การแบ่งหน้า: มีถัดไป¶

หากค่าการตอบกลับ hasNext เป็น true หมายความว่ามีประวัติการสนทนาที่ผ่านมาอีกมากมาย กล่าวอีกนัยหนึ่ง คุณสามารถใช้ค่าการตอบกลับ nextIndex เป็น index เพื่อดึงประวัติข้อความช่องทางก่อนหน้าเพิ่มเติม

URL ที่ร้องขอ¶

พารามิเตอร์เส้นทาง¶

พารามิเตอร์หัวเรื่อง¶

พารามิเตอร์การค้นหา¶

นี่คือข้อมูลสตริงคำค้นที่จำเป็นเมื่อขอการดึงข้อความช่อง

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

เนื้อหาการตอบกลับ > ข้อมูล¶

เนื้อหาของร่างตอบกลับ > ข้อมูล > เนื้อหา¶

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

curl --request GET 'https://test-api-chat.withhive.com/api/v1/games/1/channels/open:1/messages?size=50' \
--header 'Authorization: hivechat 005056fffea3fd10-000400fd-00000797-f67881178d98d1cd-64ae9a76'

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "hasNext": true,
    "nextIndex": "67c7d83336af25202c1c0ad4",
    "content": [
    // as size=50, returns 50 objects each of which is like the followings.
      {
        "gameIndex": 1,
        "from": 1111112,
        "extraData": "김하이브",
        "to": "open:10",
        "message": "zzz",
        "langCode": "ko",
        "timestamp": "2025-03-05T04:50:59.757Z",
        "timestampMillis": 1741150259757
      },
      {
        "gameIndex": 1,
        "from": 1111111,
        "extraData": null,
        "to": "open:10",
        "message": "하이브2",
        "langCode": "ko",
        "timestamp": "2025-03-05T04:51:01.689Z",
        "timestampMillis": 1741150261689
      },
    ]
  }
}