Documentation





Chat (BETA)

Console 官网 Community Technical support





Agora Chat Web API Reference

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

Contact contains the APIs for contact-related operations.

Functions

Const acceptContactInvite

acceptContactInvite(to: string): void

接受好友申请。
```
connection.acceptContactInvite('user1')
```
Parameters
- to: string
Returns void

addContact

addContact(to: string, message?: string): void

添加好友。
```
connection.addContact('user1', 'I am Bob')
```
Parameters
- to: string
- Optional message: string
Returns void

addReaction

addReaction(params: { messageId: string; reaction: string }): Promise<void>

添加消息 Reaction。
```
connection.addReaction({messageId: 'messageId', reaction: 'reaction'})
```
Parameters
- params: { messageId: string; reaction: string }
  - messageId: string
    Adds a reaction to the message.
    connection.addReaction({messageId: 'messageId', action: 'action'})
  - reaction: string
    
    在消息上添加的 Reaction，最大长度为 128 字符。
Returns Promise<void>

Const addUsersToBlocklist

addUsersToBlocklist(options: { name: string | string[] }): void

添加联系人至黑名单。
```
connection.addUsersToBlocklist({name: 'user1'})
```
Parameters
- options: { name: string | string[] }
  - name: string | string[]
    Declines a friend request.
    connection.declineContactInvite('user1')
Returns void

Const declineContactInvite

declineContactInvite(to: string): void

拒绝好友申请。
```
connection.declineContactInvite('user1')
```
Parameters
- to: string
Returns void

deleteContact

deleteContact(to: string): void

删除指定好友。
```
connection.deleteContact('user1')
```
Parameters
- to: string
Returns void

Const deleteConversation

deleteConversation(params: { channel: string; chatType: "singleChat" | "groupChat"; deleteRoam: boolean; error?: any; success?: any }): Promise<AsyncResult<DeleteSessionResult>>

Parameters
- params: { channel: string; chatType: "singleChat" | "groupChat"; deleteRoam: boolean; error?: any; success?: any }
  - channel: string
    Gets the conversation list and the latest message under the conversation.
    connection.getConversationlist()
  - chatType: "singleChat" | "groupChat"
    会话类型：
    
    singleChat：单聊；
    
    groupChat：群聊。
  - deleteRoam: boolean
    删除会话时是否同时删除服务端漫游消息。
    
    true：是；
    
    false：否。
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<DeleteSessionResult>): void
    - Parameters
      - res: AsyncResult<DeleteSessionResult>
      Returns void
Returns Promise<AsyncResult<DeleteSessionResult>>

deleteReaction

deleteReaction(params: { messageId: string; reaction: string }): Promise<void>

删除消息的 Reaction。
```
connection.deleteReaction({messageId: 'messageId', reaction: 'reaction'})
```
Parameters
- params: { messageId: string; reaction: string }
  - messageId: string
    
    消息 ID。
  - reaction: string
    
    要删除的 Reaction。
Returns Promise<void>

fetchUserInfoById

fetchUserInfoById(userId: string | string[], properties?: ConfigurableKey | ConfigurableKey[]): Promise<AsyncResult<UpdateOwnUserInfoParams>>

Whether to delete server roaming messages during conversation deletion.
- true: Yes;
- false: No.
Parameters
- userId: string | string[]
- Optional properties: ConfigurableKey | ConfigurableKey[]
Returns Promise<AsyncResult<UpdateOwnUserInfoParams>>

Const getBlocklist

