# Dispatch Notify
{% hint style="warning" %}
This submodule utilizes API endpoints that require the **plus** version of Sonoran CAD or higher. For more information, view our [pricing ](https://docs.sonoransoftware.com/cad/pricing/faq)page.
{% endhint %}
{% hint style="success" %}
Looking for VPS, web, or dedicated hosting? Check out our official [server hosting](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/broken-reference)!
{% endhint %}
This submodule:
* Notifies officers of incoming calls
* [Allows officers to attach to calls via command](#2-officer-attaches-to-the-call)
* Automatically routes attached units to the postal code
* Unit GPS routing is updated whenever the dispatch postal is updated
* [Allows the call postal and GPS routing to be automatically updated to the primary unit's location](#primary-unit-tracking-pursuit)
* Notifies the civilian making the emergency call when an officer is en-route.
## Video Showcase
Check out our video showcase of this submodule [here](https://youtu.be/eWmeFpz8jiA).
## Activation Guide
### 1. Download and Install the Core
If you haven't already, be sure to install and configure the [SonoranCAD Core](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation) first.
### 2. Activate the Submodule and all Dependencies
Dispatch Notify requires you to [enable the following submodules](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/submodule-configuration#activating-a-submodule):
* `callcommands`
* `locations`
* `postals`
### 3. Add your Game Server IP and Port
Be sure to have your game server IP and port set in the admin panel under `Advanced` > `In-Game Integration` > `Server Events and Integrated Live Map`
### 4. Set Your API ID
Don't forget to set your account [API ID](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id) to properly link your in-game user to the CAD.
### 5. Configuration
Review the `dispatchnotify_config.lua` file to configure the submodule to behave how you like. The file is well documented. Please review **all** the settings!
## Commands
| Command | Description |
| ---------- | -------------------------------------------------------------- |
| /rcall | Respond/Attach to the new dispatch call |
| /togglegps | Toggle the GPS auto-lock when dispatch updates the postal code |
### Configuration
| Config Value | Description |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enableUnitNotify | Enable incoming 911 call notifications |
| emergencyCallType | Specifies what emergency calls are displayed as. Some countries use different numbers (like 999) |
| civilCallType | Specifies non-emergency call types. If unused, set to blank ("") |
| dotCallType | Some communities use 511 for tow calls. Specify below, or set blank ("") to disable |
| respondCommandName | Command to respond to calls with |
| enableUnitResponse | Enable call responding (self-dispatching)
If disabled, running commandName will return an error to the unit
|
| dispatchDisablesSelfResponse | If a dispatcher is detected to be online, automatically disable the response command. |
| dispatchDisablesUnitNotify | If a dispatcher is detected to be online, automatically suppress incoming 911 call notifications to units. |
| enableUnitNotifyToggleCommand | Enable an in-game command to override unit 911 notifications |
| unitNotifyToggleCommand | In-game command to override unit 911 notifications |
| unitNotifyToggleAce | Ace permission allowed to use the command. Leave blank ("") to allow anyone to use the command |
| enableCallerNotify | Enable "units are on the way" notifications |
| notifyMethod | chat: Sends a message in chat
pnotify: Uses pNotify to show a notification
custom: Use the custom event SonoranCAD::dispatchnotify:IncomingCallNotifyinstead (Provides single parameter) - The message.
|
| unitNotifyMethod | chat: Sends a message in chat
pnotify: Uses pNotify to show a notification
ox\_lib: Uses ox\_lib to show a notification
lation\_ui: Uses lation UI to show a notification
custom: Use the custom event
SonoranCAD::dispatchnotify:IncomingCallNotifyinstead (Provides single parameter) - The message
|
| notifyMessage | NotifyMessage: Message template to use when sending to the player
You can use the following replacements:
{officer} - officer name
|
| incomingCallMessage | How should officers be notified of a new 911 call? Parameters:
{location} - location of call (street + postal)
{description} - description as given by civilian
{caller} - caller's name
{callId} - ID of the call so LEO can respond with /r911
{command} - The command to use
|
| unitDutyMethod | How to detect if units are online?
incad: units must be logged into the CAD
permissions: units must have the "sonorancad.dispatchnotify" ACE permission (see docs)
esxjob: requires esxsupport submodule, use jobs instead for on duty detection
custom: Use custom function (defined below as unitDutyCustom)
|
| esxJobsAllowed | What jobs should count as being on duty? |
| waypointType | Customise the title of a call made in the CAD
postal: set gps to caller's postal (less accurate, more realistic) - REQUIRES CONFIGURED POSTAL SUBMODULE
exact: set gps to caller's position (less realistic)
none: disable waypointing
|
| waypointFallbackEnabled | Fall back to postal if exact coordinates cannot be found (for self-generated calls) |
| callTitle | Type of waypoint to use when officer is attached
Default: OFFICER RESPONSE
|
| sendNotesToUnits | Enable "the sending of notes to units" notifications |
| notifyMessage | NotifyMessage: Message template to use when sending to the player
You can use the following replacements:
{callid} - The CAD Call ID
{note} - The Note Added
|
| enableAddNote | Enable "the adding of the notes" notifications |
| addNoteCommand | Command to add notes to a call with |
| enableAddPlate | Enable "the adding of plates that are locked" notifications - REQUIRES [CONFIGURED WRAITHV2 ](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/broken-reference)SUBMODULE |
| addPlateCommand | Command to add plates to a call with |
## Dispatch Call Responding
### 1. Civilian Places a 911 Call
This call can be placed from the Civilian menu of the CAD, or via the `/911` command in-game, supplied by the [callcommands ](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/call-commands)submodule.
### 2. Officer Attaches to the Call
All on-duty officers get a notification (if configured) and can use the attach command to respond to the call.
#### A. Call Attach Command
By default, this command is `/rcall `, where callid is the ID shown in the call notification.
#### B. GPS Toggle Command
Units can optionally choose to disable the postal updating when dispatch updates the call (or primary unit tracking) by using the `/togglegps` command. This is a toggle and will be shown in chat what it gets changed to. This is `ON` by default.
## Primary Unit Tracking (Pursuit)
Dispatch notify can also be used to track the primary unit on a call. This will auto route attached units via GPS to the primary unit in real-time. Additionally, the postal code on the call will be continually updated for dispatchers to easily view. This is highly useful for pursuits, where additional units need to catch up and join the chase.
### 1. Toggle Unit Tracking for the Primary Unit
#### A. Via the CAD UI:
Dispatchers can set the primary unit to any unit currently attached to the call. The slider next to the Primary Unit box will toggle tracking mode. When enabled, the postal will automatically update based on the primary unit's location and be sent to all attached units.
A unit can also designate themselves as primary, but only if Self Dispatch is enabled.
## Troubleshooting
* No notifications for 911 calls
* Units must be logged into the CAD (by default) or meeting the requirements depending on how the submodule is configured.
* If using pNotify notifications, ensure that resource is running.
* Units do not automatically attach to calls
* Ensure their [API ID](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id) is set so the server knows who they are.
* Caller is not notified when units attach to the call
* If the caller ever leaves the server and rejoins, this feature does not work.
* If dispatch created the call within the CAD, there is no way to notify a caller.
* Ensure you are not overriding the 911 command (default `/911`) with another resource.