VoiceGateway

Resolve a recording-lost incident

POST
/api/v1/org/{orgId}/project/{projectId}/alert-incidents/{incidentId}/resolve

Authorization

consoleSession
cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length
incidentId*string

An alert incident's id; one from another project, or not a UUID, is not_found.

Response Body

The resolved incident.

application/json
  1. response
id*string

The incident.

ruleId*string

The rule.

Value in"slow-answer""cut-off""job-failed""slow-join""plain-phone""recording-lost""ingress-error"
subject*string

What the incident is about: an agent for call and job rules, else the trunk, egress or ingress.

state*string

Firing until its resolve condition holds, or a person resolves a lost recording.

Value in"firing""resolved"
openedAt*string

When it opened.

Formatdate-time
resolvedAt*|

When it resolved.

Formatdate-time
resolvedBy*|

condition when the resolve rule held; person for a lost recording a person resolved.

Value in"condition""person"null
occurrences*|

Occurrences grouped into it.

Range1 <= value
lastOccurrence*

The latest thing the rule matched.

holdReason*|

Why a firing incident has not resolved when the data cannot decide, such as fewer than 5 calls in the last 30 minutes.

silentSince*|

The incident's source has reported nothing since this time. It stays firing: silence never resolves it.

Formatdate-time
deliveries*array<>

Every delivery of its changes, oldest first.

Example Request
curl -X POST 'https://example.com/api/v1/org/string/project/string/alert-incidents/string/resolve'
Example Response
{  "id": "string",  "ruleId": "slow-answer",  "subject": "string",  "state": "firing",  "openedAt": "2019-08-24T14:15:22Z",  "resolvedAt": "2019-08-24T14:15:22Z",  "resolvedBy": "condition",  "occurrences": 1,  "lastOccurrence": {    "at": "2019-08-24T14:15:22Z",    "where": "string",    "detail": "string",    "callId": "string"  },  "holdReason": "string",  "silentSince": "2019-08-24T14:15:22Z",  "deliveries": [    {      "id": "string",      "channel": "email",      "change": "firing",      "state": "pending",      "attempts": 0,      "nextAttemptAt": "2019-08-24T14:15:22Z",      "status": "string",      "message": "string",      "deliveredAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Was this page helpful?