Developers
API Reference
Five API families, each documented in full on CarrierX Docs. Start with the reference that matches what you are building.
docs.carrierx.com5 references
- Core API ReferenceUse core abilities like renting phone numbers, configuring recording storage, and managing trunk groups./voice/core-api/
- FlexML API ReferenceCreate simple or complex voice applications with the CarrierX FlexML API./flexml/
- Mediator API ReferenceConnect two parties with two-stage dialing and manage the call in progress./mediator/
- Conference V2 API ReferenceBuild conference calling into your application with the current conference API./conference/conf-v2-api/conf-v2-api-ref/
- Conference API Referencev1/conference/conf-v1-api/conf-v1-api-ref/
Quick Start Guides
Navigate through renting a phone number, creating a SIP trunk, and configuring application and FlexML endpoints.
- 1Renting a Phone NumberPDF· 134 KBThis guide will walk you through the process of searching for and adding a phone number to your account.
- 2Create a SIP TrunkPDF· 150 KBThis guide will walk you through the process of provisioning a SIP trunk, a fundamental building block of voice communication.
- 3Configuring Application EndpointsPDF· 153 KBApplication endpoints provide advanced workflow capabilities such as call routing, playing recordings, and enabling large conference calls.
- 4FlexML - Inbound CallsPDF· 164 KBThis guide will walk you through accepting an inbound call to your FlexML endpoint. Review "Configuring Application Endpoints" first.
- 5FlexML - Outbound CallsPDF· 166 KBThis guide will walk you through creating an outbound call from your FlexML endpoint. Review "Configuring Application Endpoints" first.