<AIAssistant> verb allows you to start a voice assistant on the call.
Attributes
| ATTRIBUTE | DESCRIPTION | OPTIONS | DEFAULT |
|---|---|---|---|
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, assistant | user |
Examples
action attribute is set on <Connect>, TeXML makes a request to that URL when the assistant conversation ends and executes the TeXML instructions returned in the response. The request payload includes a Reason field describing why the conversation ended (for example service_error), so the action endpoint can branch on it — such as returning a <Dial> to a human agent on error: