文档

SendCustomMessageToUsers - 指定房间成员发送自定义消息

更新时间:

调用SendCustomMessageToUsers向房间中的指定成员发送自定义消息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:SendCustomMessageToUsersWrite
  • IMP
    acs:imp:*:{#accountId}:*

请求参数

名称类型必填描述示例值
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间的唯一标识,在调用CreateRoom时返回。

AE35-****-T95F
Bodystring

自定义消息体的内容,大小不超过2048个字节。

Hello, World
ReceiverListarray

自定义消息的接收人用户ID列表,最大长度不超过100。

string

自定义消息的接收人用户ID列表。最多可输入100个用户ID。

["34**29"]

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

调用指定房间成员发送自定义消息的返回结果。

MessageIdstring

自定义消息的唯一ID标识。由数字、大小写字母组成,最大长度20个字符。

0io**Fs6Q384

示例

请求示例

http(s)://[Endpoint]/?Action=SendCustomMessageToUsers
&AppId=7m***q
&RoomId=AE35-****-T95F
&Body=Hello, World
&ReceiverList=["34**29"]
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "MessageId": "0io**Fs6Q384"
    }
}

XML格式

<SendCustomMessageToUsersResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <MessageId>0io**Fs6Q384</MessageId>
    </Result>
</SendCustomMessageToUsersResponse>

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)