List Receptionists | ElevenLabs Documentation

[
  {
    "is_active": true,
    "agent_id": "",
    "config": {
      "additional_instructions": "string",
      "tone_traits": [
        "string"
      ],
      "details_to_collect": [
        "string"
      ],
      "llm": "gpt-4o-mini",
      "reasoning_effort": "none",
      "disable_rag": false,
      "background_voice_detection": true,
      "turn_eagerness": "eager",
      "voice_id": "5kMbtRSEKIkRZSdXxrZg",
      "language": "string",
      "additional_languages": [
        "string"
      ],
      "first_message": "Hello! Thanks for calling. How can I help you today?",
      "disable_first_message_interruptions": false,
      "enable_end_call_tool": true,
      "enable_skip_turn_tool": true,
      "enable_play_keypad_touch_tone_tool": false,
      "agent_rules": [
        {
          "title": "string",
          "description": "string",
          "priority": "strict",
          "id": "string",
          "created_at_unix": 1
        }
      ],
      "transfer_rules": [
        {
          "label": "string",
          "phone_number": "string",
          "condition": "string",
          "post_dial_digits": "string",
          "id": "string",
          "created_at_unix": 1
        }
      ],
      "hide_caller_number_on_transfers": false,
      "record_after_transfers": false,
      "procedures": [
        {
          "name": "string",
          "trigger": "string",
          "body": "",
          "id": "string",
          "created_at_unix": 1,
          "source_key": "string"
        }
      ],
      "enable_secure_mode": false,
      "enable_spam_protection": false
    },
    "deactivated_at_unix": 1,
    "deactivation_reason": "tier_downgrade",
    "name": "Receptionist",
    "agent_exists": true,
    "is_transfer_allowed": false,
    "widget": {
      "orb_color_1": "string",
      "orb_color_2": "string",
      "variant": "tiny",
      "placement": "top-left",
      "dismissible": true,
      "main_label": "string",
      "start_call": "string"
    }
  }
]

List every customer-facing receptionist for the workspace.

レスポンス

成功レスポンス。

is_activeboolean読み取り専用

agent_idstringオプションデフォルト値

ID of the ElevenLabs agent behind this receptionist.

configobjectオプション

deactivated_at_unixinteger or nullオプション

Unix timestamp when this receptionist was deactivated. None when active.

deactivation_reasonenum or nullオプション

Why this receptionist was deactivated. None when active.

許可された値:

namestringオプションデフォルト値 Receptionist

Display name of the receptionist.

agent_existsbooleanオプションデフォルト値 true

False when the receptionist’s underlying agent was deleted; it cannot take calls until it is set up again.

is_transfer_allowedbooleanオプションデフォルト値 false

Whether this receptionist can configure and use transfer rules.

エラー

422

Unprocessable Entity Error

ヘッダー

レスポンス

エラー