API docs by Redocly

Logging Service (1.2.1)

Download OpenAPI specification:Download

RetrieveLogEvents, ListLogEventsByEventTypeAndDateRange

Retrieves LogEvents. Use limit and start parameters for pagination.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

logEventType
string (LogEventType)
Enum: "CallProcessLogEvent" "CallStartLogEvent" "CallEndLogEvent" "RecCallStartLogEvent" "RecCallEndLogEvent" "CallTransferLogEvent" "RouteLogEvent" "MediaStartLogEvent" "MediaEndLogEvent" "RecMediaStartLogEvent" "RecMediaEndLogEvent" "RecordingFailedLogEvent" "MessageLogEvent" "AdditionalAgencyLogEvent" "IncidentMergeLogEvent" "IncidentUnMergeLogEvent" "IncidentLinkLogEvent" "IncidentUnLinkLogEvent" "IncidentClearLogEvent" "IncidentReopenLogEvent" "LostQueryLogEvent" "LostResponseLogEvent" "CallSignalingMessageLogEvent" "SipRecMetadataLogEvent" "NonRtpMediaMessageLogEvent" "AliLocationQueryLogEvent" "AliLocationResponseLogEvent" "MalformedMessageLogEvent" "IncidentSplitLogEvent" "DiscrepancyReportLogEvent" "ElementStateChangeLogEvent" "ServiceStateChangeLogEvent" "AdditionalDataQueryLogEvent" "AdditionalDataResponseLogEvent" "LocationQueryLogEvent" "LocationResponseLogEvent" "CallStateChangeLogEvent" "GatewayCallLogEvent" "HookflashLogEvent" "LegacyDigitsLogEvent" "AgentStateChangeLogEvent" "QueueStateChangeLogEvent" "KeepAliveFailureLogEvent" "RouteRuleMsgLogEvent" "PolicyChangeLogEvent" "VersionsLogEvent" "SubscribeLogEvent" "AnnouncementStartLogEvent" "AnnouncementEndLogEvent" "SessionStartLogEvent" "SessionEndLogEvent" "SessionStateChangeLogEvent" "EidoLogEvent" "EidoDereferenceFactoryQueryLogEvent" "EidoDereferenceFactoryQueryResponse" "SubscriptionRequestedLogEvent" "SubscriptionRequestedResponseLogEvent" "SubscriptionTerminatedLogEvent" "EidoDeniedLogEvent" "EidoTransmissionErrorLogEvent" "WebSocketEstablishedLogEvent" "WebSocketTerminatedLogEvent"

LogEvent type

startTime
string <date-time>
Example: startTime=2020-03-10T11:00:01-05:00

Start time

endTime
string <date-time>
Example: endTime=2020-03-15T11:00:01-05:00

End time

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "logEventContainers": [
    ]
}

LogEvent

Logs a new event into the Logging Service

Request Body schema: application/json
required

LogEvent data to add (JWS using flattened JSON serialization)

payload
required
string <byte>
protected
required
string <byte>
signature
required
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "protected": "string",
  • "signature": "string"
}

Response samples

Content type
application/json
"string"

RetrieveLogEvent

Retrieves a LogEvent based on logEventId. LogEvent is returned in JWS using flattened JSON serialization

path Parameters
logEventId
required
string

ID of the logEvent

Responses

Response samples

Content type
application/json
{
  • "payload": "string",
  • "protected": "string",
  • "signature": "string"
}

RetrieveConversationText

Returns an HTML formatted record suitable for human consumption of the text portion of a call, including all text sent by all parties.

query Parameters
callId
required
string

Call ID of the call

Responses

Response samples

Content type
application/json
"string"

ListLogEventsByCallId, ListLogEventsByIncidentId

Retrieves LogEvents IDs. Use limit and start parameters for pagination.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

callId
string

Call ID of the call

incidentId
string

Incident ID of the call

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "logEventIds": [
    ]
}

ListCallsByIncidentId, ListCallsByDateRange, ListCallsByLocation

Returns a list of Call Identifiers associated with a specific Incident Tracking Identifier, occurred within a time range or within a specified geographic region.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

incidentId
string

Incident ID of the call

startTime
string <date-time>
Example: startTime=2020-03-10T11:00:01-05:00

Start time

endTime
string <date-time>
Example: endTime=2020-03-15T11:00:01-05:00

End time

area
string

Area of interest

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "callIds": [
    ]
}

ListIncidentsByDateRange, ListIncidentsByLocation

Returns a list of Incident Tracking Identifiers occurring within a time/date range. Returns a list of Incidents that occurred within a specified geographic region.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

startTime
string <date-time>
Example: startTime=2020-03-10T11:00:01-05:00

Start time

endTime
string <date-time>
Example: endTime=2020-03-15T11:00:01-05:00

End time

area
string

Area of interest

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "logEventIds": [
    ]
}

ListAgenciesByCallId, ListAgenciesByIncidentId

Returns a list of agencies involved in a Call or an Incident.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

incidentId
string

Incident ID of the call

callId
string

Incident ID of the call

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "agencyIds": [
    ]
}

RetrieveVersions

Retrieves all supported versions, vendor parameter is optional.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "fingerprint": "string"
}