WhatsApp Setup

Managed WhatsApp provisioning, business-scoped recipient identity, asynchronous replies, and the separate service voice-note API.

WhatsApp setup and business-account registration are managed provisioning operations. They are not workspace-scoped endpoints in the public Platform API. Workspace applications do not create or delete the upstream business setup with a Platform API key.

Contact Amigo to complete business-account provisioning and bind a WhatsApp use case to an eligible service. Use Cases and Bindings describes the public service-binding operations.

Managed Conversations

Ordinary inbound messages can drive the bound agent and receive an asynchronous text reply. Recipient addressing uses a business-scoped user identifier; do not substitute a phone number or assume that phone metadata is always present. Continuity uses the recipient identity and use case.

Managed free-form replies require an inbound message to that use case within the previous 23 hours. Template registration and status tracking do not currently provide a template-send path. An approved template therefore does not enable out-of-window outreach through this send path.

Inbound media and reaction records, read receipts, agent completion, and outbound delivery have separate meanings. A reaction without message or media content does not drive an agent turn, and a read receipt does not prove that the agent completed the task.

The public conversation-start and channel-switch operations do not create outbound WhatsApp threads. The former synchronous service text-turn route has also been removed. See WhatsApp concepts for delivery and media boundaries.

Separate Voice-Note API

Voice Turn

post

Run one WhatsApp-style voice-note turn against the service's agent.

Accepts OGG Opus audio (or any format Deepgram's prerecorded endpoint accepts). Server keys the conversation on (workspace, service, phone_number) and returns the agent's spoken reply as OGG Opus — or WAV PCM16 when the Accept header prefers audio/wav.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

service_idstring · uuidRequired

Header parameters

acceptstring · nullableOptional

Body

audiostringRequired

phone_numberstring · max: 16RequiredPattern: ^\+[1-9]\d{1,14}$

Responses

200

Agent spoken reply — OGG Opus by default, WAV PCM16 (16 kHz mono) when the request's Accept header prefers audio/wav

anyOptional

204

Agent elected silence

409

Concurrent voice turn in progress for this speaker

422

Validation Error

application/json

post/v1/{workspace_id}/services/{service_id}/voice-turn

POST /v1/{workspace_id}/services/{service_id}/voice-turn HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38

{
  "audio": "text",
  "phone_number": "text"
}

No content

This operation accepts recorded audio and returns the agent's audio response to the calling integration. That integration is responsible for delivery to WhatsApp or another destination. It is not automatic managed WhatsApp media processing.

Voice-note continuity is keyed by workspace, service, and phone number and remains separate from managed WhatsApp text history. See Voice Agent for response negotiation and session behavior.