Home ›Features ›API Hub ›Number API Calls

API Directory — Full Call Reference

Reference for the PBXMe API calls documented in the supplied Postman collection, plus separately identified operational endpoints. The documented platform calls use HTTP POST unless noted. Authenticate first with Login, then use the returned account values and generated session authentication as required by each call.

Base URL: https://newsip.pbxme.com

Get Free API Key Back to API Hub

Authentication

Login

Endpoint: https://newsip.pbxme.com/api/login/

Before using the API, whitelist the source IP address of the server making requests in the user’s account portal. Each account has its own username and password. For the initial Login request, use those credentials together with the fixed x-auth-token published in the API documentation. A successful Login returns the account id, account_token, and a generated session x-auth-token. Use the generated session x-auth-token in the request header for subsequent calls in the same API session, and send the returned id and account_token in request bodies as the documented id and token values.

Variable	Description
username	Your PBXMe account number
password	Your PBXMe account password

Example Request:

POST https://newsip.pbxme.com/api/login/
x-auth-token: YOUR_INITIAL_X_AUTH_TOKEN
Content-Type: application/json

{
  "username": "YOUR_ACCOUNT_NUMBER",
  "password": "YOUR_PASSWORD"
}

⚠️ Save the returned id, account_token, and generated session x-auth-token. Use the session x-auth-token in the header of subsequent API calls, and use the returned id and account_token in request bodies as id and token.

Account

Charges History

Endpoint: {{URL}}/api/charges_history/get_charges_history_list/

Returns the charge history for the authenticated account.

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: https://newsip.pbxme.com/api/cdrs_export

Generates a Call Detail Records (CDR) report for the requested date range. Following the API request, the report is sent to the email address registered on the account. The email includes a ZIP file attachment containing the CDR report in Excel format.

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 Disabled in Current Reference

The current API reference marks this call as disabled and provides the complete country list in its example. Use the numeric country_id from that reference when calling DID Available List.

DID Available List

Endpoint: {{URL}}/customer/did_crud/

Returns available numbers for a selected country.

Variable	Description
action	`available_list`
parent_id	Static value “0”
country_id	Optional numeric country ID from the Country List reference
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
reseller_id	Static value “0”
id	Your account ID
token	account_token

DID Purchased List

Endpoint: {{URL}}/customer/did_crud/

Returns the DIDs currently assigned to your account.

Variable	Description
action	`purchase_list`
id	Account ID returned by Login
token	`account_token` returned by Login

DID Release

Endpoint: {{URL}}/customer/did_management/

Releases a DID from your account.

Variable	Description
action	`release`
did_id	DID ID to release
accountid	Account ID returned by Login
id	Account ID returned by Login
token	`account_token` returned by Login

DID Forward Setting

Endpoint: {{URL}}/customer/did_management/

Updates the call-routing/forwarding settings for a DID. The supplied API example demonstrates call_type=2 with a trunk IP in call_type_value. This call is a telephony forwarding configuration API and should not be treated as a generic HTTP event-webhook API.

Variable	Description
id	Account ID returned by Login
token	`account_token` returned by Login
action	`forward`
did_id	DID ID from the Purchased List
call_type	Documented example uses static value `2`
call_type_value	Documented example uses your trunk IP
always	Documented example uses static value `5`
user_busy	Documented example uses static value `5`
user_not_registered	Documented example uses static value `5`
no_answer	Documented example uses static value `5`
extensions	Mandatory field; documented example uses an empty value
call_type_vm_flag	Mandatory field; documented example uses an empty value
always_destination	Mandatory field; documented example uses an empty value
always_vm_flag	Mandatory field; documented example uses an empty value
user_busy_destination	Mandatory field; documented example uses an empty value
user_busy_vm_flag	Mandatory field; documented example uses an empty value
user_not_registered_destination	Mandatory field; documented example uses an empty value
user_not_registered_vm_flag	Mandatory field; documented example uses an empty value
no_answer_destination	Mandatory field; documented example uses an empty value
no_answer_vm_flag	Mandatory field; documented example uses an empty value

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. Forwarding can be configured to another SMS number, email address, or webhook URL. For webhook-only forwarding, dest_sms and dest_email may be omitted.

Variable	Description
action	`add`
id	Account ID returned by Login
token	`account_token` returned by Login
did	SMS-enabled number
dest_sms	Optional SMS forwarding destination
dest_email	Optional email forwarding destination
webhook_url	Optional HTTP webhook destination

SMS Config Update

