Kaynağa Gözat

docs: 添加接口说明

weijianghai 2 yıl önce
ebeveyn
işleme
1f099e4f58
1 değiştirilmiş dosya ile 91 ekleme ve 0 silme
  1. 91 0
      domainBAPI接口说明.md

+ 91 - 0
domainBAPI接口说明.md

@@ -0,0 +1,91 @@
+# domainBAPI接口说明
+
+## 接口1: 路由查询
+
+- 实现细节:
+
+基本透传结果,需要注意非联通号码返回信息不同
+
+```http
+POST HTTP://127.0.0.1:12089/domainB/api/route/
+Content-Type: application/json
+
+{
+  "phoneNumber": "18503369666",
+  "fromSystem": "test"
+}
+```
+
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "成功",
+  "data": {
+    "phoneNumber": "18503369666",
+    "isUnicomNumber": true,
+    "userStatus": "2",
+    "routeType": "00",
+    "eparchyCode": "0335",
+    "provinceCode": "18"
+  }
+}
+```
+
+## 接口2: 5GSA查询
+
+- 实现细节:
+
+需要查询全国用户,因此需要套一层路由查询
+
+```http
+POST HTTP://127.0.0.1:12089/domainB/api/sa/
+Content-Type: application/json
+
+{
+  "phoneNumber": "18503369666",
+  "fromSystem": "test"
+}
+```
+
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "成功",
+  "data": {
+    "isUnicomNumber": true,
+    "isHaveSa": true,
+    "isUdmUser": true
+  }
+}
+```
+
+## 接口3: 功能查询
+
+- 实现细节:
+
+由于操作员权限限制,查询仅支持河北联通用户,需要注意处理非河北联通用户及非联通用户的特殊情况
+
+```http
+POST HTTP://127.0.0.1:12089/domainB/api/product/saAndVolte/
+Content-Type: application/json
+
+{
+  "phoneNumber": "18503369666",
+  "fromSystem": "test"
+}
+```
+
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "成功",
+  "data": {
+    "isHebeiUnicomNumber": true,
+    "isHaveSa": true,
+    "isHaveVolte": true
+  }
+}
+```