VEverdun
parents

Get Disarm Voice Status

get/parents/{parent_id}/disarm-number/voice

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/parents/{parent_id}/disarm-number/voice
  • Auth
    HTTP bearer

Path parameters

parent_idstring required

Response

Successful Response

statusstring required

'connected' means the voice platform routes this line's inbound calls to the disarm agent and asks this API who is calling. It does not prove the carrier delivers calls there - only a real call does. 'not_connected' means calls will not be answered (texting is unaffected); reasons says why. 'unknown' means the voice platform could not be read or voice is not configured here - never treat it as either answer. 'no_line' means the client has no disarm line.

reasonsstring[]

not_connected: not_on_voice_platform, no_agent, wrong_agent, no_webhook, wrong_webhook. unknown: voice_not_configured, voice_platform_unreachable.

checked_atstring date-time required

When the voice platform was read.

Example response

{
  "status": "connected",
  "reasons": [
    "no_agent",
    "no_webhook"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.