- Python
- TypeScript
set_voicemail_action() tells the agent what to do if it reaches an answering machine.set_voicemail_action() and reach_person() both handle voicemail and cannot be used together. If you are using reach_person(), set voicemail behavior there via its voicemail_message or voicemail_hangup parameters instead. Using both raises an error.signature
call.set_voicemail_action(
hangup: bool = False,
message: str | None = None,
)
setVoicemailAction() tells the agent what to do if it reaches an answering machine.setVoicemailAction() and reachPerson() both handle voicemail and cannot be used together. If you are using reachPerson(), set voicemail behavior there via its voicemailMessage or voicemailHangup options instead. Using both throws an error.signature
await call.setVoicemailAction(
action: { hangup: true } | { message: string },
): Promise<void>
Example
- Python
- TypeScript
example.py
@agent.on_call_start
def on_call_start(call: guava.Call):
call.set_voicemail_action(
message="Hi, this is Alex from Bright Smile Dental. Please call us back at 555-0100 to confirm your appointment.",
)
You must specify exactly one of
hangup or message — passing both or neither raises an error.example.ts
agent.onCallStart(async (call: guava.Call) => {
await call.setVoicemailAction({
message: "Hi, this is Alex from Bright Smile Dental. Please call us back at 555-0100 to confirm your appointment.",
});
});
Pass exactly one of
hangup or message — the parameter type accepts { hangup: true } or { message: string }, not both.