PurpleCallio documentation

REST API for Calls

The PurpleCallio REST API gives your backend a clear call lifecycle: create, accept, reject, join, leave, end, and inspect calls.

Call lifecycle

Create calls on the server and use the returned information to connect participants through hosted UI or an SDK integration.

Use server-side requests

REST operations are intended for trusted backend code. Pair API calls with your application's own authorization checks.

Create a call with the REST API

request.sh

curl -X POST https://purplecallio.com/api/calls \
  -H "x-api-key: $PURPLECALLIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"callerId":"user_alice","receiverId":"user_bob"}'

Still having trouble?

If you're having an issue with this integration, our support team can help.

Contact Support

Build with PurpleCallio

Explore the documentation to choose hosted UI, React components, or the headless SDK for your integration.

Read the quickstart Create an account