跳转至

发送消息

消息发送

用户向公众号发送消息后,公众号会向用户发送回复消息,目前融云公众服务 API 支持文本、图片、语音、图文等消息类型。

请注意,在发送多媒体(图片、语音)消息时需要预先上传多媒体文件到融云服务器。

方法名:/message/send.json

调用方式:参见 API 调用签名规则

URL:https://api.ps.ronghub.com/message/send.json

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

文本消息

示例

Request:

POST /message/send.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
   "fromuser":"app.public.server112@uwd1c0sxdlx2",
   "touser":"sdfxl@uwd1c0sxdlx2",
   "msgtype":"text",
   "text":
   {
        "content":"Hello"
   },
   "userinfo":
   {
	       "id":"1",
	       "name":"xiaomei",
	       "headimgurl":"http://aa.com/a.jpg"
   }
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
touser 接收用户标识,格式:用户 Id + @ + App key 例如:sdfxl@uwd1c0sxdlx2
msgtype 消息类型,文本为 text,图片为 image,语音为 voice,图文消息为 news,此处为 text。
content 消息内容,最大长度为 2000 个字节。
userinfo 用户收到消息时显示的发送用户信息,如不传时显示应用公众号的基本信息。
id 客户端显示的用户 Id。
name 客户端显示的用户昵称。
headimgurl 客户端显示的用户头像。

Response:

正常示例:

{ "errcode" : 0,"errmsg" : "ok" }

错误示例:

