Skip to main content
POST

Autorisierungen

​
X-HiDesk-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-HiDesk-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
​
provider_call_id
string
erforderlich

HiDesk's unique identifier for this call. Must match the value sent on POST /api/voice/incoming-call.

Maximum string length: 255
Beispiel:

"hd_01HZ4T8K5W3N6R8VYJ7A2QXM9P"

​
event
enum<string>
erforderlich

Event type. Currently the only supported value is call.completed.

Verfügbare Optionen:
call.completed
​
status
enum<string>
erforderlich

Final call status:

  • completed — call connected and ended normally.
  • missed — caller hung up before agent engagement.
  • error — the agent or telephony layer raised an error during the call.
Verfügbare Optionen:
completed,
missed,
error
​
start_time
string<date-time>
erforderlich

Call start timestamp in ISO 8601 (UTC).

Beispiel:

"2026-05-11T14:30:22Z"

​
end_time
string<date-time>
erforderlich

Call end timestamp in ISO 8601 (UTC).

Beispiel:

"2026-05-11T14:33:47Z"

​
duration_seconds
integer
erforderlich

Total connected call duration in seconds (telephony connect → telephony hangup).

Erforderlicher Bereich: x >= 0
Beispiel:

205

​
provider_call_url
string<uri>
erforderlich

Direct link to view this call in the HiDesk UI. Surfaced in the anny admin dashboard.

Beispiel:

"https://app.hidesk.com/calls/hd_01HZ4T8K5W3N6R8VYJ7A2QXM9P"

​
transfer_duration_seconds
integer

Portion of duration_seconds spent on a live-agent transfer, if any.

Erforderlicher Bereich: x >= 0
Beispiel:

0

​
transcript
string | null

Full conversation transcript. null if transcription is disabled for this organization or the call did not produce text (e.g. missed).

​
summary
string | null

AI-generated call summary. null if summarization is disabled or no useful content was produced.

​
recording_url
string<uri> | null

URL to the raw WAV recording. null if recording is disabled. The link is short-lived; anny stores its own copy on receipt.

Antwort

OK — payload received and processed synchronously. Equivalent to 202 for retry purposes.