调用SendCustomMessage给房间里的所有成员发送一条自定义消息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SendCustomMessage

系统规定参数。取值:SendCustomMessage

Request Object

请求参数的结构体。

Domain String 7m***q

应用的appKey。

RoomId String 9645**c180a1

房间ID,由调用CreateRoom时返回。

SenderId String 62**59

消息的发送者ID。

SubType Integer 100001

消息的类型,由业务自定义,请传递100000以上。

Body String Hello,World

消息体。

返回数据

名称 类型 示例值 描述
RequestId String FE22D613-D3C6-4A58-87CA-F21FC85AA08E

请求ID。

ResponseSuccess Boolean true

请求是否成功。

ErrorCode String 1000

错误码,请求异常时返回。

ErrorMessage String internal error

错误信息,请求异常时返回。

Result Object

请求的返回结果。

MessageId String 0io**Fs6Q384

消息的唯一ID标识。由数字、大小写字母组成,长度不超过20。

示例

请求示例

http(s)://[Endpoint]/?Action=SendCustomMessage
&Request={"Domain":"7m***q","RoomId":"9645**c180a1","SenderId":"62**59","SubType":100001,"Body":"Hello,World"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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