发送消息 (POST) - go-wechat-http

请求参数

Header 参数

Authorization

string

必需

认证Token，例如：Bearer YOUR_TOKEN

示例值:

Bearer YOUR_TOKEN

Content-Type

string

请求体的内容类型

必需

示例值:

application/json

Body 参数application/json

action

string

动作名称

必需

示例值:

send_message

params

object

SendMsgParams

必需

send_message 动作的参数

message_type

enum<string>

OneBotMessageType

可选

OneBot 消息类型 (私聊 'private', 群聊 'group')

枚举值:

privategroup

示例值:

private

user_id

string

可选

用户 ID (私聊时需要)

示例值:

wxid_xxxxxxxxxxxxxx

group_id

string

可选

群组 ID (群聊时需要)

示例值:

xxxxxxxxx@chatroom

message

array[object (MessageSegment) {2}]

必需

消息内容 (OneBot 标准的消息段数组)

示例值:

[{"type":"text","data":{"text":"这是一条测试消息。"}},{"type":"image","data":{"url":"http://example.com/image.jpg"}}]

auto_escape

boolean

可选

是否自动转义 (OneBot V11 字段)

示例值:

false

send_id

string

可选

发送者 ID (兼容字段，私聊时为用户 ID, 群聊时为群组 ID)。如果提供此字段，可不提供 message_type, user_id, group_id。

示例值:

wxid_zzzzzzzzzzzz

group_ids

array[string]

可选

群组标签 ID 列表。如果提供此字段，将向这些标签下的所有成员发送消息。

示例值:

["label_id_1","label_id_2"]

echo

string

原样返回字段

可选

示例值:

request_echo_123

示例

{
    "action": "send_message",
    "params": {
        "message_type": "private",
        "user_id": "wxid_xxxxxxxxxxxxxx",
        "message": [
            {
                "type": "text",
                "data": {
                    "text": "你好！"
                }
            }
        ],
        "auto_escape": false
    },
    "echo": "echo_private_text"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1:10614/send_message' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "send_message",
    "params": {
        "message_type": "private",
        "user_id": "wxid_xxxxxxxxxxxxxx",
        "message": [
            {
                "type": "text",
                "data": {
                    "text": "你好！"
                }
            }
        ],
        "auto_escape": false
    },
    "echo": "echo_private_text"
}'

返回响应

🟢200操作结果

application/json

Body

status

enum<string>

执行状态

必需

枚举值:

okfailed

示例值:

ok

retcode

integer <int64>

必需

返回码 (0 为成功, 其他为错误码，具体定义见 oneboterr 包)

示例值:

0

message

string

可选

错误信息 (仅在 status 为 'failed' 时有效)

示例值:

参数无效

echo

string

可选

原样返回的 echo 字段

示例值:

request_echo_123

data

object

MsgRespData

可选

发送消息成功时的响应数据

time

number <double>

时间戳

可选

示例值:

1678886400.123

message_id

string

可选

消息 ID (通常是虚拟生成的)

示例值:

abc-123-def-456

示例

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "message_id": "some-random-uuid",
        "time": 1625884293
    },
    "echo": "echo_private_text"
}