Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.govworx.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview of CAD Integration

The GovWorx CommsCoach Assist product provides on-screen, real-time support for emergency telecommunicators. It’s ability to extract information from transcripts of live calls provides a unique opportunity to reduce the cognitive load on telecommunicators by directly sending remarks / notes to a Computer Aided Dispatch (CAD) system. The API provided by CommsCoach Assist allows CAD vendors to support such behavior by:
  • Implementing a simple push or pull interface for their CAD system.
  • Using the push based API in CommsCoach Assist to link CAD incidents to active calls.

​
Linking CAD Incidents to Calls

Regardless of whether they are seeking to support a pull or push based method for getting notes generated by CommsCoach Assist, CAD vendors need to leverage the Link Incident API endpoint. Calling this endpoint will link a CAD incident with an active call in CommsCoach Assist. This call provides key identifiers that can be used to implement other parts of the integration.

​
Pull-based CAD Notes

CAD vendors can implement a pull / polling based approach to getting notes from CommsCoach Assist by using the Incident Notes endpoint. This endpoint returns a set of notes along with a cursor value. When the cursor is sent on subsequent requests, only notes that have been created after the cursor’s point in time are returned. In order to use this method, CAD vendors must track the Call ID that was returned by the Link Incident endpoint.

​
Push-based CAD Integration

The push-based model allows for a wider variety of data to be sent from CommsCoach Assist to a Computer Aided Dispatch system. The vendor must implement all calls, even if it ignores some of the data sent. CommsCoach Assist sends push data with a short time-out (in order to prevent holding resources in CommsCoach Assist longer than necessary), so CAD vendors are encouraged to queue these requests and deal with them in an async fashion. CAD vendors can set any “base-url” they like provides the individual endpoints are implemented as per this documents. For example:
  • <base-url>/notes
  • <base-url>/fields
  • <base-url>/response-plan
Could be implemented as:
  • govworx/notes
  • govworx/fields
  • govworx/response-plan
Or:
  • external-cad-info/notes
  • external-cad-info/fields
  • external-cad-info/response-plan
Basically, any path prefix that results in a valid URL.

​
Notes

Vendors must implement the /notes endpoint in order to get CAD notes generated by CommsCoach Assist pushed directly to them.

​
Fields

CommsCoach Assist has the ability to detect relevant values for common CAD incident fields. CAD vendors can accept these values by implementing the /fields endpoint.

​
Response Plans

CommsCoach Assist may have configurations, depending on the agency, that allow it to determine Response Plans. CAD vendors can receive information from CommsCoach Assist about Response Plans by implementing the /response-plan endpoint.