getBlocklist(params?: { error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

Gets the blocklist.
```
connection.getBlocklist()
```
Parameters
- Optional params: { error?: any; success?: any }
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<string[]>): void
    - Parameters
      - res: AsyncResult<string[]>
      Returns void
Returns Promise<AsyncResult<UserId[]>>

getChatToken

getChatToken(agoraToken: string): Promise<any>

Parameters
- agoraToken: string
Returns Promise<any>

getContacts

getContacts(params?: { error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

获取联系人列表。
```
connection.getContacts()
```
Parameters
- Optional params: { error?: any; success?: any }
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: RosterData[]): void
    - Parameters
      - res: RosterData[]
      Returns void
Returns Promise<AsyncResult<UserId[]>>

getConversationlist

getConversationlist(params?: { error?: any; success?: any }): Promise<AsyncResult<conversationList[]>>

获取会话列表以及会话下的最新一条消息。
```
connection.getConversationlist()
```
Parameters
- Optional params: { error?: any; success?: any }
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<conversationList[]>): void
    - Parameters
      - res: AsyncResult<conversationList[]>
      Returns void
Returns Promise<AsyncResult<conversationList[]>>

getHistoryMessages

getHistoryMessages(options: { chatType?: "singleChat" | "groupChat" | "chatRoom"; cursor?: null | string | number; pageSize?: number; searchDirection?: string; targetId: string; fail?: any; success?: any }): Promise<HistoryMessages>

获取对话历史消息。
```
connection.getHistoryMessages({targetId:'user1',chatType:'groupChat', pageSize: 20})
```
Parameters
- options: { chatType?: "singleChat" | "groupChat" | "chatRoom"; cursor?: null | string | number; pageSize?: number; searchDirection?: string; targetId: string; fail?: any; success?: any }
  - Optional chatType?: "singleChat" | "groupChat" | "chatRoom"
    会话类型（SDK V4.0）：
    
    singleChat：单聊；
    
    groupChat：群组聊天；
    
    chatRoom：聊天室聊天。
    
    （默认）单聊。
  - Optional cursor?: null | string | number
    
    起始消息 ID，默认值为 -1，即从最新消息开始。
  - Optional pageSize?: number
    
    每次获取的消息条数。默认值为 20，最大值是50。
  - Optional searchDirection?: string
    是否选择正向拉取历史消息（从最老向最新拉取）。
    
    up：向上搜索；
    
    down：向下搜索；
    
    （默认）up。
  - targetId: string
    
    对方的用户 ID 或者群组 ID。
  - fail?:function
    - fail(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: MessagesType[]): void
    - Parameters
      - res: MessagesType[]
      Returns void
Returns Promise<HistoryMessages>

getReactionDetail

getReactionDetail(params: { cursor?: string; messageId: string; pageSize?: number; reaction: string }): Promise<AsyncResult<GetReactionDetailResult>>

获取 Reaction 详情。
```
getReactionDetail({messageId: 'messageId', reaction: 'reaction', cursor: '', pageSize: 20})
```
Parameters
- params: { cursor?: string; messageId: string; pageSize?: number; reaction: string }
  - Optional cursor?: string
    
    游标。如果数据还有下一页，该方法的返回值会包含此字段，传递此字段可获取下一页的数据，为 null 时获取第一页数据。
  - messageId: string
    
    消息 ID。
  - Optional pageSize?: number
    
    每页返回的数量。默认为 20，最大为 100。
  - reaction: string
    
    要获取的 Reaction。
Returns Promise<AsyncResult<GetReactionDetailResult>>

Const getReactionlist

getReactionlist(params: { chatType: "singleChat" | "groupChat"; groupId?: string; messageId: string | string[] }): Promise<AsyncResult<GetReactionListResult[]>>

获取消息的 Reaction 列表。
```
connection.getReactionlist({chatType: 'chatType', messageId: 'messageId'})
```
Parameters
- params: { chatType: "singleChat" | "groupChat"; groupId?: string; messageId: string | string[] }
  - chatType: "singleChat" | "groupChat"
    会话类型：
    
    singleChat：单聊；
    
    groupChat：群组聊天；
  - Optional groupId?: string
    
    群组 ID。
  - messageId: string | string[]
    
    消息 ID。
Returns Promise<AsyncResult<GetReactionListResult[]>>

recallMessage

recallMessage(option: { chatType?: "singleChat" | "groupChat" | "chatRoom"; isChatThread?: boolean; mid: string; to: string; type?: "chat" | "groupchat" | "chatroom"; fail?: any; success?: any }): Promise<SendMsgResult>

Removes contacts from the blocklist.
```
connection.removeUserFromBlocklist({name: 'user1'})
```
Parameters
- option: { chatType?: "singleChat" | "groupChat" | "chatRoom"; isChatThread?: boolean; mid: string; to: string; type?: "chat" | "groupchat" | "chatroom"; fail?: any; success?: any }
  - Optional chatType?: "singleChat" | "groupChat" | "chatRoom"
    会话类型（SDK V4.0）：
    
    singleChat：单聊；
    
    groupChat：群组聊天；
    
    chatRoom：聊天室聊天。
  - Optional isChatThread?: boolean
    The chat type for SDK V4.0:
    
    singleChat: one-to-one chat;
    
    groupchat: group chat;
    
    chatroom: chat room.
  - mid: string
    
    需要撤回的消息 ID。
  - to: string
    
    消息的接收方。
  - Optional type?: "chat" | "groupchat" | "chatroom"
    会话类型（SDK V3.0）:
    
    chat：单聊；
    
    groupchat：群组聊天；
    
    chatroom：聊天室聊天。
  - fail?:function
    - fail(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: number): void
    - Parameters
      - res: number
      Returns void
Returns Promise<SendMsgResult>

Const removeUserFromBlocklist

removeUserFromBlocklist(options: { name: string | string[] }): void

将联系人从黑名单中移除。
```
connection.removeUserFromBlocklist({name: 'user1'})
```
Parameters
- options: { name: string | string[] }
  - name: string | string[]
    Adds a contact to the blocklist.
    connection.addUsersToBlocklist({name: 'user1'})
Returns void

reportMessage

reportMessage(params: { messageId: string; reportReason: string; reportType: string }): Promise<void>

举报消息。
```
reportMessage()
```
Parameters
- params: { messageId: string; reportReason: string; reportType: string }
  - messageId: string
  - reportReason: string
  - reportType: string
Returns Promise<void>

updateCurrentUserNick

updateCurrentUserNick(nick: string): Promise<AsyncResult<BaseUserInfo[]>>

修改收到推送消息时显示的昵称。该昵称在用户注册时设置。不属于用户属性。
```
connection.updateCurrentUserNick('Tom')
```
Parameters
- nick: string
Returns Promise<AsyncResult<BaseUserInfo[]>>

Const updateUserInfo

updateUserInfo(params: UpdateOwnUserInfoParams | ConfigurableKey, value?: any): Promise<AsyncResult<UpdateOwnUserInfoParams>>

Parameters
- params: UpdateOwnUserInfoParams | ConfigurableKey
- Optional value: any
Returns Promise<AsyncResult<UpdateOwnUserInfoParams>>

Const uploadPushToken

uploadPushToken(params: { deviceId: string; deviceToken: string; notifierName: string; error?: any; success?: any }): Promise<AsyncResult<UploadTokenResult>>

The app ID for the push service, which is the senderID for Firebase Cloud Messaging (FCM) and "appId+#+AppKey" for the vivo push service.

Parameters
- params: { deviceId: string; deviceToken: string; notifierName: string; error?: any; success?: any }
  - deviceId: string
    Gets the contact list.
    connection.getContacts()
  - deviceToken: string
    
    推送 token，用于标识相同的设备。用户可自定义该推送 token。
  - notifierName: string
    
    推送服务的 App ID，对于 Firebase Cloud Messaging (FCM) 是 senderId, 对于 VIVO 推送服务是 “appId+#+AppKey”。
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<UploadTokenResult>): void
    - Parameters
      - res: AsyncResult<UploadTokenResult>
      Returns void
