Pancake POSDevelopers
/
llms.txt
VIEN
Sales

Auto Voice

1 endpoints · https://pos.pages.fm/api/v1

View Markdown
Endpoints
POST/shops/{SHOP_ID}/orders/{ORDER_ID}/trigger_callTrigger auto voice call for an order

Trigger auto voice call for an order

POST/shops/{SHOP_ID}/orders/{ORDER_ID}/trigger_call

Trigger an automated outbound call (Auto Voice) to the order's customer phone number and play the selected voice. Returns a background job id; the call outcome is delivered asynchronously. The SIP subscription must have the Auto Voice add-on enabled.

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4
ORDER_IDstringrequired

Order ID

Example: "1418"

Request body

Request body containing the voice id to play

object
voice_idstring · uuidrequired

Voice id (copied from the voice management screen)

Responses

object
successboolean

Success status

Request
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}/trigger_call?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "voice_id": "3f7c2b9a-1e4d-4a2b-9c8e-2b1d0a9f6e5c"
}'
Response 200
{
  "success": true
}