有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: lcic.tencentcloudapi.com 。

1、按照指定身份发送消息,目前支持表情消息、图片消息、文本消息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SendRoomNormalMessage。
Version String 公共参数,本接口取值:2022-08-17。
Region String 公共参数,此参数为可选参数。
SdkAppId Integer 低代码互动课堂的SdkAppId。
示例值:12222
RoomId Integer 房间ID。
示例值:1212457
FromAccount String 管理员指定消息发送方账号(若需设置 FromAccount 信息,则该参数取值不能为空)
示例值:2WqeRoOMJKQqnnL1lILRFHpdFla
MsgBody.N Array of MsgBody 自定义消息
CloudCustomData String 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)。
示例值:your cloud custom data
NickName String 昵称,当FromAccount没有在房间中,需要填写NickName,当FromAccount在房间中,填写NickName无意义
示例值:菲菲

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 指定用户给房间中发送消息

输入示例

POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendRoomNormalMessage
<公共请求参数>

{
    "SdkAppId": 3520371,
    "RoomId": 352320437,
    "FromAccount": "2WqeRoOMJKQqnnL1lILRFHpdFla",
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "TextMsgContent": {
                "Text": "abc"
            },
            "FaceMsgContent": {
                "Index": 1,
                "Data": "abc"
            },
            "ImageMsgContent": {
                "UUID": "494d1feab",
                "ImageFormat": 1,
                "ImageInfoList": [
                    {
                        "Type": 1,
                        "Size": 12033,
                        "Width": 2048,
                        "Height": 800,
                        "URL": "https://grg-1258699.cos.ap-shanghai.myqcloud.com/room_messages.png"
                    }
                ]
            }
        }
    ],
    "CloudCustomData": "abcsd"
}

输出示例

{
    "Response": {
        "RequestId": "abee5f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.GroupNotExist 群组不存在
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。