Docs

API

Playground

Try requests in the signed-in app. This docs site only offers copy-paste curl — it never executes a cf_ secret.

In-app playground

After you sign in, open https://console.callfora.com/integrations. Integration Hub can attach your key to sample calls against Callfora External API v1 (users, click-to-dial, chat, SMS, quote, CDR, presence) using your session and stored key hash — not a secret pasted into the browser address bar.

This documentation origin does not proxy API calls and will not collect keys. Paste curl into your own terminal or the in-app playground only.

Copy-paste examples

Replace cf_your_api_key_here and the tenant UUID. Host defaults to https://console.callfora.com.

List users
curl -X GET "https://console.callfora.com/api/v1/users" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "Content-Type: application/json"
Click-to-dial
curl -X POST "https://console.callfora.com/api/v1/click2dial" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "X-User-Email: user@example.com" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-call-001" \
  -d '{"destination":"+15551234567"}'
Send SMS
curl -X POST "https://console.callfora.com/api/v1/sms/conversations/{id}/messages" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "X-User-Email: user@example.com" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-sms-001" \
  -d '{"body":"Hello from Integration Hub"}'
Send chat
curl -X POST "https://console.callfora.com/api/v1/chat/messages" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "X-User-Email: user@example.com" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: chat-message-001" \
  -d '{"conversationId":"00000000-0000-0000-0000-000000000000","content":"Hello"}'
Pricing quote
curl -X POST "https://console.callfora.com/api/v1/pricing/quote" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "Content-Type: application/json" \
  -d '{"planId":"uuid","seatCount":10,"billingTerm":"MONTHLY"}'
Presence
curl -X GET "https://console.callfora.com/api/v1/presence" \
  -H "X-API-Key: cf_your_api_key_here" \
  -H "X-Tenant-Id: your-tenant-uuid" \
  -H "Content-Type: application/json"