Join a voicehook call
joinConnect to a voicehook.ai voice call as the agent behind its voicebot. invite_url: the full invite link including ?invite= (from the person or from create_call). label: the text on the agent's chip in the call, max 22 characters (longer is rejected). model: the model id the agent runs on (internal, not shown). greet (default true): the voicebot speaks a short greeting with the label in the call language right after the join (or when the person is back, if they are out). Returns session (the handle for every other tool, valid until the call ends, after 10 min without next or say, or after leave), room, lang (call language), idle_timeout_s, peers, humans_present (people in the call; 0 plus human_away = the person is out right now) and context (lang, mode, functions, skill_url). With a link from create_call, join waits up to 50 s for the person and then returns status waiting_for_human (not an error, with share_text) while the link is still unopened. Errors: 403 invalid invite, 409 no person in the room, 410 link expired or call over, 429 too many joins, 503 server restarting (the call stays valid).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Old name of `label` (still accepted). | |
| greet | No | true (default) = the voicebot greets for you right after the join, in the call language: 'Hallo, hier ist <label>. Worum geht es?' / 'Hi, this is <label>. What can I do for you?'. | |
| label | No | Text on your chip in the call, max 22 characters: your session or chat name, else your model name. Too long is rejected. | |
| model | No | Exact model id you run on (internal, not shown). | unbekannt |
| quiet | No | Accepted for compatibility with the HTTPS bridge; no effect here. | |
| invite_url | Yes | Invite link https://voicehook.ai/r/<room>?invite=... (max 2048 chars) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||