SIP設備端對接說明
1. 整體架構
2. 業務流程
3. 可視對講物模型說明
進行SIP物模型開發前,需要優先對接人臉和二維碼門禁服務,具體對接手冊請查看http://bestwisewords.com/document_detail/178726.html, 通過這份對接手冊,您將明確怎么使用LinkKitSDK中物模型的開發。
可視對講門禁物模型
字段 | 類型 | 輸入參數 | 輸出參數 | 參數類型 | 參數說明 |
querySipNumber 查詢SipNumber | service | sipNumber | String | SIP編號 | |
SyncSipNumber 頒發SipNumber | service | sipNumber | enum | SIP變化 | |
password | String | 密碼 | |||
sipServerPort | String | SIP Server端口號 | |||
sipServerAddr | String | SIP Server地址 | |||
SyncGroupIdAndRoomId 同步組號和房間號 | service | groupRoomMappingFileUrl | String | 映射關系文件URL詳細格式如下: | |
doorOpenEvent 開門事件 | event | sourceType | enum | 源類型0-云對講1-電話開門-1-普通開門在云對講過程中開門為0,其他為-1 | |
number | String | 呼叫的SIP賬號,普通開門時為空 | |||
extInfo | String | 擴展信息{ "roomId": "xx", "captureImg":"XXX",//開門抓圖Filekey, 由下文OSS文件上傳鏈路獲得} | |||
OssStsTokenRequest StsToken請求上報 | event | RequestType | enum | 0:圖片文件上傳1:文本文件上傳2:其他類型文件上傳 | |
SendOssStsToken 下發OssStsToken | service | Credentials | String | 加密的訪問憑證加密方式詳見開門事件傳圖一章節 | |
BucketName | String | OSSbucket名稱 | |||
EndPoint | String | OSS的EndPoint名稱 | |||
ObjectName | String | OSS存儲空間名稱 | |||
ExtInfo 擴展屬性 | 屬性 | String | {"intercomDeviceMode":0 //0 單元門口機,1圍墻機,默認為單元門口機} |
映射關系文件格式示例
{"syncGroupRoomList": [{"groupId": "Group-1","roomId": "Room-1"},{"groupId": "Group-2","roomId": "Room-2"},{"groupId": "Group-3","roomId": "Room-3"},{"groupId": "Group-4","roomId": "Room-4"}]}
房號下發規則
門禁機存在兩種按照模式:一種是安裝在單元樓下, 稱為單元門口機,服務的范圍為本單元的房屋。另外一種是安裝在小區大門口,稱為圍墻機,服務的范圍是全小區,或者小區中的一片區域(多個樓棟)。這兩種模式卻別由其服務的范圍引入:單元門口機服務的是本單元房屋,所以在可視對講中,輸入房號即可定位到目標房屋。圍墻機服務的是小區,或者多個樓棟,那么需要輸入具體的樓棟-單元-房號,才能定位到房屋。這將引入門禁機上交互的差異,以及在上文中提到下發組號和房間號的差異。
單元門口機下發的是房號,如上文中映射關系文件格式中提到的:groupId->roomId的規則下文重點對圍墻機模式進行解釋。
圍墻機RoomId字段規則定義如下:
${樓幢}-${單元}-${房號}
例如示下:
1-3-1202
10-3A-1709
最長位數:
3位-3位-5位,規則數字+字母
門禁機交互界面:
1.支持輸入 ${樓幢}-${單元}-${房號} 的規則。
2.設備端需要有“圍墻機模式”和“單元門口機模式”。
在圍墻機模式下,用戶輸入樓幢、單元、房號的信息。
在單元門口機模式下,用戶只需要輸入房號。
圍墻機模式由物模型中ExtInfo字段進行下發或者設備端上報,具體的格式定義為:
ExtInfo:
{"intercomDeviceMode":0 //0 單元門口機,1圍墻機,默認為單元門口機}
在ExtInfo中增加一個intercomDeviceMode的屬性。
屬性定義如下:
字段名稱 | 類型 | 說明 |
intercomDeviceMode | Integer | 門禁機工作模式0 單元門口機,1圍墻機,默認為單元門口機 |
主動查看視頻及視頻預覽
當門禁機發起視頻時,室內設備,如貓精,app等需要先行查看門禁視頻的內容,再決定是否接聽,避免用戶與一些無關人員,或者不想會見的人員進行通話。
門禁發起視頻門禁
在SIP標準協議中,支持earlymedia(信令:183)模式,在接通前投遞音頻及視頻流。
整體流程如下:
門禁設備端需要支持呼叫時總是發起EarlyMedia呼叫。
配置EarlyMedia啟用
在發起后啟動攝像頭采集
主動查看門禁視頻
用戶可以通過貓精端/App主動查看當前樓下門禁機的視頻流,應對外賣/快遞通過電話呼入的情況,進行二次確認。主動查看門禁視頻通過自動接聽的方式完成,整體流程如下:
門禁設備端需要支持的點
配置自動接聽
靜默接聽,不會發出響鈴提示
通話時間60S【支持可配置】
使用限制
當門禁設備在呼叫中,無法查看。
同時只允許一個貓精進行查看。
開門事件圖片上傳
當遠程開門時,需要進行開門事件圖片留檔,方便門禁管理方進行回溯,如下是一個典型的開門事件上報以及傳圖流程:
ststoken使用OssStsTokenRequest來進行請求,請求時指定需要獲取的目標類型。
當前支持的目標類型有:
0:圖片文件上傳
1:文本文件上傳
2:其他類型文件上傳
下發的SendOssStsToken中Credentials字段是加密后的ststoken。
加密方式為 AES加密,使用的密鑰為設備證書(ProductKey、DeviceName、DeviceSecret)中的DS前16位,加密模式為:AES/ECB/PKCS5Padding。
加密前的源文格式:
{"securityToken":"XXXX","accessKeySecret":"xxxx","accessKeyId":"xxxxx","expiration":"XXXXX"}
4. 對接注意事項
服務端口定義
功能 | 端口 | 備注 |
SIP | 6050 | SIP協議端口 |
RTP | 10000-20000 | 多媒體流端口 |
多媒體格式
多媒體流 | 格式 | 備注 |
音頻 | PCM | 采樣率16K 雙通道 |
視頻 | H.264 | 480P |
設備的遠程開門服務請遵循人臉+二維碼門禁對接中的remoteopen服務進行開門。
5.使用時長
建議設備端側控制單次使用時長,1~5分鐘,最好UI可配置。