API Reference
Carrier & EMR Integrations API
Programmatically configure telecom carriers (Sinch, RingCentral), partner eFax gateways (Praxis), test live trunk connectivity, and manage encrypted credentials.
GET
/v1/integrationsReturns an array of configured integrations for the authenticated organization. Sensitive API secrets and JWT tokens are masked automatically.
Response Example (200 OK)
{
"integrations": [
{
"id": "int_9a8f2bc014",
"integrationType": "SINCH",
"enabled": true,
"status": "ACTIVE",
"maskedCreds": {
"projectId": "••••••••9841",
"apiKey": "••••••••7719",
"apiSecret": "••••••••"
},
"createdAt": "2026-09-18T10:00:00.000Z",
"updatedAt": "2026-09-21T18:30:00.000Z"
},
{
"id": "int_7c2e4f910a",
"integrationType": "RINGCENTRAL",
"enabled": false,
"status": "INACTIVE",
"maskedCreds": {
"clientId": "••••••••1120",
"jwtToken": "••••••••"
},
"createdAt": "2026-09-19T14:15:00.000Z",
"updatedAt": "2026-09-20T09:00:00.000Z"
}
]
}POST
/v1/integrationsSaves or updates integration credentials. Payload credentials are encrypted in-memory with AES-256-GCM before writing to storage.
Request Body Schema
| Field | Type | Required | Description |
|---|---|---|---|
| integrationType | string | Yes | Carrier enum (e.g. SINCH, RINGCENTRAL, PRAXIS_SFTP). |
| creds | object | Yes | Carrier credential fields (e.g. projectId, apiKey, apiSecret, jwtToken). |
| enabled | boolean | No | Whether this carrier trunk is actively enabled for routing (default: true). |
POST
/v1/integrations/testSends an authenticated ping / query to the carrier's REST API to verify credential validity, account health, and network latency.
Response Example (200 OK)
{
"success": true,
"carrier": "SINCH",
"status": "connected",
"message": "Sinch Fax API credentials validated successfully.",
"latencyMs": 142
}DELETE
/v1/integrations/:carrierPermanently removes the carrier configuration and purges encrypted secrets from the database.
