REST API documentation
Phone-number REST APIs
Discover available countries and numbers, inspect the complete offer, and manage the numbers you own.
Choose the API and credential together
Approved Developer & Automation, Business and Communications Provider accounts can integrate enabled services. An individual developer does not need to pretend to be a company. Application SMS/MMS requires the applicable sending approval and registration. Personal & Family service has no customer-accessible messaging-origination API.
| API family | Base URL | Authentication and result |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Approved Basic credentials; eligible provisioned tokens only for operations that support them. JSON status and response. |
| Emergency registration | https://api.multi.tel/emergency | Approved Basic credentials or specifically provisioned bearer access. JSON code, message and data. |
| Portal REST integrations | Host and operation shown in your account’s developer reference | Use that operation’s documented credential, scopes and schema. Browser session requests are a separate surface. |
Set MULTITEL_API_USERNAME and MULTITEL_API_PASSWORD through your server’s secret configuration before using the examples. Never embed them in public browser JavaScript, URLs or source control. Dedicated credentials are managed in API Integration settings.
Read the available country catalogue
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"The v3 response contains status and a response array. Country entries include isocode, name, countrycode, capability information and next_function. Availability is account- and inventory-dependent; a country is not a promise that every prefix or number type is in stock.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}From discovery to activation
- Choose the country, subdivision where required, area and number type using the matching geography operations.
- Read the selected number’s setup, monthly and usage prices, channels, allowance and registration requirements.
- Submit the required end-user documents and review their status. A number may remain pending until approval.
- Order once with the exact inventory/price selection. If the response is uncertain, inspect your inventory before submitting another order.
- Configure voice routing and messaging delivery independently, then test the complete intended route.
Handle errors and retries
- Authentication or permission failure
- Check the API credential’s enabled state, permitted service and source-IP restriction. A portal session cookie is not an integration credential.
- Insufficient credit or unmet approval
- Resolve the account balance, sending approval or document requirement before repeating the operation.
- No result
- Handle empty inventory or a missing caller name as an ordinary outcome. Do not assume a syntactically valid number has every service.
- Network timeout or service failure
- Use bounded retries with backoff for reads. For a purchase, send or registration, inspect the operation state first; retrying an accepted request can duplicate a billable action.
Idempotency support belongs to each API family. The Emergency API supports retry keys; that does not make arbitrary v3 requests idempotent. Keep timestamps, returned IDs and redacted responses for support.
Continue with your account’s reference
The signed-in reference filters operations by your permissions and enabled services. Use its exact host, credential type, request fields and response schema. The consoles can execute live operations, including purchases and messages.