Quick Start

​

In short

• Contract an ACTIVE number, it’s the origin line (from).
• Originate with from, to, and what to say when answered (speak, audio, or gather).
• Track and control via API or webhooks (voice.call.*).

​

Before you start

• ACTIVE number in the workspace
• Key with voice:call (and voice:read / voice:control as needed)
• Balance or credits available
• Auth: Authorization: Bearer sk_live_... or x-api-key
• Base URL: https://api.notifique.dev
• Destinations in E.164 with + (e.g. +5511999887766)

​

1. Originate a call

​

1A, Via dashboard

1. Voice → New call
2. Select origin and destination numbers
3. Set the prompt (TTS or audio) and dispatch

​

1B, Via API

POST /v1/voice/calls
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "from": "+5511987654321",
  "to": ["+5511999887766"],
  "type": "speak",
  "payload": {
    "text": "Hello! This is a Notifique test call.",
    "voice": "female-natural"
  },
  "clientState": "verification-campaign-42"
}

{
  "success": true,
  "data": {
    "id": "clvoice1...",
    "direction": "OUTBOUND",
    "fromE164": "+5511987654321",
    "toE164": "+5511999887766",
    "status": "QUEUED",
    "clientState": "verification-campaign-42",
    "createdAt": "2025-02-15T10:00:00.000Z"
  }
}

• type: "play", play audio from URL: payload.audioUrl
• type: "gather", collect DTMF: payload.gather with prompt, maxDigits, timeoutSecs
• type: "template", workspace template: payload.templateId + optional variables
• record: true, record the call
• machineDetection: "detect", detect voicemail

​

2. List and query

GET /v1/voice/calls?page=1&limit=20&direction=OUTBOUND
Authorization: Bearer sk_live_xxxxx

GET /v1/voice/calls/:id?includeEvents=true
Authorization: Bearer sk_live_xxxxx

​

3. Control active call

POST /v1/voice/calls/clvoice1.../actions/speak
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "text": "Press 1 for sales or 2 for support.",
  "voice": "female-natural"
}

​

4. Download recording

GET /v1/voice/calls/:id/recordings/:recordingId/download
Authorization: Bearer sk_live_xxxxx

​

5. Inbound calls

1. Configure inboundVoiceAction on the number, Phone Numbers
2. With WEBHOOK_CONTROL, receive voice.call.received and control via API
3. With FORWARD, forward to forwardToE164
4. With TTS_HANGUP, speak configured text and hang up

​

6. Webhooks (optional)

​

TTS voices

​

All send types

​

Next steps

• Introduction: when to use and call lifecycle
• Scopes: key permissions
• Webhook events: real-time status
• Billing: per-minute cost