调用SendMessage发送一条单聊或者群聊消息。

  • 支持文本、图片、语音、视频、文件、地理位置、@消息、回复、合并转发和自定义消息。
  • 支持单边消息等多种功能。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
AppId String apitest

AppId。IMPaaS租户的ID。

RequestParams Object

消息发送请求体。

Uuid String 8c086146-889e-4642-b3d9-17e97ae6****

消息UUID。业务方产生用于去重。

AppCid String $1$123:567

会话ID。单聊或群聊会话的ID。

ConversationType Integer 1

会话类型。取值:

  • 1:单聊会话。
  • 2:群聊会话。
SenderId String 950000010

消息发送者用户ID。

ContentType Integer 1

消息内容类型。取值:

  • 1:文本。
  • 2:图片。
  • 3:语音。
  • 4:视频。
  • 5:地理位置。
  • 8:群@消息。
  • 9:文件。
  • 10:回复消息。
  • 11: 消息合并转发。
  • 101:自定义消息。
Content String {"text":"hello world"}

消息内容。不同消息类型的消息内容格式请参见参数类型说明

Extensions Map

消息扩展字段。

String {"k1": "v1"}

扩展字段内容。

Options Object

消息选项。

RedPointPolicy Integer 0

未读消息红点控制。取值:

  • 0:增加红点。
  • 1:不增加红点。
    说明 可不填,默认值为0。
ReceiveScopeOption Object

消息的实时接收和拉消息控制。

说明 如果不传此参数,消息实时发给该会话的所有成员,并且所有成员都可拉到该条消息。
ReceiverIds Array of String ["950000011", 950000012"]

接收者ID列表。多个ID用英文逗号(,)分隔。

ExcludeReceiverIds Array of String ["950000010", 950000009"]

不接收者ID列表。多个ID用英文逗号(,)分隔。

ReceiveScope Integer 0

消息获取控制。

  • 0:会话内除指定ExcludeReceivers均可获取。
  • 1:会话内仅指定ReceiverIds可获取。
SingleChatCreateRequest Object

创建单聊会话的请求。单聊会话不存在时新建,仅用于自定义单聊。

AppCid String $3$123:567

单聊会话ID。

AppUids Array of String ["8100088", "8100089"]

用户ID列表。多个ID用英文逗号(,)分隔。

Extensions Map

单聊会话扩展信息。

String {"k1": "v1"}

扩展字段内容。

UserConversation Map

用户会话视图扩展信息。

Object

扩展字段内容。

UserExtensions Map

扩展字段内容。

String {"k1": "v1"}

扩展字段内容。

返回数据

名称 类型 示例值 描述
RequestId String yiepfjeqa

请求ID。

Code String 0

错误码。

Message String ""

错误信息。

Result object

返回业务对象。

MsgId String 28017165705.center_daily

发送成功的消息ID。

CreateTime Long 1609763319539

消息创建时间戳。单位:毫秒。

示例

请求示例

http(s)://[Endpoint]/?AppId=apitest
&RequestParams={
"Uuid":"8c086146-889e-4642-b3d9-17e97ae6e70e",
"AppCid":"$1$123:567",
"ConversationType":1,
"SenderId":"950000010",
"ContentType":1,
"Content":"{\"text\":\"hello world\",\"extensions\":{}}",
"Extensions":{"key":"{\"k1\": \"v1\"}"},
"Options":{
"RedPointPolicy":0,
"ReceiveScopeOption":{"ReceiverIds":["[\"950000011\", 950000012\"]"],
"ExcludeReceiverIds":["[\"950000010\", 950000009\"]"],
"ReceiveScope":0},
"SingleChatCreateRequest":{
"AppCid":"$3$123:567",
"AppUids":["[\"8100088\", \"8100089\"]"],
"Extensions":{"key":"{\"k1\": \"v1\"}"},
"UserConversation":{
"key":{
"UserExtensions":{"key":"{\"k1\": \"v1\"}"
}}}}}}
&公共请求参数

正常返回示例

XML格式

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

<RequestId>yiepfjeqa</RequestId>
<Code>0</Code>
<Message>""</Message>
<Result>
    <MsgId>28017165705.center_daily</MsgId>
    <CreateTime>1609763319539</CreateTime>
</Result>

JSON格式

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

{
  "RequestId" : "yiepfjeqa",
  "Code" : "0",
  "Message" : "\"\"",
  "Result" : {
    "MsgId" : "28017165705.center_daily",
    "CreateTime" : 1609763319539
  }
}

错误码

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