Workspaces

Get Voicemail Settings

What the AI voice agent does when an outbound call reaches an answering machine: ``hang_up`` (the default) or ``leave_message`` (a short, pre-approved message naming the company, saying it is an AI assistant, with ``callback_number`` and how to opt out). Either way the call ends ``voicemail``.

API key access

Needs the workspace:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/workspaces/current/voicemail
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/workspaces/current/voicemail" \  -H "X-Workspace-Id: string"
{
  "mode": "hang_up",
  "callback_number": "string",
  "configured": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}