浏览代码

docs: 更新接口文档

weijianghai 2 年之前
父节点
当前提交
7b55e78833
共有 1 个文件被更改,包括 40 次插入0 次删除
  1. 40 0
      doc/接口文档/domainBAPI接口说明.md

+ 40 - 0
doc/接口文档/domainBAPI接口说明.md

@@ -32,6 +32,16 @@ Content-Type: application/json
 }
 ```
 
+### 输出参数说明
+<table>
+    <tr><td>phoneNumber</td><td>手机号</td></tr>
+    <tr><td>isUnicomNumber</td><td>是否联通号码</td></tr>
+    <tr><td>userStatus</td><td>用户状态;1:drds 号码在用状态 且为新架构号码 2:oracle 号码在用状态 且为cBss常态化号码 3:非CB 号码在cBss系统没有路由记录 4:drds 号码失效状态 且为新架构号码 5:oracle 号码失效状态 且为cBss常态化号码</td></tr>
+    <tr><td>routeType</td><td>路由类型</td></tr>
+    <tr><td>eparchyCode</td><td>地市编码</td></tr>
+    <tr><td>provinceCode</td><td>省份编码</td></tr>
+</table>
+
 ## 接口2: 5GSA查询
 
 - 实现细节:
@@ -61,6 +71,13 @@ Content-Type: application/json
 }
 ```
 
+### 输出参数说明
+<table>
+    <tr><td>isUnicomNumber</td><td>是否联通号码</td></tr>
+    <tr><td>isHaveSa</td><td>是否有SA服务</td></tr>
+    <tr><td>isUdmUser</td><td>是否UDM用户</td></tr>
+</table>
+
 ## 接口3: 功能查询
 
 - 实现细节:
@@ -92,6 +109,14 @@ Content-Type: application/json
 
 ```
 
+### 输出参数说明
+<table>
+    <tr><td>isHebeiUnicomNumber</td><td>是否河北联通号码</td></tr>
+    <tr><td>is5gProduct</td><td>是否5g套餐</td></tr>
+    <tr><td>isHaveSa</td><td>是否开通5g</td></tr>
+    <tr><td>isHaveVolte</td><td>是否开通volte</td></tr>
+</table>
+
 ## 接口4:用户资料三户返回
 
 ```http
@@ -115,6 +140,11 @@ Content-Type: application/json
 }
 ```
 
+### 输出参数说明
+<table>
+    <tr><td>userState</td><td>用户状态</td></tr>
+</table>
+
 ## 接口5:欠费接口整合
 
 ```http
@@ -142,3 +172,13 @@ Content-Type: application/json
   }
 }
 ```
+
+### 输出参数说明
+<table>
+    <tr><td>payFee</td><td>应交金额=费用合计-上次余额,应交金额&gt;=0(往月欠费+实时话费)</td></tr>
+    <tr><td>balanceFee</td><td>当前余额</td></tr>
+    <tr><td>realFee</td><td>实时话费</td></tr>
+    <tr><td>creditClass</td><td>信用等级</td></tr>
+    <tr><td>totalCreditValue</td><td>用户总信用度</td></tr>
+    <tr><td>availableCreditValue</td><td>可用额度</td></tr>
+</table>