跳转至

消息发送

信息提示

通过 Server API 发送融云内置消息或已注册的自定义消息时,客户端收到消息后是否存储、计数,以融云内置消息或注册自定义消息时是否存储(ISPERSISTED)、是否计数(ISCOUNTED)设置为准。

融云的内置消息以 JSON 方式进行数据序列化,如果你需要扩展消息可以使用任意方式扩展,不限于 JSON。详见融云内置消息结构详解

单聊

消息发送

说明:一个用户向另外一个用户发送消息,单条消息最大 128k。

方法名:/message/private/publish

发送频率:单个应用每分钟最多发送 6000 条信息,每次接收消息的用户上限为 1000 人,如:一次发送给 1000 人时,示为 1000 条消息。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/private/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toUserId String 接收用户 Id,可以实现向多人发送消息,每次上限为 1000 人。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。 如果为自定义消息,则 pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。(可选)
pushData String 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
count Int 针对 iOS 平台,Push 时用来控制未读消息显示数,只有在 toUserId 为一个用户 Id 的时候有效,客户端获取远程推送内容时为 badge 查看详细,为 -1 时不改变角标数,传入相应数字表示把角标数改为指定的数字,最大不超过 9999。(可选)
verifyBlacklist Int 是否过滤接收用户黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0 不过滤。(可选)
isPersisted Int 针对融云服务端是否存储此条消息,客户端则根据消息注册的 ISPERSISTED 标识判断是否存储,如果旧版客户端上未注册该消息时,收到该消息后默认为存储,但无法解析显示。0 表示为不存储、 1 表示为存储,默认为 1 存储消息。(可选)
isIncludeSender Int 发送用户自己是否接收消息,0 表示为不接收,1 表示为接收,默认为 0 不接收,只有在 toUserId 为一个用户 Id 的时候有效。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName 为自定义消息类型时,content 需要自己解析呈现。pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。

示例

Request:

POST /message/private/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&toUserId=2193&toUserId=2192&objectName=RC:TxtMsg&pushContent=thisisapush&pushData=%7B%22pushData%22%3A%22hello%22%7D&count=4&verifyBlacklist=0&isPersisted=1&isIncludeSender=0

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

模板消息发送

说明:一个用户向多个用户发送不同消息内容,单条消息最大 128k。

方法名:/message/private/publish_template

发送频率:单个应用每分钟最多发送 6000 条信息,每次接收消息的用户上限为 1000 人。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/private/publish_template.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

请注意:发送请求时 HTTP Request Header 中的 Content-Type 类型必须为 application/json

示例

Request:

POST /message/private/publish_template.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "fromUserId":"fromuser",
    "objectName":"RC:TxtMsg",
    "content":"{\"content\":\"{c}{d}{e}\",\"extra\":\"bb\"}",
    "toUserId":["21","22"],
    "values":[{"{c}":"1","{d}":"2","{e}":"3"},{"{c}":"4","{d}":"5","{e}":"6"}],
    "pushContent":["push{c}","push{c}"],
    "pushData":["pushd","pushd"],
    "verifyBlacklist":0
}

参数说明

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toUserId String[] 接收用户 Id,提供多个本参数可以实现向多人发送消息,上限为 1000 人。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
values String[] 消息内容中,标识位对应内容。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String[] 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。如果为自定义消息,定义显示的 Push 内容,内容中定义标识通过 values 中设置的标识位内容进行替换。如消息类型为自定义不需要 Push 通知,则对应数组传空值即可。(必传)
pushData String[] 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
verifyBlacklist Int 是否过滤发送人黑名单列表,0 为不过滤、 1 为过滤,默认为 0 不过滤。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

提示

上面示例中用户 Id 为 21 的用户,收到信息为 123,上面示例中用户 Id 为 22 的用户,收到信息为 456

