短信验证码接口文档

互亿无线短信验证码API中国·上海4008808898互亿无线短信验证码API接口说明文件标识Ihuyi_SMSAPI-SEND版本编号V3.3发布者上海思锐信息技术有限公司发布日期2010-05-12最新更新2024-08-06

目录192541.概要 4305601.1文档说明 4103401.2提交方式 4299521.3加密方式 4121921.4APIID/APIKEY 482111.5短信模版 4104202.短信单条发送 541172.1接口描述 5267802.2请求地址 5152862.3请求参数 5210622.4响应示例 6115642.5响应参数 756702.6GET请求示例 8117493.短信批量发送 8285653.1接口描述 8196943.2请求地址 8220443.3请求参数 8321483.4响应参数 925813.5传参说明 10143434.余额查询 10243884.1接口描述 1051204.2请求地址 11320944.3请求参数 11219534.4响应示例 11198574.5响应参数 12265974.6GET请求示例 12178055.发送回执推送 12206965.1接口描述 129305.2推送参数 13268666.上行回复推送 1333036.1接口描述 13323946.2推送参数 13178047.提交模板 14162507.1接口描述 14155527.2请求地址 14153417.3请求参数 14288897.4响应参数 15134207.5模板审核状态推送 1555328.删除模板 16137018.1接口描述 16301618.2请求地址 16218938.3请求参数 1647558.4响应参数 17197349.生成动态密码方式 173020010.常见问题 181069210.1如何处理乱码 18716210.2如何实现UNIX时间戳 19453511.短信DEMO 201122312.短信插件 20259113.联系方式 22

