Skip to content

The current latest version of the SDK Guide is v4.25.3.0.

The Console guide and API guide are updated only to the latest version. Click here to go to the latest version.

Hive Developers

[API guide] Chat API guide update

Korean
English
Japanese
Chinese (Simplified)
Chinese (Traditional)
Thai

Initializing search

Update News
SDK Guide
Console Guide
API Guide
Releases
FAQ

Hive Developers

Update News
Update News
- All
  All
- Notice
  Notice
SDK Guide
SDK Guide
- SDK Development flow
  SDK Development flow
  - Getting started
    
    Getting started
    
    Pre installation
    
    Pre installation
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
    
    SDK installation
    
    SDK installation
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
    
    Post installation
    
    Post installation
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
  - Feature installation
    
    Feature installation
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
  - Basic configuration
    
    Basic configuration
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
  - Market-specific configuration
    
    Market-specific configuration
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
  - Pre development
    
    Pre development
    
    Android
    
    iOS
    
    Cocos2d-x
    
    Unity
    
    Unreal Engine 4
    
    Unreal Engine 5
  - App development
    
    App development
  - App build
    
    App build
    
    Android
    
    iOS
    
    Unity Android
    
    Unity iOS
    
    Unity Windows
    
    Unreal Android
    
    Unreal iOS
    
    Unreal Windows
  - App service
    
    App service
- Basic configuration
  Basic configuration
  - Configuration file
    
    Configuration file
    
    Overview
    
    All engines
    
    Unity
    
    Unreal
  - Configuration class
    
    Configuration class
- SDK initialization
  SDK initialization
- Provisioning
  Provisioning
  - Terms
  - Notification popups
    
    Notification popups
    
    Country restrictions, Update, General notices
    
    Server maintenance
  - Remote services
- Authentication
  Authentication
  - Prerequisites
    
    Prerequisites
    
    All engines
    
    All engines
    
    Key input by IdP
    
    Additional settings by IdP
    
    Android
    
    iOS
    
    Unity
    
    Unreal
  - Login logout
  - Check user data
  - Link Idp
  - Encourage account linking with games
  - Verify as an adult
  - Add-ons
  - Troubleshooting guide
- Billing
  Billing
  - Prerequisites
    
    Prerequisites
    
    Android
    
    iOS
    
    Unity
    
    Unreal
  - IAP v4 initialization
  - View product list and purchase
  - Receipt verification
  - Promotional IAP
  - Subscription payment system
  - PG payment
  - Item
  - Additional features
    
    Additional features
    
    consumption information sending consent inquiry
- Notification
  Notification
  - Prerequisites
    
    Prerequisites
    
    Android
    
    iOS
    
    Unity
    
    Unreal
  - Getting started
  - Sending remote Push
  - Sending local Push
  - Advanced
- Promotion
  Promotion
  - Prerequisites
    
    Prerequisites
    
    All engines
    
    Android
    
    iOS
    
    Unity
    
    Unreal
  - Display interstitial banners
  - Display news page
  - Review and exit popups
  - Promotion badge
  - Offerwall
  - Advanced
  - User engagement (UE, Deep link)
  - User acquisition (UA)
- Marketing Attribution
  Marketing Attribution
  - Prerequisites
    
    Prerequisites
    
    All Engines
    
    Android
    
    iOS
    
    Unity
    
    Unreal
  - Automatic event tracking
  - Manual event tracking
  - Send exposed ad info
  - Deferred deep link tracking
  - Reference
  - Trouble shooting
- Match making
  Match making
  - Individual Match
  - Group Match
- Chat
  Chat
  - Preparation
    
    Preparation
    
    Android
    
    iOS
    
    Unity
  - Connection management
  - Channel
  - User
  - Message
  - Event management
- Customer support
  Customer support
- Community
  Community
- Analytics
  Analytics
  - Prerequisites
    
    Prerequisites
    
    Pre-work
    
    All engines
  - Structure
  - Send Analytics log
    
    Send Analytics log
    
    Sending logs to the Hive server
    
    Fluentd
    
    Fluentd
    
    Overview
    
    How to use Fluentd
    
    How to use Fluentd Docker
    
    Application library
    
    Specific log file
    
    Transmission test guide
    
    HTTP
    
    SDK
    
    Log batch files
    
    Log batch files
    
    Overview
    
    Prerequisites
    
    How to send log batches
  - Integrating with MMP service
    
    Integrating with MMP service
    
    Integrating with Airbridge
    
    Integrating with Appsflyer
    
    Integrating with Adjust
    
    Leveraging MMP data
  - Display the Analytics consent banner
