添加快捷评论 - 即时通信

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

operator_id

string

必需

进行添加快捷评论操作的用户账号 ID。

message

object

被指定的消息对象。

必需

conversation_type

integer

必需

会话类型。1：单聊；2：高级群；3：超大群。

sender_id

string

必需

消息的发送者 ID。

receiver_id

string

必需

消息的接收者 ID。

message_server_id

number

必需

消息的服务器 ID。

message_client_id

string

必需

消息的客户端 ID。

create_time

number

消息的发送时间。

必需

extension

string

可选

快捷评论的扩展字段，JSON 格式。例如："{"k":"v"}"。
该字段长度上限以使用的 IM 套餐为准；IM 旗舰版及以上套餐才支持配置字段上限。

index

number

必需

快捷评论类型，必须大于 0。可在本地自定义映射关系，例如：
表情回复。1：笑脸。2：大笑。UI 层根据 index 展示对应的表情。
文本快捷回复等其他回复场景。

push_config

object

推送相关配置项。

可选

push_enabled

boolean

可选

该消息是否需要 APNs 推送或 Android 系统通知栏推送，默认为 true（推送）。只有该字段为 true 时，推送相关参数才会生效。

push_content

string

可选

推送文案，长度上限 500 位字符。如果不填，则使用默认推送文案。

push_payload

string

可选

推送对应的 payload，必须是 JSON 格式，长度上限 2048 位字符。详情请参考推送 payload 配置。

示例

{
  "operator_id": "string",
  "message": {
    "conversation_type": 0,
    "sender_id": "string",
    "receiver_id": "string",
    "message_server_id": 0,
    "message_client_id": "string",
    "create_time": 0
  },
  "extension": "string",
  "index": 0,
  "push_config": {
    "push_enabled": true,
    "push_content": "string",
    "push_payload": "string"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/messages/actions/quick_comment' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

code

integer

必需

状态码，200 表示请求成功。

msg

string

必需

提示信息。请求失败时返回错误信息，请求成功时返回 "success"。

data

object

必需

返回的 JSON 数据对象，请求失败则返回空对象。

time

number

必需

添加快捷评论的服务器时间。

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "time": 0
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误