Skip to main content
The <AIAssistant> verb allows you to start a voice assistant on the call.

​
Attributes

ATTRIBUTEDESCRIPTIONOPTIONSDEFAULT
id The identifier of the AI assistant. The AI assistant can be created using the AI Assistant API. -
join The ID of an existing AI assistant conversation to join. When set, the call leg is added as a participant to the specified conversation instead of starting a new one. Use participantName and participantRole to configure the joining participant. -
participantName The display name of the participant joining the conversation. Only used when join is set. -
participantRole The role of the participant joining the conversation. Only used when join is set. user, assistantuser

​
Examples

<Response>
    <Connect>
        <AIAssistant id=\"assistant-776d0d6f-716d-4d8f-b6da-b95181636838\">
        </AIAssistant>
    </Connect>
</Response>

<!-- Join an existing AI assistant conversation -->
<Response>
    <Connect>
        <AIAssistant join=\"v3:abc123def456\" participantName=\"John\" participantRole=\"user\">
        </AIAssistant>
    </Connect>
</Response>