添加消息表情回复

对活跃消息会话中的某条消息添加表情回复。

使用限制

WhatsApp在线咨询 消息渠道支持此操作。

请求 URL

POST {base_url}/{api_path}/message/reaction?access_token={access_token}

请求参数

参数 是否必填 类型 说明
emoji String 要添加的表情符号。
注: 可使用 获取菜单选项 接口查询可用的表情符号 (menu=emoji)。
msg_id Integer 要回复表情的消息的 ID。
注: 可使用 查询单个消息会话的消息 接口查询具体消息的 ID。
sender_type Integer 发送者的类型。
取值范围
  • 1:分机用户。
  • 9:第三方分析平台 (消息通过二次开发接口传递)
sender_no String 发送者的标识。
取值范围
  • 此参数在 sender_type 设为 1 时必填,用于指定分机号码。
  • sender_type 设为 9,可设置此参数为 api 或留空。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。

示例

请求示例
提示: 如需移除表情回复,使用相同 emojimsg_id 再次调用此接口即可。若该表情回复已存在,则会被移除。
POST /openapi/v1.0/message/reaction?access_token=YFDLCQxMq0oHzKNRQpMunoFU1NLaSP3f HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "emoji": "👍",
    "msg_id": 123,
    "sender_no": "3200",
    "sender_type": 1
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}