Eyun 开发者文档

Appearance

POST{BASE_URL}/wx-api/api/message/sendRichText
写操作消息JSON · Bearer App Token · body appid

发送富文本消息 ​

发送带表情、@ 成员的富文本；群聊 @ 功能通过本接口实现。

请求参数 ​

参数必填类型说明
appid是string实例 appid，标识操作哪个已登录账号。示例：we_xxxxxxxxxxxxxxx
conversationId是int64会话 id：单聊传对方 userId，群聊传 roomId，给自己发传当前账号 uin；必须是 JSON number。示例：1688855874759204
content是array<object>消息内容，子字段见下。示例：[{"type":0,"text":"你好 "},{"type":3,"text":"[愉快]"},{"type"…
content[] 字段
字段类型说明
content[].typeint640 纯文本、3 表情（如 [愉快]）、5 @提及；带 userId 表示 @某人，不带 userId 表示 @所有人
content[].textstringtype 0/3 的文本内容

请求示例 ​

http
POST {BASE_URL}/wx-api/api/message/sendRichText
Authorization: Bearer <你的 App Token>
Content-Type: application/json

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "conversationId": 1688855874759204,
  "content": [
    {
      "type": 0,
      "text": "你好 "
    },
    {
      "type": 3,
      "text": "[愉快]"
    },
    {
      "type": 5
    },
    {
      "type": 5,
      "userId": 1688855319807969
    },
    {
      "type": 0,
      "text": " 测试一下"
    }
  ]
}
bash
curl -X POST '{BASE_URL}/wx-api/api/message/sendRichText' \
  -H 'Authorization: Bearer <你的 App Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "appid": "we_xxxxxxxxxxxxxxx",
  "conversationId": 1688855874759204,
  "content": [
    {
      "type": 0,
      "text": "你好 "
    },
    {
      "type": 3,
      "text": "[愉快]"
    },
    {
      "type": 5
    },
    {
      "type": 5,
      "userId": 1688855319807969
    },
    {
      "type": 0,
      "text": " 测试一下"
    }
  ]
}'
python
import requests

url = "{BASE_URL}/wx-api/api/message/sendRichText"
headers = {"Authorization": "Bearer <你的 App Token>", "Content-Type": "application/json"}
body = """{
  "appid": "we_xxxxxxxxxxxxxxx",
  "conversationId": 1688855874759204,
  "content": [
    {
      "type": 0,
      "text": "你好 "
    },
    {
      "type": 3,
      "text": "[愉快]"
    },
    {
      "type": 5
    },
    {
      "type": 5,
      "userId": 1688855319807969
    },
    {
      "type": 0,
      "text": " 测试一下"
    }
  ]
}"""

resp = requests.post(url, headers=headers, data=body.encode("utf-8"))
print(resp.text)
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String url = "{BASE_URL}/wx-api/api/message/sendRichText";
String body = "{\n" +
    "  \"appid\": \"we_xxxxxxxxxxxxxxx\",\n" +
    "  \"conversationId\": 1688855874759204,\n" +
    "  \"content\": [\n" +
    "    {\n" +
    "      \"type\": 0,\n" +
    "      \"text\": \"你好 \"\n" +
    "    },\n" +
    "    {\n" +
    "      \"type\": 3,\n" +
    "      \"text\": \"[愉快]\"\n" +
    "    },\n" +
    "    {\n" +
    "      \"type\": 5\n" +
    "    },\n" +
    "    {\n" +
    "      \"type\": 5,\n" +
    "      \"userId\": 1688855319807969\n" +
    "    },\n" +
    "    {\n" +
    "      \"type\": 0,\n" +
    "      \"text\": \" 测试一下\"\n" +
    "    }\n" +
    "  ]\n" +
    "}";

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create(url))
    .header("Authorization", "Bearer <你的 App Token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
php
<?php

$url = '{BASE_URL}/wx-api/api/message/sendRichText';
$body = <<<'JSON'
{
  "appid": "we_xxxxxxxxxxxxxxx",
  "conversationId": 1688855874759204,
  "content": [
    {
      "type": 0,
      "text": "你好 "
    },
    {
      "type": 3,
      "text": "[愉快]"
    },
    {
      "type": 5
    },
    {
      "type": 5,
      "userId": 1688855319807969
    },
    {
      "type": 0,
      "text": " 测试一下"
    }
  ]
}
JSON;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer <你的 App Token>',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

响应示例 ​

响应结构与发送文本消息相同

成功时 data 就是刚发出的完整消息，字段见发送文本消息的响应示例。data.content 回显你发送的内容或上传字段，形状随消息类型不同，见消息模块总览的码表。

响应字段 ​

字段类型说明
codeint64统一封套状态码：0=成功，负数=失败
detailstring附加明细，通常为空
messagestring文案：成功为 ok；失败形如 -码|描述
timestring服务端处理时间 YYYY-MM-DD HH:MM:SS

常见错误 ​

下表为企微错误码。业务失败时顶层 code=-1，具体错误码在 message 的 | 前，例如 -3004|参数错误；鉴权与网关错误见错误码。

错误码含义怎么办
-4014过期或错误的 uin 作 conversationId先 personal/getInfo 取当前 uin
-3020用自聊伪房间 roomId 作发送目标给自己发用当前账号 uin
-3004参数错误检查字段名与类型，数字 id 不能传字符串

下一步 ​