Professional Documents
Culture Documents
鸿联企信通接口文档
鸿联企信通接口文档
⽬录
鸿联企信通接⼝⽂档 ...............................................................................................................1
⽬录 1
1. 保密说明 ...............................................................................................................................2
1. 保密原则 ...................................................................................................................2
2. 保密内容 ...................................................................................................................2
2. 短信下发接⼝ ....................................................................................................................... 3
3. 服务器接⼝地址 ....................................................................................................3
4. 短信发送参数 ........................................................................................................4
3. 发送返回参数说明 ................................................................................................5
4. 说明........................................................................................................................5
3. 上⾏推送接⼝ ....................................................................................................................... 6
5. 上⾏推送接⼝默认参数 ........................................................................................6
2. 说明 ........................................................................................................................ 6
3. 上⾏推送示例 ........................................................................................................7
4. 状态报告推送接⼝ ............................................................................................................... 7
1. 保密说明
1. 保密原则
本资料所有权属于北京鸿联九五信息产业有限公司,任何其他公司、个⼈
⽆论以任何形式获取了本资料,在使⽤本资料都应遵守以下保密原则:
1. 在未经北京鸿联九五信息产业有限公司授权许可下,不得以任何形式使
⽤本资料;
2. 不得传播本资料信息;
3. 不得恶意复制、散发本资料。
4. 但是不限制合作公司或个⼈在双⽅协议基础上,即北京鸿联九五信息产
业有限公司授权许可下,正常的使⽤本资料,包括在授权许可下,在公
司内部其他部⻔阅取、复制、使⽤本资料信息,或者是和第三⽅公司、
个⼈共同享⽤本资料信息。
2. 保密内容
本资料的保密内容包括:
1. 在双⽅协议的基础上,北京鸿联九五信息产业有限公司提供的资料,包
括在正式场合下提供的资料,以及在特定场合下提供的正式和⾮正式资
料和信息;
2. 在北京鸿联九五信息产业有限公司许可下,从北京鸿联九五信息产业有
限公司获取的资料和信息;
3. 从其他途径获取,但未经北京鸿联九五信息产业有限公司授权许可的本
资料信息。
本资料的保密内容不包括:
1. 北京鸿联九五信息产业有限公司已经公开或者即将公开的资料信息;
2. 经北京鸿联九五信息产业有限公司授权许可后,可以传播的资料信息;
3. 在未知本资料信息的情况,⾃主开发的信息;
4. 在接受本协议前已经获取的信息。
2. 短信下发接⼝
3. 服务器接⼜地址
接⼝采⽤HTTP协议:
调⽤URL:http://47.95.31.224:8069/sms/api/sms/send
请求⽅式:post/get
4. 短信发送参数
附1:java版
URLEncoder.encode("短信内容","gbk")
示例:get版本
http://47.95.31.224:8069/sms/api/sms/send?
username=XXXXXX&password=XXXXXX&message=ceshi&phone=13800
138000&epid=XXXXXX&linkid=1234567890&subcode=
3. 发送返回参数说明
返回代码 代码说明
00 提交成功
1 参数不完整,请检查所带的参数名是否都正确
鉴权失败,⼀般是⽤户名密码不对(1.1版本后会更新同步
2
返回密码错误功能)
7 短信内容字数超过500个字
81 ⼿机号码错误,请检查⼿机号是否正确
82 linkid 有值时,参数⻓度超过20位
83 ⼀次提交的⼿机号数量超过1000个。
84 系统错误,请联系管理员
85 账号状态异常,请联系管理员
ERR
IP验证未通过,请联系管理员增加鉴权IP
IP:XX.XX.XX.XX
4. 说明
➢ 接⼝有IP鉴权,⾮鉴权IP地址不允许访问;
➢ 接⼝⽀持get/post⽅式提交,字段不分先后顺序;
➢ 各参数名统⼀使⽤⼩写字⺟⽅式;
➢ phone为⼿机号码,最多⼀次传1000个⼿机号,以英⽂半⻆逗号隔开;
message采⽤gbk编码格式传送短信内容,内容必须2次⽤encode编码,编码编
码类型⽤GBK,这是为了避免特殊字符。
URLEncoder.encode("短信内容","gbk"),
➢ linkid字段为每次的发送标识,要有唯⼀性,⻓度不超过20位,可⽤于匹配
状态报告;
➢ username为⽤户名,建议使⽤英⽂名称;
➢ password为密码,兼容明⽂密码与32位的MD5密⽂密码,建议使⽤32位的
MD5密⽂密码;
➢ epid为客户企业ID,使⽤数字格式;
➢ subcode为发送时传送的扩展码,可为空;
➢ 注意:如果返回值错误,重复提交次数不要超过3次
3. 上⾏推送接⼝
上⾏指⼿机⽤户给发送⽅回复的信息。
上⾏信息通过HTTP协议进⾏推送。接⼝地址由合作⽅提供相应的URL。
5. 上⾏推送接⼜默认参数
参数名称 参数说明 备注
phone 主叫号码(源地址)
msgContent ⽤户上⾏消息内容
2. 说明
➢ 上⾏推送接⼝参数名允许⾃定义
➢ 上⾏回复与下⾏短信需要按spNumber进⾏匹配。spNumber为下⾏短信
时所使⽤的地址码。
3. 上⾏推送⽰例
h t t p : / / 合 作 ⽅ 接 收 上 ⾏ 推 送 的 地 址 ?
phone=13800138000&spNumber=10690036123456&msgContent=TD&linkid=3401
4001B20FD20F&serviceup=SQA0001
4. 状态报告推送接⼝
状态报告⽤来表示发送的短信是否成功发送到⼿机上。其中,移动和电信
鸿联企信通接⼝协议
DELIVRD 表示成功,联通 0 表示成功。其它错误状态需要参⻅各运营商错误
状
态报告说明。
状态报告通过 HTTP 协议进⾏传送。
接⼝地址由合作⽅提供相应的 URL
4.1. 状态报告推送接⼝参数
参数名称 参数说明 备注
PlatForm 平台名称 平台默认参数,不⽤考虑
FSubmitTime 响应时间
4.2 说明
状态报告中的 Flinkid 是接⼝下发时带的唯⼀标识,可以⽤来匹配是哪条下
⾏短信的状态;下⾏短信的 linkid 与状态报告的 FlinkID ⼀致。
鸿联企信通接⼝协议
北京鸿联九五信息产业有限公司 第 9 ⻚ 共 14 ⻚
4.3 示例
http://合作⽅接收状态报告推送的地址?PlatForm=A111&FUnikey=BCAE3A0
00B62A4420000000013800138000&FOrgAddr=10690036123456&FDestAddr=138
00138000&FSubmitTime=20161125113900&FFeeTerminal=13800138000&FService
UPID=123456&FReportCode=DELIVRD&FAckStatus=0&FLinkID=201611251137
28995961