# 消息通讯API

# 静态模板发送

# 接口定义

接口名称	stc_tpl_send
接口描述	使用模板Id发送富信。若模板状态为不可用(审核中、审核不通过、已禁用、已删除)发送请求将直接被驳回。只支持静态模板发送，不支持动参模板发送。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/stc_tpl_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/stc_tpl_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
tplid	模板ID	String,必填	最大长度不超20个字符，由字母、数字、下划线、减号组成。可以使用云通讯模板创作页面生成的模板Id，也可以使用tpl_upload接口返回的模板Id。
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
mobile	用户手机号列表	String,必填	多个手机号请用英文逗号分隔，最大支持5000个号码。号码规则详见“手机号码规则”。
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该条富信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含用户自定义流水号。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"tplid": "808405902",
	"mobile": "135xxxxxxxx,130xxxxxxxx",
	"svrtype": "test",
	"exno": "006",
	"custid": "56asdd-47503-abce",
	"exdata": "exdata"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	消息流水号	Long(64位)，必填	对应Java和C#中的long，不可用int解析。 result非0时，msgid为0 注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将msgid的值赋给custid。 result非0时，custid为空。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "56asdd-47503-abce"
}

# 文本动参模板发送

# 接口定义

接口名称	dynatxt_tpl_send
接口描述	使用模板Id发送富信。若模板状态为不可用(审核中、审核不通过、已禁用、已删除)发送请求将直接被驳回。只支持文本动参模板发送，动参必须是txt类型。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/dynatxt_tpl_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/dynatxt_tpl_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
tplid	模板ID	String,必填	最大长度不超20个字符，由字母、数字、下划线、减号组成。可以使用云通讯模板创作页面生成的模板Id，也可以使用tpl_upload接口返回的模板Id。
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
mobile	用户手机号列表	String,必填	多个手机号请用英文逗号分隔，最大支持5000个号码。号码规则详见“手机号码规则”。
content	参数变量名和变量值对	String,选填	用于替换动态参数模板中的参数变量，字段总长度不超过1000字节，参数变量值使用utf-8编码。 content字段为JSON字符串，格式如下： { "p1": "参数变量值1", "p2": "参数变量值2", .... "pn": "参数变量值n" } 注意: 字段类型是JSON字符串，不是JSON对象
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该条富信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含用户自定义流水号。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"tplid": "808405902",
	"mobile": "135xxxxxxxx,130xxxxxxxx",
	"content": "{\"p1\":\"参数变量值1\",\"p2\":\"参数变量值2\"}",
	"svrtype": "test",
	"exno": "006",
	"custid": "56asdd-47503-abce",
	"exdata": "exdata"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	消息流水号	Long(64位)，必填	对应Java和C#中的long，不可用int解析。 result非0时，msgid为0 注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将msgid的值赋给custid。 result非0时，custid为空。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "56asdd-47503-abce"
}

# 图片动参模板发送

图片动参需单独申请开通权限，请联系客服开通

# 接口定义

接口名称	dynapic_tpl_send
接口描述	使用模板Id发送富信。若模板状态为不可用(审核中、审核不通过、已禁用、已删除)发送请求将直接被驳回。该接口不支持静态模板发送，动参中必须含有图片参数，图片只支持jpg类型，仅支持图片动参。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/dynapic_tpl_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/dynapic_tpl_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
tplid	模板ID	String,必填	最大长度不超20个字符，由字母、数字、下划线、减号组成。可以使用云通讯模板创作页面生成的模板Id，也可以使用tpl_upload接口返回的模板Id。
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
mobile	用户手机号列表	String,必填	多个手机号请用英文逗号分隔，最大支持5000个号码。号码规则详见“手机号码规则”。
content	参数变量名和变量值对	String,选填	用于替换动态参数模板中的参数变量，字段总长度不超过1000字节，参数变量值使用utf-8编码。注意： content字段类型是JSON字符串，不是JSON对象，数据结构详见下表。
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该条富信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含用户自定义流水号。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空

content数据结构：

