Get Use Case

Your API key for authentication. Use Bearer format.

ID of the use case.

ID of the use case.

ID of the organization that owns 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.

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.

Classification tags for the use case.

Detailed work hours for each day of the week.

Enable detailed work hours in the UI.

Models the use case is evaluated on.

Parameters to extract with AI.

Generic message to play if the call is after hours.

Hide the use case from the UI.

Webhooks to call when the use case is executed.

Keywords you want the transcriber to know about.

Preferred language for the use case.

Specifies the maximum duration in minutes for this use-case. This value is overridden by the maximum duration specified for individual calls. If neither is provided, the default duration is 10 minutes.

Name of the use case.

Parameters to pass to the use case.

Play 'This call is being recorded' message for inbound calls.

Play 'This call is being recorded' message for outbound calls.

Available labels for the samples.

Show the original caller ID on the call screen.

Timezone of the use case.

Fallback phone number to transfer the call to if something breaks.

End of the work hours.

Start of the work hours.