Documentation
Chat (BETA)
Console 官网 Community Technical support
English
search-icon

Agora Chat Web API Reference

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

Hierarchy

Index

Properties

Methods

Properties

Optional body

body?: { filename: string; type: string; url: string }

The message body.

Type declaration

  • filename: string

    The file name.

  • type: string

    The file type.

  • url: string

    The file URL.

chatType

chatType: ChatType

Session type.

Optional ext

ext?: {}

The message extension.

Type declaration

  • [key: string]: any

Optional file

file?: FileObj

The file object.

Optional from

from?: string

The sender, which can only be the current user and can not be changed.

Optional group

group?: string
deprecated

Whether the session type is group.

Optional height

height?: number

The image height.

id

id: string

The message ID.

Optional isChatThread

isChatThread?: boolean

Whether the message is a thread message.

Optional msgConfig

msgConfig?: { allowGroupAck: boolean }

Whether read receipts are required during a group session.

Type declaration

  • allowGroupAck: boolean

Optional roomType

roomType?: boolean
deprecated

Whether the session type is chat room.

Optional secret

secret?: string

The key required to download the file.

Optional thumb

thumb?: string

The thumbnail URL.

Optional thumb_secret

thumb_secret?: string

The key required to download the thumbnail.

time

time: number

Time.

to

to: string

The recipient.

type

type: "img"

The message type.

Optional url

url?: string

The file URL. If the file is uploaded, you can directly use the URL.

Optional width

width?: number

The image width.

Methods

Optional fail

  • fail(): void

  • The callback for a message sending failure.

    Returns void

Optional onFileUploadComplete

  • onFileUploadComplete(data: any): void

Optional onFileUploadError

  • onFileUploadError(error: any): void

Optional onFileUploadProgress

  • onFileUploadProgress(data: any): void

Optional success

  • success(): void

  • The callback for message sending success.

    Returns void