- Datastore
  Datastore
  - Prerequisites
    
    Prerequisites
    
    Android
    
    iOS
    
    Unity
    
    Unreal
- Hercules
  Hercules
- Ad Monetization
  Ad Monetization
  - Adiz
    
    Adiz
    
    Unity
    
    Android
    
    iOS
  - Adkit
    
    Adkit
    
    AD(X)
    
    AD(X)
    
    Unity
    
    C++
    
    ADOP
    
    ADOP
    
    Unity
    
    C++
    
    Android
    
    iOS
- Add-ons
  Add-ons
  - Calling web content
  - Game Controller Support
  - RTT4U
    
    RTT4U
    
    Overview
    
    Installation
    
    How-to-use
    
    Troubleshooting Guide
  - Remote Launch Crossplay Launcher
  - Touch Gestures
  - Custom Cursor
  - Get launch parameter
- TalkPlus
  TalkPlus
  - None
  - Unity
  - Android
  - iOS
- Crossplay Launcher
  Crossplay Launcher
  - Prepare app files
  - Prepare webpage to serve app
  - Upload app to server
    
    Upload app to server
    
    Overview
    
    Upload new app to server
    
    Upload patch version to server
  - Review app
  - Release app
  - Error code
- Remote Play
  Remote Play
  - Integrate plugins
    
    Integrate plugins
    
    Register callbacks for receiving chat strings
    
    Change blind images
- References
  References
  - Identifier
Console Guide
Console Guide
- Console
  Console
  - Look around the main screen
  - Console permission management
    
    Console permission management
    
    About Console permission management
    
    Owner, admin permisson
    
    Member permission
    
    Personal information processing permission
  - Plans and Payments
    
    Plans and Payments
    
    Dashboard
    
    Plans
    
    Payment Information
    
    Billing and Payment History
- Appcenter
  Appcenter
- Provisioning
  Provisioning
  - Terms of service
    
    Terms of service
    
    About terms
    
    Link terms
    
    Terms group settings
    
    Terms group settings
    
    About terms group settings
    
    Country combination
    
    Terms of service group(L)
    
    Terms of service combination(M)
    
    Content management
    
    Content management
    
    About content management
    
    Manage Terms Type(T)
    
    Manage Content(S)
    
    Standard structure of terms of service
  - Notice pop-up
  - Remote logging
  - Remote configuration
  - Webview access settings
- Authentication
  Authentication
- Billing
  Billing
- Notification
  Notification
  - Push certificate management
    
    Push certificate management
    
    About push certificate management
    
    Push certificate settings
    
    iOS certificate renewal
  - Push v4
    
    Push v4
    
    About push v4
    
    Dashboard
    
    Push campaign list
    
    Register push campaign
    
    Register targeting data
    
    Token list
  - Manage template
    
    Manage template
    
    About manage template
    
    Campaign title template
    
    Message template
  - SMS OTP
    
    SMS OTP
    
    About SMS OTP
    
    Service token issuance
    
    Send information settings
    
    Search sending history
    
    Search authentication history
- Promotion
  Promotion
  - Promotion Settings
  - Validation Settings
  - How to test campaign reward
  - Event Banner Registration and Management
  - Media Banner Registration and Management
  - Registering Rolling Banner
  - Spot Banner Registration
  - Custom View Registration
  - Custom Board
  - Web Banners
  - Invite Campaign Registration and Management
  - User Engagement (UE, Deeplin)
  - Utilizing YouTube Videos
  - Cross promotion Ad
    
    Cross promotion Ad
    
    About Cross promotion
    
    Register Ad
    
    Manage Ad
    
    Manage Advertiser Code
    
    Report
    
    Ad Cost Settlement
  - Cross promotion Monetization
    
    Cross promotion Monetization
    
    About monetization
    
    Monetization Settings
    
    Report
    
    Tally Ad Revenue
- Social
  Social
  - Notices
- Customer service
  Customer service
  - Getting started
    
    Getting started
    
    Initial settings
    
    Admin settings
  - Contact
    
    Contact
    
    Contact list
    
    Template registration
    
    Register FAQ
  - Contact Analysis
  - Service Rating
  - Mail
    
    Mail
    
    Account settings
    
    Register new account
    
    Mail list
    
    Spam mail registration
    
    Contact only reply
  - VIP management
  - Manage Refunds