参数	参数名称	参数约束	参数约束
p1	动参内容	JSON对象	第1个动参
p2	动参内容	JSON对象	第2个动参
…			动参内容数据结构详见下表
pN	动参内容	JSON对象	第N个动参

动参内容数据结构：

参数	参数名称	参数约束	参数约束
type	动参类型	String,必填	动参类型 txt: 纯文字动参 jpg: 图片动参
source	动参来源	String,必填	动参来源 txt:内容源自纯文字 url:内容源自URL链接地址
content	动参资源内容	String,必填	动参资源内容当source=txt时，填写经过utf-8编码的文字；当source=url时，填写资源URL地址，URL长度不能超过1024个字节。

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"tplid": "808405902",
	"mobile": "135xxxxxxxx,130xxxxxxxx",
	"content": "{\"p1\":{\"type\":\"txt\",\"source\":\"txt\",\"content\":\"123\"},\"p2\":{\"type\":\"jpg\",\"source\":\"url\",\"content\":\"http://abc.com/1.jpg\"}}",
	"svrtype": "test",
	"exno": "006",
	"custid": "56asdd-47503-abce",
	"exdata": "exdata"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	消息流水号	Long(64位)，必填	对应Java和C#中的long，不可用int解析。 result非0时，msgid为0 注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将msgid的值赋给custid。 result非0时，custid为空。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "56asdd-47503-abce"
}

# 通用动参模板发送

# 接口定义

接口名称	uni_tpl_send
接口描述	使用模板Id发送富信。若模板状态为不可用(审核中、审核不通过、已禁用、已删除)发送请求将直接被驳回。支持文本动参、图片动参模板发送。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/uni_tpl_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/uni_tpl_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
tplid	模板ID	String,必填	最大长度不超20个字符，由字母、数字、下划线、减号组成。可以使用云通讯模板创作页面生成的模板Id，也可以使用tpl_upload接口返回的模板Id。
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
mobile	用户手机号列表	String,必填	多个手机号请用英文逗号分隔，最大支持5000个号码。号码规则详见“手机号码规则”。
content	参数变量名和变量值对	String,选填	参见“图片动参模板发送”中content字段的描述
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该条富信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含用户自定义流水号。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"tplid": "808405902",
	"mobile": "130xxxxxxxx,131xxxxxxxx",
	"content": "{\"p1\":{\"type\":\"txt\",\"source\":\"txt\",\"content\":\"123\"},\"p2\":{\"type\":\"jpg\",\"source\":\"url\",\"content\":\"http://abc.com/1.jpg\"}",
	"svrtype": "test",
	"exno": "006",
	"custid": "56asdd-47503-abce",
	"exdata": "exdata"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	本次请求的消息流水号	Long(64位),必填	对应Java和C#中的Long，不可用int解析。注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将msgid的值赋给custid。 result非0时，custid为空。
detail	发送详情	JSON数组,选填	发送详情包括手机号、消息流水号，数据结构详见下表。 result非0时，detail为空。

detail数据结构：

参数	参数名称	参数约束	参数约束
mobile	手机号码	String,必填	号码规则详见“手机号码规则”。
msgid	该手机号码的消息流水号	Long(64位),必填	对应Java和C#中的Long，不可用int解析。注意：类型是Long，所以会出现负数，属于正常。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "56asdd-47503-abce",
	"detail": [{
		"mobile": "130xxxxxxxx",
		"msgid": 2177343094593642363
	}, {
		"mobile": "131xxxxxxxx",
		"msgid": 2177343094593642364
	}]
}

# 个性化动参模板发送

# 接口定义

接口名称	multi_tpl_send
接口描述	使用模板Id发送富信。若模板状态为不可用(审核中、审核不通过、已禁用、已删除)发送请求将直接被驳回。支持个性化文本动参、图片动参。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/multi_tpl_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/multi_tpl_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
tplid	模板ID	String,必填	最大长度不超20个字符，由字母、数字、下划线、减号组成。可以使用云通讯模板创作页面生成的模板Id，也可以使用tpl_upload接口返回的模板Id。
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
multimt	个性化信息详情	JSON数组,必填	个性化信息详情：详情见下 multimt中最多可支持5000个手机号的个性化信息
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该条富信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含用户自定义流水号。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空

