“茧米云通讯开放平台”为企业及个人开发者提供各种通讯服务,开发者通过嵌入API能在应用中轻松实现各种通讯功能,包括国际短信、国内短信、语音、彩信、流量、网络传真等。
“茧米云通讯开放平台”独特的沙箱开发环境,可帮助让各行各业的业务系统低成本、快速便捷地接入通讯能力,降低开发者建设通信能力的技术门槛和成本门槛。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码需要MD5 32位加密 | |
cmd | String | 是 | 30 | 命令字 | getnum |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=getnum&uid=0001&psw=202cb962ac59075b964b07152d234b70
101错误。
100#已发送条数#还可发送条数
100#9#198
无
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码需要MD5 32位加密 | |
cmd | String | 是 | 30 | 命令字 | modifpsw |
newpsw | String | 是 | 32 | 新密码,不需要MD5加密,长度6到32位 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=modifpsw&uid=88577&psw=4e4ab643907180059a3ca192314f182b&newpsw=654321
100 修改成功;
101 修改失败。
108 密码太简单;
无
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码需要MD5 32位加密 | |
cmd | String | 是 | 30 | 命令字 | send |
mobiles | String | 是 | 600 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
msgid | int | 否 | 消息编号,客户端生成,唯一性;每提交一次msgid要不同; | ||
subid | String | 否 | 3 | 拓展号 | |
msg | String | 是 | 2000 | 消息内容,GBK 编码格式,需要urlencoder; 消息结尾需要加签名,签名写到【】里; |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=send&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13590234458&msgid=10002&msg=test
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|
参数名 | 类型 | 必填 | 描述 |
---|---|---|---|
type | String | 是 | 推送类型,1 表示短信状态 |
count | int | 是 | 本次推送短信记录数 |
eprId | int | 是 | 企业ID |
mobile | String | 是 | 手机号码 |
msgId | String | 是 | 客户MSGID,对应发送的MSGID |
status | int | 是 | 发送状态,0 失败,1成功 |
statusCode | String | 是 | 运营商返回的状态码 |
userId | String | 是 | 客户账号 |
无
<?xml version="1.0" encoding="utf-8"?>
<returnForm>
<type>1</type>
<count>2</count>
<list>
<pushStatusForm>
<eprId>0</eprId>
<mobile>15766208001</mobile>
<msgId>1461822936915</msgId>
<status>0</status>
<statusCode>UNDELIV</statusCode>
<userId>pangrihui5</userId>
</pushStatusForm>
<pushStatusForm>
<eprId>0</eprId>
<mobile>15766208001</mobile>
<msgId>1461822936915</msgId>
<status>0</status>
<statusCode>UNDELIV</statusCode>
<userId>pangrihui5</userId>
</pushStatusForm>
</list>
</returnForm>
无
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|
参数名 | 类型 | 必填 | 描述 |
---|---|---|---|
type | String | 是 | 推送类型,2 表示上行 |
count | int | 是 | 本次推送短信记录数 |
eprId | int | 是 | 企业ID |
mobile | String | 是 | 手机号码 |
msgId | String | 是 | 客户MSGID,对应发送的MSGID |
status | int | 是 | 发送状态,0 失败,1成功 |
userId | String | 是 | 客户账号 |
无
<?xml version="1.0" encoding="utf-8"?>
<returnForm>
<type>2</type>
<count>2</count>
<list>
<pushSmsForm>
<eprId>115</eprId>
<mobile>15766228295</mobile>
<msgId>1461029714745</msgId>
<content><![CDATA[新年好。祝协会蓬勃兴旺。多搞活动啊。]]></content>
<userId>pangrihui</userId>
</pushSmsForm>
<pushSmsForm>
<eprId>115</eprId>
<mobile>15766228295</mobile>
<msgId>1461029714745</msgId>
<content><![CDATA[新年好。祝协会蓬勃兴旺。多搞活动啊。]]></content>
<userId>pangrihui</userId>
</pushSmsForm>
</list>
</returnForm>
1.每次最多推送200个上行短信
2.推送数据格式为XML格式
3.响应说明:客户端接收成功请返回:100 或 OK 或 SUCCESS
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码,需要MD5 32加密, 不区分大小写 | |
cmd | String | 是 | 30 | 命令字 | uploadvoicefile |
无 | 语音文件流 | 是 | 语音文件流,文件格式:mp3,文件大小限制5M以内 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=uploadvoicefile&uid=001&psw=ac59075b964b07152d234b70
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
无
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码,需要MD5 32加密 | |
cmd | String | 是 | 30 | 命令字 | sendvoicecall |
mobiles | String | 是 | 6000 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
msgid | int | 否 | 客户端生成,唯一性;每提交一次msgid要不同 | ||
msg | String | 否 | 1000 | 消息内容,GBK 编码格式,需要urlencoder;180字一条;如果上传的是文件,此字段为:空 | |
filename | String | 否 | 200 | 语音文件序号,上传时返回的,如果发送的是文本,此字段为:空 | |
daycheck | int | 否 | 发送天限制,0 不限制 1周一至周五 2 周一至周六 默认 0 | ||
timecheck | int | 否 | 发送时间限制,0不限制 1工作时间发送(9-12 14-18) 默认 1 | ||
callType | int | 否 | 发送时间限制,0不限制 1工作时间发送(9-12 14-18) 默认 1 | ||
speed | int | 否 | 发送速度,1-1200条/分钟.默认60 | ||
batchnum | long | 否 | 批次号 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=sendvoicecall&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13682488577&msgid=10002&msg=test
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码,需要MD5 32加密 | |
cmd | String | 是 | 30 | 命令字 | sendvoice |
mobiles | String | 是 | 6000 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
msgid | int | 否 | 消息编号,客户端生成,唯一性;每提交一次msgid要不同 | ||
senddate | String | 否 | 10 | 发送日期,格式:YYYY-MM-DD | |
sendtime | String | 否 | 8 | 发送时间,格式:hh:mm:ss | |
msg | String | 否 | 1000 | 消息内容,GBK 编码格式,需要urlencoder;180字一条;如果上传的是文件,此字段为:空 | |
filename | String | 否 | 200 | 语音文件序号,上传时返回的,如果发送的是文本,此字段为:空 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=sendvoice&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13682488577msgid=1001&senddate=2010-05-01&sendtime=10:33&msg=test
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码,需要MD5 32加密 | |
cmd | String | 是 | 30 | 命令字 | sendvoice |
mobiles | String | 是 | 6000 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
msgid | String | 否 | 500 | 消息编号,客户端生成,唯一性;每提交一次msgid要不同 | |
msg | String | 否 | 2000 | 消息内容,GBK 编码格式,需要urlencoder;180字一条;如果上传的是文件,此字段为:空 | |
filename | String | 否 | 500 | 语音文件序号,上传时返回的,如果发送的是文本,此字段为:空 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=sendvoice&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13682488577&msgid=10002&msg=test
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码,需要MD5 32加密 | |
cmd | String | 是 | 30 | 命令字 | sendvote |
mobiles | String | 是 | 6000 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
msgid | int | 否 | 消息编号 | ||
senddate | String | 否 | 10 | 发送日期,格式:YYYY-MM-DD | |
sendtime | String | 否 | 8 | 发送时间,格式:hh:mm:ss | |
msg | String | 否 | 1000 | 消息内容,GBK 编码格式,需要urlencoder;180字一条;如果上传的是文件,此字段为:空 | |
filename | String | 否 | 200 | 语音文件序号,上传时返回的,如果发送的是文本,此字段为:空 |
参数名 | 类型 | 必填 | 描述 |
---|
http://api.91jianmi.com/sdk/SMS?cmd=sendvote&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13682488577msgid=1001&senddate=2010-05-01&sendtime=10:33&msg=test
返回码 | 说明 |
---|---|
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
cmd | String | 是 | 30 | 命令字 | addContent |
key | String | 是 | 32 | 验证KEY,Cmd+timestamp+apiKey MD5加密 | |
timestamp | String | 是 | 14 | 时间戳,格式yyyyMMddHHmmss | |
ucuid | String | 是 | 30 | 账号 | |
password | String | 是 | 30 | 密码,需MD5 32位加密, 不区分大小写 | |
content | String | 是 | 6000 | 彩信内容,XML格式样 |
参数名 | 类型 | 必填 | 描述 |
---|
http://i.huixun35.com/ClientApi?cmd=addContent&ucuid=8888&password=f379eaf3c831b04de153469d1bec345e×tamp=20150924160329&key=b101776e3a04838593d3234acc505a67&content=...
{"result":"100","taskId":"137150924160329353"}
takkId 彩信内容资源批次号,用于号码发送时
返回码 | 含义 |
result=100 | 成功 |
result=101 | 失败 |
result=102 | 验证失败 |
result=106 | 限制发送(或条数不够) |
result=107 | 参数不全 |
1.图片转换层次比较多,需要注意下,转换参考模板如下
URLEncoder.encode(Base64.encode(FileHelper.fileToBetyArray(new File(filePath))))
2. 彩信内容格式:
<mms>
<title></title>
<body>
<frame>
<playtimes>3</playtimes> --播放时长(秒)
<img type="jpg"> JCJGiLk8pV%2BqX6S… </img>--图片,转成字节数组后base64再URLEncoder,大小80K以内
<text> <![CDATA[文字内容]]></text> --文字内容量, <![CDATA[]]>处理特殊符号
</frame>
<frame>
<playtimes>3</playtimes>
<img type="gif">JCJGiLk8pV%2BqX6S… <img>
<text><![CDATA[文字内容]]></text>
</frame>
</body>
</mms>
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
cmd | String | 是 | 30 | 命令字 | mmsSend |
key | String | 是 | 32 | 验证KEY,Cmd+timestamp+apiKey MD5加密 | |
timestamp | String | 是 | 14 | 时间戳,格式yyyyMMddHHmmss | |
ucuid | String | 是 | 30 | 账号 | |
password | String | 是 | 30 | 密码,需MD5 32位加密, 不区分大小写 | |
mobiles | String | 是 | 6000 | 接收号码,多个号码用逗号,分隔 | |
taskId | String | 是 | 300 | 内容资料Id,添加彩信内容时返回 |
参数名 | 类型 | 必填 | 描述 |
---|
http://i.huixun35.com/ClientApi?cmd=mmsSend&ucuid=8888&password=f379eaf3c831b04de153469d1bec345e×tamp=20150924161444&key=3b98863482c5840d8b9d25d5c798b6ac&mobiles=13682488577,13128922913&taskId=499150924142046190
Json格式 {"result":"100"}
返回码 | 含义 |
result=100 | 成功 |
result=101 | 失败 |
result=102 | 验证失败 |
result=106 | 限制发送(或条数不够) |
result=107 | 参数不全 |
无
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
cmd | String | 是 | 30 | 命令字 | setStatusUrl |
key | String | 是 | 32 | 验证KEY,Cmd+timestamp+apiKey MD5加密 | |
timestamp | String | 是 | 14 | 时间戳,格式yyyyMMddHHmmss | |
ucuid | String | 是 | 30 | 账号 | |
password | String | 是 | 30 | 密码,需MD5 32位加密, 不区分大小写 | |
statusUrl | String | 是 | 500 | 回调地址,可带自定义参数 |
参数名 | 类型 | 必填 | 描述 |
---|---|---|---|
mobile | String | 是 | 手机号码 |
status | int | 是 | 状态,2 发送成功 3发送失败 |
taskId | int | 是 | 记录标识号 |
receiveTime | String | 是 | 状态创建时间 |
http://i.huixun35.com/ClientApi?cmd=setStatusUrl&ucuid=0001&password=19a130d5b1890c20975106242f527c2b&key=a3e75362e3d7f17a7223ed960028186c×tamp=20150825181530&statusUrl=http://www.xxxxx.com/GetMMSStatus
Json格式 {"result":"100"}
返回码 | 含义 |
result=100 | 成功 |
result=101 | 失败 |
result=102 | 验证失败 |
result=106 | 限制发送(或条数不够) |
result=107 | 参数不全 |
回调格式: http://回调的URL? mobile=13812345678 taskid=10218& status=2& receiveTime=2014-05-26 17:00:12
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|---|---|---|---|---|
cmd | String | 是 | 30 | 命令字 | sendIntlSms |
uid | String | 是 | 30 | 账号 | |
psw | String | 是 | 32 | 密码需要MD5 32位加密 | |
msgid | int | 否 | 消息编号,客户端生成,唯一性;每提交一次msgid要不同; | ||
msg | String | 是 | 1000 | 消息内容,GBK 编码格式,需要urlencoder; 消息结尾需要加签名,签名写到【】里; | |
mobiles | String | 是 | 6000 | 手机号码,多个号码用逗号隔开最多500个号码,建议100个提交一次; | |
sendtime | String | 否 | 30 | 定时发送时间,格式YYYY-MM-DD hh:mm:ss,该参数不是必须的,立即发送不需要该参数;带上该参数,用来设置定时的发送时间 |
参数名 | 类型 | 必填 | 描述 |
---|
http://c.huixun35.com/ClientApi?cmd=sendIntlSms&uid=0001&psw=202cb962ac59075b964b07152d234b70&mobiles=13590234458&msgid=10002&msg=test&sendtime=2016-01-01 00:00:00
返回码 | 说明 |
100 | 成功 |
101 | 失败 |
102 | 验证失败(密码不对) |
103 | 号码有错(接收号码格式错误) |
104 | 内容有错(敏感内容) |
105 | 操作频率过快(每秒十次) |
106 | 限制发送(无条数) |
107 | 参数不全(请查看提交的参数) |
此接口不返回手机接收状态,只表示调接口是否成功。
参数名 | 类型 | 必填 | 字段长度 | 描述 | 默认值 |
---|
参数名 | 类型 | 必填 | 描述 |
---|---|---|---|
type | String | 是 | 推送类型,1 表示短信状态 |
count | int | 是 | 本次推送短信记录数 |
eprId | int | 是 | 企业ID |
mobile | String | 是 | 手机号码 |
msgId | String | 是 | 客户MSGID,对应发送的MSGID |
status | int | 是 | 发送状态,0 失败,1成功 |
statusCode | String | 是 | 运营商返回的状态码 |
userId | String | 是 | 客户账号 |
无
<?xml version="1.0" encoding="utf-8"?>
<returnForm>
<type>1</type>
<count>2</count>
<list>
<pushStatusForm>
<eprId>0</eprId>
<mobile>15766208001</mobile>
<msgId>1461822936915</msgId>
<status>0</status>
<statusCode>UNDELIV</statusCode>
<userId>pangrihui5</userId>
</pushStatusForm>
<pushStatusForm>
<eprId>0</eprId>
<mobile>15766208001</mobile>
<msgId>1461822936915</msgId>
<status>0</status>
<statusCode>UNDELIV</statusCode>
<userId>pangrihui5</userId>
</pushStatusForm>
</list>
</returnForm>
1.每次最多推送200个短信状态
2.推送数据格式为XML格式
3.响应说明:客户端接收成功请返回:100 或 OK 或 SUCCESS