Assistant

Get the assistant

The assistant of the project: its voice, languages, instructions, website and fixed greeting.

get/assistant

Request

Base URL: https://api.hypamoon.com/api/v1
URL: https://api.hypamoon.com/api/v1/assistant
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: assistant:write)

The assistant.

configuredboolean required

Whether the assistant was ever set up with PUT /assistant.

voicestring nullable required

The voice, like ava. It speaks the language.

languagestring required

The language the assistant opens and speaks in, like en.

languagesstring[] required

The languages your callers speak, with language first.

speech_recognitionstring required

The language of speech recognition: the one language, or multi when there are two or more.

instructionsstring required

What the assistant does: your instructions.

websitestring nullable required

The website the assistant reads for opening hours, address and services.

greetingstring required

The fixed greeting, in the language. It follows from the project name and always says the caller is talking to a digital assistant.

synced_atstring date-time nullable required

When the assistant was last updated at the carrier.

No recorded changes to this operation across all 1 revision of this API.