1.概要1.1文档说明本文档主要提供给互亿平台的用户对接接口的使用说明，开发者可以利用ihuyi提供的HTTP接口，调用ihuyi的短信验证码/通知服务。1.2提交方式GET/POST1.3加密方式1、采用HTTPS协议提交请求2、通过MD5动态签名方式加密1.4APIID/APIKEY登录用户中心，进入【验证码通知短信】模块，在【产品总览】页面右侧，如下图所示：1.5短信模版短信模板是对您将要发送的短信进行相似性提取后的内容。举个例子，A用户在您平台注册会员，需要发送一条短信，内容如下：您好，您的验证码是：666666同时，B用户也在您的平台注册会员，发送了如下短信：您好，您的验证码是：888888我们提取相似度以后，可以制作以下短信模板：您好，您的验证码是：【变量】其中，变量是可变的，可以是数字、字母、汉字。注意：未付费用户仅可使用默认短信模板，付费用户可以通过左侧导航【验证码通知短信】-【短信发送】-【签名/模版管理】新增短信模板，运营商审核通过之后即可正式使用。1.6短信签名短信签名是加在短信的开头或结尾，在【】加上您的公司名称或店铺名称的标识符，例如：【互亿无线】。根据电信基础运营商的规定，每条短信必须附加短信签名，否则将无法正常发送。注意：未付费用户仅可使用默认短信签名【互亿无线】，付费用户可以通过点击左侧导航【验证码通知短信】-【短信发送】-【签名/模版管理】修改签名，运营商审核通过之后即可正式使用。2.短信单条发送2.1接口描述通过POST、GET方式进行短信提交，数据编码采用utf-8格式，24小时全天发送。内容格式为：Content-Type:application/x-www-form-urlencoded2.2请求地址http://106./webservice/sms.php?method=Submit2.3请求参数参数名称参数值描述必填accountAPIID（用户中心【验证码通知短信】-【产品纵览】查看）是password1、APIKEY（用户中心【验证码通知短信】-【产品纵览】查看）2、动态密码（生成动态密码方式请看该文档末尾的说明）是mobile接收手机号码，只能提交1个号码是content短信内容（编码格式为UTF-8，支持500个字的长短信，长短信按多条计费）例如：您的验证码是：1234。请不要把验证码泄露给其他人。是timeUnix时间戳（10位整型数字，当使用动态密码方式时为必填）否format返回格式（可选值为：xml或json，系统默认为xml）否用户通过http或https提交发送短信请求到服务器后，服务器会返回一串xml格式的字符串，SubmitResult结构说明如下：参数名称类型描述codeint返回值为2时，表示提交成功smsidstring当提交成功后，此字段为流水号，否则为0msgstring提交结果描述2.4响应示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>2</code><msg>提交成功</msg><smsid>14745625541233112231</smsid></SubmitResult>示例（失败）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>405</code><msg>用户名或密码不正确</msg><smsid>0</smsid></SubmitResult>2.5响应参数codemsg0提交失败2提交成功400非法ip访问401帐号不能为空402密码不能为空403手机号码不能为空4030手机号码已被列入黑名单404短信内容不能为空405APIID或APIKEY不正确4050账号被冻结40501动态密码已过期40502动态密码校验失败4051剩余条数不足4052访问ip与备案ip不符406手机号码格式不正确407短信内容含有敏感字符4070签名格式不正确4071没有提交备案模板4072提交的短信内容与审核通过的模板内容不匹配40722变量内容超过指定的长度【8】4073短信内容超出长度限制4074短信内容包含emoji符号4075签名未通过审核4077短信变量内容含有敏感字符408发送超限【50】条，已加入黑名单，可登入平台解除4082超出同一手机号一天之内【100】条短信限制4085同一手机号一天之内验证码短信发送超出【10】条2.6GET请求示例http://106./webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手机号码&content=您的验证码是：1234。请不要把验证码泄露给其他人。3.短信批量发送3.1接口描述通过POST方式进行短信提交，数据编码采用utf-8格式，24小时全天发送。内容格式为：Content-Type:application/x-www-form-urlencoded3.2请求地址https://106./webservice/sms.php?method=SubmitBatch3.3请求参数参数名称参数值描述必填accountAPIID(用户中心【验证码通知短信】-【产品总览】查看)是password1、APIKEY(用户中心【验证码通知短信】-【产品总览】查看)2、动态密码(生成动态密码方式请看该文档末尾的说明)是mobile手机号码（可参考下文示例）是templateid模板ID选填content短信内容选填timeUnix时间戳（10位整型数字，当使用动态密码方式时为必填）否format返回格式（可选值为：xml或json，系统默认为xml）否sendTime定时发送时间否用户通过http或https提交发送短信请求到服务器后，服务器会返回一串xml格式的字符串，SubmitBatchResult结构说明如下：参数名称类型描述codeint返回值为2时，表示提交成功smsidstring流水号（对应提交时返回的smsid）msgstring回执状态说明3.4响应参数codemsg0提交失败2提交成功400非法ip访问401帐号不能为空402密码不能为空403手机号码不能为空4031手机号码必须大于1个4032手机号码必须小于5000个404模板ID模和模板内容二选一4041模板ID不正确405APIID或APIKEY不正确4050账号被冻结40501动态密码已过期40502动态密码校验失败40505没有签定合同4051剩余条数不足4052访问ip与备案ip不符4053用户不存在4054帐户无效406手机号码格式不正确407短信内容含有敏感字符4070签名格式不正确4074短信内容包含emoji符号4075签名未通过审核4077短信变量内容含有敏感字符408定时发送时间无效(大于当时间10分钟，小于当前时间7天409计费错误3.5传参说明1、不含变量手机号格式：号码之间使用英文逗号隔开，如：136xxxx1111,136xxxx2222,136xxxx3333模板ID：对应您在平台报备过的模板ID，如：624452模板内容：您有新的订单，请注意查收。2、含变量手机号格式：变量之间用半|符号隔开，如：136xxxx1111|11111111|菜鸟,136xxxx2222|22222222|京东,136xxxx3333|3333333333|顺丰模板ID：对应您在平台报备过的模板ID，如：624452模板内容：您的订单号是：【变量】。已由【变量】快递发出，请注意查收。注意：单次提交最少2个号码，最多5000个号码模板ID和模板内容二选一，如果传模板内容或者号码数量超过500都会进入人工审核流程。4.余额查询4.1接口描述通过接口可以方便的查询你的账户验证码通知短信剩余条数。4.2请求地址http://106./webservice/sms.php?method=GetNum4.3请求参数参数名称参数值描述必填accountAPIID（用户中心【验证码通知短信】-【产品纵览】查看）是password1、APIKEY（用户中心【验证码通知短信】-【产品纵览】查看）2、动态密码（生成动态密码方式请看该文档末尾的说明）是timeUnix时间戳（10位整型数字，当使用动态密码方式时为必填）否format返回格式（可选值为：xml或json，系统默认为xml）否用户通过http或https提交帐户余额查询请求到服务器后，服务器会返回一串xml格式的字符串，GetNumResult结构说明如下：参数名称类型描述codeint状态返回值msgstring查询结果描述numstring剩余数量4.4响应示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>2</code><msg>查询成功</msg><num>856</num></GetNumResult>示例（失败）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>405</code><msg>用户名或密码不正确</msg><num>0</num></GetNumResult>4.5响应参数codemsg2查询成功400非法ip访问401帐号不能为空402密码不能为空405用户名或密码不正确4050账号被冻结4.6GET请求示例http://106./webservice/sms.php?method=GetNum&account=APIID&password=APIKEY5.发送回执推送5.1接口描述用户先提供数据接收地址，然后绑定到互亿无线系统后台，平台会以POST方式实时的将回执信息推送到此地址，内容格式为：Content-Type:application/x-www-form-urlencoded。5.2推送参数参数名称参数值描述code状态值（2成功其他为失败）msg回执状态说明mobilephone手机号码smsid流水号（对应提交时返回的smsid）report_time回执时间例：2017-08-0214:31:51注意:成功接收请输出字符“success”（不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。6.上行回复推送6.1接口描述用户先提供数据接收地址，然后绑定到互亿无线系统后台，平台会以POST方式实时的将回复信息推送到此地址，内容格式为：Content-Type:application/x-www-form-urlencoded。6.2推送参数参数名称参数值描述mobilephone手机号码content上行内容smsid流水号（对应提交时返回的smsid）（仅作参考）reply_time上行时间例：2017-05-2417:46:50注意:成功接收请输出字符“success”（不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。7.提交模板7.1接口描述通过POST、GET方式提交短信模版，数据编码采用utf-8格式，内容格式为：Content-Type:application/x-www-form-urlencoded。7.2请求地址http://106./webservice/sms.php?method=AddTemplate&account=APIID&password=APIKEY&content=【互亿无线】尊敬的会员，您好，夏季新品已上市，请关注。退订回TD7.3请求参数参数名称参数值描述methodAddTemplateaccount提交账户password提交账户密码（可以明文密码或使用32位MD5加密）content模板内容type1验证码2通知scene使用场景返回值AddTemplateResult结构说明：参数名称类型描述codeint返回值为2时，表示添加成功msgstring提交状态描述templateidint添加成功则返回模板ID7.4响应参数codemsg2添加成功400非法ip访问401用户名不能为空402密码不能为空404模板内容不能为空405用户名或密码不正确4050账号被冻结407模板内容含有敏感字符7.5模板审核状态推送在遵守HTTP协议规范的前提下，通过POST方式将回执推送到用户指定的URL地址，内容格式为：Content-Type:application/x-www-form-urlencoded。参数说明：参数名称参数值描述code状态值（2成功0驳回）msg审核状态描述templateid模板ID注意：1.成功接收请输出字符“success”（不包含引号）结束推送，否则以接收失败处理。2.每个回执最多推送3次。每次间隔叠加60秒。3.code值说明2成功0驳回（原因请看msg字段）8.删除模板8.1接口描述通过POST、GET方式提交短信模版，数据编码采用utf-8格式，内容格式为：Content-Type:application/x-www-form-urlencoded。8.2请求地址http://106./webservice/sms.php?method=DelTemplate&account=APIID&password=APIKEY&templateid=1238.3请求参数参数名称参数值描述methodDelTemplateaccount提交账户password提交账户密码（可以明文密码或使用32位MD5加密）templateid模板id返回值AddTemplateResult结构说明：参数名称类型描述codeint返回值为2时，表示删除成功msgstring提交状态描述8.4响应参数codemsg2删除成功400非法ip访问401用户名不能为空402密码不能为空404模板ID不能为空或模板ID不存在405用户名或密码不正确4050账号被冻结9.生成动态密码方式以PHP为例，提交短信的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手机号：138xxxxxxxx内容：您的验证码是：2546。请不要把验证码泄露给其他人。time：1451544941结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx您的验证码是：2546。请不要把验证码泄露给其他人。1451544941');注意：因为短信内容会包含中文，所以字符编码统一为UTF-8查询剩余条数的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手机号：138xxxxxxxxtime：1451544941结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix时间戳参考地址：/Tools/unixtime.aspx10.常见问题10.1如何处理乱码说明：将短信内容（content）进行UTF-8编码后提交。PHP乱码：$content=iconv("GBK","UTF-8",$content);JAVA乱码：sb.append("&content="+URLEncoder.encode(content,"UTF-8"));C#乱码：byte[]bTemp=System.Text.Encoding.GetEncoding("GBK").GetBytes(sbTemp.ToString());10.2如何实现UNIX时间戳语言代码JAVAStringdate=newjava.text.SimpleDateFormat("dd/MM/yyyyHH:mm:ss").format(newjava.util.Date(Unixtimestamp*1000))Linuxdate-d@UnixtimestampCstrptime(datetime,"%Y-%m-%d%H:%M:%S",&tm_time);unixtime=mktime(&tm_time);C++std::time_tt=std::time(0);DELPHIusesDateUtils;DateTimeToUnix(Now)GOimport"time"cur:=time.Now()timestamp:=cur.UnixNano()/1000000Perl先my$time=Unixtimestamp然后my($sec,$min,$hour,$day,$month,$year)=(localtime($time))[0,1,2,3,4,5,6]PHPdate('r',Unixtimestamp)Node.jsvardate=newDate(time*1000);vartime=date.getTime()/1000;Python先importtime然后time.gmtime(Unixtimestamp)RubyTime.at(Unixtimestamp)SHELLdate+%s//UNIX的时间戳;VBScript/ASPDateAdd("s",Unixtimestamp,"01/01/197000:00:00")VB6DateDiff("s","1970-1-10:0:0",ToUnixTime)易语言时间_到时间戳（）11.短信DEMO语言DEMO地址PHP/demo/sms/php.htmlJAVA/demo/sms/java.htmlASP/demo/sms/asp.htmlASP.NET(C#)/demo/sms/aspx.htmlJSP/demo/sms/jsp.htmlC/demo/sms/c.htmlC++/demo/sms/cpp.htmlDELPHI/demo/sms/delphi.htmlGO/demo/sms/go.htmlNODE.JS/demo/sms/nodejs.htmlPYTHON/demo/sms/python.htmlRUBY/demo/sms/ruby.htmlSHELL/demo/sms/shell.htmlVB6/demo/sms/vb6.html易语言/demo/sms/eyuyan.html12.短信插件语言下载地址ECtouch