Place a call from the inbox number
Requires message_send. Speaks say with text-to-speech from the inbox number. mode say_and_record speaks, then records a reply as a voicemail. to must be a US or Canada number (HTTP 400 international_not_allowed). Premium-rate numbers return HTTP 400 premium_rate_blocked. say is required and at most 1000 characters (HTTP 400 missing_say or say_too_long). HTTP 409 phone_number_not_found when the inbox has no active number. Free has no voice minutes. Starter includes 30 minutes per active number each month. Pro includes 300 minutes plus 30 for each active number past the 3 included numbers. Outbound calls past that allowance return HTTP 402 plan_limit_exceeded with upgrade_url and resource voice_minutes. Each account can place at most 100 calls per UTC day (HTTP 409 daily_call_cap). A paused inbox is HTTP 403 inbox_paused. The stored message has channel voice. A later status callback sets status to queued, ringing, completed, no-answer, or failed, and duration_seconds. client_id and Idempotency-Key follow the send rules. HTTP 404 not_found when voice is off.
Request
- Base URL: https://cooperemail.com
- URL: https://cooperemail.com/api/v1/inboxes/{id}/calls
- Auth: HTTP bearer
Path parameters
Headers
Optional. 1 to 256 characters: letters, digits, and - . _ ~. The same key and the same request within 24 hours returns the stored message with HTTP 200, idempotent true, and Idempotent-Replayed: true, and does not send again. A different request is 409 idempotency_key_conflict. A second call while the first is still running is 409 idempotency_request_in_progress. An empty or invalid value is 400 invalid_idempotency_key. A failed send removes the key. When client_id is also set, client_id is checked first. Keys expire after 24 hours.
Request body
Response
client_id or Idempotency-Key replay.
Changes
No recorded changes to this operation across all 1 revision of this API.