Israel Number API Calls
This API reference describes each available API call, its endpoint, required variables, and usage. All calls use POST method unless noted. Obtain your account token via the Login call before using any other endpoint.
Four API Call Groups
Jump straight to the group of calls you need.
Authentication
The Login call to get your account token, required before any other API call.
Account
Balance, charges history, and Call Detail Record (CDR) export.
DID (Number) Management
Search, purchase, release, and set forwarding for virtual numbers.
SMS Configuration
Create, update, and delete SMS forwarding configurations.
🔑 Authentication
The required first call before using any other API endpoint.
Authenticates your account and returns the token required for all subsequent API calls.
| Variable | Description |
|---|---|
username | Your IsraelNumber account number |
password | Your IsraelNumber account password |
{
"username": "{{account_number}}",
"password": "{{password}}"
}id and account_token values — these are required by all other API calls.💳 Account
Balance, charges history, and data export.
Returns the current balance on your account.
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 |
{
"id": "{{id}}",
"token": "{{token}}",
"number": "{{account_number}}"
}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
Search, purchase, release, and configure forwarding for virtual numbers across 145 countries.
Returns all available countries and their country IDs. Use the country ID when searching for available DIDs.
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 |
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 |
Returns all DIDs currently assigned to your account with full details per number.
| Variable | Description |
|---|---|
action | purchase_list |
Releases a DID from your account.
| Variable | Description |
|---|---|
action | release |
did_id | DID ID to release |
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.israelnumber.com/api/sms
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 |
Updates an existing SMS forwarding configuration.
| Variable | Description |
|---|---|
action | update |
Deletes an existing SMS forwarding configuration for a DID.
| Variable | Description |
|---|---|
action | delete |
Returns the SMS forwarding settings for a specific DID.
| Variable | Description |
|---|---|
action | get |
Returns all SMS forwarding configurations on the account.
| Variable | Description |
|---|---|
action | list |
Quick Reference — All API Calls
Fast lookup table for every available call.
| 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 |
Ready to Start Building?
Create a free account and get your API token in under 2 minutes.