multimt数据结构：

参数	参数名称	参数约束	参数约束
mobile	手机号码	String,必填	号码规则详见“手机号码规则”。
p1	第1个动参对象	JSON对象	第1个动参对象，见下描述
p2	第2个动参对象	JSON对象	第2个动参对象
…
pN	第N个动参对象	JSON对象	第N个动参对象

动参对象数据结构：

参数	参数名称	参数约束	参数约束
type	动参类型	String,必填	动参类型 txt: 纯文字动参 jpg: 图片动参
source	动参来源	String,必填	动参来源 txt:内容源自纯文字 url:内容源自URL链接地址
content	动参资源内容	String,必填	当source=txt时，填写经过utf-8编码的文字；当source=url时，填写资源URL地址，URL长度不能超过1024个字节。

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"tplid": "808405902",
	"multimt": [{
		"mobile": "130xxxxxxxx",
		"p1": {
			"type": "txt",
			"source": "txt",
			"content": "123"
		},
		"p2": {
			"type": "jpg",
			"source": "url",
			"content": "http://abc.com/1.jpg"
		}
	}, {
		"mobile": "131xxxxxxxx",
		"p1": {
			"type": "txt",
			"source": "txt",
			"content": "456"
		},
		"p2": {
			"type": "jpg",
			"source": "url",
			"content": "http://abc.com/2.jpg"
		}
	}],
	"svrtype": "test",
	"exno": "006",
	"custid": "56asdd-47503-abce",
	"exdata": "exdata"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	消息流水号	Long(64位),必填	对应Java和C#中的Long，不可用int解析。注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将msgid的值赋给custid。 result非0时，custid为空。
detail	发送详情	JSON数组,选填	发送详情包括手机号、消息流水号，数据结构详见“通用动参模板发送”回应参数中detail字段的描述。 result非0时，detail为空。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "56asdd-47503-abce",
	"detail": [{
		"mobile": "130xxxxxxxx",
		"msgid": 2177343094593642363
	}, {
		"mobile": "131xxxxxxxx",
		"msgid": 2177343094593642364
	}]
}

# 预览发送

预览发送用于快速预览富信，可直接下发至手机实时查看展示效果。该接口仅用于快速预览，每天默认分配20条额度，仅支持移动号码。支持上传的素材和资源类型有:

文字text ：txt (utf-8编码的文字)

图片image ：jpg/jpeg/png/gif

音频audio ：mp3/wav

视频video ：mp4/3gp

# 接口定义

