Get Calls
This endpoint allows you to retrieve all active emergency calls, active dispatch calls, and previously closed dispatch calls.
This API endpoint requires the plus version of Sonoran CAD or higher. For more information, see our pricing page.
Get Calls
POST
https://api.sonorancad.com/emergency/get_calls
This endpoint allows you to retrieve all active emergency calls, active dispatch calls, and previously closed dispatch calls.
Request Body
id*
string
Your community's ID
key*
string
Your community's API Key
type*
string
GET_CALLS
data*
array
Array of request objects
closedLimit
int
Limit number of closed dispatch calls returned (Max 100, Default 10)
closedOffset
int
Used to paginate through the closed dispatches when paired with the limit
{
// See below for full object structuring
"activeCalls": [], // DISPATCH CALL Array
"emergencyCalls": [], // EMERGENCY CALL Array
"closedCalls": [], // CLOSED CALL Array
}
{
"id": "YOUR_COMMUNITY_ID",
"key": "YOUR_API_KEY",
"type": "GET_CALLS",
"data": [
{
"serverId": 1 // Default 1 - See out guide on setting up multiple servers
"closedLimit": 100, // OPTIONAL: Limit number of closed calls retuned (Max 100, default 10)
"closedOffset": 0 // OPTIONAL: Used to paginate beyond the limit
},
]
}
Object Structuring
The GET_CALLS API endpoint returns arrays of the following object structures:
{
"callId": -1,
"origin": 0, // See ORIGIN Enum
"status": 0, // See CALL_STATUS Enum
"priority": 1, // 1, 2, or 3
"block": "123",
"address": "4234 E. Example Ave",
"postal": "456",
"title": "Traffic Stop",
"code": "10-39 - Traffic Stop",
"description": "Traffic Stop - Blue Sedan - XP123BS",
"notes": [],
"idents": [1, 2, 3] // Array of identifier IDs
}
Enumeration Values
Sonoran CAD uses integer enumeration values for the origin
and status
fields. See the tables below for more information.
0
CALLER
1
RADIO DISPATCH
2
OBSERVED
3
WALK_UP
Last updated
Was this helpful?