All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

New 911 Call

The 911 Call API endpoint allows you to send 911 calls from in-game directly to your dispatchers.

This API endpoint requires the standard version of Sonoran CAD or higher. For more information, see our pricing page.

It is recommended to use the "Callcommands Export" rather than a "Raw API Call" whenever possible.

Raw API Call

This framework export handles the .

Parameters

Property
Type
Description

Export

This method utilizes the plugin to execute a 911 call.

Troubleshooting

  1. "/rcall is not drawing a postal route to the call location

    1. If you are using the Raw API Call method, please ensure that you have useCallLocation set to true.

    2. On either version of the call, please ensure that the postal is a valid, integer value

Boolean

Should the postal location be drawn when using the /rcall command

postal

Integer

Postal location of the call

plate

String

OPTIONAL: Plate to report in the call

cb

Function

OPTIONAL: Callback function

"Units are not getting the call in-game"
  1. Please ensure that you have the dispatchnotify plugin installed

  2. Please ensure the unit is on duty with the configured method in dispatchnotify

  3. Please ensure your server's port and IP are correctly set in the Admin -> In-game Integration -> Livemap section of CAD

caller

String

Name of the caller

location

String

Street(s) name

description

String

Call description

Emergency Call API endpoint
Callcommands
callcommands

useCallLocation

function call911(caller, location, description, postal, plate, cb)
    exports["sonorancad"]:performApiRequest({{
        ["serverId"] = GetConvar("sonoran_serverId", 1),
        ["isEmergency"] = true,
        ["caller"] = caller,
        ["location"] = location,
        ["description"] = description,
        ["metaData"] = {
            ["useCallLocation"] = true,
            ["plate"] = plate,
            ["postal"] = postal
        }
    }}, "CALL_911", cb)
end
-- Parameters
emergency, caller, location, description, source, silenceAlert, useCallLocation type
-- Usage example (client sided)
local pos = GetEntityCoords(PlayerPedId())
local s1, s2 = GetStreetNameAtCoord(pos.x, pos.y, pos.z)
local street1 = GetStreetNameFromHashKey(s1)
local street2 = GetStreetNameFromHashKey(s2)
local streetLabel = street1
if street2 ~= nil then
	streetLabel = streetLabel .. ' ' .. street2
end

TriggerServerEvent('SonoranCAD::callcommands:SendCallApi', true, 'Bystander', streetLabel, 'Someone is selling drugs on the street', GetPlayerServerId(PlayerId()), nil, nil, '911')

Dispatch and Emergency Calls

These endpoints allow you to create, update, and close dispatch and emergency (911) calls.

Set Call Postal

This endpoint allows you to easily update the postal on a dispatch call.

This API endpoint requires the plus version of Sonoran CAD or higher. For more information, see our pricing page.

This framework export handles the Set Call Postal API endpoint.

function setCallPostal(callId, postal)
    exports["sonorancad"]:performApiRequest({{
        ["serverId"] = GetConvar("sonoran_serverId", 1),
        ["callId"] = callId,
        ["postal"] = postal
    }}, "SET_CALL_POSTAL", function(_)
    end)
end

Parameters

Property
Type
Description

callId

Integer

Call ID to add the note to

postal

Integer

Postal to add to the call

Add Call Note

This endpoint allows you to add a new dispatch call note.

This API endpoint requires the plus version of Sonoran CAD or higher. For more information, see our pricing page.

This framework export handles the Add Call Note API endpoint.

function addCallNote(callId, note)
    exports["sonorancad"]:performApiRequest({{
        ["serverId"] = GetConvar("sonoran_serverId", 1),
        ["callId"] = callId,
        ["note"] = note
    }}, "ADD_CALL_NOTE", function(_)
    end)
end

Note Object

Call notes are formatted on dispatch calls with the following object:

Parameters

Property
Type
Description

callId

Integer

Call ID to add the note to

note

Note Object

See Note Object above

{
    "time": "12:00:00",
    "label": "A-10",
    "type": "text",
    "content": "This is a note!"
}

Remove 911

This endpoint allows you to remove an existing emergency/911 call from the CAD.

This API endpoint requires the Standard version of Sonoran CAD or higher. For more information, see our pricing page.

This framework export handles the Remove Emergency Call API endpoint.

function remove911(callId)
    exports["sonorancad"]:performApiRequest({{
        ["serverId"] = GetConvar("sonoran_serverId", 1),
        ["callId"] = callId
    }}, "REMOVE_911", function(_)
    end)
end

Parameters

Property
Type
Description

callId

Integer

Call ID to remove