文档中心

消息表情回复（“Reaction”）指用户在单聊和群聊场景中对单条消息回复表情，可丰富用户聊天时的互动方式。

本页介绍如何使用即时通讯 IM RESTful API 实现 Reaction 功能。

#前提条件

要调用环信即时通讯 RESTful API，请确保满足以下要求：

• 已在环信即时通讯云控制台 开通配置环信即时通讯 IM 服务。
• 已从服务端获取 app token，详见 使用 App Token 鉴权。
• 了解环信 IM RESTful API 的调用频率限制，详见 接口频率限制。

#公共参数

#请求参数

#认证方式

环信即时通讯 REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，必须在请求头部填入如下 Authorization 字段：

Authorization: Bearer YourAppToken

为提高项目的安全性，环信使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 RESTful API 仅支持使用 app token 的鉴权方式，详见 使用 App Token 鉴权。

#创建/追加 Reaction

在单聊或群聊场景中对单条消息创建或追加 Reaction。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/reaction/user/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

其他字段及描述详见 公共参数。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 响应状态码 了解可能的原因。

#示例

#请求示例

curl -g -X POST 'https://localhost:8089/easemob-demo/easeim/reaction/user/e1' -H 'Authorization: 

Bearer <YourAppToken>' -H 'Content-Type: application/json' --data-raw '{
    "msgId":"997625372793113144",
    "message":"emoji_40"
}' 

#响应示例

{ "requestStatusCode": "ok", "timestamp": 1645774821181, "data": { "id": "946481033434607420", "msgId": 

"msg3333", "msgType": "chat", "groupId": null, "reaction": "message123456", "createdAt": "2022-02-24T10:

57:43.138934Z", "updatedAt": "2022-02-24T10:57:43.138939Z" } } 

#根据消息 ID 获取 Reaction

该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息，包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。获取的 Reaction 的用户列表只展示最早三个添加 Reaction 的用户。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/reaction/user/{username}?msgIdList={N,M}&msgType={msgType}&groupId={groupId}

#路径参数

参数及描述详见 公共参数。

#查询参数

#请求 header

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 响应状态码 了解可能的原因。

#示例

#请求示例

curl -g -X GET 'https://localhost:8089/easemob-demo/easeim/reaction/user/{{userId}}?msgIdList=msgId1&m

sgType=chat' -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "requestStatusCode": "ok", "timestamp": 1645774821181, "data": [ { "msgId": "msg123", "reactionLis

t": [ { "reactionId": "944330310986837168", "reaction": message123456, "count": 0, "state": false, 

"userList": [ "test123", "test456", "test1" ] } ] }, { "msgId": "msg1234", "reactionList": [ { "reactionId":

 "945272584050659838", "reaction": message123456, "count": 0, "state": false, "userList": [ "test5" ] } ] } ] } 

#删除 Reaction

删除当前用户追加的 Reaction。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/reaction/user/{username}?msgId={msgId}&message={message}

#路径参数

参数及描述详见 公共参数。

#请求 header

#查询参数

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 响应状态码 了解可能的原因。

#示例

#请求示例

curl -g -X DELETE 'https://localhost:8089/easemob-demo/easeim/reaction/user/wz?msgId=997625372793

113144&message=emoji_40' -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "requestStatusCode": "ok", "timestamp": 1645774821181 } 

#根据消息 ID 和表情 ID 获取 Reaction 信息

该方法根据指定的消息的 ID 和表情 ID 获取对应的 Reaction 信息，包括使用了该 Reaction 的用户 ID 及用户人数。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/reaction/user/{username}/detail?msgId={msgId}&message={message}&limit={limit}&cursor={cursor}

#路径参数

参数及描述详见 公共参数。

#查询参数

#请求 header

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

其他字段及描述详见 公共参数。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 响应状态码 了解可能的原因。

#示例

#请求示例(第一页)

curl -g -X GET 'https://localhost:8089/easemob-demo/easeim/reaction/user/wz/detail?msgId=99762778773075000

8&message=emoji_40&limit=50' -H 'Authorization: Bearer <YourAppToken>' 

#请求示例(第 N 页)

curl -g -X GET 'https://localhost:8089/easemob-demo/easeim/reaction/user/wz/detail?msgId=997627787730750008

&message=emoji_40&cursor=944330529971449164&limit=50' -H 'Authorization: Authorization: Bearer <YourAppToken>' 

#响应示例

{ "requestStatusCode": "ok", "timestamp": 1645776986146, "data": { "reactionId": "946463470818405943", "reaction":

 "message123456", "count": 1, "state": true, "userList": ["wz1"], "cursor": "946463471296555192" } }