Skip to content
vocapable.Docs

Read the agent's most recent receptionist release candidate

GET
/v1/agents/{agent_id}/receptionist-release/candidate
curl --request GET \
  --url https://api.vocapable.com/v1/agents/example/receptionist-release/candidate \
  --header 'Authorization: Bearer <token>'

The latest candidate of any status; read-only impersonation can see it too.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agent_id
required
Agent Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ReceptionistReleaseCandidate

One staged candidate and its lifecycle.

While status is staged the line routes directly to the agent, whose active version is this unqualified candidate: carrier ingress answers only a challenge-verified carrier canary with it and gives every other caller the deterministic fallback. The candidate closes as qualified when the matching qualified version is published, withdrawn when its route is removed, or superseded by a restaged candidate.

object
id
required
Id
string
agent_definition_id
required
Agent Definition Id
string
agent_version_id
required
Agent Version Id
string
version
required
Version
integer
phone_number_id
required
Phone Number Id
string
status
required
Status
string
Allowed values: staged qualified withdrawn superseded
staged_by
Any of:
string
staged_at
required
Staged At
string format: date-time
qualified_version_id
Any of:
string
qualified_at
Any of:
string format: date-time
closed_at
Any of:
string format: date-time
Example
{
  "status": "staged"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}