跳转到正文
消息类

上传合并转发消息

upload_forward_message:上传自定义合并转发正文(不发送消息)。

#define FORWARD_TARGET_FRIEND  1u
#define FORWARD_TARGET_GROUP   2u

const UploadForwardMessageResult *upload_forward_message(
    uint64_t self_id, const char *platform, uint32_t target_type, uint64_t target_id,
    const char *title, const char *summary,
    const char *const *preview, uint32_t preview_count,
    const char *messages_json);
void free_upload_forward_message_result(const UploadForwardMessageResult *result);
  • 权限:upload_forward_message
  • 调用要求:需要账号在线,请在工作线程中调用

参数

参数类型必填说明
self_iduint64_t是在线 Bot QQ 号,不能为 0
platformconst char *是所属平台 PLATFORM_*
target_typeuint32_t是FORWARD_TARGET_FRIEND(1)或 FORWARD_TARGET_GROUP(2)
target_iduint64_t是好友 QQ 号或群号,不能为 0;好友目标找不到信息时失败
titleconst char *是非空 UTF-8 标题(最多 1024 字节)
summaryconst char *否摘要(最多 1024 字节),不显示可传 "" 或 NULL
preview / preview_countconst char *const * / uint32_t否预览文案数组(最多 20 条,每条最多 1024 字节);不需要时传 NULL, 0
messages_jsonconst char *是UTF-8 JSON 数组,每条记录含 nickname(必填,最多 128 字节,显示带 "[自定义]" 前缀)与 message 消息段数组;每组至少 1 条,嵌套最多 2 层,每条文本合计最多 8192 字节

使用限制

  • 每条记录的 nickname 必填且最多 128 字节,显示时自动带 "[自定义]" 前缀,不接受他人的账号标识。
  • 任一输入无效则整个上传直接失败,不执行上传。
  • 嵌套引用已有转发:取同一账号、平台和目标的 upload_forward_message 结果中 result->message 数组中唯一的 forward 对象,原样放入当前记录的 message 数组——不要传入整个结果数组、只传 res_id,或自行添加 user_id。

返回值 UploadForwardMessageResult

成功后将 result->message 原样传给 send_friend_message 或 send_group_message(同一账号、平台和目标,需对应发送权限)。用完必须调用 free_upload_forward_message_result(result) 交还。

字段类型说明
codeint32_t0 表示成功;失败为 RESULT_LOCAL_ERROR
errorconst char *失败原因
res_idconst char *合并转发资源 ID
messageconst char *含一条 forward 段的 JSON 数组(data.count 为顶层条数)

本页目录