注意,如 content 中定义了标识 {d} ,则在 values 中需要对 {d} 进行设置,否则 {d} 会以文本方式随消息一起发送给用户。toUserIdvaluespushContentpushData 的数量必须相等。

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName为自定义消息类型时,content需要自己解析呈现。pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。

状态消息发送

说明:向目标用户发送消息时,只有用户在线时会收到此条消息,如当前未在线则不会再收到此条消息,状态消息不计数、不存储,单条消息最大 128k。

方法名:/statusmessage/private/publish

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/statusmessage/private/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toUserId String 接收用户 Id,可以实现向多人发送消息,每次上限为 1000 人。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,参考融云消息类型表.示例说明;如果 objectName 为自定义消息类型,该参数可自定义格式。(必传)
verifyBlacklist Int 是否过滤发送人黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0 不过滤。(可选)
isIncludeSender Int 发送用户自己是否接收消息,0 表示为不接收,1 表示为接收,默认为 0 不接收。(可选)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /statusmessage/private/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408706337
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content={\"content\":\"c#hello\"}&fromUserId=2191&toUserId=2191&toUserId=2192&objectName=RC:TxtMsg

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

系统

消息发送

说明:一个用户向一个或多个用户发送系统消息,单条消息最大 128k,会话类型为 SYSTEM。

方法名:/message/system/publish

发送频率:单个应用每秒钟最多发送 100 条消息,每次最多同时向 100 人发送,如:一次发送 100 人时,示为 100 条消息。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/system/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toUserId String 接收用户Id,提供多个本参数可以实现向多用户发送系统消息,上限为 100 人。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。 如果为自定义消息,则 pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。(可选)
pushData String 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
isPersisted Int 针对融云服务端是否存储此条消息,客户端则根据消息注册的 ISPERSISTED 标识判断是否存储,如果旧版客户端上未注册该消息时,收到该消息后默认为存储,但无法解析显示。0 表示为不存储、 1 表示为存储,默认为 1 存储消息。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName为自定义消息类型时,content需要自己解析呈现。pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。

示例

Request:

POST /message/system/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&toUserId=2191&toUserId=2192&objectName=RC:TxtMsg&pushContent=thisisapush&pushData%22%3A%22hello%22%7D

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

模板消息发送

说明:一个用户向一个或多个用户发送系统消息,单条消息最大 128k,会话类型为 SYSTEM。

方法名:/message/system/publish_template

发送频率:单个应用每秒钟最多发送 100 条消息,每次最多同时向 100 人发送,如:一次发送 100 人时,示为 100 条消息。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/system/publish_template.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

请注意:发送请求时 HTTP Request Header 中的 Content-Type 类型必须为 application/json

示例

Request:

POST /message/system/publish_template.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "fromUserId":"fromuser",
    "objectName":"RC:TxtMsg",
    "content":"{\"content\":\"{c}{d}{e}\",\"extra\":\"bb\"}",
    "toUserId":["21","22"],
    "values":[{"{c}":"1","{d}":"2","{e}":"3"},{"{c}":"4","{d}":"5","{e}":"6"}],
    "pushContent":["push{c}","push{c}"],
    "pushData":["pushd","pushd"]
}

参数说明

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toUserId String 接收用户 Id,提供多个本参数可以实现向多人发送消息,上限为 100 人。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
values String 消息内容中,标识位对应内容。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。如果为自定义消息,定义显示的 Push 内容,内容中定义标识通过 values 中设置的标识位内容进行替换。如消息类型为自定义不需要 Push 通知,则对应数组传空值即可。(必传)
pushData String 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

提示

上面示例中用户 Id 为 21 的用户,收到信息为 123,上面示例中用户 Id 为 22 的用户,收到信息为 456

注意,如 content 中定义了标识 {d} ,则在 values 中需要对 {d} 进行设置,否则 {d} 会以文本方式随消息一起发送给用户。toUserIdvaluespushContentpushData 的数量必须相等。

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName为自定义消息类型时,content需要自己解析呈现。pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。

群组

消息发送

