发送群消息

POST

/apps/v1/robot/chats/{chat_id}/message

接口描述：企业应用在开启机器人功能后可以通过接口发送群消息。
请求地址：https://service.cheng-xun.cn/api/apps/v1/robot/chats/{chat_id}/message?access_token={access_token}
请求方式：POST

请求参数

Authorization

Path 参数

chat_id

string

必需

Query 参数

access_token

string

必需

组织应用 access token

Header 参数

User-Agent

string

可选

默认值:

Body 参数application/json

消息内容

msg_type

enum<string>

消息类型

必需

TEXT：文本消息；CARD：文本卡片消息；TEXT 则传递 text 参数，CARD 则传递 card 参数

枚举值:

TEXTCARD

text

object (ChatTextMessageDTO)

文本消息

可选

消息内容

content

string

消息内容

必需

文本消息内容

>= 1 字符<= 1500 字符

reminder

object (ChatTextReminder)

消息提醒信息

已废弃

消息内容

card

object (ChatCardMessageDTO)

卡片消息

可选

消息内容

title

string

标题

可选

不超过50个字符，超出则报错，超出一行则折行显示，最多显示2行，超出2行则自动截断

>= 0 字符<= 50 字符

description

string

描述

可选

不超过1000个字符，超出则报错，支持一些HTML基本标签，如加粗, 换行

>= 0 字符<= 1000 字符

link_name

string | null

链接名称

可选

不超过10个字符，超出则报错

<= 10 字符

link_url

string | null

链接URL

可选

链接URL

示例

{
    "msg_type": "TEXT",
    "text": {
        "content": "string",
        "reminder": {
            "staff_ids": [
                0
            ],
            "all": true
        }
    },
    "card": {
        "title": "string",
        "description": "string",
        "link_name": "string",
        "link_url": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://service.cheng-xun.cn/api/apps/v1/robot/chats//message?access_token' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msg_type": "TEXT",
    "text": {
        "content": "string",
        "reminder": {
            "staff_ids": [
                0
            ],
            "all": true
        }
    },
    "card": {
        "title": "string",
        "description": "string",
        "link_name": "string",
        "link_url": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

ResponseDTO

err_code

integer

可选

err_msg

string

可选

默认值:

ErrorCode.SUCCESS.getErrMsg()

示例

{
  "errCode": 0,
  "errMsg": ""
}

修改于 2025-04-01 02:36:03

查询机器人创建的群列表

给指定用户发送消息

发送群消息

接口描述：企业应用在开启机器人功能后可以通过接口发送群消息。请求地址：https://service.cheng-xun.cn/api/apps/v1/robot/chats/{chat_id}/message?access_token={access_token} 请求方式：POST#

请求参数

示例代码

返回响应

接口描述：企业应用在开启机器人功能后可以通过接口发送群消息。
请求地址：https://service.cheng-xun.cn/api/apps/v1/robot/chats/{chat_id}/message?access_token={access_token}
请求方式：POST