Set Callouts

Replace available ERS callouts for a server.

PUT https://api.sonorancad.com/v2/emergency/servers/{serverId}/callouts

Rate limit: 2 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Replace the ERS callout configuration for a server.

Path Parameters

Name

Type

Description

serverId

integer

Configured Sonoran CAD server ID.

Request Body

{
  "callouts": [
    {
      "id": "armed_suspect",
      "data": {
        "PedActionOnNoActionFound": "Flee",
        "PedActionMinimumTimeoutInMs": 2000,
        "PedChanceToFleeFromPlayer": 50,
        "PedChanceToObtainWeapons": 30,
        "CalloutName": "Armed Suspect",
        "CalloutDescriptions": ["Reports of an armed suspect in the area."],
        "PedChanceToAttackPlayer": 20,
        "PedActionMaximumTimeoutInMs": 10000,
        "Enabled": true,
        "CalloutLocations": [],
        "PedChanceToSurrender": 30,
        "PedWeaponData": ["WEAPON_PISTOL"],
        "CalloutUnitsRequired": {
          "towRequired": false,
          "fireRequired": false,
          "description": "Single suspect, use caution.",
          "policeRequired": true,
          "ambulanceRequired": false
        }
      }
    }
  ]
}

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:setAvailableCalloutsV2({
    // See the request body above for the full callout shape.
    { id = 'armed_suspect', data = {} },
  }, 1)

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the Lua export client:

local response = cad:setAvailableCalloutsV2({
    // See the request body above for the full callout shape.
    { id = 'armed_suspect', data = {} },
  }, 1)

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.setAvailableCalloutsV2([
    // See the request body above for the full callout shape.
    { id: 'armed_suspect', data: {} },
  ], 1);
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.setAvailableCalloutsV2([
    # See the request body above for the full callout shape.
    { "id": 'armed_suspect', "data": {} },
  ], 1)

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.setAvailableCalloutsV2(
    new[]
    {
        new AvailableCalloutV2
        {
            Code = "10-70",
            Label = "Structure Fire",
            Priority = 1
        }
    },
    1
);

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Set Callouts"
  version: "1.0.0"
  description: "Replace available ERS callouts for a server."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/emergency/servers/{serverId}/callouts:
    put:
      summary: "Set Callouts"
      operationId: "setCallouts"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                serverId: 1
                callouts: 1
      parameters:
        -
          description: "Configured Sonoran CAD server ID."
          name: "serverId"
          in: "path"
          schema:
            type: "integer"
          example: 1
          required: true
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              callouts:
                - id: "armed_suspect"
                  data:
                    PedActionOnNoActionFound: "Flee"
                    PedActionMinimumTimeoutInMs: 2000
                    PedChanceToFleeFromPlayer: 50
                    PedChanceToObtainWeapons: 30
                    CalloutName: "Armed Suspect"
                    CalloutDescriptions:
                      - "Reports of an armed suspect in the area."
                    PedChanceToAttackPlayer: 20
                    PedActionMaximumTimeoutInMs: 10000
                    Enabled: true
                    CalloutLocations: []
                    PedChanceToSurrender: 30
                    PedWeaponData:
                      - "WEAPON_PISTOL"
                    CalloutUnitsRequired:
                      towRequired: false
                      fireRequired: false
                      description: "Single suspect, use caution."
                      policeRequired: true
                      ambulanceRequired: false
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request PUT \
  --url "https://api.sonorancad.com/v2/emergency/servers/1/callouts" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "callouts": [
    {
      "id": "armed_suspect",
      "data": {
        "PedActionOnNoActionFound": "Flee",
        "PedActionMinimumTimeoutInMs": 2000,
        "PedChanceToFleeFromPlayer": 50,
        "PedChanceToObtainWeapons": 30,
        "CalloutName": "Armed Suspect",
        "CalloutDescriptions": ["Reports of an armed suspect in the area."],
        "PedChanceToAttackPlayer": 20,
        "PedActionMaximumTimeoutInMs": 10000,
        "Enabled": true,
        "CalloutLocations": [],
        "PedChanceToSurrender": 30,
        "PedWeaponData": ["WEAPON_PISTOL"],
        "CalloutUnitsRequired": {
          "towRequired": false,
          "fireRequired": false,
          "description": "Single suspect, use caution.",
          "policeRequired": true,
          "ambulanceRequired": false
        }
      }
    }
  ]
}'

Response

Successful requests return application/json.

{
  "serverId": 1,
  "callouts": 1
}

PreviousSet Street Sign Config NextGet Pager Config

Last updated 19 days ago

Was this helpful?