客户接口说明客户接口说明 1第一章 发送接口 21.1请求地址 21.2参数说明 21.3返回值 2第二章余额及已发送量查询接口 32.1请求地址 32.2参数说明 32.3返回值 3第三章非法关键词查询 43.1请求地址 43.2参数说明 43.3返回值 4第四章状态报告接口 54.1请求地址 54.2参数说明 54.3返回值 54.4错误返回值——状态报告请求错误返回格式及对应值 6第五章上行接口 65.1请求地址 65.2参数说明 65.3返回值 75.4错误返回值——回复请求错误返回格式及对应值 7第六章附加说明 8接口说明:客户接口部分提供httpurl方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8第一章 发送接口1.1请求地址请求地址是客户接口程序调用时请求的url地址,采用的是httppost接口,地址是:8888/sms.aspx对应UTF-8:8888/smsGBK.aspx对应GB2312入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 1.2参数说明:8888/sms.aspx:8888/smsGBK.aspx参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号,由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开content发送内容短信的内容,内容需要UTF-8编码sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-2409:08:10action发送任务命令设置为固定的:sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。例如:action=send&userid=12&account=账号&password=密码&mobile=,&content=内容&sendTime=&extno=1.3返回值在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
status----------返回状态值:成功返回Success失败返回:Faildmessage----------返回信息:见下表remainpoint----------返回余额taskID ----------- 返回本次任务的序列IDsuccessCounts--成功短信数:当成功后返回提交成功短信数返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符:表示检查到不允许发送的非法字符对不起,您当前要发送的量大于您当前余额当支付方式为预付费是,检查到账户余额不足其他错误其他数据库操作方面的错误第二章余额及已发送量查询接口2.1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httppost接口,地址是:8888/sms.aspx:8888/smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 2.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:overage例如:action=overage&userid=12&account=账号&password=密码2.3返回值
status-------返回状态值:成功返回Success失败返回:Faildmessage--------------返回信息提示:见下表payinfo--------------返回支付方式 后付费,预付费overage-------------返回余额sendTotal----返回总点数 当支付方式为预付费是返回总充值点数返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误第三章非法关键词查询3.1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httppost接口,地址是:8888/sms.aspx:8888/smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 3.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:checkkeywordcontent检测发送内容需要发送的内容例如:action=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值
message--------------返回信息提示:见下表返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词未包含非法字符未检查出非法关键词第四章状态报告接口4.1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httppost接口,地址是:8888/statusApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 4.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码4.3返回值
-------------对应的手机号码1212-------------同一批任务ID10---------状态报告----10:发送成功,20:发送失败2011-12-0222:12:11-------------接收时间DELIVRD-上级网关返回值,不同网关返回值不同,仅作为参考1212202011-12-0222:12:1124.4错误返回值——状态报告请求错误返回格式及对应值
1-------------错误码用户名或密码不能为空-------------错误描述1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确第五章上行接口5.1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是httppost接口,地址是:8888/callApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 5.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码5.3返回值
-------------对应的手机号码1212-------------同一批任务ID你好,我不需要---------上行内容2011-12-0222:12:11-------------接收时间1212你好,本次活动路线是怎么的2011-12-0222:12:115.4错误返回值——回复请求错误返回格式及对应值
1-------------错误码用户名或密码不能为空-------------错误描述1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确6 附加说明6.1 接口地址常用接口地址::8888/sms.aspx备用接口地址:6.2 郑重声明1.禁止相同的内容多个手机号连续一条一条提交.否则禁用帐号,由此带来损失由客户自行负责.2.请客户提供外网服务器IP以便于绑定IP发送,提高账号的安全性!3.在程序里最好有配置文件,程序自动判断当某个接口连接超时提交速度变慢时.程序可以自动切换其它的接口以下是推荐的几个服务器,仅接口地址不同而已.方法全部相同;备用地址1:备用地址2:备用地址3:特别提示:域名不能访问的请使用以下地址访问http://211.149.223.30:8888/sms.aspx对应UTF-8http://211.149.223.30:8888/smsGBK.aspx对应GB2312