ข้อความ¶

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

ภาพรวม¶

ส่วนนี้อธิบายประเภทข้อความและวิธีการส่งที่ API รองรับ รวมถึงการแปลข้อความและฟีเจอร์เพิ่มเติม

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

ข้อความที่ส่งไปยังผู้เข้าร่วมช่อง ซึ่งทำงานในลักษณะการกระจายเสียง
ประวัติข้อความจะถูกจัดเตรียมตาม channelId

ข้อความไดเร็กต์¶

ข้อความที่ส่งตรงไปยังผู้ใช้คนอื่น ทำงานในลักษณะทางเดียว

ข้อความแจ้งเตือน¶

ข้อความแจ้งเตือนแบ่งออกเป็นข้อความแจ้งเตือนช่องและข้อความแจ้งเตือนผู้ใช้.

ข้อความแจ้งเตือนช่อง: ส่งเฉพาะไปยังผู้ใช้ที่เชื่อมต่อกับ channelId ที่ระบุ
ข้อความแจ้งเตือนผู้ใช้: ส่งเฉพาะไปยังผู้ใช้ที่มี playerId ที่ระบุ

ข้อความที่กำหนดเอง¶

ข้อความที่กำหนดเองใช้เพื่อส่งข้อมูลจำนวนมาก แตกต่างจากข้อความแชทปกติ และไม่ใช่สำหรับการสนทนาระหว่างผู้ใช้

การแปลข้อความ¶

ส่วนนี้อธิบายฟีเจอร์การแปลอัตโนมัติและการแปลด้วยมือ รวมถึงรหัสภาษาที่มีให้สำหรับการแปล

การแปลอัตโนมัติ¶

ไคลเอนต์เกมสามารถตั้งค่าได้ว่าจะเปิดใช้งานการแปลอัตโนมัติในแต่ละช่องทางหรือไม่ การตั้งค่าจะถูกรีเซ็ตเมื่อออกจากช่องทางหรือ断开การเชื่อมต่อจากเซิร์ฟเวอร์ซ็อกเก็ต
ข้อความจะถูกแปลโดยใช้ รหัสภาษา ที่ตั้งค่าเมื่อเชื่อมต่อกับเซิร์ฟเวอร์ซ็อกเก็ต หากต้องการเปลี่ยนภาษาการแปล ให้เชื่อมต่อใหม่ด้วย รหัสภาษา ใหม่

การแปลด้วยตนเอง¶

เรียกใช้ API การแปลข้อความ AI เพื่อทำการแปลข้อความต้นฉบับด้วย AI.

รหัสภาษา¶

ภาษา	ชื่อท้องถิ่น	รหัสภาษาของ Hive
เกาหลี	한국어	ko
อังกฤษ	English	en
ญี่ปุ่น	日本語	ja
จีน (แบบย่อ)	简体中文	zh-hans
จีน (แบบดั้งเดิม)	繁體中文	zh-hant
ฝรั่งเศส	Français	fr
เยอรมัน	Deutsch	de
รัสเซีย	русский	ru
สเปน	Español	es
โปรตุเกส	Português	pt
อินโดนีเซีย	Bahasa Indonesia	id
เวียดนาม	tiếng Việt	vi
ไทย	ไทย	th
อิตาลี	Italiano	it
ตุรกี	Türkçe	tr
อาหรับ	العربية	ar

ฟีเจอร์ข้อความเพิ่มเติม¶

ฟีเจอร์ที่สามารถเพิ่มลงในข้อความที่ส่งได้รวมถึงการถูกใจ, การกล่าวถึง, และการตอบกลับ.

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

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

ดึงประวัติข้อความก่อนและหลัง messageId ที่ระบุในช่อง นี่สามารถขอได้เฉพาะเมื่อ chatHistoryAllowed เป็น true ในการตั้งค่าช่อง

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

