A.1 功能要求
終端信息上報功能是指終端通過蜂窩網絡,主動向泛智能終端管理平臺上報終端和用戶卡基本信息的過程。
終端信息上報流程
終端開機,首次成功登網后,應該向泛智能終端平臺發起信息上報,發送終端信息。
具體流程如下:
(1) 終端開機首次成功登網后啟動信息上報流程,IsFirstAttachedCellNet置為TRUE;
(2) 終端查看移動網絡數據業務是否可用,若數據連接可用,進行上報信息數據準備,否則本次信息上報流程結束;
(3) 終端將打包的終端信息數據發送到泛智能終端管理平臺,具體要求請參考第七章終端信息上報接口要求部分;
(4) 泛智能終端管理平臺收到終端信息上報消息后,向終端反饋消息,若終端收到泛智能終端管理平臺反饋消息(具體消息內容請參考第八章ResultCode定義),啟動終端信息更新定時器,IsFirstAttachedCellNet置為FALSE,本次終端信息上報流程結束;若終端收到泛智能終端管理平臺反饋的響應報文信息未成功或者連接超時后,直接結束本次信息上報流程;
(5) 對于連接超時的情況,終端應進行多輪重試,終端最多進行3輪重試,重試時間間隔為0.5小時,若都不成功,則到下次重新開機時再次重試。
終端信息上報流程
終端信息更新規則
如下是對終端的要求:
(1) 終端信息上報成功后(收到泛智能終端管理平臺的信息上報成功消息),每隔24小時循環上報終端信息。
例如:設備第一次開機上報信息成功時間為2018年7月20日18:30:00,那么該設備再次上報終端信息時間為2018年7月21日18:30:00。
(2) 對于終端信息上報失敗的情況,終端也應該每隔24小時循環上報終端信息。
例如:設備收到信息上報錯誤消息反饋的時間為2018年7月20日18:30:00,那么設備再次上報終端消息時間為2018年7月21日18:30:00。
(3) 終端在國際漫游狀態下,信息上報功能禁止使用。
終端信息上報模塊系統要求
信息上報模塊要求做到對用戶不可見,不可卸載,具備可擴展性,服務名或進程名不能帶有中國電信的特征字符。信息上報模塊運行完成后即退出,不常駐內存。
終端信息上報模塊升級要求
信息上報模塊應具備可擴展性且能通過OTA升級,升級時應對用戶不可見。版本號字段(PDM-Version)取值格式為1.0、2.0、3.0等,初始值為1.0。
A.2 接口版本頭域要求
接口版本頭域要求
在http頭域中增加如下頭域:
頭域名稱 | 功能 | 說明 |
PDM-Version | 用于標識不同接口版本 | 與接口文檔版本號保持一致,初始版本為:(Cell-PDM-V1.0) |
PDM-APP-ID | 標識泛智能終端管理平臺可識別的APPID | 終端廠商向運營商申請可用的APPID,泛智能終端管理平臺僅接納經過授權的APPID(預留,默認為DeviceName) |
PDM-APP-Key | 標識泛智能終端管理平臺可識別的APPID對應的Key值 | 用于標識APPID的對應Key值。(預留,默認為DeviceName) |
DeviceName,具體格式為:終端廠商名稱代碼-終端型號
具體要求:
1)DeviceName只能由英文字母、數字、-(英文減號),+(英文加號)、空格組成
2)廠商代碼名稱默認為前3位,如果廠商代碼名稱少于3位,則“-”號前移
3)DeviceName字段只能包含唯一的一個“-”(英文減號),如出現多于一個“-”,則僅保留第一個即廠家名稱代碼和終端型號之間的“-”,后續的“-”由空格代替,例如廠商簡稱為JM,終端型號為NAIDE-Z189123時,機型字段的描述應為JM-NAIDE Z189123;
4)如果廠商在工信部登記的終端型號中已包含由中國電信分配的廠商代碼,則終端型號字段填寫為正式終端型號中去掉該代碼的后面字符,例如:三星SCH-F609的DeviceName填寫應為SCH-F609,而不應為SCH-SCH609或其他。
A.3 終端信息上報接口要求
接口描述
(1) 接口功能
實現對4G多形態泛智能終端的信息上報功能
(2) 調用方法
POST
(3) 格式
JSON
(4) 請求名稱
DevReg
(5) 泛智能終端管理平臺地址
http://pdm.tydevice.com/cellular
請求消息參數說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
1 eqSN | 必選 | Int | 4 | 消息中的請求序列號 一個消息中會有多個請求序列,序列號在同一次請求中需保持唯一性 |
ReqName | 必選 | String | 24 | 標識操作行為,終端信息上報操作值為“DevReg” |
BrandName | 必選 | String | 10 | 品牌名稱 |
ModelName | 必選 | String | 10 | 終端型號,與廠商在工信部登記的終端型號一致 |
DeviceID | 必選 | Object | 123 | 設備IMEI、MEID, SN等 |
ModuleInfo | 必選 | Object | 35 | 終端采用的模組信息 |
TerminalFWVersion | 必選 | String | 30 | 終端固件版本號 |
TerminalOSVersion | 必選 | String | 20 | 終端OS版本號,具體格式為:OS名稱-版本號 |
SIMInfoList | 必選 | List[SIMInfo] | 197 | 終端用戶卡信息列表,暫時支持最多4個 |
NetInfoList | 必選 | List[SIMInfo] | 25x4=100 | 當前工作的網絡信息,暫時支持最多4個 |
IsFirstAttachedCellNet | 必選 | Boolean | 2 | 標識終端是開機登網后首次上報終端信息,初始值為TRUE,上報信息成功后置為FALSE |
設備標識對象DeviceID說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
IMEIList | 必選 | List[String] | 15x4=60 | 設備IMEI,暫時支持最多4個 |
MEID | 可選 | String | 14 | 設備MEID,CDMA網絡設備標識 |
SN | 可選 | String | 32 | 設備SN |
MACID | 可選 | String | 17 | 設備MAC地址 |
終端模組對象ModuleInfo說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
Manufacture | 必選 | String | 10 | 模組廠商名稱,未采用模組時,值為空“” |
ModuleName | 必選 | String | 10 | 模組型號,與廠商在工信部登記的模組型號一致,未采用模組時,值為空“” |
ModuleID | 必選 | String | 15 | 模組的IMEI,未采用模組時,值為空“” |
用戶卡信息對象SimInfo說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
IMSIList | 必選 | List[String] | 15x3=45 | 用戶卡IMSI,最多3個 |
ICCID | 必選 | String | 20 | 用戶卡ICCID |
EID | 必選 | String | 32 | eSIM終端必選,eSIM卡EID |
Active | 必選 | Boolean | 2 | eSIM終端必選(預留),擴展字段,暫不考慮 |
終端登錄網絡信息對象NetInfo說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
MCC | 必選 | String | 3 | 移動國家碼 |
MNC | 必選 | String | 2 | 移動網絡號 |
CELLID | 必選 | String | 20 | 當前工作模式的CELLID,上報次序為LTE>WCDMA>GSM;無用戶卡時值為空“” |
響應消息參數說明
參數 | 必選/可選 | 類型 | 最大字節數 | 描述 |
RespSN | 必選 | int | 4 | 消息中的請求序列號 |
ReqName | 必選 | String | 24 | 操作響應類型,與請求消息中請求類型相同。終端信息上報操作值為“DevReg”。 |
ResultCode | 必選 | int | 4 | 操作結果值標識 操作返回碼,具體值請參見數據定義章節ResultCode定義。 |
消息示例
請求操作
[
{
"ReqSN": 1,
"ReqName":"DevReg",
"BrandName":"DeviceCompanyName-A",
" ModelName":"ModelName",
"DeviceID":
{
"IMEI":"86370103116020",
"MEID":"A100005C4FFAD5",
"SN":"",
"MACID":"3C:FA:21:FB:07:55"
}
"ModuleID":
{
"Manufacture ":"ModuleCompany-A",
"ModuleName":"ModuleName",
"ModuleID":"86370103116031"
}
"ModuleName":"ModuleCompany-Model",
"ModuleID":"86370103116031",
"TerminalFWVersion":"4.2.1",
"TerminalOSVersion":"Android-7.0",
"SIMInfoList": {
{
"ICCID":"567654578789",
"IMSI":"460011418603044",
"EID":"89086003103121217200000000000176",
"ACTIVE":"TRUE"
}
}
"NetInfoList": {
{
"MCC":"460",
"MNC":"11",
"CELLID":"38481"
}
}
"IsFirstAttachedCellNet":TRUE
}
]
響應:
[
{
"RespSN":1,
"ResultCode ":0,
"ReqName ":"DevReg",
}
]
A.4 數據定義
ResultCode定義
ResultCode對各個操作的返回值進行定義,不同操作以及對應不同業務的操作結果采用不同的ResultCode分段對應。
ResultCode分段 | 分段說明 | 已確定ResultCode值 |
0~999 | 終端信息上報返回結果 | 0:信息上報操作成功 1:消息頭錯誤 2:設備名稱錯誤 3:無效的DeviceID 4:EID與IMEI不匹配 5:非法的Module(模組未入庫) |
說明:
(1) 消息頭錯誤
DeviceName格式錯誤;
(2) 設備名稱錯誤
指的是終端上報的設備名稱與終端在產品庫報備的機型名稱不一致;
(3) 無效的DeviceID
指的是終端串碼(IMEI/MEID)未向終端產品庫報備,即通過產品串碼庫無法查到該串碼信息;
(4) EID與IMEI不匹配
指的是通過EID與IMEI對應關系庫查詢,無法查到該EID與IMEI的匹配關系;
(5) 非法的Module
指的是終端采用的模組沒有入電信終端產品庫。
|