Agora Chat Web API Reference

Overview ChatSDK Chatroom Connection Contact EventHandler Group Logger Message Presence SilentMode StatusCode Thread Translation Types

Hierarchy

ConnectionParameters

Index

Properties

Optional apiUrl

apiUrl?: string

The URL of the specified REST server. This command is used when DNS is not enabled. Usually this API is used for specific customers and need to contact account manager to get it.

appKey

appKey: string

The unique application key registered in console.

Optional autoReconnectNumMax

autoReconnectNumMax?: number

The maximum number of reconnection.

Optional delivery

delivery?: boolean

Whether to enable the delivery receipt function. - true: Enable; - (Default)false: Do not enable.

Optional deviceId

deviceId?: string

The unique web device ID. By default, it is a random number.

Optional heartBeatWait

heartBeatWait?: number

The heartbeat interval (in seconds). The default value is 30,000s.

Optional https

https?: boolean

Whether to use HTTPS only. By default, the browser determines whether to use HTTPS only according to the domain name.

Optional isDebug

isDebug?: boolean

Whether to start logging.

Optional isHttpDNS

isHttpDNS?: boolean

Whether to enable DNS to prevent DNS hijacking. - (Default)true: Enable; - false: Do not enable.

Optional url

url?: string

The URL of the specified message server. This command is used when DNS is not enabled. Usually this API is used for specific customers and need to contact account manager to get it.

Optional useOwnUploadFun

useOwnUploadFun?: boolean

Whether to use your own upload function, for example, when uploading images and files to your server. - true: Use your own upload function; - (Default)false: Do not use your own upload function.