URL การร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v2/games/{gameIndex}/channels/{channelId}/messages`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v2/games/{gameIndex}/channels/{channelId}/messages`
HTTP METHOD	`GET`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	ดัชนีเกม Hive	จำนวนเต็ม	ใช่
channelId	รหัสช่องทางในการดึงข้อมูล	จำนวนเต็ม	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	สตริง	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
prevSize	ขนาดของการดึงข้อความช่องก่อนหน้า (ขั้นต่ำ `0` ~ สูงสุด `50`) (ค่าเริ่มต้น: `0`)	จำนวนเต็ม	N
nextSize	ขนาดของการดึงข้อความช่องถัดไป `messageId` จะถูกละเว้นหากไม่ระบุค่านี้ (ขั้นต่ำ `0` ~ สูงสุด `50`) (ค่าเริ่มต้น: `0`)	จำนวนเต็ม	N
messageId	messageId ที่ใช้สำหรับการดึงข้อมูล (`null` จะดึงข้อความช่องล่าสุด)	สตริง	N
order	วิธีการจัดเรียงตามวันที่ (`ASC`, `DESC`) (ค่าเริ่มต้น: `DESC`)	สตริง	N

prevSize และ nextSize¶

prevSize และ nextSize กำหนดขอบเขตของข้อความที่จะถูกดึงมาในคำขอเดียว

prevSize จะดึงประวัติข้อความก่อนหน้า และ nextSize จะดึงประวัติข้อความถัดไปตามที่ระบุ messageId ตัวอย่างเช่น หากระบุ prevSize=10 และ nextSize=5 พร้อมกับ messageId จะดึงข้อความ 10 ข้อความก่อนหน้า messageId และ 5 ข้อความถัดไป

หากมีการเรียก API การดึงประวัติข้อความช่องโดยไม่ระบุ messageId จะมีการดึงข้อความล่าสุดเท่านั้นตามจำนวนที่ตั้งค่าโดย prevSize และค่าของ nextSize จะไม่ถูกนำมาใช้

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์การตอบกลับ	จำนวนเต็ม
message	คำอธิบายของผลลัพธ์	สตริง
data	ข้อมูลการตอบกลับ	ออบเจ็กต์

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
hasNext	ว่ามีข้อความเพิ่มเติมที่สามารถดึงได้หรือไม่	boolean
nextMessageId	messageId ที่ใช้สำหรับดึงข้อความถัดไป	string
hasPrev	ว่าดึงข้อความก่อนหน้านี้ได้หรือไม่	boolean
prevMessageId	messageId ที่ใช้สำหรับดึงข้อความก่อนหน้า	string
content	ประวัติข้อความช่อง	object array

hasNext : หาก hasNext เป็น true จะมีประวัติข้อความถัดไปเพิ่มเติม ในกรณีนี้คุณสามารถดึงประวัติข้อความช่องเพิ่มเติมตาม messageId ที่ระบุโดย nextMessageId。
hasPrev : หาก hasPrev เป็น true จะมีประวัติข้อความก่อนหน้านี้เพิ่มเติม ในกรณีนี้คุณสามารถดึงประวัติข้อความช่องเพิ่มเติมที่อยู่ก่อน messageId ที่ระบุโดย prevMessageId。

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
gameIndex	Hive ดัชนีเกม	integer
from	รหัสประจำตัวของบัญชีที่ได้รับข้อความ รหัสผู้เล่น	long
messageId	รหัสข้อความ	string
extraData	ข้อมูลผู้ใช้งานเพิ่มเติม (`UTF-8` based) (สูงสุด `256 Byte`)	string
pluginData	ฟีเจอร์ข้อความเพิ่มเติม	object
to	รหัสช่องทางที่ข้อความถูกส่งไป	string
message	เนื้อหาข้อความ	string
langCode	Hive รหัสภาษา	string
timestamp	วันที่และเวลาที่ข้อความถูกส่ง (`UTC+0` based, รูปแบบ `yyyy-MM-dd'T'HH:mm:ss.SSSZ`)	string
timestampMillis	วันที่และเวลาที่ข้อความถูกส่ง (UnixTimestamp มิลลิวินาที)	long

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

ข้อมูลต่อไปนี้จะถูกเพิ่มเฉพาะเมื่อมีการใช้ฟีเจอร์เพิ่มเติมของข้อความ

ชื่อฟิลด์	คำอธิบาย	ประเภท
like	ข้อมูล 'ถูกใจ'	อ็อบเจ็กต์
mentions	ข้อมูลการกล่าวถึง	อาร์เรย์อ็อบเจ็กต์
reply	ข้อมูลการตอบกลับ	อ็อบเจ็กต์

Response body > data > content > pluginData > like¶