Returns Promise<AsyncResult<UploadTokenResult>>

Agora Chat Web API Reference

Index

Functions

Functions

Const acceptContactInvite

Parameters

to: string

Returns void

addContact

Parameters

to: string

Optional message: string

Returns void

addReaction

Parameters

params: { messageId: string; reaction: string }

messageId: string

reaction: string

Returns Promise<void>

Const addUsersToBlocklist

Parameters

options: { name: string | string[] }

name: string | string[]

Returns void

Const declineContactInvite

Parameters

to: string

Returns void

deleteContact

Parameters

to: string

Returns void

Const deleteConversation

Parameters

params: { channel: string; chatType: "singleChat" | "groupChat"; deleteRoam: boolean; error?: any; success?: any }

channel: string

chatType: "singleChat" | "groupChat"

deleteRoam: boolean

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<DeleteSessionResult>

Returns void

Returns Promise<AsyncResult<DeleteSessionResult>>

deleteReaction

Parameters

params: { messageId: string; reaction: string }

messageId: string

reaction: string

Returns Promise<void>

fetchUserInfoById

Parameters

userId: string | string[]

Optional properties: ConfigurableKey | ConfigurableKey[]

Returns Promise<AsyncResult<UpdateOwnUserInfoParams>>

Const getBlocklist

Parameters

Optional params: { error?: any; success?: any }

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<string[]>

Returns void

Returns Promise<AsyncResult<UserId[]>>

getChatToken

Parameters

agoraToken: string

Returns Promise<any>

getContacts

Parameters

Optional params: { error?: any; success?: any }

error?:function

Parameters

error: ErrorEvent