API Reference
Complete documentation for all Nexafone CPaaS APIs. Build powerful communication features with our comprehensive API suite.
Quick Start
2. Make Your First Request
Voice API
Make and receive voice calls programmatically
/v1/callsInitiate a new voice call
/v1/calls/{call_id}Get call details and status
/v1/calls/{call_id}/hangupHang up an active call
SMS API
Send and receive SMS messages globally
/v1/messagesSend an SMS message
/v1/messages/{message_id}Get message delivery status
/v1/messagesList all messages
Video API
Build video calling and conferencing features
/v1/roomsCreate a video room
/v1/rooms/{room_id}/participantsAdd participant to room
/v1/rooms/{room_id}Get room details
WhatsApp Business API
Send messages via WhatsApp Business
/v1/whatsapp/messagesSend WhatsApp message
/v1/whatsapp/messages/{message_id}Get message status
/v1/whatsapp/templatesCreate message template
Verify API
Phone number verification and authentication
/v1/verify/startStart verification process
/v1/verify/checkVerify the code
/v1/verify/{request_id}Get verification status
Authentication
API Key Authentication
All API requests require authentication using your API key. Include it in the Authorization header:
Rate Limits
- • Free tier: 100 requests/minute
- • Professional: 1,000 requests/minute
- • Enterprise: Custom limits
- • Rate limit headers included in responses
Webhooks
Real-time Events
Receive real-time notifications about call status, message delivery, and other events:
- • Call status updates
- • Message delivery receipts
- • Verification completions
- • Error notifications
Webhook Security
Secure your webhooks with signature verification:
Ready to Start Building?
Get your API key and start building amazing communication experiences today.