Getting started
API keys
Each dialer or service gets its own key. The full key is shown once; we keep only a fingerprint of it. Revoked keys stop working within 15 seconds.
| Name | Starts with | Created | Last used |
|---|
This month so far
Card
Invoices
| Month | Detections | Total | Status |
|---|
Daily usage, last 60 days
| Day (UTC) | Key | Plan | Calls | Billable | Machine | Person | Unsure |
|---|
Quick start: VICIdial
On each dialer, as root (replace the key with one from Keys):
curl -fsSL https://amd-api.vicifast.com/install.sh | sudo bash -s -- --key sb_live_YOUR_KEY
The installer puts SkipBeep in front of Asterisk's AMD on VICIdial's AMD routes (8369, 8373, 8375), keeps AMD() behind it as the fallback, keeps a few warm connections open so calls do not wait for a handshake, and runs a self-test. If SkipBeep cannot answer, the call carries on exactly as before. --uninstall restores your dialplan.
Your AMD Status Map works as it does today: SkipBeep sets AMDSTATUS (HUMAN, MACHINE, NOTSURE) and AMDCAUSE such as VOICEMAIL-480-0.97-SKIPBEEP.
Any platform: the streaming API
Open a WebSocket to wss://amd-api.vicifast.com/v1/stream with the header X-Api-Key: sb_live_… as soon as the call is answered, send a start message, then the called party's audio as binary frames (20–100 ms each):
{"type":"start","encoding":"mulaw","sample_rate":8000,"mode":"balanced","max_ms":4000,
"options":{"beep":false,"late_correction":false},"metadata":{"call_id":"your-id"}}
Encodings: mulaw, alaw, pcm16 at 8 or 16 kHz. Modes: fast, balanced, accurate. You receive ready, then a verdict as soon as one is reached:
{"type":"verdict","class":"machine","subtype":"voicemail","confidence":0.97,"decided_ms":480,"decided_by":"fingerprint"}
class is human, machine or unsure (treat unsure as a person). With beep on, a beep event follows a voicemail verdict when the greeting ends, so you can leave a message at the right moment. Send {"type":"stop"} or close when the call ends; an end event closes the stream. Calls with no audio at all are not billed.
Prices
| Monthly volume | Core | Plus |
|---|---|---|
| First 250k | $0.30 per 1,000 | $1.50 per 1,000 |
| 250k–1M | $0.12 | $1.50 |
| 1M–10M | $0.06 | $1.10 |
| Over 10M | $0.06 | $0.75 |
Core: verdict, subtype, timings. Plus adds beep timing, late correction and a transcript snippet. 100,000 detections free once; the first 30 days after activation are a free shadow trial; a month with any charge is at least $29. Invoices are monthly, charged to your card.
Questions: team@vicifast.com