https://sdk.wialon.com/wiki/ 2026-04-05T23:24:06+00:00 https://sdk.wialon.com/wiki/ https://sdk.wialon.com/wiki/lib/tpl/arctic/images/favicon.ico text/html 2015-09-15T13:57:43+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/activity_settings?rev=1442325463&do=diff Source of driver activity Default source of driver activity is iButton. To set another activity source, use the command unit/update_activity_settings svc=unit/update_activity_settings&params={"itemId":<long>, "type":<int>} Response { } /* success execution */ text/html 2022-10-14T16:42:47+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/add_video_packets?rev=1665765767&do=diff Adding traffic packages for an object The unit/add_video_packets request is used to add traffic packages to an object. Dealer rights are required to complete the request. svc=unit/add_video_packets&params={ "units":[<long>,...], "packets":<int> } text/html 2021-01-13T08:19:44+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/calc_last_message?rev=1610525984&do=diff Sensors values from last message To get sensors value from the last message, use the command unit/calc_last_message: svc=unit/calc_last_message&params={"unitId":<long>, "sensors":[<long>], "flags":<uint>} Parameters Name Description text/html 2021-10-18T08:32:46+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/calc_sensors?rev=1634545966&do=diff Sensors values To get sensors values, use the command unit/calc_sensors: svc=unit/calc_sensors&params={"source":<text>, "indexFrom":<uint>, "indexTo":<uint>, "unitId":<long>, "sensorId":<long>, "width":<uint>} text/html 2019-05-04T13:04:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/deactivation?rev=1556975040&do=diff Unit Deactivation To deactivate/activate units use the command svc=unit/set_active: svc=unit/set_active&params={"itemId":<long>,"active":<bool>} Parameters Name Description itemId unit ID active 0 - deactivation, 1 - activation Response { "active":<bool>, /* 0- deactivation successfully, 1 - activation successfully, or error code*/ } text/html 2015-12-09T14:56:08+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/exec_cmd?rev=1449672968&do=diff Commands: execute To send a command to a unit, use the request unit/exec_cmd: svc=unit/exec_cmd&params={"itemId":<long>, "commandName":<text>, "linkType":<text>, "param":<text>, "timeout":<uint>, "flags":<uint>} Parameters text/html 2021-12-20T12:50:25+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_accelerometers_calibration?rev=1640004625&do=diff Get accelerometer calibration parameters In order to get calibration parameters use unit/get_accelerometers_calibration: svc=unit/get_accelerometers_calibration&params={"itemId":<long>} Response { "acceleration": /* acceleration calibration coefficients */ { "coef_x":<double>, /* coefficient by x-axis */ "coef_y":<double>, /* coefficient by y-axis */ "coef_z":<double>, /* coefficient by z-axis */ "cos":<double>,… text/html 2017-10-31T11:52:28+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_command_definition_data?rev=1509450748&do=diff Commands: get definition data To get command definition data, use command unit/get_command_definition_data: svc=unit/get_command_definition_data&params={"itemId":<long>, "col":[<long>]} Params Name Description itemId unit ID col text/html 2016-09-21T16:46:23+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_drive_rank_settings?rev=1474476383&do=diff Getting drive rank settings To get drive rank settings use unit/get_drive_rank_settings: svc=unit/get_drive_rank_settings&params={"itemId":<long>} Response Returns the list of drive rank criteria and its parameters. IF criteria aren't defined then empty object returned {}. text/html 2016-10-14T11:42:09+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_fuel_settings?rev=1476445329&do=diff Fuel consumption To get fuel consumption settings of a unit, use the command unit/get_fuel_settings: svc=unit/get_fuel_settings&params={"itemId":<long>} Parameters Name Description itemId unit ID Response { "calcTypes":<uint>, /* method of calculating fuel consumption (see below) */ "fuelLevelParams":{ /* detection of fuel fillings/thefts */ "flags":<uint>, /* flags of fillings and thefts (see below) */ "ignoreStayTimeout":<uint>, /* ignore the messages after the start of … text/html 2021-03-04T13:16:03+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_messages_filter?rev=1614863763&do=diff Get settings of messages filtration To get settings of filtration of unit position information in messages, use the command unit/get_messages_filter: svc=unit/get_messages_filter&params={"itemId":<long>} Parameters Name Description itemId unit ID text/html 2020-04-13T07:32:50+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_report_settings?rev=1586763170&do=diff Get parameters used in reports To get parameters used in reports, use the command unit/get_report_settings: svc=unit/get_report_settings&params={"itemId":<long>} Parameters Name Description itemId unit ID Response { "speedLimit":<uint>, /* speed limit, km/h */ "maxMessagesInterval":<uint>, /* maximum interval between messages, seconds */ "dailyEngineHoursRate":<uint>, /* daily engine hours rate, seconds */ "urbanMaxSpeed":<uint>, /* urban speed limit, km/h */ "mileageCoefficie… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_trip_detector?rev=1385731860&do=diff Trip detection To get trip detection settings, use the command unit/get_trip_detector: svc=unit/get_trip_detector&params={"itemId":<long>} Parameters Name Description itemId unit ID Response { "type":<uint>, /* type of movement detection (see below) */ "gpsCorrection":<uint>, /* allow GPS correction: 0 - no, 1 - yes */ "minSat":<uint>, /* min satellites count */ "minMovingSpeed":<uint>, /* min moving speed, km/h */ "minStayTime":<uint>, /* min parking time, seconds */ "ma… text/html 2019-11-25T10:58:14+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_trips?rev=1574679494&do=diff Get trips for interval :!: Please execute messages/load_interval to upload messages before starting the command. To get information about trips for a specified period, please use unit/get_trips command: svc=unit/get_trips&params={"itemId":<long>, "msgsSource":<text>, "timeFrom":<uint>, "timeTo":<uint>} text/html 2022-10-14T15:38:56+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_video_settings?rev=1665761936&do=diff Get video settings To get unit video settings use request unit/get_video_settings. Required access to unit 'View detailed item properties' svc=unit/get_video_settings&params={ "itemId":long } Parameters Name Description itemId unit ID text/html 2017-10-10T13:31:13+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/get_vin_info?rev=1507642273&do=diff Get VIN info To get unit VIN info, use command unit/get_vin_info: svc=unit/get_vin_info&params={"vin":<text>} Params Name Description vin VIN number Response If success: { { "vin_lookup_result":{ "pflds":[ /* profile fields */ {"n":<text>, /* field name */ "v":<text>}, /* field value */ ... ] } } } text/html 2019-03-01T11:39:01+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/registry_custom_event?rev=1551440341&do=diff Register custom event To register custom event, use the command unit/registry_custom_event: svc=unit/registry_custom_event&params={"date":<uint>, "x":<double>, "y":<double>, "description":<text>, "violation":<uint>, "itemId":<long>, "nt":<text>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/registry_fuel_filling_event?rev=1385731860&do=diff Register fuel filling To register fuel filling event, use the command unit/registry_fuel_filling_event: svc=unit/registry_fuel_filling_event&params={"date":<uint>, "volume":<double>, "cost":<double>, "location":<text>, "deviation":<uint>, "x":<double>, "y":<double>, "description":<text>, "itemId":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/registry_maintenance_event?rev=1385731860&do=diff Register maintenance work To register maintenance work, use the command unit/registry_maintenance_event: svc=unit/registry_maintenance_event&params={"date":<uint>, "info":<text>, "duration":<int>, "cost":<double>, "location":<text>, "x":<double>, "y":<double>, "description":<text>, "mileage":<double>, "eh":<int>, "done_svcs":<text>, "itemId":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/registry_status_event?rev=1385731860&do=diff Register unit status To register unit status, use the command unit/registry_status_event: svc=unit/registry_status_event&params={"date":<uint>, "description":<text>, "itemId":<long>} Parameters Name Description date date text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/unit?rev=1385731860&do=diff Units In this chapter, all commands that can be applied to units are described. Creation of units is examined in the chapter Core: Create unit. . index text/html 2021-12-20T12:49:09+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_accelerometers_calibration?rev=1640004549&do=diff Update accelerometer calibration parameters svc=unit/update_accelerometers_calibration&params={"itemId":<long>, "timeFrom":<uint>, "timeTo":<uint>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_access_password?rev=1385731860&do=diff Unit access password To update unit access password, use the command unit/update_access_password: svc=unit/update_access_password&params={"itemId":<long>, "accessPassword":<text>} Parameters Name Description itemId unit ID accessPassword text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_calc_flags?rev=1385731860&do=diff Counter calculation parameters To update calculation parameters for counters, use the command unit/update_calc_flags: svc=unit/update_calc_flags&params={"itemId":<long>, "newValue":<uint>} Parameters Name Description itemId unit ID newValue text/html 2018-04-23T15:40:48+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_command_definition?rev=1524498048&do=diff Commands: create, edit, delete To create, edit or delete command, use the command unit/update_command_definition: svc=unit/update_command_definition&params={"itemId":<long>, "id":<long>, "callMode":<text>, "n":<text>, "c":<text>, "l":<text>, "p":<text>, "a":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_device_type?rev=1385731860&do=diff Device type and unique ID To update device (hardware) type and unique ID of a unit, use the command unit/update_device_type: svc=unit/update_device_type&params={"itemId":<long>, "deviceTypeId":<long>, "uniqueId":<text>} Parameters text/html 2018-08-03T13:10:02+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_drive_rank_settings?rev=1533301802&do=diff Update drive rank settings svc=unit/update_drive_rank_settings&params={"itemId":<long>, "driveRank": { "acceleration":[ { "flags":<uint>, "min_value":<double>, … text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_eh_counter?rev=1385731860&do=diff Counter of engine hours To set a new value for engine hours counter, use the command unit/update_eh_counter: svc=unit/update_eh_counter&params={"itemId":<long>, "newValue":<uint>} Parameters Name Description itemId unit ID newValue text/html 2020-11-16T11:39:58+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_fuel_calc_types?rev=1605526798&do=diff Fuel consumption: type of calculation Fuel Sensor Configuration To change the type of fuel consumption calculation, use the command unit/update_fuel_calc_types: svc=unit/update_fuel_calc_types&params={"itemId":<long>, "calcTypes":<ubyte>} Parameters Name Description text/html 2020-11-16T11:39:06+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_fuel_impulse_params?rev=1605526746&do=diff Fuel consumption: impulse fuel consumption sensors Fuel Sensor Configuration To update parameters of impulse fuel consumption sensors, use the command unit/update_fuel_impulse_params: svc=unit/update_fuel_impulse_params&params={"itemId":<long>, "maxImpulses":<uint>, "skipZero":<bool>} text/html 2020-11-16T11:38:54+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_fuel_level_params?rev=1605526734&do=diff Fuel consumption: fuel fillings/thefts detection Fuel Sensor Configuration To update parameters of fuel fillings/thefts detection, use the command unit/update_fuel_level_params: svc=unit/update_fuel_level_params&params={"itemId":<long>, "flags":<uint>, "ignoreStayTimeout":<uint>, "minFillingVolume":<double>, "minTheftTimeout":<uint>, "minTheftVolume":<double>, "filterQuality":<ubyte>, "fillingsJoinInterval":<uint>, "theftsJoinInterval"… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_fuel_math_params?rev=1385731860&do=diff Fuel consumption: consumption math To update parameters of fuel consumption math, use the command unit/update_fuel_math_params: svc=unit/update_fuel_math_params&params={"itemId":<long>, "idling":<double>, "urban":<double>, "suburban":<double>, "loadCoef":<double>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_fuel_rates_params?rev=1385731860&do=diff Fuel consumption: consumption by rates To update parameters of fuel consumption by rates, use the command unit/update_fuel_rates_params: svc=unit/update_fuel_rates_params&params={"itemId":<long>, "consSummer":<double>, "consWinter":<double>, "winterMonthFrom":<ubyte>, "winterDayFrom":<ubyte>, "winterMonthTo":<ubyte>, "winterDayTo":<ubyte>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_hw_params?rev=1385731860&do=diff Hardware configuration To update hardware configuration, use the command unit/update_hw_params: svc=unit/update_hw_params&params={"hwId":<text>, "action":<text>, ...} Parameters Required parameters: Name Description hwId hardware type ID text/html 2015-09-23T08:46:34+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_image?rev=1442997994&do=diff Edit unit image To assign the image to unit, use the command unit/update_image: Same as at the other (e.g. when you copy unit) svc=unit/update_image&params={"itemId":<long>, "oldItemId":<long>} From library: svc=unit/update_image&params={"itemId":<long>, "libId":<long>, "path":<text>} text/html 2016-09-27T13:41:46+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_messages_filter?rev=1474983706&do=diff Update settings of messages filtration To update settings of filtration of unit position information in messages, use the command unit/update_messages_filter: svc=unit/update_messages_filter&params={"itemId":<long>, "enabled":<bool>, "skipInvalid":<bool>, "minSats":<ubyte>, "maxHdop":<double>, "maxSpeed":<uint>, "lbsCorrection":<double>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_mileage_counter?rev=1385731860&do=diff Counter of mileage To set a new value for mileage counter, use the command unit/update_mileage_counter: svc=unit/update_mileage_counter&params={"itemId":<long>, "newValue":<uint>} :!: You can find an example of this request in the sample Creating, editing and deleting items. text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_phone?rev=1385731860&do=diff Phone number To set a new phone number, use the command unit/update_phone: svc=unit/update_phone&params={"itemId":<long>, "phoneNumber":<text>} :!: Character '+' in phone number should be replaced by code %2B. Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_phone2?rev=1385731860&do=diff Second phone number To set a new value for second phone number, use the command unit/update_phone2: svc=unit/update_phone2&params={"itemId":<long>, "phoneNumber":<text>} :!: Character '+' in phone number should be replaced by code %2B. text/html 2020-10-09T06:52:29+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_report_settings?rev=1602226349&do=diff Update parameters used in reports To update parameters used in reports, use the command unit/update_report_settings: svc=unit/update_report_settings&params={"itemId":<long>, "params":{ "speedLimit":<uint>, "maxMessagesInterval":<uint>, "dailyEngineHoursRate":<uint>, "urbanMaxSpeed":<uint>, "mileageCoefficient":<double>, "speedingTolerance":<uint>, "speedingMinDuration":<uint>, "speedingMode":<uint> "fuelRateCoefficient":<uint> }} text/html 2023-06-12T08:35:02+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_sensor?rev=1686558902&do=diff Sensors: create, update and delete To create, edit or delete sensors, use the command unit/update_sensor: svc=unit/update_sensor&params={"itemId":<long>, "id":<long>, "callMode":<text>, "unlink":<uint>, "n":<text>, "t":<text>, "d":<text>, "m":<text>, "p":<text>, "f":<uint>, "c":<text>, "vt":<uint>, "vs":<long>, "tbl":[ { "x":<double>, "a":<double… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_service_interval?rev=1385731860&do=diff Service intervals To create, edit or delete service intervals, use the command unit/update_service_interval: svc=unit/update_service_interval&params={"itemId":<long>, "id":<long>, "callMode":<text>, "n":<text>, "t":<text>, "im":<uint>, "it":<uint>, "ie":<uint>, "pm":<uint>, "pt":<uint>, "pe":<uint>, "c":<uint>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_traffic_counter?rev=1385731860&do=diff Counter of GPRS traffic To set a new value for GPRS traffic counter, use the command unit/update_traffic_counter: svc=unit/update_traffic_counter&params={"itemId":<long>, "newValue":<uint>, "regReset":<uint>} Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_trip_detector?rev=1385731860&do=diff Update trip detection settings To update trip detection settings, use the command unit/update_trip_detector: svc=unit/update_trip_detector&params={"itemId":<long>, "type":<ubyte>, "gpsCorrection":<bool>, "minSat":<uint>, "minMovingSpeed":<uint>, "minStayTime":<uint>, "maxMessagesDistance":<uint>, "minTripTime":<uint>, "minTripDistance":<uint>} text/html 2016-10-24T16:40:10+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_unique_id2?rev=1477327210&do=diff Second unique ID To set a new value for second unit unique ID, use the command unit/update_unique_id2: :!: It is relevant only to several hardware types with two modems. svc=unit/update_unique_id2&params={"itemId":<long>, "uniqueId2":<text>} text/html 2022-10-14T16:51:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_video_autopay?rev=1665766260&do=diff Setting auto-purchase of traffic packages for an object The unit/update_video_status request is used to set the auto-purchase value for traffic packets. Dealer rights are required to complete the request. svc=unit/update_video_autopay&params={ "units":[<long>,...], "value":<int> } text/html 2022-10-14T16:43:28+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/update_video_status?rev=1665765808&do=diff Change video billing settings for an unit The unit/update_video_status request is used to change the video billing status for an unit. Dealer rights are required to complete the request. svc=unit/update_video_status&params={ "units":[<long>,...], "status":<int> } text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/upload_image?rev=1385731860&do=diff Upload unit image To upload an image for a unit, use the command unit/upload_image: svc=unit/upload_image&params={"itemId":<long>, "eventHash":<text>} Parameters Name Description itemId unit ID eventHash event name which will be generated after uploading the image (optional parameter) text/html 2022-10-14T15:35:20+00:00 https://sdk.wialon.com/wiki/en/local/remoteapi2304/apiref/unit/video_settings?rev=1665761720&do=diff Update video settings Use request unit/update_video_settings to update settings to get video from unit There is needed access “Edit not mentioned properties”. svc=unit/update_video_settings&params={ "itemId":long, "settings":[ {"channel":int,"name":text,"flags":int}, {"channel":int,"name":text,"flags":int}, ...]}