Documentation
Chat (BETA)
All
Product
Voice Call
Video Call
Interactive Live Streaming Premium
Interactive Live Streaming Standard
Chat (BETA)
Content Moderation
Agora Basics
Beta Product
Voice Call v4.0.0 Beta
Video Call v4.0.0 Beta
Interactive Live Streaming Standard v4.0.0 Beta
Interactive Live Streaming Premium v4.0.0 Beta
New Live Broadcast
Beta Products
Video Call v4.0.0 Preview
Interactive Live Streaming Premium v4.0.0 Preview
Interactive Live Streaming Standard v4.0.0 Preview
Previous Product
Voice Call (Legacy)
Video Call (Legacy)
Interactive Live Streaming Premium (Legacy)
Interactive Live Streaming Standard (Legacy)
Real-time Messaging
Live-stream Shopping
Lecture Hall
AI Interactive Classroom
Use Case
Multiple Hosts
Single Host
Virtual Host
PK Host
Console
官网
Community
Technical support
English
简体中文
English
Log In
Sign Up
Sign Up
Log In
Language
中文
English
官网
Console
Community
Technical support
Docs
API Reference
Downloads
Code Samples
FAQ
Docs
API Reference
Downloads
Code Samples
FAQ
4.0.0 Beta
Search
Search in this product
Search in all products
Search
Documentation
Chat (BETA)
API Reference
CustomMsgSetParameters | Agora Chat SDK API Reference
Agora Chat Web API Reference
v1.0.6
v1.0.5
v1.0.3
v1.0.1
No data
Overview
ChatSDK
Chatroom
Connection
Contact
EventHandler
Group
Logger
Message
Presence
SilentMode
StatusCode
Thread
Translation
Types
Hierarchy
CustomMsgSetParameters
Index
Properties
chat
Type
custom
Event
custom
Exts
ext
from
room
Type
to
Methods
fail
success
Properties
chat
Type
chat
Type
:
ChatType
custom
Event
custom
Event
:
string
custom
Exts
custom
Exts
:
{}
Type declaration
[
key:
string
]:
any
Optional
ext
ext
?:
{}
Type declaration
[
key:
string
]:
any
Optional
from
from
?:
string
Optional
room
Type
room
Type
?:
boolean
to
to
:
string
Methods
Optional
fail
fail
(
)
:
void
Returns
void
Optional
success
success
(
)
:
void
Returns
void
Modules
ChatSDK
Chatroom
Connection
Contact
Event
Handler
Group
Logger
Message
Presence
Silent
Mode
Status
Code
Thread
Translation
Types
Chat
Room
Type
Common
Connection
Contact
Type
Error
Event
Handler
Type
Group
Type
Message
Presence
Type
Reaction
Type
Silent
Mode
Type
Thread
Type
Translation
Type
Utils
message/audio
message/channel
message/cmd
message/custom
message/delivery
message/file
message/img
message/location
message/read
message/text
message/video
Custom
Msg
Set
Parameters
chat
Type
custom
Event
custom
Exts
ext
from
room
Type
to
fail
success
Your feedback matters to us!