Updates an existing SMS forwarding configuration. SMS forwarding settings can be managed either through the API or from the account HTTP portal.

Variable	Description
action	`update`
id	Account ID returned by Login
token	`account_token` returned by Login
did	SMS-enabled DID
dest_sms	Optional SMS forwarding destination
dest_email	Optional email forwarding destination
webhook_url	Optional HTTP webhook destination

SMS Config Delete

Variable	Description
action	`delete`
id	Account ID returned by Login
token	`account_token` returned by Login
did	DID whose SMS forwarding configuration should be deleted

Get SMS Config

Variable	Description
action	`get`
id	Account ID returned by Login
token	`account_token` returned by Login
did	DID whose SMS forwarding configuration should be returned

SMS Config List

Variable	Description
action	`list`
id	Account ID returned by Login
token	`account_token` returned by Login

Outbound SMS — Separate Operational Endpoint

This endpoint is operational but is not part of the supplied Postman collection.

Send Outbound SMS Separate API

Endpoint: https://api.pbxme.com/astppsend-sms

Sends an outbound SMS through the PBXMe network. This call uses HTTP GET rather than the POST pattern used by the documented Newsip API calls.

Variable	Description
username	Your PBXMe account username / account number
password	Your account password
destination	Destination phone number
callerid	Sender / caller ID value permitted for your account
message	SMS message text
sms	SMS mode parameter required by the endpoint
whatsapp	WhatsApp mode parameter supported by the endpoint

Your source IP must be configured under My Account → IP Settings. Because this endpoint is outside the supplied Postman collection, treat its parameter requirements as a separate operational API contract.

Example Request URL:

https://api.pbxme.com/astppsend-sms
  ?username=YOUR_ACCOUNT
  &password=YOUR_PASSWORD
  &destination=DESTINATION_NUMBER
  &callerid=YOUR_CALLER_ID
  &message=Hello
  &sms=1
  &whatsapp=0

Inbound SMS → Webhook Available Now

Incoming SMS can be forwarded to your own HTTP endpoint and the destination can be configured programmatically through POST /api/sms using webhook_url. The same SMS forwarding settings can also be configured from the account HTTP portal under Forward Type → API.

URL template: https://example.com/api?from={CallerID}&text={SMS_TEXT}&to={SMS_DST_ADDR}

Placeholder	Live value
{CallerID}	Sender phone number
{SMS_TEXT}	Inbound SMS message text
{SMS_DST_ADDR}	The SMS-enabled PBXMe destination number

API configuration example:

POST https://newsip.pbxme.com/api/sms
x-auth-token: YOUR_SESSION_X_AUTH_TOKEN
Content-Type: application/json

{
  "action": "add",
  "id": "YOUR_ACCOUNT_ID",
  "token": "YOUR_ACCOUNT_TOKEN",
  "did": "YOUR_SMS_ENABLED_DID",
  "webhook_url": "https://example.com/api?from={CallerID}&text={SMS_TEXT}&to={SMS_DST_ADDR}"
}

SMS-to-webhook configuration is available both through the API and through the account HTTP portal. For webhook-only forwarding, dest_sms and dest_email may be omitted.

Quick Reference — All API Calls

Call	Endpoint	Purpose
Login	/api/login/	Authenticate and get account token
Charges History	/api/charges_history/get_charges_history_list/	Retrieve transaction history
CDRs Export	/api/cdrs_export	Generate a CDR report for a selected date range. The report is delivered to the account registered email address as an Excel file inside a ZIP attachment.
Get Country List	Disabled in current reference	Use numeric country IDs provided in the current API reference example
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, email, or webhook forwarding configuration
SMS Config Update	/api/sms	Update SMS, email, or webhook forwarding configuration
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
Outbound SMS Send	https://api.pbxme.com/astppsend-sms	Send outbound SMS via separate HTTP GET API
Inbound SMS → Webhook	/api/sms or account HTTP portal	Configure inbound SMS forwarding to an HTTP endpoint using `webhook_url`

More API Guides

AI Agent Integration

Give your AI agent a real local number. Learn more →

DID Number Provisioning

Search, order, and release numbers via API. Learn more →

SMS

SMS via API

Configure SMS/email forwarding, send outbound SMS, and route inbound SMS to a webhook. Learn more →

Webhooks & Events

Inbound SMS-to-webhook routing and verified integration guidance. Learn more →

Ready to Call the API?

Create an account and build against the documented API calls and separately identified operational endpoints above.

Get Free API Key Back to API Hub