{"errcode":1002,"errmsg":"invalid media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

图片消息

示例

Request:

POST /message/send.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-imestamp: 1408706337
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
   "fromuser":"app.public.server112@uwd1c0sxdlx2",
   "touser":"123@uwd1c0sxdlx2",
   "msgtype":"image",
   "image":
   {
         "media_id":"123434343443"
   } ,
   "userinfo":
   {
         "id":"1",
         "name":"xiaomei",
         "headimgurl":"http://aa.com/a.jpg"
   }
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
touser 接收用户标识,格式:用户 Id + @ + App key 例如:123@uwd1c0sxdlx2
msgtype 消息类型,文本为 text,图片为 image,语音为 voice,图文消息为 news,此处为 image。
media_id 图片 Id,调用多媒体上传接口上传图片后获得。
userinfo 用户收到消息时显示的发送用户信息,如不传时显示应用公众号的基本信息。
id 客户端显示的用户 Id。
name 客户端显示的用户昵称。
headimgurl 客户端显示的用户头像。

Response:

正常示例:

{ "errcode" : 0,"errmsg" : "ok" }

错误示例:

{"errcode":1002,"errmsg":"invalid media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

语音消息

示例

Request:

POST /message/send.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
   "fromuser":"app.public.server112@uwd1c0sxdlx2",
   "touser":"123@uwd1c0sxdlx2",
   "msgtype":"voice",
   "voice":
   {
         "media_id":"123434343443"
   } ,
   "userinfo":
   {
         "id":"1",
         "name":"xiaomei",
         "headimgurl":"http://aa.com/a.jpg"
   }
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
touser 接收用户标识,格式:用户 Id + @ + App key 例如:123@uwd1c0sxdlx2
msgtype 消息类型,文本为 text,图片为 image,语音为 voice,图文消息为 news,此处为 voice。
media_id 语音 Id,调用多媒体上传接口上传语音后获得。
userinfo 用户收到消息时显示的发送用户信息,如不传时显示应用公众号的基本信息。
id 客户端显示的用户 Id。
name 客户端显示的用户昵称。
headimgurl 客户端显示的用户头像。

Response:

正常示例:

{ "errcode" : 0,"errmsg" : "ok" }

错误示例:

{"errcode":1002,"errmsg":"invalid media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

图文消息

示例

Request:

POST /message/send.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
   "fromuser":"app.public.server112@uwd1c0sxdlx2",
   "touser":"123@uwd1c0sxdlx2",
   "msgtype":"news",
   "news":
   {
       "articles": [
        {
            "title":"haha ",
            "description":" hahahaahhaha",
            "url":"URL",
            "picurl":"PIC_URL"
        },
        {
            "title":"lala",
            "description":" lalalalala",
            "url":"URL",
            "picurl":"PIC_URL"
        }
        ]
   },
   "userinfo":
   {
	       "id":"1",
        "name":"xiaomei",
        "headimgurl":"http://aa.com/a.jpg"
   }
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
touser 接收用户标识,格式:用户 Id + @ + App key 例如:123@uwd1c0sxdlx2
msgtype 消息类型,文本为 text,图片为 image,语音为 voice,图文消息为 news,此处为 news。
articles 图文消息,一个图文消息最少为 1 条,最多为 10 条图文。
title 图文消息的标题。
description 图文消息的描述,描述内容不超过 1000 个汉字( 1 个汉字等于 2 个字符)。
url 图文消息被点击后跳转的链接。
picurl 图文消息的图片链接,支持JPG。
userinfo 用户收到消息时显示的发送用户信息,如不传时显示应用公众号的基本信息。
id 客户端显示的用户 Id。
name 客户端显示的用户昵称。
headimgurl 客户端显示的用户头像。

Response:

正常示例:

{ "errcode" : 0,"errmsg" : "ok" }

错误示例:

{"errcode":1002,"errmsg":"invalid media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

消息群发

公众号需要向全部关注用户发送消息时,融云公众服务为公众号提供了每天 一 条的群发权限,按自然天计算,暂时只支持向全部关注用户发送消息。

请注意,在群发多媒体消息时需要预先上传多媒体文件到融云服务器。

方法名:/message/sendall.json

调用方式:参见 API 调用签名规则

URL:https://api.ps.ronghub.com/message/sendall.json

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

群发文本消息

示例

Request:

POST /message/sendall.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
  "fromuser":"app.public.server112@uwd1c0sxdlx2",
  "filter":{
     "is_to_all": true
  },
  "text":{
     "content":"CONTENT"
  },
  "msgtype":"text"
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
filter 用于设定图文消息的接收者。
is_to_all 用于设定是否向全部用户发送,值为 true 或 false,目前暂只支持 true,默认为 true。
content 消息内容,最大长度为 2000 个字节。
msgtype 消息类型,图文消息为 mpnews,文本消息为 text,语音为 voice,图片为 image,此处为 text。

Response:

正常示例:

{
  "errcode":0,
  "errmsg":"ok",
  "msg_id":"adf330werfewfcxsdls"
}

错误示例:

{"errcode":1002,"errmsg":"media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

群发图文消息

示例

Request:

POST /message/sendall.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
  "fromuser":"app.public.server112@uwd1c0sxdlx2",
  "filter":{
     "is_to_all":true
  },
  "mpnews":{
     "media_id":"123dsdajkasd231jhksad"
  },
  "msgtype":"mpnews"
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
filter 用于设定图文消息的接收者。
is_to_all 用于设定是否向全部用户发送,值为 true 或 false,目前暂只支持 true,默认为 true。
msgtype 消息类型,图文消息为mpnews,文本消息为 text,语音为 voice,图片为 image,此处为 mpnews。

Response:

正常示例:

{
  "errcode":0,
  "errmsg":"ok",
  "msg_id":"adf330werfewfcxsdls"
}

错误示例:

{"errcode":1002,"errmsg":"media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

提示

注意图文消息的 media_id 需要通过上传图文消息素材方法来得到。

群发语音消息

示例

Request:

POST /message/sendall.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
  "fromuser":"app.public.server112@uwd1c0sxdlx2",
  "filter":{
     "is_to_all": true
  },
  "voice":{
     "media_id":"123dsdajkasd231jhksad"
  },
  "msgtype":"voice"
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
filter 用于设定图文消息的接收者。
is_to_all 用于设定是否向全部用户发送,值为 true 或 false,目前暂只支持true,默认为 true。
media_id 用于群发的消息的 media_id。
msgtype 消息类型,图文消息为 mpnews,文本消息为 text,语音为 voice,图片为 image,此处为 voice。

Response:

正常示例:

{
  "errcode":0,
  "errmsg":"ok",
  "msg_id":"adf330werfewfcxsdls"
}

错误示例:

{"errcode":1002,"errmsg":"media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

提示

注意此处 media_id 需通过上传多媒体文件方法来得到。

群发图片消息

示例

Request:

POST /message/sendall.json HTTP/1.1
Host: api.ps.ronghub.com
RC-App-Key: uwd1c0sxdlx2
RC-Nonce: 14314
RC-Timestamp: 1408710653491
RC-Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{
  "fromuser":"app.public.server112@uwd1c0sxdlx2",
  "filter":{
     "is_to_all": true
  },
  "image":{
     "media_id":"123dsdajkasd231jhksad"
  },
  "msgtype":"image"
}

表单参数:

名称 是否必须 说明
fromuser 发送用户标识,格式:公众号 Id + @ + App key 例如:app.public.server112@uwd1c0sxdlx2
filter 用于设定图文消息的接收者。
is_to_all 用于设定是否向全部用户发送,值为 true 或 false,目前暂只支持 true,默认为 true。
media_id 用于群发的消息的 media_id。
msgtype 消息类型,图文消息为 mpnews,文本消息为 text,语音为 voice,图片为 image,此处为 image。

Response:

正常示例:

{
  "errcode":0,
  "errmsg":"ok",
  "msg_id":"adf330werfewfcxsdls"
}

错误示例:

{"errcode":1002,"errmsg":"media_id"}

可根据返回错误码,在 API 返回状态码说明 中查看错误明细。

提示

注意此处 media_id 需通过上传多媒体文件方法来得到。