API Directory — Full Call Reference
Every available API call, its endpoint, required variables, and usage. All calls use POST unless noted. Obtain your account token via the Login call before using any other endpoint.
Base URL: https://newsip.pbxme.com
Authentication
Login
Endpoint: {{URL}}/api/login/
Authenticates your account and returns the token required for all subsequent API calls.
| Variable | Description |
|---|---|
| username | Your PBXme account number |
| password | Your PBXme account password |
Example Request:
{
"username": "{{account_number}}",
"password": "{{password}}"
}⚠️ Save the returned id and account_token values — these are required by all other API calls.
Account
Get Balance
Returns the current balance on your account.
Charges History
Endpoint: {{URL}}/api/charges_history/get_charges_history_list/
Returns account charge and refill history, including DID purchases, renewals, refills, and postcharges.
| Variable | Description |
|---|---|
| id | Account ID returned by Login |
| token | account_token returned by Login |
| number | Your account number |
Example Request:
{
"id": "{{id}}",
"token": "{{token}}",
"number": "{{account_number}}"
}CDRs Export
Endpoint: {{URL}}/api/cdrs_export
Exports Call Detail Records (CDRs) for a selected date range.
| Variable | Description |
|---|---|
| id | Account ID |
| token | account_token |
| from_date | Start date and time |
| to_date | End date and time |
DID (Number) Management
Get Country List
Returns all available countries and their country IDs. Use the country ID when searching for available DIDs.
DID Available List
Endpoint: {{URL}}/customer/did_crud/
Returns available numbers for a selected country.
| Variable | Description |
|---|---|
| action | list |
| country_id | Country ID from Get Country List |
| id | Account ID |
| token | account_token |
DID Assign
Endpoint: {{URL}}/customer/did_management/
Purchases and assigns a DID to your account.
| Variable | Description |
|---|---|
| action | assign |
| did_id | DID ID from Available List |
| accountid | Your account ID |
| id | Your account ID |
| token | account_token |
DID Purchased List
Endpoint: {{URL}}/customer/did_crud/
Returns all DIDs currently assigned to your account with full details per number.
| Variable | Description |
|---|---|
| action | purchase_list |
DID Release
Endpoint: {{URL}}/customer/did_management/
Releases a DID from your account.
| Variable | Description |
|---|---|
| action | release |
| did_id | DID ID to release |
DID Forward Setting
Endpoint: {{URL}}/customer/did_management/
Updates the routing/forwarding destination for a DID. Use this call to configure where incoming calls are forwarded.
| Variable | Description |
|---|---|
| call_type | Forwarding type |
| call_type_value | Destination value for the forwarding type |
| always | Always forward destination |
| user_busy | Forward when line is busy |
| user_not_registered | Forward when not registered |
| no_answer | Forward on no answer |
SMS Configuration
All SMS config calls use the endpoint: https://newsip.pbxme.com/api/sms
SMS Config Add
Creates an SMS forwarding configuration for an SMS-enabled number.
| Variable | Description |
|---|---|
| action | add |
| did | SMS-enabled number |
| dest_sms | SMS destination number |
| dest_email | Email destination for SMS forwarding |
SMS Config Update / Delete / Get / List
Updates, deletes, retrieves, or lists existing SMS forwarding configurations for a DID.
| Action | Description |
|---|---|
| update | Updates an existing SMS forwarding configuration |
| delete | Deletes an existing SMS forwarding configuration for a DID |
| get | Returns the SMS forwarding settings for a specific DID |
| list | Returns all SMS forwarding configurations on the account |
Quick Reference — All API Calls
| Call | Endpoint | Purpose |
|---|---|---|
| Login | /api/login/ | Authenticate and get account token |
| Get Balance | — | Return current account balance |
| Charges History | /api/charges_history/get_charges_history_list/ | Retrieve transaction history |
| CDRs Export | /api/cdrs_export | Export call records by date range |
| Get Country List | Country List API | List all available countries and IDs |
| DID Available List | /customer/did_crud/ | Browse available numbers by country |
| DID Assign | /customer/did_management/ | Purchase and assign a number |
| DID Purchased List | /customer/did_crud/ | List all numbers on your account |
| DID Release | /customer/did_management/ | Release a number from your account |
| DID Forward Setting | /customer/did_management/ | Configure call forwarding for a number |
| SMS Config Add | /api/sms | Create SMS forwarding config |
| SMS Config Update | /api/sms | Update SMS forwarding config |
| SMS Config Delete | /api/sms | Delete SMS forwarding config |
| Get SMS Config | /api/sms | Get SMS config for a specific DID |
| SMS Config List | /api/sms | List all SMS configs on account |
More API Guides
|
| ||||
|
|
Ready to Call the API?
Get your free API key and start building against the full call reference above.