ชื่อฟิลด์	คำอธิบาย	ประเภท
playerIds	รหัสผู้เล่นของผู้ใช้ที่เพิ่ม 'ถูกใจ' (หลายรายการ)	อาร์เรย์ยาว

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
playerId	รหัสผู้เล่นของผู้ใช้ที่กล่าวถึง	long

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
originalMessageId	รหัสของข้อความต้นฉบับ	string
originalMessage	เนื้อหาของข้อความต้นฉบับ	string
originalExtraData	ข้อมูลเพิ่มเติมของข้อความต้นฉบับ	string
originalTimestampMillis	วันที่และเวลาที่ส่งข้อความต้นฉบับ (UnixTimestamp Millisecond)	long

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

curl --request GET 'https://test-api-chat.withhive.com/api/v2/games/1/channels/open:1/messages?messageId=abcdefg&nextSize=10&prevSize=10&order=DESC' \
--header 'Authorization: hivechat 005056fffea3fd10-000400fd-00000797-f67881178d98d1cd-64ae9a76'

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

{
  "code": 0,
  "message": "Success.",
  "data": {
    "hasNext": true,
    "nextMessageId": "XY0QSDRezljxWI02",
    "hasPrev": true,
    "prevMessageId": "j2FwC8Zdq5vwX8kJ",
    "content": [
      {
        "gameIndex": 1,
        "from": 1111112,
        "messageId" : "0n4K8pkqjpWjkrUH",
        "extraData": "김하이브",
        "to": "open:10",
        "message": "안녕하세요.",
        "langCode": "ko",
        "timestamp": "2025-03-05T04:50:59.757Z",
        "timestampMillis": 1741150259757
      },
      {
        "gameIndex": 1,
        "from": 1111111,
        "messageId" : "J3N1YYimo5o7Mpb5",
        "extraData": "",
        "to": "open:10",
        "message": "하이브",
        "langCode": "ko",
        // 메시지 추가 기능을 사용하였을 경우
        "pluginData" : {
          // 좋아요
          "like": {
            "playerIds": [
              1
            ]
          },
          // 멘션
          "mentions": [
            {
              "playerId": 101
              }
          ],
          // 답글
          "reply": {
            "originalMessageId": "yIKzxKCihLVu9VR8",
            "originalMessage": "111",
            "originalExtraData": null,
            "originalTimestampMillis": 1752487464039
            }
        },
        "timestamp": "2025-03-05T04:51:01.689Z",
        "timestampMillis": 1741150261689
      },
      // 이하 동일한 형식의 객체
    ]
  }
}

API การส่งข้อความแจ้งเตือน¶

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

URL การร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/notice`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/notice`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	Hive ดัชนีเกม	จำนวนเต็ม	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	string	Y
Content-Type	ประเภทข้อมูลคำขอ (`application/json`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
channelId	รหัสช่องที่ข้อความจะถูกส่งไปยัง	สตริง	N
langCode	Hive รหัสภาษา ที่ข้อความจะถูกส่งไปยัง (หากไม่ได้ระบุ จะส่งไปยังทุกภาษา)	สตริง	N
message	เนื้อหาของข้อความแจ้งเตือนที่จะส่ง (สูงสุด `200` ตัวอักษร)	สตริง	Y

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

หากมีการระบุ channelId ข้อความจะถูกส่งไปยังผู้ใช้ทั้งหมดที่เชื่อมต่อกับช่องที่ระบุในฐานะ ข้อความแจ้งเตือนช่อง。
หากไม่มีการระบุ channelId ข้อความจะถูกส่งไปยังผู้ใช้ทั้งหมดที่เชื่อมต่อกับเซิร์ฟเวอร์ซ็อกเก็ตในฐานะ ข้อความแจ้งเตือนผู้ใช้。

ร่างคำขอ > langCode¶

หากมีการระบุ langCode ข้อความจะถูกส่งไปยังผู้ใช้ที่มีรหัสภาษาตรงกันเท่านั้น ตัวอย่างเช่น หาก langCode เป็น en ข้อความจะถูกส่งไปยังผู้ใช้ที่ตั้งค่า langCode เป็น en เท่านั้น
หากไม่มีการระบุ langCode ข้อความจะถูกส่งไปยังผู้ใช้ทุกคนไม่ว่าจะเป็นภาษาใดก็ตาม

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์	integer
message	คำอธิบายของผลลัพธ์	string

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

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."
}

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

