Documentation on the Data Insights API endpoints, including request structure, response structure, and examples included here:
Notice - Demo Account: This account is processing
voice audio from a variety of sources, including real-time audio. Some features may be disabled
for demonstration purposes.
Developer Resources
The moderation messages are messages which are HTTP POSTed from ToxMod to your player management system (at a specific HTTPS endpoint that you can set on the Administration page in the ToxMod Web Console). These messages convey that a moderator has taken an action on the ToxMod web console with respect to a specific player/session/offense/user report that your player management system should handle. For example, if a moderator bans a player on the ToxMod Web Console, a moderation message will be sent to your player management system with that information (moderator identification, player identification, session identification, action type e.g. "ban", etc.). The moderation message also includes evidence relevant to the offense being moderated (e.g. transcriptions, audio URLs, context, ToxMod's score and category). This same moderation message mechanism is used for automated ToxMod actions if automation is enabled. Please see the linked documentation for full and latest details.
Documentation on the format of the moderation messages, the integration procedure, and examples of how to verify the message signatures using the Modulate ToxMod Public Key:
The moderation result and appeals integration allows ToxMod to track statistics about and learn from actions after they've been taken by moderators in the ToxMod Web Console (or by automation if it's enabled). The moderation result endpoint gives information to ToxMod about what actions your player management system actually took due to offenses escalated by ToxMod (for example, your moderators may issue a "strike" action in the ToxMod Web Console, but your player management system might add that to two existing strikes and issue a suspension instead - this endpoint allows ToxMod to be aware of that for tracking and statistics).
The appeals endpoint gives information to ToxMod about the existence and result of appeals on actions taken against players due to ToxMod escalated offenses. For example, if ToxMod escalated an offense that was sent to your player management system (through a moderator action on the ToxMod Web Console, or via automation) and a player was disciplined based on that offense but later overturned the disciplinary action through an appeal, this endpoint would let ToxMod know that the escalated offense was incorrect. This is particularly important if automation is enabled, as it allows ToxMod to track statistics about accuracy of automated offenses and continually improve performance.
Documentation on the moderation result and appeals API endpoints, including optional fields and examples:
Download a copy of Modulate's ToxMod public key for signature verification of moderation messages. Each moderation message sent from Modulate's system to the customer's integration URL (specified in admin) is signed with this key. The signatures may either be verified in real-time during moderation, and/or logged for future audit.
The user report integration allows ToxMod to consume reports of toxicity or code of conduct violations submitted by users and correlate that report information with evidence of toxicity in voice chat sessions identified by ToxMod. The user report endpoint allows you to securely send user report data to the ToxMod console.
Documentation on the user report API endpoints, including optional fields and examples:
Changes from 1.8.0 to 1.8.3:
Removed success message in `tox_set_log_error_callback` and ` tox_set_log_info_callback` to prevent compilation error in Unreal Engine 5.
Bumped cURL dependency to 8.4.0 for high severity security fix
Fixed an issue with proximity chat functions in XBox builds
Changes from 1.7.0 to 1.8.0:
Added support for proximity chat features via the `tox_proximity_chat_set_player_can_hear()` and `tox_proximity_chat_set_can_hear_player()` functions. Added `enable_proximity_chat` member to `tox_config_t` struct to differentiate between proximity chat and normal chat sessions.
Added support for player-to-player muting actions, both as input to conversational analysis of which players can hear certain offenses, as well as additional signals for disruptive behavior heard by the muting player.
Added support for global muting options on a per-player basis, which inform ToxMod that a player is not participating in voice chat.
Downloads
Windows platforms, macOSX and Linux builds are x86_64 only, and Android and iOS builds are arm64. All builds are shipped as shared libraries or DLLs, with Windows builds for Debug and Release modes. Additional dependencies, such as libopus1.3.1, are included alongside an example test program to verify functionality and demonstrate a simple integration.
Wraps the Core Library version 1.8.3.
Downloads
The following downloads include ToxMod plugins for Unity, as well as example code and helper functions for integrating into a variety of voice chat frameworks. These plugins support Windows 10 64bit, macOSX (intel 64-bit and Apple Silicon), iOS, and Android (armv8a) - including Quest headsets. Some of the platforms may not be supported in all example code projects if the voice chat framework libraries do not support them.
ToxMod for Unity software (Standalone):