Download OpenAPI specification:Download
Account management
Creates a new sub-account. Requires administrator API key. The new account password is auto-generated and returned in the response.
Body for add account.
| name required | string |
| username required | integer 10-digit numeric account username. |
| apikey required | string |
| email required | string |
| masterAccount | integer Billing account. Defaults to the new account username if omitted. |
{- "name": "Acme Corp",
- "username": 4592086960,
- "apikey": "Administrator API Key",
- "email": "billing@example.com",
- "masterAccount": 4592086960
}{- "account": {
- "name": "Acme Corp",
- "username": 4592086960,
- "password": "abc1234567",
- "email": "billing@example.com",
- "masterAccount": 4592086960
}, - "statusCode": "200",
- "status": "Success",
- "message": "Account Information"
}Returns the API key (Bearer token) for the account identified by username and password. No Bearer token is required or accepted. Rate limited to 6 requests per hour per IP.
Account credentials
| username required | integer Account username. |
| password required | string Account password. |
{- "username": 1234567890,
- "password": "abc1234567"
}{- "statusCode": "200",
- "status": "Success",
- "apikey": "dec759ed81963fd9a4b8a9c8f3e22b1a"
}Returns call detail records for the account within a time range. start and end are Unix timestamps. Defaults: start=now, end=24 hours ago. Rate limited to 6 requests per hour per IP address.
Body for call detail records.
| end | integer End time as Unix timestamp. Defaults to 24 hours before current time. |
| start | integer Start time as Unix timestamp. Defaults to current time. |
| apikey required | string |
{- "end": 1699913600,
- "start": 1700000000,
- "apikey": "Your API Key"
}{- "cdr": [ ],
- "statusCode": "200",
- "status": "Success"
}Returns account details including balance, rate, and configuration. Rate limited to 6 requests per hour per IP address.
Body for account info.
| apikey required | string |
{- "apikey": "Your API Key"
}{- "account": [ ],
- "statusCode": "200",
- "status": "Success"
}Returns the current monthly recurring charges broken down by service plus a total. Rate limited to 6 requests per hour per IP address.
Body for monthly recurring charges.
| apikey required | string |
{- "apikey": "Your API Key"
}{- "mrc": [ ],
- "statusCode": "200",
- "status": "Success"
}Sends a password recovery link to the email address associated with the account. No authentication required.
Body for account recovery.
| email required | string |
{- "email": "john@example.com"
}{- "statusCode": "200",
- "status": "Success",
- "message": "Please check your email (john@example.com) for details"
}Returns the current SIP registration details for the account including the registered SIP URI and user agent string.
Body for sip registration.
| apikey required | string |
{- "apikey": "Your API Key"
}{- "account": {
- "uri": "sip:4592086960@192.0.2.1:5060",
- "agent": "Zoiper rv2.8.97/"
}, - "statusCode": "200",
- "status": "Success"
}Creates a new account. No authentication required. Returns account credentials. A verification email is sent to the provided address.
Body for account signup.
| name required | string |
| email required | string |
| promo | string Optional promotional code. |
{- "name": "John Doe",
- "email": "john@example.com",
- "promo": "PROMO2024"
}{- "account": {
- "name": "John Doe",
- "masterAccount": 4592086960,
- "username": 4592086960,
- "password": "abc1234567",
- "email": "john@example.com"
}, - "statusCode": "200",
- "status": "Success",
- "message": "Account Information"
}