Sandbox & environments

Choose your environment

Credentials and requests

Select Sandbox in the portal and use your Sandbox API key in X-Api-Key. Keep it in a server environment variable such as ILLYVOIP_SANDBOX_API_KEY. Do not substitute your production key. Browser-bootstrap operations use the short-lived Bearer authentication defined in their contract.

All 53 main production method/path pairs are present in the sandbox specification. Reuse the documented method and path with the sandbox base URL, but consult its separate specification for exact sandbox request and response schemas. Simulated results do not prove live carrier behavior, delivery, billing or resource persistence.

Select a scenario

Choose a scenario in the portal playground, or send X-Illyvoip-Sandbox-Scenario from your own HTTP client. The supported values depend on the endpoint. The default is success; common alternatives are not-found, rate-limited, forbidden and service-unavailable.

curl "https://sandbox-api.illyvoip.com/api/v1/rates/countries" \
  -H "X-Api-Key: ${ILLYVOIP_SANDBOX_API_KEY:?Set ILLYVOIP_SANDBOX_API_KEY}" \
  -H "X-Illyvoip-Sandbox-Scenario: rate-limited"

Open Sandbox Playground

Scenarios by endpoint

Values below come from the sandbox specification reviewed on 9 October 2026. Select the endpoint first; its available scenarios may differ from the previous selection.

Compatibility operations

The sandbox specification also lists the following five compatibility operations, beyond the 53 main reference operations. They are not evidence of production support and are not added to the production playground menu. Their exact schemas are available in the sandbox specification.

• POST /api/v1/voice/calls — Create call (compatibility)
• POST /api/v1/voice/calls/hangup — End call (compatibility)
• POST /api/v1/voice/calls/dtmf — Send DTMF (compatibility)
• POST /api/v1/voice/calls/transfer — Transfer call (compatibility)
• POST /api/v1/voice/call-control/send-dtmf — Send DTMF

Separate environment specifications

Download Sandbox OpenAPI JSON · Download Production OpenAPI YAML

Moving to production

Change the base URL and credentials together, remove the sandbox scenario header, and review the live endpoint’s requirements. Re-check inputs and resource IDs; sandbox identifiers are not production identifiers. Confirm production behavior through your approved integration testing before enabling real customer activity.

The HTTP sandbox is separate from the Webphone SDK’s live browser-calling playground. Selecting an HTTP scenario is not proof that browser calls, webhook delivery or external carrier operations are simulated.