2_中国联通a-paas能力开放平台api规范-全业务平台分册 v1.8_第1页
2_中国联通a-paas能力开放平台api规范-全业务平台分册 v1.8_第2页
2_中国联通a-paas能力开放平台api规范-全业务平台分册 v1.8_第3页
2_中国联通a-paas能力开放平台api规范-全业务平台分册 v1.8_第4页
2_中国联通a-paas能力开放平台api规范-全业务平台分册 v1.8_第5页
已阅读5页,还剩92页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

中国联通公司发布中国联通公司企业标准QB/CUXXX2016中国联通APAAS能力开放平台API规范全业务平台分册20162发布20162实施修改后版本最后修改时间章节修改内容V1220160228新建V132016032451用户号码验证51用户号码验证接口返回结果增加产品编码和产品名称字段V142016032952章节信用额度查询52章节信用额度查询输入参数删除SERVICECLASSCODE字段;输出参数新增CREDITINFO_ENTITY实体2016033041基础产品订单提交41基础产品订单提交修改输入参数,删除下划线,SERIAL_NUMBER改为USERNUMBER2016033151用户号码验证服务51用户号码验证服务修改返回结果结构,增加验证结果实体V152016040155免费资源查询新增55免费资源查询接口20160405调整接口和调用逻辑调整接口逻辑,除用户号码验证接口外,其他所有接口输入参数增加公共参数实体;在调用所有接口之前需要先调用用户号码验证接口,并将返回结果填到其他接口输入参数公共实体中。V162016060356当月话费查询57历史账单查询58手机上网流量新增56当月话费查询新增57历史账单查询新增58手机上网流量2016060657历史账单查询移网返回参数删除业务订单号字段172016061942积分扣减59积分查询510用户余额详细信息查询新增42积分扣减新增59积分查询新增510用户余额详细信息查询1820160622511用户订购资费产品查询512SIM信息查询513号卡关系变更同步新增511用户订购资费产品查询新增512SIM信息查询新增513号卡关系变更同步目录目录41概述611背景612范围713平台介绍714参考文献815缩略语与术语82接入技术921传输协议922API调用方式923SDK调用方式93API接口列表94办理类API1041基础产品订单提交1042积分扣减135查询类1851用户号码验证1852信用额度查询2253账户余额查询2654欠费查询3055免费资源查询3556当月话费查询4057用户历史账单查询4658手机上网流量5359用户基本信息查询57510用户详细资料查询62511用户业务受理历史查询70512短信息查询(暂不启用)75513缴费记录查询79514国际漫游免缴资格查询(暂不启用)83515终端信息查询(暂不启用)86516登网信息查询(暂不启用)89517特服变更94518挂失解挂99519积分查询102520用户余额详细信息查询1066公共实体列表11361请求公共参数实体1137附录11471省份代码11572地市代码11673客户类型12474证件类别编码12575用户状态12576会员级别12777开户方式12778用户类型12879业务类型1281概述11背景随着行业和公司发展,IT和各业务领域更深度融合,IT已不仅是信息化部门的专有任务,越来越多业务单元需要直接参与到IT建设中。传统IT模式正在转变,“平台应用”新格局快速形成,IT部门将逐步更加聚焦于IT整体规划、共享能力提供、数据聚合、基础设施和服务提供等领域。为构建平台和应用间桥梁,APAAS能力体系应运而生,在2015年IT整体规划中,参照IT三层架构总体规划,进一步将各类公共业务能力进行沉淀,形成应用能力层(PAAS),通过APAAS实现IT、数据、运营、应用能力的复用和整合,促进集中统一运营红利释放。各类业务单元(BU)作为APAAS能力使用方,获得更加透明、标准化的平台能力支撑,通过平台业务应用新的IT模式,最大程度发挥自身运营灵活性,并也可实现自身能力复用、沉淀。各类能力单元(AU)做为APAAS能力提供方,视角也在逐步发生变化,由系统建设组织者逐步变为公共能力的生产者或运营者,可以专注能力潜力挖掘,打造更有价值的能力。12范围此文档是APAAS能力开放平台对外提供的服务接口规范,适用于所有通过API和SDK方式调用开放能力的场景。所有业务应用需要按照此规范要求进行服务调用,并根据返回结果做适当的业务处理。13平台介绍APAAS运营支撑平台是面向业务单元的一个能力视图,是具体的服务、管理、交易平台,包括能力商店、能力开放平台、应用部署环境管理。通过能力商店实现能力提供统一管理,所有开放能力均在能力商店上架,统一管理,统一订购;通过能力开放平台,实现能力开放,对第三方、子公司、省分BU、总部BU提供统一能力调用;通过应用部署环境管理,为创新应用提供自助式分布式部署环境。对于BU来说,APAAS运营支撑平台呈现业务标准化能力,屏蔽各能力提供平台差异化服务;另一方面对于内部各类AU提供规范服务接入,APAAS运营支撑平台是公司平台化运营的基础业务能力体系。本规范主要是针对APAAS能力开放平台对外提供的服务接口规范;14参考文献15缩略语与术语151缩略语152术语本文档所涉及的术语定义请参见下表。名词解释能力用于支撑各类业务活动的公共要素或环节,各类业务应用的“公约数”、承载一定业务功能,可复用,相对稳定。一个能力可以包括多个服务服务服务是指提供某项业务功能的具体API接口应用接入业务单元使用能力开放平台的能力,完成业务应用建设的过程业务经理业务应用的建设与维护人员,能力经理能力的建设和运营人员,AU的能力提供方平台运营方APAAS整体运营基本责任单元,负责APAAS体系的运营API调用方式通过接口地址调用服务的技术实现方式SDK调用方式通过SDK方式调用服务的技术实现方式英文缩写英文全称中文解释APAASABILITYPLATFORMASASERVICE业务能力层IPAASINTEGRATIONPLATFORMASASERVICE技术组件层AUABILITYUNIT能力单元BUBUSINESSUNIT业务单元APPKEYAPPKEY应用IDAPP_SECRETAPP_SECRET应用密钥2接入技术21传输协议采用HTTP传输协议,并采用RESTFUL风格的服务访问方式。POST把提交的数据则放置在HTTP包的包体中。所有参数值需要转换为UTF8编码。支持POST请求方式的API接口,所需要拼接的URL格式示例如下HTTP/OPEN10010COM/API/XXX服务名称/XX版本号22API调用方式通过HTTPPOST请求方式进行API调用,并根据API规范拼接正确的URL,就能够办理相应业务或取得相应数据。23SDK调用方式APAAS能力开放平台SDK提供了调用接口(API)的请求封装、签名、返回解析、消息监听等功能,使用SDK可以轻松完成API的调用,API结果的获取,消息的实时监听。3API接口列表API类型API名称API标识4办理类API41基础产品订单提交411应用场景适用基础产品订购、退订的订单提交412请求说明API名称CNALLSERVICECOREBASICTRANORDERSUB外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICTRAN/ORDERSUB/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICTRAN/ORDERSUB/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1413输入参数4131应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR40Y服务号码PRODUCTIDVARCHAR8Y产品标识MODIFYTAGCHAR1Y操作标志0订购1退订STARTENABLECHAR1Y生效标识0立刻生效1预约生效PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体414返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答码应答码0000成功8888其他错误RESPDESCVARCHAR500Y应答描述415实体列表416API调用示例4161请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PRODUCTID“12345678“,“MODIFYTAG“0“,“STARTENABLE“0“,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“4162返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“成功“,异常返回(全业务异常返回)“DATA“RSPCODE“0110“,“RSPDESC“省分接口调用超时“,异常返回(开放平台异常时返回)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“417SDK调用示例4171请求示例4172返回示例418错误码解释419备注说明42积分扣减421应用场景用于积分扣减、回退或转赠。暂时只支持4G用户。422请求说明API名称CNALLSERVICECOREBASICTRANSCOREDEDUCT外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICTRAN/SCOREDEDUCT/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICTRAN/SCOREDEDUCT/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1423输入参数4231应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR30Y服务号码AREACODEVARCHAR4N固网区号固网必填SERVICETYPECHAR1Y业务类型1积分调整2ECS积分兑换3积分回退4积分转赠5积分销售PAYFEEMODECHAR1Y支付方式0积分支付1积分现金OPERTYPECHAR2Y操作类型01扣减02回退03转赠04销售(仅能取值“合作伙伴积分”)POINTSVARCHAR50Y积分数CHANTYPECHAR1Y积分消费渠道0积分商城1网上营业厅2手机营业厅3短信营业厅4实体营业厅5自助终端机6微信厅7迷你厅CONSUMETYPECHAR1Y积分用途0合作方产品1一卡充21G流量半年包3网厅交费4积分活动5积分转赠6积分销售7实体营业厅兑换DONEEAREACODEVARCHAR6N积分受赠区号DONEENUMBERVARCHAR40N积分受赠号码GIFTOWNERSHIPCHAR1N礼品归属范围0全国1省分(根据区号确定)PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体424返回结果名称类型必填说明备注RESPCODEVARCHAR40Y应答码应答编码0000成功1204号码不存在1420客户无积分1560可转赠积分余额不足1561不同地市号码不可转赠8888其它错误RESPDESCVARCHAR256N结果描述附加描述信息425实体列表426API调用示例4261请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PUB_PARAMS“CUSTOMID“01239012391031“,“PROVINCECODE”10”,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“4262返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“ENABLE“,“USERSTATE“01“,“PROVINCECODE“11“,“EPARCHYCODE“110“,“CUSTNAME“客户名称“,“CUSTTYPE“0“,“CERTTYPECODE“01“,“CERTCODE“身份证号码“,“PRODUCTNAME“4G全国套餐106元“,“VIPCLASSID“0“,“DEPOSITMONEY“16“,“ROAMSTAT“0“,“LANDLVL“3“,“EXEMPT“3“,“VLRREGPOSITION“VLR登记位置“,“PHONEBAND“手机品牌“异常返回(全业务异常返回)“DATA“RSPCODE“1204“,“RSPDESC“省份不支持该业务“异常返回(开放平台异常时返回)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“427SDK调用示例4271请求示例4272返回示例428错误码解释429备注说明5查询类51用户号码验证511应用场景根据号码获取号码省份、地市、网别、付费类型等基本信息。调用其他接口前需要先调用此接口,将此接口返回结果填到相关输入公共参数中。512请求说明API名称CNALLSERVICECOREBASICQUERYUSERNUMBERCHECK外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/USERNUMBERCHECK/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/USERNUMBERCHECK/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1513输入参数5131应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR40Y服务号码514返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答码应答码0000成功8888其他错误RESPDESCVARCHAR500N应答描述CHECKRESULTCHECKRESULT_ENTITYN验证结果实体515实体列表5151验证结果实体51511实体说明实体名称CHECKRESULT_ENTITY实体描述51512实体数据名称类型必填说明备注PROVINCECODEVARCHAR3Y省分编码CITYCODEVARCHAR3Y地市编码NETTYPEVARCHAR2Y网别012G023G03固定电话04宽带(ADSL)05宽带(LAN)06小灵通07WLAN业务08融合09集团10上网卡114GOPENDATEVARCHAR14Y入网时间YYYYMMDDHH24MISSPAYTYPEVARCHAR1Y付费类型0不区分付费类型只针对于小灵通1预付费2后付费SUBSCRBSTATVARCHAR10Y用户状态用户状态BRANDVARCHAR2Y品牌标识1世界风,2如意通,3新势力4新时空,5联通商务,6其他8无线上网卡,9沃A4G后付费的标记B4G预付费无线上网卡LANDLVLVARCHAR2Y通话级别1本地通话2省内通话3国内通话4港澳台通话5国际通话6不在以上几种范围内的ROAMSTATVARCHAR2Y漫游状态1本地2省内漫游3国内漫游4国际漫游5港澳台漫游PRODUCTIDVARCHAR30N产品编码PRODUCTNAMEVARCHAR64N产品名称516API调用示例5161请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER5162返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“成功“,“CHECKRESULT“PROVINCECODE“11“,“CITYCODE“110“,“NETTYPE“11“,“OPENDATE“20150101“,“PAYTYPE“2“,“SUBSCRBSTAT“01“,“BRAND“A“,“LANDLVL“3“,“ROAMSTAT“3“,“PRODUCTID“99119092“,“PRODUCTNAME“后向定向流量包100M后付费当月生效“异常返回(全业务异常返回)“DATA“RSPCODE“0110“,“RSPDESC“省分接口调用超时“异常返回(开放平台异常时返回)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“517SDK调用示例5171请求示例5172返回示例518错误码解释519备注说明52信用额度查询521应用场景查询用户信用额度信息。522请求说明API名称CNALLSERVICECOREBASICQUERYCREDITBALANCE外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/CREDITBALANCE/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/CREDITBALANCE/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1523输入参数5231应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR40Y服务号码AREACODEVARCHAR4N固网区号固网必填PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体524返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答编码0000信用度查询成功1204号码不存在8888其它RESPDESCVARCHAR500N应答描述CREDITINFOCREDITINFO_ENTITYN信用度信息实体525实体列表5251信用度信息实体52511实体说明实体名称CREDITINFO_ENTITY实体描述52512实体数据名称类型必填说明备注CREDITCLASSVARCHAR8N信用等级信用等级,信用度等级编码原则是3G用户遵循3G信用度编码(A、B、C、D、E、Z【无信用等级】)、其他用户遵循统一数据模型CRDTTHRESHOLDVARCHAR11Y信用额度信用额度单位分TOTALCREDITVALUEVARCHAR11N用户总信用度单位分AVAILABLECREDITVALUEVARCHAR11N用户可用信用度单位分526API调用示例5261请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“5262返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“成功“,“CREDITINFO”“CREDITCLASS“A“,“CRDTTHRESHOLD“300“异常返回(全业务异常返回)“DATA“RSPCODE“0110“,“RSPDESC“省分接口调用超时“异常返回(开放平台异常时返回)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“527SDK调用示例5271请求示例5272返回示例528错误码解释529备注说明53账户余额查询531应用场景适用与账户余额、账户可用余额、实时话费等简单信息查询532请求说明API名称CNALLSERVICECOREBASICQUERYACCTBALANCE外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/ACCTBALANCE/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/ACCTBALANCE/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1533输入参数5331应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR40Y服务号码TELAREACODEVARCHAR4N固网区号固网必填PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体534返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答码应答码0000成功1204该号码不存在8888其他错误RESPDESCVARCHAR500Y应答描述ACCTMONEYINFOACCTMONEYINFO_ENTITYN账户余额信息实体535实体列表5351账户余额信息实体53511实体说明实体名称ACCTMONEYINFO_ENTITY实体描述53512实体数据名称类型必填说明备注BALANCEVARCHAR11N账户余额单位分ACCTBALANCEVARCHAR11Y账户可用余额单位分ACCTCURNTBALANCEVARCHAR11N账户当前可用余额单位分REALFEEVARCHAR11N实时话费单位分ACCTBALANCEUNAVAILABLEVARCHAR11N账户冻结余额单位分536API调用示例5361请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“5362返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“成功“,“ACCTMONEYINFO“BALANCE“320“,“ACCTBALANCE“120“,“ACCTCURNTBALANCE“20“,“REALFEE“100“,“ACCTBALANCEUNAVAILABLE“200“异常返回(全业务异常返回)“DATA“RSPCODE“1204“,“RSPDESC“该号码不存在“异常返回(开放平台异常时返回)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“537SDK调用示例5371请求示例5372返回示例538错误码解释539备注说明54欠费查询541应用场景查询用户已欠话费金额。542请求说明API名称CNALLSERVICECOREBASICQUERYOWEFEE外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/OWEFEE/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/OWEFEE/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1543输入参数5431应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR30Y服务号码TELAREACODEVARCHAR4N固网区号NPUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体544返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答码应答码0000成功1204该号码不存在8888其他错误RESPDESCVARCHAR500Y应答描述OWEFEEINFOOWEFEEINFO_ENTITYN欠费信息实体545实体列表5451欠费信息实体54511实体说明实体名称OWEFEEINFO_ENTITY实体描述54512实体数据名称类型必填说明备注TOTALFEEVARCHAR11Y往月欠费合计(不包括滞纳金及实时话费)单位分PAYFEEVARCHAR11Y应交金额应交金额费用合计上次余额,应交金额0单位分CYCLEOWEFEEINFOCYCLEOWEFEEINFO_ENTITYN分账期欠费信息实体5452分账期欠费信息实体54521实体说明实体名称CYCLEOWEFEEINFO_ENTITY实体描述54522实体数据名称类型必填说明备注CYCLEIDVARCHAR6Y账期标识LATEFEEVARCHAR11Y本次滞纳金合计单位分RECEIVEDLATEFEEVARCHAR11Y已收滞纳金单位分BALANCEVARCHAR11Y本次欠费合计(包含滞纳金)单位分FEEVARCHAR11Y该账期应收单位分RECEIVEDFEEVARCHAR11Y已收费用单位分546API调用示例5461请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“5462返回示例正确返回“DATA“RSPCODE“0000“,“OWEFEEINFO“TOTALFEE“10000“,“PAYFEE“3792“,“CYCLEOWEFEEINFO“CYCLEID“201602“,“LATEFEE“1998“,“RECEIVEDLATEFEE“2789“,“BALANCE“6382“,“FEE“689“,“RECEIVEDFEE“7868“异常返回(全业务返回异常)“DATA“RSPCODE“1204“,“RSPDESC“该号码不存在“异常返回(开放平台自身异常)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“547SDK调用示例5471请求示例5472返回示例548错误码解释549备注说明55免费资源查询551应用场景查询该号码当月包月分钟数、当月剩余分钟、当月超出分钟数、共享时长类型(本地、省内、省间、漫游、主叫、被叫)、共享流量、共享短信数等。552请求说明API名称CNALLSERVICECOREBASICQUERYFEEPOLICYADDUP外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/FEEPOLICYADDUP/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/FEEPOLICYADDUP/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1553输入参数5531应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR30Y服务号码TELAREACODEVARCHAR4N固网区号固网必填CYCLEIDCHAR6Y账期PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体554返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答编码应答码0000成功,如果有相应免费资源信息则返回FEEPOLICYADDUPINFO实体。如果没有免费资源信息,则不返回FEEPOLICYADDUPINFO节点。1204此用户不存在。8888其他错误。RESPDESCVARCHAR500N应答描述FEEPOLICYADDUPINFOFEEPOLICYADDUPINFO_ENTITYN免费资源实体555实体列表5551欠费信息实体55511实体说明实体名称FEEPOLICYADDUPINFO_ENTITY实体描述55512实体数据名称类型必填说明备注RESOURCETYPEVARCHAR2N资源类型资源类型01上网流量值(除13、18、20外的其他流量值)02语音电话03国内可视电话04短信05M值06T值08彩信09本地共享时长10国内共享时长11本地长途12本地通话13定向流量14亲情时长15主套餐WLAN时长16叠加包WLAN时长17融合WLAN时长18国际漫游流量19国际语音20闲时流量RESOURCESOURCEVARCHAR1N资源来源标识0当月套餐(默认)1结转资源FEEPOLICYNAMEVARCHAR200Y套餐名称FEEPOLICYIDVARCHAR8Y套餐标识ADDUPITEMNAMEVARCHAR100Y免费资源名称ADDUPUPPERVARCHAR20Y累计值上限,即套餐内包含的免费资源量。XUSEDVALUEVARCHAR20Y已经使用的免费资源量XCANUSEVALUEVARCHAR20Y剩余免费资源量XEXCEEDVALUEVARCHAR20Y超出部分使用量ELEMTYPEVARCHAR1Y累计量单位0金额(分)1时长(分钟)2短信条数(条)3流量(MB)4M个数5T个数CYCLEIDCHAR6Y账期556API调用示例5561请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“CYCLEID“201604“,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“,5562返回示例正确返回“DATA“RSPCODE“0000“,“FEEPOLICYADDUPINFO“RESOURCETYPE“01“,“RESOURCESOURCE“0“,“FEEPOLICYNAME“96元套餐“FEEPOLICYID“98098“,“ADDUPITEMNAME“76TB7“,“ADDUPUPPER“1000“,“XUSEDVALUE“200“,“XCANUSEVALUE“800“,“XEXCEEDVALUE“0“,“ELEMTYPE“3“,“CYCLEID“201604“异常返回(全业务返回异常)“DATA“RSPCODE“1204“,“RSPDESC“该号码不存在“异常返回(开放平台自身异常)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“557SDK调用示例5571请求示例5572返回示例558错误码解释559备注说明如果用户的免费资源已使用完,则剩余量填写0,超出部分填写在超出量中。例如套餐内每月有500分钟免费通话,用户某月通话700分钟,则套餐内免费资源上限500,资源已使用量700,剩余量0,超出量200。56当月话费查询561应用场景查询该号码当月话费详细信息。562请求说明API名称CNALLSERVICECOREBASICQUERYCURRENTFEE外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/CURRENTFEE/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/CURRENTFEE/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1563输入参数5631应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR30Y服务号码TELAREACODEVARCHAR4N固网区号固网必填QUERYTYPEVARCHAR1N查询方式固网用户必填1按用户2按账户PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体564返回结果移网返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答编码RESPDESCVARCHAR500N应答描述REALFEEVARCHAR10Y实时话费AMOUNTVARCHAR10Y话费余额ITEMINFOITEMINFO_ENTITYN费用项明细信息实体固网返回结果名称类型必填说明备注RSPMSGRSPMSG_ENTITYY返回公共参数实体REALTIMEFEEVARCHAR10Y实时话费(当月已产生话费)与省分BSS一致,4G固网返回单位元单位元REALTIMEBALANCEVARCHAR10Y实时余额4G固网返回单位元单位元ACCIDVARCHAR10N账户标识当按照2账户查询时返回,按1用户查询时不返回ACCDETALINFOACCDETALINFO_ENTITYN用户账单信息实体565实体列表5651费用项明细信息实体56511实体说明实体名称ITEMINFO_ENTITY实体描述56512实体数据名称类型必填说明备注INTEGRATEITEMCODEVARCHAR8Y账目编码INTEGRATEITEMVARCHAR100Y账目科目名称UPPERACCTITEMCODEVARCHAR8N上级账目科目编码INTEGRATEITEMCODETYPECHAR1Y科目类型0主业1非主业FEEVARCHAR11Y应收金额RECEIVEDFEEVARCHAR11Y已收金额BALANCEVARCHAR11Y本次欠费5652用户帐单信息实体56521实体说明实体名称ACCDETALINFO_ENTITY实体描述56522实体数据名称类型必填说明备注USERNUMVARCHAR30Y用户号码STOREDOFFSETFEEVARCHAR10N预存话费冲销单位元PREPAIDOFFSETFEEVARCHAR10N预付话费冲销单位元PRESENTOFFSETFEEVARCHAR10N赠送话费冲销单位元TOTALFEEVARCHAR10N用户总费用单位元ACCLISTACCLIST_ENTITYN一级账目列表实体5653一级账目列表实体56531实体说明实体名称ACCLIST_ENTITY实体描述56532实体数据名称类型必填说明备注ACCTYPEVARCHAR60Y一级账目名称如月固定费语音通话费可视电话费增值业务费上网费DETAILLISTDETAILLIST_ENTITYN二级账目列表实体5654二级账目列表实体56541实体说明实体名称DETAILLIST_ENTITY实体描述56542实体数据名称类型必填说明备注ACCNAMEVARCHAR60Y二级账目名称ACCFEEVARCHAR10N账目费用单位厘单位元566API调用示例5661请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“PUB_PARAMS“PROVINCECODE“010“,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“,5662返回示例正确返回“DATA“RSPCODE“0000“,“RSPDESC“成功“,“REALFEE“96“,“CREDITVALUE“200“,“AMOUNT“104“,“AMOUNTNOTES“话费余额说明“,“STOPAMOUNT“304“,“TIMESTAMP“20160523142312“,“REALFESTR“起始时间20160501;截止时间20160522;月租/包月费45;话费088;账户应缴538;账户余额2232“,“NOTES“无“,异常返回(全业务返回异常)“DATA“RSPCODE“1204“,“RSPDESC“该号码不存在“异常返回(开放平台自身异常)“DATA“STATUS“SAF001“,“MESSAGE“APPKEY校验失败“567SDK调用示例5671请求示例5672返回示例568错误码解释569备注说明57用户历史账单查询571应用场景根据手机用户号码,分账期查询用户账单。该API中所有金额单位均为分。572请求说明API名称CNALLSERVICECOREBASICQUERYHISTORYBILL外网调用入口HTTP/OPEN10010COM/API/ALLSERVICE/COREBASICQUERY/HISTORYBILL/V1内网调用入口HTTP/1024921428001/API/ALLSERVICE/COREBASICQUERY/HISTORYBILL/V1HTTP请求方式HTTPPOST格式JSONAPI授权类型需要授权是否收费API否类型基础服务版本V1573输入参数5731应用级输入参数名称类型必填说明备注USERNUMBERVARCHAR30Y服务号码BILLDATEVARCHAR6Y帐单年月YYYYMMTELAREACODEVARCHAR4N固网区号固网必填PUB_PARAMSPUB_PARAMS_ENTITYY输入公共参数实体574返回结果名称类型必填说明备注RESPCODEVARCHAR4Y应答编码应答码0000成功1204该号码不存在8888其他错误RESPDESCVARCHAR500N应答描述BILLINFOBILLINFO_ENTITYN账单信息实体575实体列表5751用户账单信息实体57511实体说明实体名称BILLINFO_ENTITY实体描述57512实体数据名称类型必填说明备注USERNUMBERVARCHAR30Y用户号码AREACODEVARCHAR6N长途区号ALLFEEVARCHAR11Y本月发生费用合计RECVFEEUSEDVARCHAR11Y预存话费冲销PRESENTFEEUSEDVARCHAR11Y赠送话费冲销BACKFEEVARCHAR11Y退费ACTIONFEEUSEDVARCHAR11Y预付话费冲销DERATEFEEVARCHAR11Y减免ADJUSTFEEVARCHAR11Y补收WRITEOFFFEEVARCHAR11Y本月冲销费用合计BALANCEVARCHAR11Y本月应缴费用合计BILLDETAILBILLDETAIL_ENTITYN用户账单详细信息实体DEPOSITDETAILDEPOSITDETAIL_ENTITYN用户账本详细信息实体SCOREDETAILSCOREDETAIL_ENTITYN用户积分信息实体RESULTMEMOVARCHAR500Y备注信息5752用户账单详细信息实体57521实体说明实体名称BILLDETAIL_ENTITY实体描述57522实体数据名称类型必填说明备注PARENTITEMCODEVARCHAR8Y父账目编码,1表示没有父账目项INTEGRATEITEMCODEVARCHAR8Y账目编码INTEGRATEITEMVARCHAR100Y账目名称FEEVARCHAR11Y账目金额BALANCEVARCHAR11N账目余额(未销账金额,即欠费)USEDVALUEVARCHAR200N使用量DISCNTVARCHAR11N优惠金额ADJUSTBEFOREVARCHAR11N账前调整金额ADJUSTAFTERVARCHAR11N账后调整金额5753用户账本详细信息实体57531实体说明实体名称DEPOSITDETAIL_ENTITY实体描述57532实体数据名称类型必填说明备注DEPOSITNAMEVARCHAR100Y账本名称LASTMONEYVARCHAR11Y上期余额RECVFEEVARCHAR11Y本期存入XNEWBALANCEVARCHAR11Y本期可用余额FEEVARCHAR11Y本期扣费BALANCEVARCHAR11Y当前结余5754用户积分详细信息实体57541实体说明实体名称SCOREDETAIL_ENTITY实体描述57542实体数据名称类型必填说明备注RSRVSCORE1VARCHAR11Y本期新增积分消费积分奖励积分调整积分RSRVSCORE2VARCHAR11Y新增消费积分RSRVSCORE3VARCHAR11Y新增奖励积分RSRVSCOREADJUSTVARCHAR11Y增加调整积分SCOREUSEVALUEVARCHAR11Y本期应用积分,本期已兑换积分SCOREIDLEVALUEVARCHAR11Y可应用积分,当前剩余积分576RESULTMEMO576VARCHAR500576Y576备注信息576576API调用示例5761请求示例“APP_KEY“X9LELKX“,“TIMESTAMP“20140101101937212“,“SERIAL_NUMBER“COKD31N20140101101937816X93Z92“,“SIGN“COKD31SLKJKLSDAKDJASLDAKJDJKAS“,“DATA“USERNUMBER,“BILLDATE“201502“,“PUB_PARAMS“PROVINCECODE”10”,“CITYCODE“012“,“NETTYPE“01“,“PAYTYPE“1“5762返回示例正确返回(移网)“DATA“RESPCODE“0000“,“RESPDESC“成功“,“BILLSTR“账单详情“正确返回(固网非4G)“DATA“RESPCODE“0000“,“RESPDESC“成功“,“ACCDETALINFO“USERNUM“01012345“,“PRESENTOFF

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论