Skip to content

API documentation update: chat API guide update

I changed the API classification and modified several field information.

http API update

  • Added message API classification
    • Changed API classification
      • Existing: Channel API > Announcement Message Sending API
      • Changed: Message API > Channel Announcement Message Sending API
    • Added user announcement message API
    • Added channel custom message API
    • Added user custom message API
    • Added channel message history retrieval API
  • Added detailed error codes
    • New code added for HTTP status code 400
      • 400 Custom message size exceeded. The maximum size is 8,000 bytes.: Custom message size exceeded (maximum 8,000 bytes)
  • Removed extraData from response values
    • Channel retrieval API (response > data > members)
    • Channel participants retrieval API (response > data > members)
  • Added chatHistoryAllowed message history retrieval availability
    • Response value for retrieving the entire channel list
    • Response value for channel retrieval
    • Request value for channel creation
    • Response value for retrieving user participation channels
  • Fixed typos and changed descriptions
    • Retrieving the entire channel list
      • Changed description of query parameter size field
        • Existing: Minimum 10 ~ Maximum 100
        • Changed: Minimum 1 ~ Maximum 10
    • Changed time type of timestampMillis
      • integer → long
    • Channel entry
      • Changed request example
    • Channel message history retrieval
      • Changed API endpoint
      • Removed Content-Type from path parameters
    • Channel creation
      • Changed guidance on actions based on the presence of playerId in request data
    • Channel exit
      • Added explanation that channels without participants, where the channel owner is not SYSTEM, will be periodically deleted
    • User blocking
      • Added explanation that it is a feature to limit real-time message sending and receiving
    • Channel announcement message
      • Added guidance on actions based on the presence of channelId and langCode in request data
    • Revised overview description
    • Changed wording
      • Time → Date
    • Fixed some spacing
    • Changed the notation of type array
      • Example: array → object array

websocket API changes

  • Packet Type
    • Added NOTIFY_NOTICE
  • Client Connection
    • Changed request example
  • Client Reconnection
    • Changed request example
  • Notice Message
    • Renamed to user notice message
    • Changed Body playerId information
  • Channel Notice Message
    • Changed Body channelId information
  • Changed extraData data transmission packet
    • Removed extraData from request values
      • CONNECT
      • RECONNECT
    • Added extraData to request values
      • CHANNEL_CHAT
      • DIRECT_CHAT
    • Removed extraData from response values
      • NOTIFY_ENTER_CHANNEL
      • NOTIFY_EXIT_CHANNEL
    • Changed response key value (fromExtra → extraData)
      • NOTIFY_CHANNEL_CHAT
      • NOTIFY_DIRECT_CHAT
  • Added timestampMillis to response values
    • NOTIFY_ENTER_CHANNEL
    • NOTIFY_EXIT_CHANNEL
    • NOTIFY_DELETE_CHANNEL
    • NOTIFY_CHANNEL_NOTICE
    • NOTIFY_CHANNEL_CHAT
    • NOTIFY_DIRECT_CHAT
  • Added langCode to request values
    • CONNECT
    • RECONNECT
  • Added Socket Server Event Message
    • NOTIFY_NOTICE
  • Removed deprecated packets
    • NOTIFY_DISCONNECT