跳到主要内容

未列出页
此页面未列出。搜索引擎不会对其索引,只有拥有直接链接的用户才能访问。

发送公众号消息

发送公众号消息。

请求方法

POST:https://<your-domain-url>/media-platform/mc/msg/send.json

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

字段类型描述
fromMcIdString公众号 Id。(必传)
toUserIdString接收用户 Id,可以实现向多人发送消息,每次上限为 1000 人。(必传)
objectNameString消息类型标识。可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与即时通讯服务预定义的消息类型的 ObjectName 重名。(必传)
contentString发送消息内容,;如果 objectName 为自定义消息类型,该参数可自定义格式。(必传)
pushContentString定义显示的 Push 内容,如果 objectName 为即时通讯服务预定义的消息类型时,则发送后用户一定会收到 Push 信息。 如果为自定义消息,则 pushContent 为自定义消息显示的 Push 内容,如果不传则用户不会收到 Push 通知。(可选)
pushDataString针对 iOS 平台为 Push 通知时附加到 payload 中,Android 客户端收到推送消息时对应字段名为 pushData。(可选)
countString仅目标用户为 iOS 设备有效,Push 时用来控制桌面角标未读消息数,只有在 toUserId 为一个用户 Id 时有效,客户端获取远程推送内容时为 badge 查看详细,为 -1 时不改变角标数,传入相应数字表示把角标数改为指定的数字,最大不超过 9999。(可选)
verifyBlacklistInt是否过滤接收用户黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0 不过滤。(可选)
isPersistedInt针对即时通讯服务端历史消息中是否存储此条消息,客户端则根据消息注册的 ISPERSISTED 标识判断是否存储;针对自定义消息,如果旧版客户端上未注册该消息时,根据此属性确定是否存储在本地,但无法解析显示。0 表示为不存储、 1 表示为存储,默认为 1 存储消息,此属性不影响离线消息功能,用户未在线时都会转为离线消息存储。(可选)
isIncludeSenderInt发送用户自己是否接收消息,0 表示为不接收,1 表示为接收,默认为 0 不接收,只有在 toUserId 为一个用户 Id 的时候有效。(可选)
isRouteInt发出的消息是否路由到应用服务器,0 表示为不路由,1 表示为路由,默认为 1 路由。(可选)

请求示例

POST /media-platform/mc/msg/send.json HTTP/1.1
Host: your-domain-url
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content={\"content\":\"c#hello\"}&fromMcId=2191&toUserId=2193&toUserId=2192&objectName=RC:TxtMsg&pushContent=thisisapush&pushData={\"pushData\":\"hello\"}&count=4&verifyBlacklist=0&isPersisted=1&isIncludeSender=0&isRoute=1

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

字段类型描述
codeInt返回码,200 为正常。

返回结果示例

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