API C ChatInfo.SendAddonMessage

Sends a message over an addon comm channel.
 success = C_ChatInfo.SendAddonMessage(prefix, message [, chatType, target])
 = C_ChatInfo.SendAddonMessageLogged
==Arguments==
:;prefix: - Message prefix, can be used as your addon identifier; at most 16 characters.
:;message: - Text to send, at most 255 characters. All characters (decimal ID 1-255) are permissible except NULL (ASCII 0).
:;chatType: - The addon channel to send to.
:;target: - The player name or custom channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes.
==Returns==
:;success: - True if the message was successfully sent. This is regardless of being registered to its prefix or any server-side throttling.
==Chat types==
{| class="sortable darktable zebra"
! chatType !! Retail !! Classic !! Description
|-
| "PARTY" || ✔️ || ✔️ || Addon message to party members
|-
| "RAID" || ✔️ || ✔️ || Addon message to raid members. If not in a raid group, the message will instead be sent on the PARTY chat type.
|-
| "INSTANCE_CHAT" || ✔️ || ✔️ || Addon message to grouped players in instanced content such as dungeons, raids and battlegrounds
|-
| "GUILD" || ✔️ || ✔️ || Addon message to guild members. Prints a "You are not in a guild." system message if you're not in a guild.
|-
| "OFFICER" || ✔️ || ✔️ || Addon message to guild officers
|-
| "WHISPER" || ✔️ || ✔️ || Addon message to a player. Only works for players on the same or any connected realms. Use player name as target argument. Prints a "No player named '%s' is currently playing." system message if that player is offline.
|-
| "CHANNEL" || ✔️ || ❌ || Addon message to a custom chat channel. Use channel number as target argument. Disabled on Classic to prevent players communicating over custom chat channels
|-
| "SAY" || ❌ || ✔️ || Addon message to players within /say range. Subject to heavy throttling and certain specific characters are disallowed
|-
| "YELL" || ❌ || ✔️ || Addon message to players within /yell range. Subject to heavy throttling and certain specific characters are disallowed
|}
==Details==
* Recipients must register a prefix using () to receive its messages via . This prefix can be max 16 characters long and it's recommended to use the addon name if possible so other authors can easily see which addon a registered prefix belongs to.
===C_ChatInfo.SendAddonMessageLogged===
Addons transmitting user-generated content should use this API so recipients can report violations of the Code of Conduct.
* Fires when receiving messages sent via this function.
* The message has to be plain text for the game masters to read it. Moreover, the messages will silently fail to be sent if it contains an unsupported non-printable character. Some amount of metadata is tolerated, but should be kept as minimal as possible to keep the messages readable for Blizzard's game masters. 
* This function has been introduced as a solution to growing issues of harassment and doxxing via addon communications, where players would use addons to send content against the terms of service to other players (roleplaying addons are particularly affected as they offer a free form canvas to share a RP profiles). As regular addon messages are not logged they cannot be seen by game master, they had no way to act upon this content. If you use this function, game masters will be able to check the addon communication logs in case of a report and act upon the content. Users should report addon content that is against the terms of service using Blizzard's support website via the Harassment in addon text option.
==Example==
Whispers yourself an addon message when you login or /reload
local prefix = "SomePrefix123"
local playerName = UnitName("player")
local function OnEvent(self, event, ...)
	if event == "CHAT_MSG_ADDON" then
		print(event, ...)
	elseif event == "PLAYER_ENTERING_WORLD" then
		local isLogin, isReload = ...
		if isLogin or isReload then
			C_ChatInfo.SendAddonMessage(prefix, "You can't see this message", "WHISPER", playerName)
			C_ChatInfo.RegisterAddonMessagePrefix(prefix)
			C_ChatInfo.SendAddonMessage(prefix, "Hello world!", "WHISPER", playerName)
		end
	end
end
local f = CreateFrame("Frame")
f:RegisterEvent("CHAT_MSG_ADDON")
f:RegisterEvent("PLAYER_ENTERING_WORLD")
f:SetScript("OnEvent", OnEvent)
==Libraries==
There is a server-side throttle on in-game addon communication so it's recommended to serialize, compress and encode data before you send them over the addon comms channel.
Serialize:
* LibSerialize (stats)
* AceSerializer
Compress/Encode:
* LibDeflate (stats)
* LibCompress (stats)
Comms:
* ChatThrottleLib (docs, stats)
* AceComm
The LibSerialize project page has detailed examples and documentation for using LibSerialize + LibDeflate and AceComm:
-- Dependencies: AceAddon-3.0, AceComm-3.0, LibSerialize, LibDeflate
MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceComm-3.0")
local LibSerialize = LibStub("LibSerialize")
local LibDeflate = LibStub("LibDeflate")
function MyAddon:OnEnable()
 self:RegisterComm("MyPrefix")
end
-- With compression (recommended):
function MyAddon:Transmit(data)
 local serialized = LibSerialize:Serialize(data)
 local compressed = LibDeflate:CompressDeflate(serialized)
 local encoded = LibDeflate:EncodeForWoWAddonChannel(compressed)
 self:SendCommMessage("MyPrefix", encoded, "WHISPER", UnitName("player"))
end
function MyAddon:OnCommReceived(prefix, payload, distribution, sender)
 local decoded = LibDeflate:DecodeForWoWAddonChannel(payload)
 if not decoded then return end
 local decompressed = LibDeflate:DecompressDeflate(decoded)
 if not decompressed then return end
 local success, data = LibSerialize:Deserialize(decompressed)
 if not success then return end
 -- Handle `data`
end
==Patch changes==
====Retail====
====Classic====
==See also==
* ()
* ()
* () - Battle.net equivalent.
==References==