Overview
The DECT JSON-RPC API is provided by the DECT Native Remote API Component. This component is part of the DECT Driver OS specific bundle:
Methods
Method |
Parameters |
Description |
Example |
|---|---|---|---|
cmbs_dsr_han_mngr_Init_Req |
|
Request for Initialize the HAN Manager |
{"id":1,"method":"cmbs_dsr_han_mngr_Init_Req","params":[0]} |
cmbs_dsr_han_mngr_Init_Rsp |
|
Response for Initialize the HAN Manager |
{"id": -10, "method": "cmbs_dsr_han_mngr_Init_Rsp", "params": [0, {"UleAppProtocolId": 1, "UleAppProtocolVersion": 0 } ] } |
cmbs_dsr_han_mngr_Start_Req |
|
Request for Start the HAN Manager |
{"id":2,"method":"cmbs_dsr_han_mngr_Start_Req"} |
cmbs_dsr_han_mngr_Start_Rsp |
|
Response for Start the HAN Manager |
{"id": -12, "method": "cmbs_dsr_han_mngr_Start_Rsp", "params": [0] } |
cmbs_dsr_han_device_ReadTable_Req |
|
Request for Reading the Device Registered with the Device Management Service |
{ "id":6,"method":"cmbs_dsr_han_device_ReadTable_Req","params": [ 5,0,false ] } |
cmbs_dsr_han_device_ReadTable_Rsp |
|
Response for Reading the Device Registered with the Device Management Service |
{"id": -13, "method": "cmbs_dsr_han_device_ReadTable_Rsp", "params": [0, [ {"IPUI": [0, 240, 178, 17, 0 ], "RequestedPageTime": 1, "Id": 1, "RegistrationStatus": 6, "EMC": 4075, "PageTime": 1, "HanUnits": [ {"Id": 1, "Type": 515, "OptionalInterfaces": [ ] } ] } ] ] } |
cmbs_dsr_han_device_WriteTable_Req |
|
Request for Writing updated Device Table into the Management Service |
|
cmbs_dsr_han_device_WriteTable_Rsp |
|
|
|
cmbs_dsr_han_bind_ReadTable_Req |
Reading the Binding Table from the Bind Service |
|
|
cmbs_dsr_han_bind_ReadTable_Rsp |
|
|
|
cmbs_dsr_han_bind_WriteTable_Req |
Writing the Binding Table into the Bind Service |
|
|
cmbs_dsr_han_bind_WriteTable_Rsp |
|
|
|
cmbs_dsr_han_group_ReadTable_Req |
Reading the Group Table from the Group Service |
|
|
cmbs_dsr_han_group_ReadTable_Rsp |
|
|
|
cmbs_dsr_han_group_WriteTable_Req |
Reading the Group Table from the Group Service |
|
|
cmbs_dsr_han_group_WriteTable_Rsp |
|
|
|
cmbs_dsr_han_msg_SendTxRequest_Req |
|
Request for link to a specific device |
{"method":"cmbs_dsr_han_msg_SendTxRequest_Req", "params":1,"id":1 } |
cmbs_dsr_han_msg_SendTxRequest_Rsp |
|
Response for link to a specific device |
{"id": -260, "method": "cmbs_dsr_han_msg_SendTxRequest_Rsp", "params": [ { 0, 2 ] } |
cmbs_dsr_han_msg_SendTxEnd_Req |
|
Request for inform the Message Service that the link to a specific device is not required |
{"method":"cmbs_dsr_han_msg_SendTxEnd_Req, "params":1,"id":1"} |
cmbs_dsr_han_msg_SendTxEnd_Rsp |
|
Response for Inform the Message Service that the link to a specific Device is not required |
{"id": -268, "method": "cmbs_dsr_han_msg_SendTxEnd_Rsp", "params": [ 0, 2 ] } |
cmbs_dsr_han_msg_Send_Req |
|
Request for Send messages to other units |
{ "id":54,"method":"cmbs_dsr_han_msg_Send_Req","params": [ 1, { "ImmediateSend":false,"Reserved":0,"IsLast":false }, {"InterfaceId":5,"DstAddressType":0,"InterfaceType":1,"MsgSequence":1,"InterfaceMember":-2,"SrcDeviceId":0,"DstDeviceId":2,"DstUnitId":0,"SrcUnitId":2,"MsgType":9} ] } |
cmbs_dsr_han_msg_Send_Rsp |
|
Response for Send messages to other units |
: { "id": -262, "method": "cmbs_dsr_han_msg_Send_Rsp", "params": [ 0, 1 ] } |
cmbs_dsr_han_device_GetConnectionStatus_Req |
|
Request for link status to a specific device |
{ "id":52,"method":"cmbs_dsr_han_device_GetConnectionStatus_Req","params":[2 ] } |
cmbs_dsr_han_device_GetConnectionStatus_Rsp |
|
Response for link status to a specific device |
{ "id": -68, "method": "cmbs_dsr_han_device_GetConnectionStatus_Rsp", "params": [ 0, 2, 0 ] } |
cmbs_dsr_sys_Start_Rsp |
|
Response for System start |
{"id": -23, "method": "cmbs_dsr_sys_Start_Rsp", "params": [ 0 ]} |
cmbs_dsr_sys_Reset_Req |
Request for Base station system reboot |
{ "id":12,"method":"cmbs_dsr_sys_Reset_Req" } |
|
rpc_Stop_Forced_Server_Req |
Request for Remote api forced stop |
|
|
cmbs_dsr_param_Get_Req |
|
Request for Reading a particular CMBS parameter value |
{ "id":1,"method":"cmbs_dsr_param_Get_Req","params": [0, \1] } |
cmbs_dsr_param_Get_Rsp |
|
|
{ "id": -2, "method": "cmbs_dsr_param_Get_Rsp", "params": [0, {"Data": [0, 254, 177, 71, 0 ], "Type": 0, "Id": 1 } ] } |
cmbs_dsr_param_Set_Req |
Request for Writing CMBS parameter data at base station |
|
|
cmbs_dsr_param_Set_Rsp |
|
|
|
cmbs_dsr_param_area_Get_Req |
|
Request for Reading area parameter |
{ "id":1,"method":"cmbs_dsr_param_area_Get_Req","params": [ 0,20,1 ] } |
cmbs_dsr_param_area_Get_Rsp |
|
Response for Reading area parameter |
{ "id": -1, "method": "cmbs_dsr_param_area_Get_Rsp", "params": [ 0, { "Data": 128, "Type": 0, "Offset": 20 } ] } |
cmbs_dsr_param_area_Set_Req |
|
|
|
cmbs_dsr_param_area_Set_Rsp |
|
|
|
cmbs_dsr_cord_RegistrationOpen_Req |
|
Request for Open the Base station for registration |
{ "method":"cmbs_dsr_cord_RegistrationOpen_Req","params":[ 60 ] ,"id":1928 } |
cmbs_dsr_cord_RegistrationOpen_Rsp |
|
Response for Open the Base station for registration |
{ "id": -267, "method": "cmbs_dsr_cord_RegistrationOpen_Rsp", "params": [ 0 ] } |
cmbs_dsr_cord_RegistrationClose_Req |
|
Request for Close the Base station for registration |
{ "method":"cmbs_dsr_cord_RegistrationClose_Req","id":247 } |
cmbs_dsr_cord_RegistrationClose_Rsp |
|
Response for Close the Base station for registration |
{ "id": -270, "method": "cmbs_dsr_cord_RegistrationClose_Rsp", "params": [ 0 ] } |
cmbs_dsr_han_device_Delete_Req |
|
Request for Delete a HAN device |
{ "id":79,"method":"cmbs_dsr_han_device_Delete_Req","params":[\ 2 ] } |
cmbs_dsr_han_device_forceful_Delete_Rsp |
|
Response for Delete a HAN device |
{ "id": -106, "method": "cmbs_dsr_han_device_forceful_Delete_Rsp", "params": [ 0, 2 ] } |
cmbs_dsr_hs_Delete_Req |
|
Request for Delete one or more handsets |
{ "method":"cmbs_dsr_hs_Delete_Req","params": [ 1 ] ,"id":241 } |
cmbs_dsr_hs_Delete_Rsp |
|
Response for Delete one or more hadnsets |
{ "id": -263, "method": "cmbs_dsr_hs_Delete_Rsp", "params": [ 0 ] } |
cmbs_dsr_fw_VersionGet_Req |
|
Request for retrieval cmbs firmware version |
{ "method":"cmbs_dsr_fw_VersionGet_Req","params":[ 1 ],"id":20 } |
cmbs_dsr_fw_VersionGet_Rsp |
|
Response for retrieval cmbs firmware version |
{ "id": -21, "method": "cmbs_dsr_fw_VersionGet_Rsp", "params": [ 0, { "SwModule": 1, "FwVersion": 30272 } ] } |
cmbs_dsr_hw_VersionGet_Req |
|
Request for retrieval cmbs hardware version |
{ "method":"cmbs_dsr_hw_VersionGet_Req","id":23 } |
cmbs_dsr_hw_VersionGet_Rsp |
|
Response for retrieval cmbs hardware version |
{" id": -24, "method": "cmbs_dsr_hw_VersionGet_Rsp", "params": [ 0, { "HwComType": 1, "HwBoard": 0, "HwChip": 0, "HwChipVersion": 1 } ] } |
cmbs_api_ModuleVersionGet_Req |
|
Request for retrieval DSPG native api version |
{ "method":"cmbs_api_ModuleVersionGet_Req","id":17 } |
cmbs_api_ModuleVersionGet_Rsp |
|
Response for retrieval DSPG native api version |
{ "id": -18, "method": "cmbs_api_ModuleVersionGet_Rsp", "params": [ 0, { "BuildNum": 2316, "Version": 665 } ] } |
rpc_api_VersionGet_Req |
|
Request for retrieval remote api version |
{ "method":"rpc_api_VersionGet_Req","id":27 } |
rpc_api_VersionGet_Rsp |
|
Response for retrieval remote api version |
{ "id": -29, "method": "rpc_api_VersionGet_Rsp", "params": [ 0, 261 ] } |
cmbs_dsr_sys_RFResume_Req |
|
Request for Resume RF power |
{ "id":12,"method":"cmbs_dsr_sys_RFResume_Req" } |
cmbs_dsr_sys_RFSuspend_Req |
|
Request for Suspend RF power |
{ "id":12,"method":"cmbs_dsr_sys_RFSuspend_Req" } |
cmbs_dsr_han_msg_RecvRegister_Req |
|
Request for Register Device(0)-Unit(yyy)-Interface(zzz) with the Message Service |
{ "id":2,"method":"cmbs_dsr_han_msg_RecvRegister_Req","params": [ { "InterfaceId":-1,"UnitId":2 } ] } |
cmbs_dsr_han_msg_RecvRegister_Rsp |
|
Response for Register Device(0)-Unit(yyy)-Interface(zzz) |
{ "id": -2, "method": "cmbs_dsr_han_msg_RecvRegister_Rsp", "params": [ 0 ] } |
cmbs_dsr_han_msg_RecvUnregister_Req |
|
Unregister Device(0)-Unit(yyy)-Interface(zzz) with the Message Service |
{ "id":3,"method":"cmbs_dsr_han_msg_RecvUnregister_Req","params": [ { "InterfaceId":-1,"UnitId":2 } ] } |
cmbs_dsr_han_msg_RecvUnregister_Rsp |
|
Response for Unregister Device(0)-Unit(yyy)-Interface(zzz) |
{ "id": -2, "method": "cmbs_dsr_han_msg_RecvUnregister_Rsp", "params": [ 0 ] } |
cmbs_dsr_han_msg_Recv_Event |
|
Event Message request from a device |
{ "id": -35, "method": "cmbs_dsr_han_msg_Recv_Event", "params": [ { "DstAddressType": 0, "DstDeviceId": 0, "SrcDeviceId": 2, "SrcUnitId": 1, "DstUnitId": 2, "MsgSequence": 0, "Data": [ ], "MsgType": 1, "InterfaceType": 1, "InterfaceMember": 1, "InterfaceId": 257 } ] } |
cmbs_dsr_hs_InRange_Event |
|
Event device is in range |
{"id": -255, "method": "cmbs_dsr_hs_InRange_Event", "params": [ 1 ] } |
cmbs_dsr_han_msg_SendTxReady_Event |
|
Event device is ready for receiving send command |
{ "id": -261, "method": "cmbs_dsr_han_msg_SendTxReady_Event", "params": [ 1 ] } |
cmbs_dsr_hs_Registered_Event |
|
Event device changed its registerered state |
{"id": -265, "method": "cmbs_dsr_hs_Registered_Event", "params": [ { "DeviceId": 1, "ModelNr": 0, "State": 0, "Type": 0, "Ipei": [ 0, 0, 0, 0, 0 ] } ] } |
cmbs_dsr_cord_RegistrationClose_Event |
|
Event Close the Base station for registration |
{ "id": -24, "method": "cmbs_dsr_cord_RegistrationClose_Event", "params": [ 0, 0 ] } |
cmbs_dsr_han_device_reg_State1_Event |
|
Event for first registration stage of a HAN device |
{ "id": -109, "method": "cmbs_dsr_han_device_reg_State1_Event", "params": [ 0, 2, { "IPUI": [ 0, 254, 179, 49, 0 ] } ] } |
cmbs_dsr_han_device_reg_State2_Event |
|
Event for second registration stage of a HAN device |
{ "id": -111, "method": "cmbs_dsr_han_device_reg_State2_Event", "params": [ 0, 2, { "UleVersion": 1, "FunVersion": 1, "OriginalDevicePagingInterval": 1, "ActualDevicePagingInterval": 1 } ] } |
cmbs_dsr_han_device_reg_State3_Event |
|
Event for third registration stage of a HAN device |
{ "id": -113, "method": "cmbs_dsr_han_device_reg_State3_Event", "params": [ 0, 2 ] } |
cmbs_dsr_han_msg_SendTxEnded_Event |
|
Event that the communication with the device was terminated in an unsolicited way - not requested by the host |
{ "id": -113, "method": "cmbs_dsr_han_msg_SendTxEnded_Event", "params": [ 1, 1 ] } |