说明:以一个用户身份向群组发送消息,单条消息最大 128k。

方法名:/message/group/publish

发送频率:单个应用每秒钟最多发送 20 条消息,每次最多向 3 个群组发送,如:一次向 3 个群组发送消息,示为 3 条消息。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/group/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id 。(必传)
toGroupId String 接收群 Id,提供多个本参数可以实现向多群发送消息,最多不超过 3 个群组。(必传)
toUserId String 群定向消息功能,向群中指定的一个或多个用户发送消息,群中其他用户无法收到该消息,当 toGroupId 为一个群组时此参数有效。注:如果开通了单群聊消息云存储功能,群定向消息不会存储到云端,向群中部分用户发送消息阅读状态回执时可使用此功能。(可选)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。 如果为自定义消息,则 pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。(可选)
pushData String 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
isPersisted Int 针对融云服务端是否存储此条消息,客户端则根据消息注册的 ISPERSISTED 标识判断是否存储,如果旧版客户端上未注册该消息时,收到该消息后默认为存储,但无法解析显示。0 表示为不存储、 1 表示为存储,默认为 1 存储消息。(可选)
isIncludeSender Int 发送用户自己是否接收消息,0 表示为不接收,1 表示为接收,默认为 0 不接收,只有在 toGroupId 为一个群组 Id 的时候有效。(可选)
isMentioned Int 是否为 @消息,0 表示为普通消息,1 表示为 @消息,默认为 0。当为 1 时 content 参数中必须携带 mentionedInfo @消息的详细内容。为 0 时则不需要携带 mentionedInfo。当指定了 toUserId 时,则 @ 的用户必须为 toUserId 中的用户。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

mentionedInfo 在 content 中 JSON 格式如下:

{
  "content":"@张三 c#hello",
  "mentionedInfo":{
    "type":2,
    "userIdList":["123","456"],
    "mentionedContent":"有人@你"
  }
}

mentionedInfo 参数说明:

名称 类型 说明
type int @ 功能类型,1 表示 @ 所有人、2 表示 @ 指定用户。(必传)
userIdList String[] 指定用户列表,type 为 2 时有效,为 1 时 userIdList 可以为空。(非必传)
mentionedContent String @ 消息的自定义 Push 内容。(非必传)

消息发送示例

Request:

POST /message/group/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&toGroupId=2193&toGroupId=2192&objectName=RC:TxtMsg&pushContent=thisisapush&pushData%22%3A%22hello%22%7D&isPersisted=1&isIncludeSender=0

群定向消息

Request:

POST /message/group/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

fromUserId=b5NwvIrW8&toGroupId=2MqOJa1Un&toUserId=LaQFXO4gw&toUserId=LaQFXO4g2&objectName=RC:TxtMsg&content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D

群 @ 消息

Request:

POST /message/group/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22%40%E5%BC%A0%E4%B8%89+c%23hello%22%2C%22mentionedInfo%22%3A%7B%22type%22%3A1%2C+%22userIdList%22%3A%5B%22123%22%2C%22456%22%5D%2C%22mentionedContent%22%3A%22%E6%9C%89%E4%BA%BA%40%E4%BD%A0%22%7D%7D&fromUserId=2191&toGroupId=2193&toGroupId=2192&objectName=RC:TxtMsg&pushContent=thisisapush&isPersisted=1&isIncludeSender=0&isMentioned=1

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName为自定义消息类型时,content需要自己解析呈现。pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。

群组状态消息

说明:向群组中发送消息,当前群组中在线用户会收到此条消息,离线用户不会再收到此条消息,状态消息不计数、不存储,单条消息最大 128k。