接口名称	rms_send
接口描述	发送由一个或多个纯文本、长链文本、图片、音频、视频、资源文件组成的富信，富信资源总大小不超过1.9M，发送的资源文件支持内容文件流、内容地址(URL)两种方式。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/rms_send https://msg-rms.monyun.cn:7121/rms/v3/std/msg/rms_send

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
expire	富信有效期	String,选填	单位：小时。必须取整。默认24小时，最大不超过72小时。
title	富信主题	String,必填	最大不超过15个字，若使用中文需经过utf-8编码
reslist	富信资源列表	JSON数组,必填	参见“模板上传”中reslist字段的描述
mobile	用户手机号列表	String,必填	多个手机号请用英文逗号分隔，最大支持5000个号码。号码规则详见“手机号码规则”。
sign	数字签名	String,必填	数字签名，用于防止富信内容和请求报文被篡改。算法：hexstr_lowercase(md5(expire+title+userid+明文密码+timestamp+reslist+mobile))
svrtype	业务类型	String,选填	最大可支持32 个字节的字符串，由英文字母、数字、@、#、下划线、减号组成
exno	扩展号	String,选填	长度不能超过6位，注意通道号+扩展号的总长度不能超过20位，若超出则exno无效，如不需要扩展号则不用提交此字段或填空
custid	自定义流水号	String,选填	该模板在您业务系统内的Id。最大可支持64位的ASCII字符串：字母、数字、下划线、减号，如不需要则不用提交此字段或填空。
exdata	自定义扩展数据	String,选填	额外提供的最大64个长度的ASCII字符串：字母、数字、下划线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空
rmstype	富信类型	String,选填	固定填1

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"expire": "24",
	"title": "富信主题",
	"reslist": [{
		"index": "1-1",
		"type": "txt",
		"name": "文本.txt",
		"source": "txt",
		"content": "【梦网科技】尊敬的张三你好，你2月的账单如下:"
	}, {
		"index": "1-2",
		"type": "jpg",
		"name": "图片.jpg",
		"source": "file",
		"content": "图片文件流的base64编码字符串"
	}, {
		"index": "2-1",
		"type": "jpg",
		"name": "图片.jpg",
		"source": "url",
		"content": "http://abc.com/1.jpg"
	}, {
		"index": "3-1",
		"type": "mp3",
		"name": "声音.mp3",
		"source": "file",
		"content": "声音文件流的base64编码字符串"
	}, {
		"index": "4-1",
		"type": "mp4",
		"name": "视频.mp4",
		"source": "url",
		"content": "https://pics0.baidu.com/feed/5243fbf2b2.mp4"
	}],
	"mobile": "135xxxxxxxx,139xxxxxxxx",
	"sign": "70e54823e6e23ac0267934104a38f17b",
	"svrtype": "test",
	"exno": "006",
	"custid": "70e55826e6e-23456789",
	"exdata": "exdata",
	"rmstype": "1"
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
msgid	消息流水号	Long(64位),必填	对应Java和C#中的Long，不可用int解析。注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	默认与请求报文中的custid保持一致，若请求报文中没有custid参数或值为空，则将tplid的值赋给custid。 result非0时，custid为空。
detail	发送详情	JSON数组,选填	详见“通用动参模板发送”回应参数中detail字段的描述。result非0时，detail为空。

# 示例:

{
	"result": 0,
	"desc": "成功",
	"msgid": 2177343094593642363,
	"custid": "70e55826e6e-23456789",
	"detail": [{
		"mobile": "135xxxxxxxx",
		"msgid": 2177343094593642363
	}, {
		"mobile": "139xxxxxxxx",
		"msgid": 2177343094593642364
	}]
}

# 获取状态报告

# 接口定义

接口名称	get_rpt
接口描述	按指定的获取条数，返回用户的接收状态报告。建议循环调用接口，当接口返回无数据时进行休眠，然后继续循环调用。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/get_rpt https://msg-rms.monyun.cn:7121/rms/v3/std/msg/get_rpt

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
retsize	每次请求想要获获取的最大条数	Int,选填	最大500,超过500按500返回。小于等于0或不填时，系统返回默认条数，默认100条。

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"retsize": 100
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
rpts	状态报告数组	JSON数组，必填	状态报告JSON数组，数据结构详见下表

rpts数据结构：

参数	参数名称	参数约束	参数约束
msgid	消息流水号	Long(64位),必填	对应下行请求响应返回的msgid 对应Java和C#中的Long，不可用int解析。注意：类型是Long，所以会出现负数，属于正常。
custid	自定义流水号	String,必填	对应下行请求响应返回的custid
pknum	当前条数	Int,必填	富信的状态报告时，该字段固定填1
pktotal	总条数	Int,必填	富信的状态报告时，该字段固定填1
mobile	用户手机号	String,必填	接收消息的用户手机号，号码规则详见“手机号码规则”
spno	通道号	String,必填	手机用户接收消息的完整通道号
exno	扩展号	String,必填	对应下行请求时填写的exno
stime	发送时间	String,必填	本条状态报告所对应的下行消息发送时间，格式：YYYY-MM-DD HH:MM:SS
rtime	返回时间	String,必填	状态报告返回时间，格式：YYYY-MM-DD HH:MM:SS
type	信息类型	String,必填	状态报告类型, 该字段固定填1
status	接收状态	Int,必填	手机用户下行消息接收状态 0：成功非0：失败
errcode	错误代码	String,必填	状态报告错误代码， DELIVRD表示成功，其他表示失败
errdesc	错误代码描述	String,必填	状态报告错误代码的描述。取值：success或fail
exdata	自定义扩展数据	String,必填	对应下行请求时填写的exdata

