向指定手机号码发送模板短信,模板内可设置部分变量。使用前需要在OpenMAS云化版平台添加短信模板。
本接口适用于非白名单模式用户,携号入网用户一般不推荐使用,使用此功能发送短信,将限制客户侧提交的短信内容。
向指定手机号码发送模板短信,模板内可设置部分变量。使用前需要在OpenMAS云化版平台添加短信模板。
本接口适用于非白名单模式用户,携号入网用户一般不推荐使用,使用此功能发送短信,将限制客户侧提交的短信内容。
● 模版短信单次只允许提交一个号码
OpenMAS云化版平台主要采用WebService方式,接口协议使用SOAP协议。
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8****************O0KF0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp******cc6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 模版短信必须填写为1001 |
sendId | 短信发送编号 | 上级为sendInfo |
mobile | 手机号码 | 必须是11位手机号码 |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
tempCode | 模版编号 | 在应用管理中申请 |
param | 参数信息 | 如:{"key":"msg","value":"888"} |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password": "U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1001",
"sendTime": "",
"extendCode": "22",
"tempCode": "SMS-10000022",
"sendInfo": [
{
"sendId": "1",
"mobile": "155****1879",
"param": [
{
"key": "msg",
"value": "888"
}
]
}
]
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
sendId | 短信发送编号 | 企业应用侧的短信编号 |
messageId | OpenMAS云化版短信编号 | 获取的短信发送结果根据该字段匹配 |
returnCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
{
"resultCode": "0",
"response": [
{
"sendId": "1",
"messageId": "685083",
"returnCode": "0"
}
]
}
向指定手机号码发送群发短信。
● 单次提交不允许超过1000个号码
● 下行短信接口调用限制,每分钟不允许超过设定调用限制(默认限速网关速率*60*2),实际设置请登录http://www.openmas.net云化版企业门户,进入【应用管理】-应用列表查询已开通接口信息。
OpenMAS云化版平台主要采用WebService方式,接口协议使用SOAP协议。
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 群发短信必须填写为1002 |
sendTime | 发送时间 | 定时短信需要填写,即时短信不需要填写 |
sendId | 短信发送编号 | 上级为sendInfo |
mobile | 手机号码 | 必须是11位手机号码 |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
content | 短信内容 | 最多不能超过1200字 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password": "U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1002",
"sendTime": "2017-06-05 18:00:00",
"extendCode": "22",
"content": "你好",
"sendInfo": [
{
"sendId": "0",
"mobile": "133****9096"
},
{
"sendId": "1",
"mobile": "182****4795"
}
]
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
sendId | 短信发送编号 | 企业应用侧的短信编号 |
messageId | OpenMAS云化版短信编号 | 获取的短信发送结果根据该字段匹配 |
returnCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
{
"resultCode": "0",
"response": [
{
"sendId": "0",
"messageId": "685085",
"returnCode": "0"
},
{
"sendId": "1",
"messageId": "685084",
"returnCode": "0"
}
]
}
短信发送结果查询。
● 每次最多返回300条,建议1分钟调用一次
OpenMAS云化版平台主要采用WebService方式,接口协议使用SOAP协议。
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 获取状态报告必须填写为1003 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password":"U7xp********c6R",
""requestTime": "20191213141516",
""sign": "4b505f9c***************0de1489c",
"funCode": "1003"
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
response | 响应详细信息 | |
messageId | OpenMAS云化版短信编号 | 获取的短信发送结果根据该字段匹配 |
resultCode | 短信发送结果 | 0表示成功,其他表示错误,详细参见短信网关代码 |
{
"resultCode": "0",
"response": {
"messageId": "9001",
"resultCode": "0"
}
}
获取用户回复的短信内容。
● 建议1分钟调用一次
OpenMAS云化版平台主要采用WebService方式,接口协议使用SOAP协议。
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 上行短信必须填写为1004 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password":"U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1004"
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 错误代码 | 详细见错误代码表 |
messageId | OpenMAS云化版短信编号 | |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
mobile | 手机号码 | |
content | 上行短信内容 |
{
"resultCode": "0",
"response": [
{
"messageId": "9001",
"mobile": "139****0001",
"content": "回复测试"
},
{
"messageId": "9002",
"mobile": "139****0002",
"content": "回复测试"
}
]
}
接口错误代码信息。
错误代码 | 错误描述 |
---|---|
1001 | 应用不存在,或者AppKey/AppSecret/sign/IP不匹配 |
1002 | 扩展码有误 |
1003 | 短信内容不能为空 |
1004 | 手机号码格式有误 |
1005 | 超出总流量 |
1006 | 超出月流量限制 |
1007 | 超出日流量限制 |
1008 | 数据入库异常 |
1009 | 未提交任何数据 |
1010 | XML提交错误 |
1011 | 存在重复的sendId |
1012 | 定时时间格式不对 |
1013 | 短信模版编号不存在 |
1014 | 超过1000个号码 |
1015 | 应用密码不正确 |
1016 | 应用状态不正确 |
1017 | IP绑定不正确 |
1018 | 超过流量限制 |
1019 | 接口类型错误 |
1020 | 超过接口限速 |
1021 | FUNCODE错误 |
1022 | 短信请求信息公共参数错误 |
1023 | 请求时间不能为空 |
1024 | 接口sign不能为空 |
1025 | 请求时间错误 |
1099 | 系统异常 |
其他 | 参见短信网关代码 |
向指定手机号码发送群发短信。
● 请求方式必须为POST请求
● Content-Type 只支持JSON格式,application/json; charset=utf-8
● 单次提交不允许超过50000个号码
● 下行短信接口调用限制,每分钟不允许超过设定调用限制(默认限速网关速率*60*2),实际设置请登录http://www.openmas.net云化版企业门户,进入【应用管理】-应用列表查询已开通接口信息。
OpenMAS云化版平台HTTP接口
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 群发短信必须填写为1002 |
sendTime | 发送时间 | 定时短信需要填写,即时短信不需要填写 |
mobiles | 手机号码 | 手机号码集合,最多50000元素,每个元素必须是11位手机号码 |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
content | 短信内容 | 最多不能超过1200字 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password": "U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1002",
"sendTime": "2017-06-05 18:00:00",
"extendCode": "33",
"mobiles": [ "133****9096","133****9097","133****9098"],
"content": "你好"
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 响应代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
resultMsg | 提示信息 | 响应成功失败描述 |
batchId | 批次号 | 发送批量短信批次唯一标识码 |
submitWaitSendCount | 提交成功数 | 发送批量短信批次提交成功数 |
blackSendList | 在黑名单中的号码集合 | 发送批量短信在黑名单中的发送号码 |
repeatSendList | 限定重发时间间隔内的号码集合 | 发送批量短信限定重发时间间隔内的发送号码 |
{
"resultCode": "0",
"resultMsg": "api及时短息批量提交成功",
"resultMap":{
"batchId": "zpQ4g3s8***************dO0KF0x8NYuv",
"submitWaitSendCount": "5000",
"blackSendList": [ "133****9096","133****9097","133****9098"] ,
"repeatSendList": [ "133****9096","133****9097","133****9098"]
}
}
短信发送结果查询。
● 请求方式必须为POST请求
● Content-Type 只支持JSON格式,application/json; charset=utf-8
● 每次最多返回300条,建议1分钟调用一次
OpenMAS云化版平台HTTP接口.
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 获取状态报告必须填写为1003 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password":"U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1003"
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 响应代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
resultMsg | 提示信息 | 响应成功失败描述 |
mobile | 发送号码 | 发送短信的号码 |
batchId | 批次号 | 信批次唯一标识码 |
resultCode | 短信发送结果 | 0表示成功,其他表示错误,详细参见短信网关代码 |
{
"resultCode": "0",
"resultMsg": "api批量获取状态报告提交成功",
"resultMap":{
"statusReportList": [
{
"batchId": "zpQ4g3s8***************dO0KF0x8NYuv",
"mobile": "133****9096",
"resultCode": "0"
} ,
{
"batchId": "zpQ4g3s8***************dO0KF0x8NYuv",
"mobile": "133****9096",
"resultCode": "0"
}
]
}
}
获取用户回复的短信内容。
● 请求方式必须为POST请求
● Content-Type 只支持JSON格式,application/json; charset=utf-8
● 建议1分钟调用一次
OpenMAS云化版平台HTTP接口.
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 上行短信必须填写为1004 |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password":"U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1004"
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 响应代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
resultMsg | 提示信息 | 响应成功失败描述 |
messageId | OpenMAS云化版短信编号 | |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
mobile | 手机号码 | |
content | 上行短信内容 |
{
"resultCode": "0",
"resultMsg": "api批量获取上行短信成功",
"resultMap":{
"uplinkSMSList": [
{
"messageId": "9001",
"mobile": "139****0001",
"content": "回复测试"
},
{
"messageId": "9002",
"mobile": "139****0002",
"content": "回复测试"
}
]
}
}
接口响应代码信息。
响应代码 | 响应代码描述 |
---|---|
0 | 请求成功 |
1 | 参数错误 |
2 | 程序异常 |
3 | 其他错误 |
接口应用类型 | WebService接口 | HTTP接口 | 兼容接口 |
---|---|---|---|
接口地址 | http://api.eyun.openmas.net/yunmas_api/ws/wsApi?wsdl | http://api.eyun.openmas.net/yunmas_api/smsApi/batchSendMessage | http://api.eyun.openmas.net/yunmas_api/SendMessageServlet |
使用说明 |
普通Webservice接口,采用SOAP协议。引用接口WSDL生成代理类,直接调用funMain方法,传json数据即可。参数示例说明详见开发者中心《WebService接口》章节。 ● 单次提交不允许超过1000个号码 ● 调用接口限制根据客户网关速率设置,具体参数请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 ● 限制访问IP,增绑IP请致电客服 |
使用Post请求,向接口提交json数据即可。参数示例说明详见开发者中心《HTTP接口》章节。 ● 请求方式必须为POST请求 ● Content-Type:必须为"application/json; charset=utf-8" ● 单次提交不允许超过50000个号码 ● 调用接口限制根据客户网关速率设置,具体参数请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 ● 限制访问IP,增绑IP请致电客服 |
兼容原OpenMas单机版、多用户版、高端机的WebService接口 ● 不建议新开通用户开此接口 ● 单次提交不允许超过1000个号码 ● 调用接口限制根据客户网关速率设置,具体参数请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 ● 限制访问IP,增绑IP请致电客服 |
优点 |
● 可以主动获取状态报告(发送结果) ● 可以主动获取上行短信(手机回复短信) |
● 可以主动获取状态报告(发送结果) ● 可以主动获取上行短信(手机回复短信) |
|
缺点 |
● 被动接收状态报告(发送结果),即客户端需要发布接口用于接收 ● 被动接收上行短信(手机回复短信),即客户端需要发布接口用于接收 |
||
推荐指数 | ![]() |
![]() |
![]() |
备注 |
1、开发者中心:http://www.openmas.net/DeveloperCenter/ 2、登录http://www.openmas.net云化版企业门户,进入【应用管理】下载示例和查询已开通接口信息 |
老SDK资料:https://pan.baidu.com/s/1pJltnQF,2020年将不再提供。 对应迁移前原OpenMas接口地址:http://xxx.xxx.xxx.xxx:9080/OpenMasService |
温馨提示:(1)不同接口类型,不可混淆使用; (2)客户端如果有多套系统对接接口,以免不同客户端系统之间相互影响、以及报障的时候无法描述清楚客户侧情况。 (3)短信签名是指行业网关上注册的签名,短信下发时由移动行业网关自动附加,格式为:【XXXX】。如需修改请联系移动客户经理。 (4)短信条数计算:66字/条,不足66个字按照1条短信计算。条数计算部分中英文字节,即1个汉字、字母、字符和数字均为一个字。
向指定手机号码发送模板短信,模板内可设置部分变量。使用前需要在OpenMAS云化版平台添加短信模板。
本接口适用于非白名单模式用户,携号入网用户一般不推荐使用,使用此功能发送短信,将限制客户侧提交的短信内容。
● 模版短信单次只允许提交一个号码
OpenMAS云化版平台HTTP接口.
参数 | 参数名称 | 参数说明 |
---|---|---|
applicationId | 应用账号(AppKey) | 如:rMq4g3s8Npq****************F0x8NYuv |
password | 应用密码(AppSecret) | 如:U7xp********c6R |
requestTime | 请求时间 | 与服务器时间差不能超过5分钟,格式如:20191213141516 |
sign | 接口校验令牌 | 生成规则请登录OpenMAS云化版平台=>应用管理=>应用列表,对应应用点击操作列查看,查看详情 |
funCode | 服务代码 | 模版短信必须填写为1001 |
sendId | 短信发送编号 | 上级为sendInfo |
mobile | 手机号码 | 必须是11位手机号码 |
extendCode | 扩展号 | 如:21001,手机端显示发件人号码10657525123421001 106575251234为集团客户的12位接入号 2为开通接口时配置的编号 1001为客户侧自定义扩展号,一般用于区分不同的业务或系统,或代表特殊意义的数字,如无需要可以不填接入号+扩展号 总长度不能超过20位 |
tempCode | 模版编号 | 在应用管理中申请 |
param | 参数信息 | 如:{"key":"msg","value":"888"} |
{
"applicationId": "rMq4g3s8Npq****************F0x8NYuv",
"password": "U7xp********c6R",
"requestTime": "20191213141516",
"sign": "4b505f9c***************0de1489c",
"funCode": "1001",
"sendTime": "",
"extendCode": "22",
"tempCode": "SMS-10000022",
"sendInfo": [
{
"sendId": "1",
"mobile": "155****1879",
"param": [
{
"key": "msg",
"value": "888"
}
]
}
]
}
参数 | 参数名称 | 参数说明 |
---|---|---|
resultCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
sendId | 短信发送编号 | 企业应用侧的短信编号 |
messageId | OpenMAS云化版短信编号 | 获取的短信发送结果根据该字段匹配 |
returnCode | 错误代码 | 0表示成功,其他表示错误,详细参见错误代码表 |
{
"resultCode": "0",
"resultMsg": null,
"resultMap": {
"returnCode":"0",
"sendId":"1",
"messageId":"11023387"
}
}