صياغة التنبيهات
يذكر التنبيه ما حدث مرتين: بالإنجليزية في title وdescription، وبصيغة مستقلة عن اللغة في code وparams.
اعرض التنبيه بلغة مستخدميك من code وparams، واحتفظ بـtitle للسجلات وللتنبيه الذي لا رمز له. لا تحلّل
title ولا description: قد تتغيّر كلماتهما.
يحمل كلَّ تنبيه من GET /v1/alerts وGET /v1/alerts/{id} هذان الحقلان، ويحملهما data في الخطاف
zaitrack.alert.raised.v1:
{
"title": "Speeding: 133 km/h (limit 120 km/h)",
"description": "133 km/h (limit 120 km/h)",
"code": "speeding.over_limit",
"params": { "value": "133", "limit": "120" }
}
codeعلى شكل<kind>.<what>. يحتفظ الرمز بمعناه بعد نشره، وتُضاف رموز جديدة كلما صار للتنبيهات ما تقوله.paramsمعاملات الرمز، وكل قيمة فيها نص. المعامل الموسوم «اختياري» أدناه يُحذف إذا لم يحمله الحدث.titleهو اسم القاعدة ثم:ثمdescription، إلا إذا كانت القاعدة تكتب عناوين تنبيهاتها بنفسها. لتبقي اسم القاعدة (كلمات مستخدمك) بجانب صياغتك، خذ منtitleما قبل: <description>؛ وإن لم ينتهِtitleكذلك فاعرضه كما هو.- التنبيه الذي سبق الرموز
codeفيه""وparamsفيه{}: اعرضdescription. - الرمز الذي لا تعرفه بعد: اعرض
descriptionالخاص بالتنبيه.
كلمات المؤسسة الخاصة
يمكن للمؤسسة أن تضع كلماتها الخاصة لرمز تنبيه بلغة ما (Console ← Notifications ← Your alert wording)، بالعناصر
النائبة نفسها والأجزاء الاختيارية نفسها. تستخدمها رسائلها و Console بدل كلمات المنصة؛ ويصبح title التنبيه
بالإنجليزية بكلماتها أيضًا. الكلمات أدناه هي كلمات المنصة: التطبيق الذي يصوغ التنبيهات بنفسه من code و
params يعرض كلمات المنصة، وهي تحمل المعنى نفسه دائمًا.
أنواع المعاملات
| النوع | في الرسالة | اعرضه |
|---|---|---|
number | عدد عشري بالأرقام الغربية: "52"، "12.5" | بأرقام مستخدميك، مع الوحدة المذكورة في الجدول |
instant | RFC 3339 بالتوقيت العالمي: "2026-10-12T08:00:00Z" | بالمنطقة الزمنية للمؤسسة؛ وإذا أبلغت المركبة عن منطقة أخرى فأضف اسمها المختصر: 20:02 (UAE) |
day | يوم في التقويم: "2026-12-31" | بصيغة التاريخ لدى مستخدميك، اليومَ نفسه |
money | رمز العملة والمبلغ بخاناتها العشرية: "SAR 968.20" | بصيغة الأرقام لدى مستخدميك، مع العملة |
id | رمز أو مرجع: رقم مهمة أو بطاقة أو مفتاح | كما هو، من اليسار إلى اليمين |
text | كلمات كتبها شخص أو نظام آخر: اسم أو مكان أو سبب | كما هي، بين علامتي اقتباس، في اتجاهها |
enum | كلمة من مجموعة ثابتة (اسم المجموعة بين قوسين أدناه) | مترجمة؛ والكلمة التي لا تعرفها كما هي |
رموز <kind>.other تحمل كلمات نظام آخر في detail (من النوع text): اعرضها بين علامتي اقتباس.
الرموز
الصياغة الإنجليزية هي المرجع. الجزء الذي بين [ ] يُحذف إذا غاب معامل فيه.
| الرمز | بالإنجليزية | المعاملات |
|---|---|---|
camera.blocked | Camera blocked: [camera {channel}] | channel number، اختياري |
camera.device_fault | Video device fault | |
camera.other | {fault}[ (camera {channel})] | fault id؛ channel number، اختياري |
camera.signal_lost | Video signal lost: [camera {channel}] | channel number، اختياري |
camera.storage_fault | Recorder storage fault | |
crash.detected | possible crash at {at}[, {speed} km/h][ ({lat}, {lon})] | at instant؛ speed number (km/h)، اختياري؛ lat number (deg)، اختياري؛ lon number (deg)، اختياري |
dispatch.late | {job}[ ({reference})] stop {stop} {stopName} | job id؛ reference id، اختياري؛ stop number؛ stopName text |
dispatch.will_be_late | {job}[ ({reference})] stop {stop} {stopName} will be late: ETA {eta}, window ends {windowEnd} | job id؛ reference id، اختياري؛ stop number؛ stopName text؛ eta instant؛ windowEnd instant |
dispatch.order_cancelled | Order {order}[ ({reference})] cancelled | order id؛ reference id، اختياري |
dispatch.order_received | Order {order}[ ({reference})]: {from} to {to}[, collect {collectAt}] | order id؛ reference id، اختياري؛ from text؛ to text؛ collectAt instant، اختياري |
dispatch.stop_failed | {job}[ ({reference})] stop {stop} {stopName} not delivered: {reason} | job id؛ reference id، اختياري؛ stop number؛ stopName text؛ reason text |
dispatch.window_missed | {job}[ ({reference})] stop {stop} {stopName} missed its window ending {windowEnd} | job id؛ reference id، اختياري؛ stop number؛ stopName text؛ windowEnd instant |
document.expired | [{subject}: ]{document}[ "{title}"][ {number}] expired on {on} | subject text، اختياري؛ subjectType enum [subject-type]؛ document enum [document-kind]؛ title text، اختياري؛ number id، اختياري؛ on day |
document.expires_in | [{subject}: ]{document}[ "{title}"][ {number}] expires in {days} days ({on}) | subject text، اختياري؛ subjectType enum [subject-type]؛ document enum [document-kind]؛ title text، اختياري؛ number id، اختياري؛ on day؛ days number (days) |
document.expires_on | [{subject}: ]{document}[ "{title}"][ {number}] expires on {on} | subject text، اختياري؛ subjectType enum [subject-type]؛ document enum [document-kind]؛ title text، اختياري؛ number id، اختياري؛ on day |
document.expires_today | [{subject}: ]{document}[ "{title}"][ {number}] expires today ({on}) | subject text، اختياري؛ subjectType enum [subject-type]؛ document enum [document-kind]؛ title text، اختياري؛ number id، اختياري؛ on day |
driver_key.blocked | blocked {keyKind} {key} presented ({detail}) | keyKind enum [key-kind]؛ key id؛ detail text |
driver_key.not_permitted | [{driver}: ]{keyKind} presented by a driver who may not drive ({detail}) | driver text، اختياري؛ keyKind enum [key-kind]؛ detail text |
driver_key.refused | the vehicle refused the driver of {keyKind} {key}: {detail} | keyKind enum [key-kind]؛ key id؛ detail text |
driver_key.unknown | unknown {keyKind} {key} presented — not a key the fleet gave a driver | keyKind enum [key-kind]؛ key id |
driver_safety.event | {event}[ ({camera} camera)] | event enum [safety-event]؛ camera enum [camera]، اختياري |
fuel.drain | {litres} l taken out of the tank while the vehicle stood ({before} l → {after} l, {from} – {to}) | litres number (l)؛ before number (l)؛ after number (l)؛ from instant؛ to instant |
fuel.purchase_flagged | {litres} l for {amount}[ at {station}]: {summary} | litres number (l)؛ amount money؛ station text، اختياري؛ summary text |
fuel.charge_flagged | {energy} kWh charge for {amount}[ at {station}]: {summary} | energy number (kWh); amount money; station text, optional; summary text |
geofence.entered | entered geofence "{fence}" | fence text |
geofence.left | left geofence "{fence}" | fence text |
geofence.dwell | inside "{fence}" for {minutes} min (permitted {permitted} min) | fence text, minutes number (min), permitted number (min) |
towing.engine_off | moving at {value} km/h with the engine off | value number (km/h) |
hos.other | Hours of service: {detail} | detail text |
idling.engine_on | engine on, not moving for over {minutes} min | minutes number (min) |
immobiliser.not_restored | back from service mode, the tracker's immobiliser is still off: {reason} | reason text |
not_in_use.unused | not used for over {hours} h (since {since}) | hours number (h)؛ since instant |
unauthorized_use.in_use | in use outside its permitted hours[ at {value} km/h] | value number (km/h)، اختياري |
unauthorized_operator.driver | driven by a driver not allowed on this vehicle[: {driver}] | driver text، اختياري |
driver_age.under | driven by a driver aged {age} (minimum {min})[: {driver}] | age number (years)؛ min number (years)؛ driver text، اختياري |
multiple_check_in.other_vehicles | [{driver} ]checked in while still the driver of {others} | driver text، اختياري؛ others text |
humidity.out_of_range | humidity {value} % (allowed {min} to {max} %) | value number (%)؛ min number (%)؛ max number (%) |
slave_seal.missing | the e-seal's slave unit is missing | |
gps.invalid | no valid GPS fix in {count} reports in a row (since {since}) | count number؛ since instant |
inspection.defects | {defects} | worst enum [defect-severity]؛ inspection enum [inspection-kind]؛ count number؛ defects text |
inspection.unsafe | Not safe to operate. {defects} | worst enum [defect-severity]؛ inspection enum [inspection-kind]؛ count number؛ defects text |
low_voltage.below | supply voltage {value} V (minimum {min} V) | value number (V)؛ min number (V) |
maintenance.due_soon | {plan} due soon[ at {dueKm} km][ at {dueHours} engine hours][ on {dueOn}] | plan text؛ dueKm number (km)، اختياري؛ dueHours number (h)، اختياري؛ dueOn day، اختياري |
maintenance.overdue | {plan} overdue[ at {dueKm} km][ at {dueHours} engine hours][ on {dueOn}] | plan text؛ dueKm number (km)، اختياري؛ dueHours number (h)، اختياري؛ dueOn day، اختياري |
offline.no_data | no data for {minutes} min (last report {last}) | minutes number (min)؛ last instant |
screening.hit | {decision} {trigger} ({hits} new hit(s)): {summary} | decision enum [screening-decision]؛ trigger enum [screening-trigger]؛ hits number؛ summary text |
secure_trip.other | {route}[ ({reference})]: {detail} | route text؛ reference id، اختياري؛ detail text |
speeding.over_limit | {value} km/h (limit {limit} km/h) | value number (km/h)؛ limit number (km/h) |
tachograph.infringement | card {card} ({severity}): {explanation} | card id؛ severity enum [tachograph-severity]؛ explanation text |
tire.condition | Tire[ {brand}][ {serial}][ at {position}]: {condition}[ ({value} {unit}, limit {limit} {unit})] | brand text، اختياري؛ serial id، اختياري؛ position id، اختياري؛ condition enum [tire-condition]؛ value number، اختياري؛ limit number، اختياري؛ unit id، اختياري |
toll.anomaly | {amount} at {gantry} ({issuer}): {summary} | amount money؛ gantry text؛ issuer text؛ summary text |
trailer.condition | {asset}[ ({ident})]: {condition} | asset text؛ ident id، اختياري؛ condition enum [trailer-condition] |
trailer.reefer_excursion | {asset}[ ({ident})]: reefer temperature out of range[ ({value} °C, limit {limit} °C)] | asset text؛ ident id، اختياري؛ value number (°C)، اختياري؛ limit number (°C)، اختياري |
trailer.seal_battery_low | {asset}[ ({ident})]: e-seal battery low[ ({value} %)] | asset text؛ ident id، اختياري؛ value number (%)، اختياري |
trailer.unaccounted | {asset}[ ({ident})]: not reporting[ for {hours} h] | asset text؛ ident id، اختياري؛ hours number (h)، اختياري |
مجموعات enum
| المجموعة | الكلمات |
|---|---|
camera | cab, road |
defect-severity | minor, major, critical |
document-kind | dangerous-goods, inspection-certificate, insurance, licence, medical, other, passport, professional-card, registration, residence-permit, road-permit |
inspection-kind | pre-trip, post-trip |
key-kind | ibutton, rfid |
safety-event | blind_spot, distracted, driver_abnormal, drowsy, fcw, ldw, obstacle, phone_use, road_sign, seatbelt_off, smoking, sos, tailgate, unsafe_lane_change |
screening-decision | clear, warn, block |
screening-trigger | request, rescreen |
subject-type | driver, vehicle |
tachograph-severity | minor, serious, very-serious, most-serious, unclassified |
tire-condition | critical_pressure, high_temperature, low_pressure, low_tread, pressure_imbalance |
trailer-condition | moved_sealed, probe_silent, reefer_excursion, seal_battery_low, seal_opened, seal_tampered, unaccounted |