# 示例:

{
	"result": 0,
	"desc": "成功",
	"rpts": [{
		"msgid": 2177343094593642363,
		"custid": "56asdd-47503-abce",
		"pknum": 1,
		"pktotal": 1,
		"mobile": "135xxxxxxxx",
		"spno": "1069123006",
		"exno": "006",
		"stime": "2019-01-28 13:54:48",
		"rtime": "2019-01-28 13:13:50",
		"type": "1",
		"status": 0,
		"errcode": "DELIVRD",
		"errdesc": "success",
		"exdata": "exdata"
	}, {
		"msgid": 2177343094593642364,
		"custid": "56asdd-47503-abce",
		"pknum": 1,
		"pktotal": 1,
		"mobile": "130xxxxxxxx",
		"spno": "1069123006",
		"exno": "006",
		"stime": "2019-01-28 13:54:48",
		"rtime": "2019-01-28 13:13:51",
		"type": "3",
		"status": 0,
		"errcode": "DELIVRD",
		"errdesc": "success",
		"exdata": "exdata"
	}]
}

# 获取上行消息

# 接口定义

接口名称	get_mo
接口描述	按指定的获取条数，返回用户的上行消息。建议循环调用接口，当接口返回无数据时进行休眠，然后继续循环调用。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	http://msg-rms.monyun.cn:7710/rms/v3/std/msg/get_mo https://msg-rms.monyun.cn:7121/rms/v3/std/msg/get_mo

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”。
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
retsize	每次请求想要获获取的最大条数	Int,选填	最大200,超过200按200返回。小于等于0或不填时，系统返回默认条数，默认100条

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"retsize": 100
}

# 回应参数

参数	参数名称	参数约束	参数约束
result	请求处理结果	Int,必填	0：成功非0：失败，详见“错误代码表”
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节
mos	上行数组	JSON数组，必填	上行JSON数组，数据结构详见下表

mos数据结构：

参数	参数名称	参数约束	参数约束
msgid	消息流水号	Long(64位),必填	上行消息唯一消息流水号。对应Java和C#中的long，不可用int解析。 result非0时，msgid为0 注意：类型是Long，所以会出现负数，属于正常。
mobile	用户手机号	String,必填	每一个mo包中仅含一个用户手机号。号码规则详见“手机号码规则”
spno	通道号	String,必填	用户回复上行消息的完整通道号
exno	扩展号	String,必填	对应下行消息时所填写的exno
rtime	接收时间	String,必填	平台收到上行消息的时间。格式：YYYY-MM-DD HH:MM:SS
type	信息类型	String,必填	1:文本 2:富媒体暂固定为1
content	信息内容	String,必填	最大支持70个字，一个字母或一个汉字都视为一个字。编码方法： UrlEncode("验证码：6666，打死都不要告诉别人哦！","UTF-8")

# 示例:

{
	"result": 0,
	"desc": "成功",
	"mos": [{
		"msgid": 2177708400960340167,
		"mobile": "135xxxxxxxx",
		"spno": "10690123006",
		"exno": "006",
		"rtime": "2019-01-28 14:09:22",
		"type": "1",
		"content": "%e6%94%b6%e5%88%b0"
	}, {
		"msgid": 2177708400960340189,
		"mobile": "130xxxxxxxx",
		"spno": "10690123006",
		"exno": "006",
		"rtime": "2019-01-28 14:09:32",
		"type": "1",
		"content": "%e6%94%b6%e5%88%b0"
	}]
}

# 状态报告回调

# 接口定义