- Analytics
  Analytics
  - Get started
  - Comprehensive indicator
  - Game indicator
    
    Game indicator
    
    About game indicator
    
    Gameplay analysis indicator
    
    User classification indicator
    
    User classification movement indicator
  - DashBoard
  - Creation indicator
    
    Creation indicator
    
    About creation indicator
    
    Indicator definition
  - Register for exclusion of sales indicators
  - Log definition
    
    Log definition
    
    How to use log definition
    
    Basic log
    
    Basic log
    
    About basic log
    
    User
    
    User
    
    User log
    
    Login log
    
    Member login step-by-step log
    
    User withdrawal log
    
    App installation and update log
    
    Concurrent access log
    
    Sales
    
    Sales
    
    Sales log
    
    Consumable product purchase log
    
    Subscription product purchase log
    
    refund log
    
    Advertising
    
    Advertising
    
    Advertising log
    
    Ad viewing log
    
    MMP
    
    MMP
    
    Airbridge log
    
    Appsflyer log
    
    Adjust log
    
    Singular log
    
    Campaign
    
    Campaign
    
    Campaign log
    
    Push open log
    
    Push sending log
    
    Promotion install log
    
    Promotion click cross log
    
    Promotion CPI v2 log
    
    Promotion open log
    
    Promotion information log
    
    etc
    
    etc
    
    pub_device_info
    
    Game log
    
    Game log
    
    About game log
    
    Custom User Property Log
    
    Gameplay analytics mate log
    
    Gameplay analytics level-up log
    
    Gameplay analytics currency log
    
    Game play analytics store click log
    
    Social activity log for gameplay analysis
    
    Game Play Analysis Content Log
  - Segment
    
    Segment
    
    How to use segment
    
    Segment(Old Version)
    
    Targeting
  - Funnel
    
    Funnel
    
    Funnel
    
    Funnel (New)
  - Retention analysis
  - Analytics bigQuery
  - Using analytics
    
    Using analytics
    
    How to use analytics
    
    Game analysis using stickiness
    
    Calculate ad view conversion rate in bigQuery
    
    Analyze ROAS with analytics indicators
    
    Retrieve indicators in bigQuery
    
    Create custom indicator for each game
    
    To Link Miracle Play
    
    To Link Miracle Play
    
    To Link Miracle Play
    
    Integration Overview
  - Custom indicator
  - Data export
  - Indicator terms
  - Concurrent User Monitoring
- Game data store
  Game data store
- Hercules
  Hercules
  - Hercules Certification
- Marketing attribution
  Marketing attribution
  - Airbridge settings
- Community & Web Shop
  Community & Web Shop
  - Getting started
    
    Getting started
    
    Overview
    
    Preparation
    
    Image assets
  - Common manangement
    
    Common manangement
    
    Airbridge Integration
    
    Site settings
    
    Main screen
    
    Search user
    
    SEO & GTM
  - Web shop
    
    Web shop
    
    Web shop settings
    
    Product management
  - Community UI
    
    Community UI
    
    Bulletin board
    
    banner
    
    Template
    
    Profile API sync
  - Community post
    
    Community post
    
    User post
    
    Admin post
    
    Search deleted post
    
    Forbidden word
    
    Admin nickname
    
    Post suspension
  - Community statistics
- Ad monetization
  Ad monetization
  - Adiz
    
    Adiz
    
    About Adiz
    
    AdMob setting
    
    Register test device
- Leaderboard
  Leaderboard
- Matchmaking
  Matchmaking
  - Matchmaking management
- Chat
  Chat
  - AI Chat Filter
- AI service
  AI service
  - Automatic translation
  - Chat abuse detection
    
    Chat abuse detection
    
    About chat abusing detection usage guide
    
    Chat log collection system
  - Text abusing detection
    
    Text abusing detection
    
    About text abusing detection system
    
    Text abusing detection system guide
    
    CLCS Usage Guide
  - Community monitoring
    
    Community monitoring
    
    About community monitoring system
    
    Keyword monitoring system guide
  - Hive community analysis
- Crash report
  Crash report
- Crossplay launcher
  Crossplay launcher
  - App management
- Remote Play
  Remote Play
  - Remote Play Settings
