地址祝福短信平台

案卷号日期华信短信平台接口文档1.
2.
2用户手册作者:创世华信科技有限公司完成日期:2020-05-25签收人:签收日期:短信接口说明用户手册1第一章短信发送接口41.
1请求地址41.
2参数说明41.
3返回值5第二章彩信发送接口62.
1请求地址62.
2参数说明6Tms文件存储规格:72.
3返回值8第三章余额及已发送量查询接口83.
1请求地址83.
2参数说明83.
3返回值8第四章状态报告接口94.
1请求地址94.
2参数说明94.
3返回值104.
4错误返回值——状态报告请求错误返回格式及对应值11第五章短信上行接口125.
1请求地址125.
2参数说明125.
3返回值125.
4错误返回值——回复请求错误返回格式及对应值13第六章推送状态与上行146.
1绑定推送地址146.
2状态报告请求参数值146.
3上行请求参数值156.
4推送返回说明16第七章修改密码167.
1请求地址167.
2参数说明167.
3返回值17第八章WebService提交短信178.
1请求地址178.
2参数说明178.
3返回值18第九章ResultCode定义18接口说明:客户接口部分提供https和WebService(目前只支持提交短信)方式的接口,客户可以根据需求选择相应接口,接口编码方式默认采用UTF-8短信平台客户端地址:http://sh2.
ipyy.
com:8080/限制:同一个号码一天限制接收10条信息.
(如有特殊需求请另在沟通)提交(下发)速度限制:3分钟之内只能提交3条,如提交(下发)第4条即失败,忘各位客户知悉第一章短信发送接口1.
1请求地址请求地址是客户接口程序调用时请求的url地址,采用的是httpspost接口,地址是https://sh2.
ipyy.
com/sms.
aspx对应UTF-8https://sh2.
ipyy.
com/smsGBK.
aspx对应GB2312https://sh2.
ipyy.
com/smsJson.
aspx对应UTF-8(返回值为json格式)https://sh2.
ipyy.
com/ensms.
ashx对应UTF-8(加密传输,使用json)入口地址一般不会发生变化,当发生变化的时候,会通知接口用户1.
2参数说明参数名称含义说明userid企业id企业ID(不验证)account发送用户帐号用户帐号,由系统管理员password发送接口密码用户账号对应的密码可以使用明文,也可以全用md5加密方式,md5采用32位大写如abc123加密后为E99A18C428CB38D5F260853678922E03mobile全部被叫号码短信发送的目的号码.
多个号码之间用半角逗号隔开content发送内容短信的内容,内容需要UTF-8编码,提交内容格式:内容+【签名】.
签名是公司的名字或者公司项目名称.
示例:您的验证码:1439【腾飞】.
【】是签名的标识符.
请按照正规的格式提交内容测试sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-2409:08:10action发送任务命令设置为固定的:sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空.
子号只能为数字,且最多5位数.
例如:https://sh2.
ipyy.
com/sms.
aspxaction=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&content=内容&sendTime=&extno=1.
3返回值在接收到客户端发送的https请求后,返回以xml的方式返回处理结果.
格式为:status返回状态值:成功返回Success失败返回:Faildmessage相关的错误描述remainpoint返回余额taskID返回本次任务的序列IDsuccessCounts--成功短信数:当成功后返回提交成功短信数1.
4Json返回值{"returnstatus":"Success","message":"操作成功","remainpoint":"-4","taskID":"1504080852350206","successCounts":"1"}1.
5加密传输参数名称含义说明UserId企业id数字类型,由供应商提供.
Text64编码后的参数详见下解Text64的生成方法:首先构造一个json串(包含发送的具体参数).
Json的结构如下:属性名称含义说明UserName帐户名称字符串类型,由供应商提供.
Stamp时间戳格式为MMddHHmmss误差不超过5分钟.
Secret认证密文生成方式Md5(password+stamp)Md5为标准32位,大写Password由供应商提供.
Stamp为上面的字段.
Moblie手机号码多个用英文逗号分开.
Text短信的内容Ext扩展号(可选项)纯数字组成,如果没有,请留空SendTime定时时间(可选项)格式为yyyy-MM-ddHH:mm:ss非定时请留空示例:{"UserName":"test","Secret":"2A8D628159B0D4D3D4D58A3EB17F3082","Stamp":"0414174715","Moblie":"15510331875","Text":"我的验证码是:7890.
【奥创时代】","Ext":"","SendTime":""}2.
将json串用utf8转为字节数组.
上边的json转换后的结果:7B22557365724E616D65223A2274657374222C22536563726574223A223241384436323831353942304434443344344435384133454231374633303832222C225374616D70223A2230343134313734373135222C224D6F626C6965223A223135353130333331383735222C2254657874223A22E68891E79A84E9AA8CE8AF81E7A081E698AFEFBC9A37383930E38082E38090E5A5A5E5889BE697B6E4BBA3E38091222C22457874223A22222C2253656E6454696D65223A22227D3.
将字节数组,用des加密.
des使用CBC模式.
Padding为PKCS7.
Key的生成方式,将Password转为字节数组,取前8位(不足8位,右侧补字节0)IV与key相同.
上面的字节数组加密后的结果:Password为test,生成的key为:7465737400000000.
D03A8A1A6F4C5A7B05336C256045BAE555F2941C491818AE6733F9753A7500B74AED0693831D1C47919FB649E388D24139DE3AB5D269FBA277398028BA410138A95FB04C53685602ED7E75E0FC8B0BE36BC210CB2983AF1406FB801A3E76A92C96F549925CF8AA6EFF8141EB1C04F677B844710C610CC0FE223F0D232D64BC7A94DE7A194EA8E50B53DA685632EB389F06BE4D0FE57850AD3133BB1C17F6AF7D5296FF4935EAAA95CC30C9A1C4644F3D23AAFB4961FA35962B88DBE8767D190A4.
将加密后的字节数组用base64方式转为字符串.
即为Text64的值.
上面加密字节生成的结果:0DqKGm9MWnsFM2wlYEW65VXylBxJGBiuZzP5dTp1ALdK7QaTgx0cR5GftknjiNJBOd46tdJp+6J3OYAoukEBOKlfsExTaFYC7X514PyLC+NrwhDLKYOvFAb7gBo+dqkslvVJklz4qm7/gUHrHAT2d7hEcQxhDMD+Ij8NIy1kvHqU3noZTqjlC1PaaFYy6zifBr5ND+V4UK0xM7scF/avfVKW/0k16qqVzDDJocRkTz0jqvtJYfo1liuI2+h2fRkK在传输此值时,请使用urlencode返回结果:{"StatusCode":1,"Description":"操作成功","MsgId":"1504141655440332","Amount":-11,"SuccessCounts":1,"Errors":[]}参数名称含义说明StatusCode发送的状态代码数字类型,1表示成功,其它为失败,参见最后的错误代码表.
Description发送说明发送结果状态操作说明MsgId任务ID提交短信的任务批次Amount当前余额当前账户的余额SuccessCounts成功的号码数量成功的号码数量Errors错误描述本次发送中,相关的错误描述第二章彩信发送接口2.
1请求地址请求地址是客户接口程序调用时请求的url地址,采用的是httpspost接口,地址是https://sh2.
ipyy.
com/mms.
aspx对应UTF-8入口地址一般不会发生变化,当发生变化的时候,会通知接口用户2.
2参数说明参数名称含义说明userid企业id企业ID(不验证)account发送用户帐号用户帐号,由系统管理员password发送接口密码用户账号对应的密码可以使用明文,也可以全用md5加密方式,md5彩用32位大写如abc123加密后为E99A18C428CB38D5F260853678922E03mobile全部被叫号码发信发送的目的号码.
多个号码之间用半角逗号隔开subject主题彩信的主题content发送内容彩信内容,tms文件的base64编码.
Tms文件存储规格:元素1名称(即元素1的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素1的二进制内容大小(整形)+元素1的二进制内容+元素2名称(即元素2的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素2的二进制内容大小(整形)+元素2的二进制内容+元素3名称(即元素3的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素3的二进制内容大小(整形)+元素3的二进制内容+.
.
.
.
.
.
.
所有元素以此类推sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-2409:08:10action发送任务命令设置为固定的:sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空.
子号只能为数字,且最多5位数.
例如:https://sh2.
ipyy.
com/mms.
aspxaction=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&subject=彩信主题&content=base64编码&sendTime=&extno=2.
3返回值返回值与短信相同.
第三章余额及已发送量查询接口3.
1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httpspost接口,地址是https://sh2.
ipyy.
com/sms.
aspxhttps://sh2.
ipyy.
com/smsGBK.
aspxhttps://sh2.
ipyy.
com/mms.
aspx彩信余额地址,查询彩信余额,使用该地址.
https://sh2.
ipyy.
com/smsJson.
aspx对应UTF-8(返回值为json格式)入口地址一般不会发生变化,当发生变化的时候,会通知接口用户3.
2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password接口密码用户账号对应的密码可以使用明文,也可以全用md5加密方式,md5彩用32位大写如abc123加密后为E99A18C428CB38D5F260853678922E03action任务名称设置为固定的:overage例如:action=overage&userid=12&account=账号&password=密码3.
3返回值status-------返回状态值:成功返回Sucess失败返回:Faildmessage返回信息提示:见下表payinfo返回支付方式后付费,预付费overage返回余额sendTotal----返回总点数当支付方式为预付费是返回总充值点数3.
4Json返回值{"returnstatus":"Success","message":"操作成功","payinfo":"后付","overage":"-4","sendTotal":"0"}返回信息提示说明操作成功查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误第四章状态报告接口4.
1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httpspost接口,地址是https://sh2.
ipyy.
com/statusApi.
aspxhttps://sh2.
ipyy.
com/statusJsonApi.
aspx(返回值为json格式)入口地址一般不会发生变化,当发生变化的时候,会通知接口用户4.
2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password接口密码用户账号对应的密码可以使用明文,也可以全用md5加密方式,md5彩用32位大写如abc123加密后为E99A18C428CB38D5F260853678922E03statusNum每次取得号码数必须为数字,默认4000,可不填action任务名称设置为固定的:querytaskid批次编号可选项,如果传此参数,则只查询该批次的状态.
例如:action=query&userid=12&account=账号&password=密码&taskid=15235164.
3返回值15023239810对应的手机号码1212同一批任务ID10状态报告----10:发送成功,20:发送失败2011-12-0222:12:11接收时间DELIVRD-上级网关返回值,不同网关返回值不同,仅作为参考150232398111212202011-12-0222:12:1124.
4错误返回值——状态报告请求错误返回格式及对应值1错误码用户名或密码不能为空错误描述1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确4.
5Json返回值错误时:{"error":"1005","remark":"密码错了","statusbox":[]}正确时:{"error":"1","remark":"成功","statusbox":[{"mobile":"15510331875","taskid":"123","receivetime":"2015-01-0100:00:00","errorcode":"dEv"},{"mobile":"13483728958","taskid":"124","receivetime":"2015-02-0100:00:00","errorcode":"back"}]}第五章短信上行接口5.
1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httpspost接口,地址是https://sh2.
ipyy.
com/callApi.
aspxhttps://sh2.
ipyy.
com/callJsonApi.
aspx(返回值为json格式)入口地址一般不会发生变化,当发生变化的时候,会通知接口用户5.
2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password接口密码用户账号对应的密码可以使用明文,也可以全用md5加密方式,md5彩用32位大写如abc123加密后为E99A18C428CB38D5F260853678922E03action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码5.
3返回值15023239810对应的手机号码1212同一批任务ID你好,我不需要上行内容2011-12-0222:12:11接收时间01----子号,即自定义扩展号150232398111212你好,本次活动路线是怎么的2011-12-0222:12:11015.
4错误返回值——回复请求错误返回格式及对应值1错误码用户名或密码不能为空错误描述1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确5.
5Json返回值错误时:{"error":"1005","remark":"密码错了","callbox":[]}正确时:{"error":"1","remark":"成功","callbox":[{"mobile":"15510331875","taskid":"","content":"a","receivetime":"0001-01-0100:00:00","extno":"123"},{"mobile":"13483728958","taskid":"","content":"b","receivetime":"0001-01-0100:00:00","extno":"456"}]}第六章推送状态与上行6.
1绑定推送地址客户需要提供一个可以在公网访问的https接口地址,由管理员配置到账户中.
在返回状态或上行时,系统会调用该地址,将状态或上行以xml形式,推送给客户方,客户应该获取整个post内容(而并非某个参数值),来取得xml内容.
c#取得xml内容示例:StreamReaderreader=newStreamReader(Request.
InputStream,Encoding.
UTF8);StringxmlContent=reader.
ReadToEnd();java取得xml内容示例:DocumentBuilderFactorybuildFactory=DocumentBuilderFactory.
newInstance();DocumentBuilderbuild=buildFactory.
newDocumentBuilder();Documentdocument=build.
parse(request.
getInputStream());php取得xml内容示例:$raw_post_data=file_get_contents('php://input','r');$doc=newDOMDocument();$doc->loadXML($raw_post_data);6.
2状态报告请求参数值15023239810对应的手机号码1212同一批任务ID10状态报告----10:发送成功,20:发送失败2011-12-0222:12:11接收时间DELIVRD-上级网关返回值,不同网关返回值不同,仅作为参考150232398111212202011-12-0222:12:1126.
3上行请求参数值15023239810对应的手机号码1212同一批任务ID你好,我不需要上行内容2011-12-0222:12:11接收时间01----子号,即自定义扩展号150232398111212你好,本次活动路线是怎么的2011-12-0222:12:11016.
4推送返回说明如果客户成功接收状态或上行,请返回"1"字符串.
如果客户处理失败,请返回"error"字符串,系统将会尝试再次推送.
最多尝试3次.
如果客户未返回值或返回其它值,当作成功处理.
如果调用时出现网络异常,则当作失败,继续重试.
第七章修改密码7.
1请求地址https://sh2.
ipyy.
com/pwd.
aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户7.
2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password接口密码用户账号对应的旧密码newpassword新密码要设置的新密码,最长20位例如:&userid=12&account=账号&password=旧密码&newpassword=新密码7.
3返回值status-------返回状态值:成功返回Sucess失败返回:Faildmessage返回信息提示:见下表第八章WebService提交短信8.
1请求地址请求地址是客户接口程序调用时请求的url地址,地址是:https://sh2.
ipyy.
com/WebService.
asmx方法名为SendSms入口地址一般不会发生变化,当发生变化的时候,会通知接口用户8.
2参数说明参数名称含义说明userName发送用户帐号用户帐号,由系统管理员password发送接口密码用户账号对应的密码sms短信参数对象SmsObject结构,详见下面说明参数名称含义说明Msisdns全部被叫号码发信发送的目的号码.
多个号码之间用半角逗号隔开SMSContent发送内容短信的内容PlanSendTime定时发送时间为空表示立即发送,定时发送格式2010-10-2409:08:10ExtNumber扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空.
子号只能为数字,且最多5位数.
8.
3返回值返回一个SendResult结构,具体含义如下:参数名称含义说明StatusCode发送的状态代码OK表示成功,其它为失败,参见最后的错误代码表.
Description发送说明发送结果状态操作说明MsgId任务ID提交短信的任务批次Amount当前余额当前账户的余额SuccessCounts成功的号码数量成功的号码数量BillingCount消费的条数消费的条数值Errors错误描述本次发送中,相关的错误描述第九章ResultCode定义错误代码定义说明1OK操作成功1001ParamError参数错误1002UserNameEmpty用户名为空1003PasswordEmpty密码为空1004UserNameError用户名错误1005PasswordError密码错误1006BindIpErrorIP绑定错误1007UserStop帐户已停用1008UserIdErrorUserId参数错误,该值必需要是数字,由供应商提供.
1009Text64ErrorText64参数错误,错误的可能有:不是有效的base64编码,Des解密失败,解析json时出错.
1010StampError时间戳错误,可能是格式不对,或是时间偏差太大(应该在5分钟以内).
2001ContentEmpty内容为空1103MsisdnEmpty手机号码为空1104ExtNumberError扩展错误2105ContentLong内容太长1106NoChannel没有发送通道2107SensitiveWords敏感词汇1108MsisdnError错误的手机号码1109MsisdnBlack黑名单的手机号码1110MsisdnNoChannel没有通道的手机号码1111AmountNotEnough额度不足1112NoProduct没有配置产品2113RequiredSuffix需要签名2114SuffixError签名错误3001SubjectEmpty主题为空9999InternalError系统内部错误