接口名称	callback_rpt
接口描述	用户收到消息后，平台将通过回调的方式，将消息的接收状态报告推送给接入客户。接口一次最多推送500条状态报告，为了不影响推送速度，建议接收到数据后立即回应，使用另外的线程异步处理业务逻辑
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	接入客户提供回调URL

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
cmd	请求命令字	String,必填	固定填写RPT_REQ
seqid	请求包序号	Int,必填	唯一的标识本次推送请求，每次网络请求均需加1
rpts	状态报告数组	JSON数组,必填	参见“获取状态报告”中rpts字段的描述

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"cmd": "RPT_REQ",
	"seqid": 1,
	"rpts": [{
		"msgid": 2177343094593642363,
		"custid": "56asdd-47503-abce",
		"pknum": 1,
		"pktotal": 1,
		"mobile": "135xxxxxxxx",
		"spno": "1069123006",
		"exno": "006",
		"stime": "2019-01-28 13:54:48",
		"rtime": "2019-01-28 13:13:50",
		"type": "1",
		"status": 0,
		"errcode": "DELIVRD",
		"errdesc": "success",
		"exdata": "exdata"
	}, {
		"msgid": 2177343094593642364,
		"custid": "56asdd-47503-abce",
		"pknum": 1,
		"pktotal": 1,
		"mobile": "130xxxxxxxx",
		"spno": "1069123006",
		"exno": "006",
		"stime": "2019-01-28 13:54:48",
		"rtime": "2019-01-28 13:13:51",
		"type": "3",
		"status": 0,
		"errcode": "DELIVRD",
		"errdesc": "success",
		"exdata": "exdata"
	}]
}

# 回应参数

参数	参数名称	参数约束	参数约束
cmd	回应命令字	String,必填	固定填写RPT_RESP
seqid	回应包序号	Int,必填	与请求中的seqid保持一致
result	请求处理结果	Int,必填	0：成功非0：失败
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节

# 示例:

{
	"cmd": "RPT_RESP",
	"seqid": 1,
	"result": 0,
	"desc": "接收成功"
}

# 上行消息回调

# 接口定义

接口名称	callback_mo
接口描述	收到用户回复的上行消息后，平台将通过回调的方式，将上行消息推送给接入客户。接口一次最多推送100条上行消息，为了不影响推送速度，建议接收到数据后立即回应，使用另外的线程异步处理业务逻辑。
请求和回应方式	HTTP/HTTPS POST 方式 UTF-8编码 JSON报文传输
请求URL	接入客户提供回调URL

# 请求参数

参数	参数名称	参数约束	参数约束
userid	用户账号	String,必填	长度最大6个字符，字母统一大写，用于接口鉴权。
pwd	鉴权信息	String,必填	定长小写32位加密字符串。规则详见“接口鉴权规则”
timestamp	时间戳	String,必填	24小时制格式: MMDDHHMMSS,即月日时分秒，定长10位,月、日、时、分、秒每段不足2位时左补0
cmd	请求命令字	String,必填	固定填写MO_REQ
seqid	请求包序号	Int,必填	唯一的标识本次推送请求，每次网络请求均需加1
mos	上行信息数组	JSON数组,必填	参见“获取上行消息”中mos字段的描述

# 示例:

{
	"userid": "XIAO18",
	"pwd": "973e01b39b87e3edf1262276bb25e119",
	"timestamp": "0124135902",
	"cmd": "MO_REQ",
	"seqid": 1,
	"mos": [{
		"msgid": 2177708400960340167,
		"mobile": "135xxxxxxxx",
		"spno": "10690123006",
		"exno": "006",
		"rtime": "2019-01-28 14:09:22",
		"type": "1",
		"content": "%e6%94%b6%e5%88%b0"
	}, {
		"msgid": 2177708400960340189,
		"mobile": "130xxxxxxxx",
		"spno": "10690123006",
		"exno": "006",
		"rtime": "2019-01-28 14:09:32",
		"type": "1",
		"content": "%e6%94%b6%e5%88%b0"
	}]
}

# 回应参数

参数	参数名称	参数约束	参数约束
cmd	回应命令字	String,必填	固定填写MO_RESP
seqid	回应包序号	Int,必填	与请求中的seqid保持一致
result	请求处理结果	Int,必填	0：成功非0：失败
desc	处理结果描述	String,必填	对result结果的详细描述，长度不超过1024字节

# 示例:

{
	"cmd": "MO_RESP",
	"seqid": 1,
	"result": 0,
	"desc": "接收成功"
}

← 模板管理API 规则说明 →