方法名:/statusmessage/group/publish

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/statusmessage/group/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id 。(必传)
toGroupId String 接收群Id,提供多个本参数可以实现向多群发送消息,最多不超过 3 个群组。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,参考融云消息类型表.示例说明;如果 objectName 为自定义消息类型,该参数可自定义格式。(必传)
verifyBlacklist Int 是否过滤发送人黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0 不过滤。(可选)
isIncludeSender Int 发送用户自己是否接收消息,0 表示为不接收,1 表示为接收,默认为 0 不接收。(可选)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /statusmessage/group/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408706337
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content={\"content\":\"c#hello\"}&fromUserId=2191&toGroupId=2193&toGroupId=2192&objectName=RC:TxtMsg&isIncludeSender=0

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

聊天室

消息发送

说明:一个用户向聊天室发送消息,单条消息最大 128k。

方法名:/message/chatroom/publish

调用频率:单个应用每秒钟限 100 条,同时向 10 个聊天室发送消息视为 10 条,如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/chatroom/publish.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
toChatroomId String 接收聊天室 Id,提供多个本参数可以实现向多个聊天室发送消息,建议最多不超过 10 个聊天室。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

objectName为自定义消息类型时,content需要自己解析呈现。

示例

Request:

POST /message/chatroom/publish.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&toChatroomId=2192&toChatroomId=2193&objectName=RC:TxtMsg

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

广播消息

说明:向应用中的所有聊天室发送一条消息,单条消息最大 128k。

提示

此服务在开通 IM 商用版的情况下,可申请开通,详细请联系商务,电话:13161856839。

方法名:/message/chatroom/broadcast

调用频率:单个应用每秒最多调用 1 次。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/chatroom/broadcast.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /message/chatroom/broadcast.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&objectName=RC:TxtMsg

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

全局广播消息

说明:向 App 中的所有用户发送一条消息,单条消息最大 128k,会话类型为 SYSTEM。

提示

该功能开发环境下可免费使用。生产环境下,需要在开发者后台高级功能设置中开通 IM 商用版后,在“广播消息和推送”中,开启后才能使用。

为满足开发者更多的发送要求,广播消息方法进行了升级,建议使用广播推送服务中的广播消息方法进行推送,/message/broadcast 方法仍然可以使用。

方法名:/message/broadcast

调用频率:单个应用每小时只能发送 2 次,每天最多发送 3 次。如需要调整发送频率,可联系销售,电话 13161856839。

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/broadcast.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送消息内容,内置消息以 JSON 方式进行数据序列化,详见融云内置消息结构详解;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。(必传)
pushContent String 定义显示的 Push 内容,如果 objectName 为融云内置消息类型时,则发送后用户一定会收到 Push 信息。 如果为自定义消息,则 pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。(可选)
pushData String 针对 iOS 平台为 Push 通知时附加到 payload 中,客户端获取远程推送内容时为 appData 查看详细,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
os String 针对操作系统发送 Push,值为 iOS 表示对 iOS 手机用户发送 Push ,为 Android 时表示对 Android 手机用户发送 Push ,如对所有用户发送 Push 信息,则不需要传 os 参数。(可选)
contentAvailable Int 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行,查看详细。1 表示为开启,0 表示为关闭,默认为 0(可选)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

提示

objectName 为自定义消息类型时,content 需要自己解析呈现,需要 Push 时 pushContent 必须填写。

示例

Request:

POST /message/broadcast.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&objectName=RC:TxtMsg&pushContent=thisisapush&pushData=%7B%22pushData%22%3A%22hello%22%7D&os=iOS

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

携带用户信息

如果需要在发送消息时携带用户信息并在客户端显示,可以在 JSON 中加入用户数据 user,下面是以文本消息类型为例携带用户信息发送:

JSON 格式

{
  "content":"hello",
  "user":
  {
    "id":"4242",
    "name":"Robin",
    "icon":"http://example.com/p1.png",
    "extra":"extra"
  },
  "extra":"helloExtra"
}

user 参数说明

名称 类型 说明
id String 发送人用户 Id,需要和 fromUserId 保持一致。
name String 为发送用户显示名称。
icon String 为发送用户显示头象。
extra String 扩展信息,可以放置任意的数据内容。