Skip to main content
POST

Autorisierungen

X-Anny-Signature
string
header
erforderlich

HMAC-SHA256 signature of the raw request body, computed with the shared HiDesk integration secret and sent as a lowercase hex string.

Verified by anny before JSON parsing. Mismatch → 401 Unauthorized.

Header

X-Anny-Signature
string
erforderlich

Hex-encoded HMAC-SHA256 of the raw request body, computed with the shared HiDesk integration secret.

Pattern: ^[A-Fa-f0-9]{64}$

Body

application/json
called_number
string
erforderlich

The anny Phone number that was dialed, in E.164 format (+ followed by 5–15 digits, leading digit non-zero).

Pattern: ^\+[1-9]\d{4,14}$
Beispiel:

"+4930123456789"

provider_call_id
string
erforderlich

HiDesk's unique identifier for this call. anny uses this value for deduplication against the post-call webhook.

Maximum string length: 255
Beispiel:

"hd_01HZ4T8K5W3N6R8VYJ7A2QXM9P"

caller_number
string | null

Caller's phone number. Send null when the caller withheld their number.

Maximum string length: 30
Beispiel:

"+4915112345678"

caller_anonymous
boolean
Standard:false

Whether the caller withheld their number. When true, caller_number must be null.

channel
enum<string>
Standard:phone

Originating channel for the call.

Verfügbare Optionen:
phone,
web,
native

Antwort

OK — agent configuration returned. HiDesk should start the AI conversation with these instructions and tools.

default_language
string
erforderlich

BCP-47 language tag the agent should open the call with. Customers may switch language mid-call.

Beispiel:

"de"

instructions
string
erforderlich

Full system prompt for the AI agent. Organization-specific and built per call — do not cache across calls.

tools
object[]
erforderlich

MCP server definitions the agent may use during the call. Headers are pre-signed and call-scoped.

call_session_id
string<uuid>
erforderlich

anny-internal session ID. Must be echoed back as call_session_id in the post-call webhook so anny can correlate metadata and recording with the conversation state.

Beispiel:

"7c3e2f1a-4d8b-4e2c-9f5a-1b6d8e0c2a47"

instructions_format
enum<string>
Standard:text

Format hint for instructions. Currently always text.

Verfügbare Optionen:
text,
markdown