Create a Use Case
Create a new use case.
Headers
Your API key for authentication. Use Bearer format.
Body
Name of the use case.
Fallback phone number to transfer the call to if something breaks.
Parameters to extract with AI.
Classification tags for the use case.
Preferred language for the use case.
en-US
, es-MX
, es-ES
, in-IN
Start of the work hours.
End of the work hours.
Timezone of the use case.
Keywords you want the transcriber to know about.
Webhook to call when the use case is executed.
Parameters to pass to the use case.
Enable automatic machine detection. This is a prerequisite to end calls on machines or for Phone Tree Navigation.
AI assistant behavior when AMD is enabled. Continue
is used for Phone Tree Navigation, Hangup
to end the call and Message
to leave a message. If amd
is set, this field is required.
Hangup
, Continue
, Message
Record of messages to leave on voicemail if amd_behavior
is set to Message
. You may use parameters as you do in the prompt for templating. The key is the language of the message and the value is the message.
Available labels for the samples.
Hide the use case from the UI.
Models the use case is evaluated on.
Response
ID of the use case.
ID of the organization that owns the use case.
Name of the use case.
Fallback phone number to transfer the call to if something breaks.
Parameters to extract with AI.
Classification tags for the use case.
Preferred language for the use case.
en-US
, es-MX
, es-ES
, in-IN
Start of the work hours.
End of the work hours.
Timezone of the use case.
Keywords you want the transcriber to know about.
Webhook to call when the use case is executed.
Parameters to pass to the use case.
Enable automatic machine detection. This is a prerequisite to end calls on machines or for Phone Tree Navigation.
AI assistant behavior when AMD is enabled. Continue
is used for Phone Tree Navigation, Hangup
to end the call and Message
to leave a message. If amd
is set, this field is required.
Hangup
, Continue
, Message
Record of messages to leave on voicemail if amd_behavior
is set to Message
. You may use parameters as you do in the prompt for templating. The key is the language of the message and the value is the message.
Available labels for the samples.
Hide the use case from the UI.
Models the use case is evaluated on.
Was this page helpful?