ส่งข้อความแจ้งเตือนผู้ใช้ไปยังผู้ใช้ที่มี ID ผู้เล่นที่ระบุ

URL ที่ร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/notice/users/{playerId}`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/notice/users/{playerId}`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	Hive ดัชนีเกม	integer	Y
playerId	Hive รหัสผู้เล่น	long	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	string	Y
Content-Type	ประเภทข้อมูลที่ร้องขอ (`application/json`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
langCode	Hive รหัสภาษาที่ ข้อความจะถูกส่งไปยัง (หากไม่ได้ระบุ จะส่งไปยังทุกภาษา)	สตริง	N
message	เนื้อหาของข้อความแจ้งเตือนที่จะส่ง (สูงสุด `200` ตัวอักษร)	สตริง	Y

เนื้อหาของคำขอ > langCode¶

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

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์	integer
message	คำอธิบายของผลลัพธ์	string

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

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."
}

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

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

URL การร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/custom-message/channels/{channelId}`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/custom-message/channels/{channelId}`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	ดัชนีเกม Hive	จำนวนเต็ม	ใช่
channelId	รหัสช่องทางในการรับข้อความ	สตริง	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	string	ใช่
Content-Type	ประเภทข้อมูลที่ส่ง (`application/json`)	string	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
message	เนื้อหาของข้อความที่กำหนดเองที่จะส่ง (`UTF-8` based) (สูงสุด `8,000 Byte`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์	จำนวนเต็ม
message	คำอธิบายของผลลัพธ์	สตริง

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

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."
}

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

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

URL ที่ร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/custom-message/users`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/custom-message/users`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	Hive ดัชนีเกม	จำนวนเต็ม	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	string	Y
Content-Type	ประเภทข้อมูลที่ร้องขอ (`application/json`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
playerIds	รายชื่อรหัสผู้เล่นที่จะได้รับข้อความ (สูงสุด `10` ผู้เล่น)	อาร์เรย์ยาว	ใช่
message	เนื้อหาของข้อความที่กำหนดเองที่จะส่ง (`UTF-8` based) (สูงสุด `8,000 ไบต์`)	สตริง	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์	จำนวนเต็ม
message	คำอธิบายของผลลัพธ์	สตริง

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

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."
}

API แปลข้อความ AI¶

แปลข้อความในข้อความไปยังภาษาที่กำหนด

URL การร้องขอ¶

เซิร์ฟเวอร์	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/translate`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/translate`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
gameIndex	Hive ดัชนีเกม	จำนวนเต็ม	ใช่

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
Authorization	โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (`Bearer`)	string	Y
Content-Type	ประเภทข้อมูลที่ร้องขอ (`application/json`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท	จำเป็น
text	ข้อความต้นฉบับ	string	Y
from	Hive รหัสภาษา ของข้อความต้นฉบับ ใช้ `auto` เพื่อตรวจจับภาษาทางอัตโนมัติ	string	Y
to	Hive รหัสภาษา ที่ข้อความจะถูกแปลไป สามารถระบุรหัสหลายรหัสได้ (เช่น `ko, en, ja`)	string	Y

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
code	รหัสผลลัพธ์	จำนวนเต็ม
message	คำอธิบายของผลลัพธ์	สตริง
data	ข้อมูลผลลัพธ์	อ็อบเจ็กต์

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
translations	วัตถุผลลัพธ์การแปล	วัตถุ

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

ชื่อฟิลด์	คำอธิบาย	ประเภท
{lang}	ข้อความที่แปลแล้ว	string

※ เมื่อขอ API แปลภาษา รหัสภาษา Hive(เช่น en, ja, ar) ที่ระบุจะถูกใช้เป็นชื่อฟิลด์ {lang}

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

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/translate' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data'{
    "text": "안녕하세요. 반갑습니다.",
    "from": "ko",
    "to": "en, ja, ar"
}'

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

{
    "code": 0,
    "message": "Success.",
    "data": {     
        "translations": {
            "ar": "مرحبا. تشرفنا.",
            "ja": "こんにちは。はじめまして。",
            "en": "Hello. Nice to meet you."
        }
    }
}