- Blockchain
  Blockchain
  - Hive blockchain
    
    Hive blockchain
    
    Overview
    
    Hive blockchain service introduction
    
    Basic setting
    
    NFT
    
    NFT
    
    User-minted
    
    Admin-minted
    
    Transaction Search
  - XPLA GAMES
    
    XPLA GAMES
    
    Overview
    
    XPLA GAMES service introduction
    
    Beta game launcher
    
    Blockchain game management
    
    Wallet
    
    Wallet
    
    Connect XPLA wallet
    
    Create multisig wallet
    
    Contract
    
    Transaction search
API Guide
API Guide
- SDK API
  SDK API
  - Result API
- Server API
  Server API
  - Authentication
    
    Authentication
    
    Searching Authentication v4 IdP lists
    
    Verifying Authentication v4 token
    
    Authenticating Authentication v4 custom
    
    Deleting Authentication v4 account
  - Web login integration
    
    Web login integration
    
    Getting started
    
    Call login page
    
    Verify login and retrieve user info
    
    Refresh token
    
    Retrieve user info with authentication API
    
    Implement login persistence (SSO)
  - Web login (deprecated)
    
    Web login (deprecated)
    
    Getting started
    
    Load login page v2
    
    Load login page v1
    
    Verify weblogin v2
    
    Verify weblogin v1
    
    Get PlayerID with Auth v4 IdP ID
  - Suspension of use
    
    Suspension of use
    
    Register and cancel suspension of use
    
    Register a suspended game server
    
    Check blocked users information
  - Promotion
    
    Promotion
    
    Notifying CPA achievement
    
    Banner list
    
    Friends list for UA
    
    Information of UA Sender
    
    UA Campaign status
    
    UA Matching based on invitation code
  - Billing
    
    Billing
    
    Sync with Item
    
    IAP v4 verifying subscription receipt
    
    IAP v4 notifying real-time subscription
    
    IAP v4 verifying receipt
    
    IAP v4 transmitting Item delivery result
    
    Purchase, cancellation, refund history per market
    
    PG payment
    
    Web PG payment
    
    Web coupon exchange
    
    Sending consumption information
  - Notification
    
    Notification
    
    OTP
    
    OTP
    
    OTP verification system
    
    Push v4
    
    Push v4
    
    Authentication
    
    Single Push
    
    Targeting registration
    
    Campaign Registration
  - Time Zone
    
    Time Zone
    
    Getting time Zone
    
    Getting country Code
  - Community & Web Shop
    
    Community & Web Shop
    
    Profile API
    
    In-app information API
  - Analytics
    
    Analytics
    
    Retrieve log
  - AI Services
    
    AI Services
    
    Automatic translation API
    
    Send chat log
    
    Detect text abusing
- Blockchain API
  Blockchain API
  - Hive Blockchain API
  - Blockchain Open API
    
    Blockchain Open API
    
    About
    
    Chain API
    
    KMS API
    
    Wallet API
    
    Multi-sig API
    
    Transaction API
    
    Token API
    
    NFT API
    
    Contract API
    
    Asset API
    
    Lock API
    
    Metadata API
    
    Extension API
  - Blockchain Auth API
- Leaderboard API
- Matchmaking API
  Matchmaking API
- Crossplay Launcher Remote Launch API
- Chat API
  Chat API
  - HTTP API
  - WebSocket API
Releases
Releases
- SDK Unity
  SDK Unity
- SDK Unreal Engine 4
  SDK Unreal Engine 4
  - Android & iOS
  - Windows
- SDK Unreal Engine 5
  SDK Unreal Engine 5
  - Android & iOS
  - Windows
- SDK Native
  SDK Native
  - Android
  - iOS
- SDK Cocos2d-x
  SDK Cocos2d-x
  - Android & iOS
- Planet Explore
- SDK Manager
- Crossplay Launcher
  Crossplay Launcher
  - Uploader & Patch Maker
  - Installation Packaging Tool for Google Play Games
- Adiz
- Adkit
  Adkit
  - AD(X)
    
    AD(X)
    
    Unity
    
    C++
  - ADOP
    
    ADOP
    
    Unity
    
    Cocos2dx-CPP
    
    Android
    
    iOS
- Plugins
  Plugins
  - Marketing Attribution
    
    Marketing Attribution
    
    Windows
  - Remote Play
    
    Remote Play
    
    Windows
FAQ
FAQ
- SDK Issues
- Other Issues

Hive
Hive Platform

Info
- May 26, 2025
- Notice: Guide Changes Notice

[API guide] Chat API guide update¶

Updates the Chat API guide. Changes the sending of channel notice messages to Send notice.

Copyright © 2024 Com2us Platform Corp.

Terms of Use
Privacy Policy

Hive Console
Hive Platform