Integration with the Service (HTTP/HTTPS API)

  • Register on the website or log into your account if you have already registered;
  • Go to the API settings and enable API;
  • Familiarize yourself with the API methods below;
  • Copy the API key and use it for authentication (Bearer token in Authorization header);
  • For the "Connect Number" and "Send Message" methods, top up your balance;

API Method Descriptions

API

Authentication

All API requests (except /api/login, /api/register, and /api/public/*) require authentication via Bearer token:

Authorization: Bearer <api_token>

Base URL: https://sms-numbers.co/api


API for Working with Numbers

GET List of Numbers

Returns a list of numbers associated with your account.

GET https://sms-numbers.co/api/numbers

Headers: Authorization: Bearer <api_token>

Query parameters:

ParameterDescription
filter (string)Optional Filter by status (e.g. active)

GET Number Details

Returns information about a specific number.

GET https://sms-numbers.co/api/number/{id}

Headers: Authorization: Bearer <api_token>

Path parameters: id (integer) — number ID from the list.


GET Search Available Numbers

Returns available numbers for connection by country (ISO 3166-1 alpha-2 code).

GET https://sms-numbers.co/api/numbers/search/{iso}

Headers: Authorization: Bearer <api_token>

Path parameters: iso (string) — two-letter country code (e.g. us, gb).

For pricing details use GET https://sms-numbers.co/api/public/countries and GET https://sms-numbers.co/api/public/prices/{country_id}.


POST Connect a Number

Allows you to connect a selected number. Purchase is processed via the web interface.

POST https://sms-numbers.co/api/number/buy

Headers: Authorization: Bearer <api_token>, Content-Type: application/json

Body: id (integer) — ID of the number to connect (from search results).


POST Disconnect a Number

Disconnects a selected number.

POST https://sms-numbers.co/api/number/cancel

Headers: Authorization: Bearer <api_token>, Content-Type: application/json

Body: id (integer) — ID of the number to disconnect (from the list of numbers).


POST Modify Number Settings

Updates message forwarding settings for the selected number.

POST https://sms-numbers.co/api/number/update

Headers: Authorization: Bearer <api_token>, Content-Type: application/json

Body parameters:

ParameterDescription
id (integer)Required Number ID
email (string)Optional Email for forwarding incoming SMS
number (string)Optional Phone for forwarding incoming SMS
user_tag (string)Optional User-defined tag

API for Messages

GET List Messages

Returns all messages for your account.

GET https://sms-numbers.co/api/messages

GET Conversations (Grouped)

Returns grouped message conversations.

GET https://sms-numbers.co/api/app/messages

GET Messages by Number

Returns messages for a specific phone number.

GET https://sms-numbers.co/api/app/messages/{number}

POST Send Message

Sends an SMS message.

POST https://sms-numbers.co/api/message/send

Body parameters:

ParameterDescription
from (string)Optional Your virtual number (or default sender)
to (string)Required Recipient phone number
body (string)Required Message text

Account & Payments

GET https://sms-numbers.co/api/account/profile — User profile

GET https://sms-numbers.co/api/account/balance — Account balance

GET https://sms-numbers.co/api/payments — Payment history

POST https://sms-numbers.co/api/payment/create — Create payment


Public Endpoints (No Auth)

GET https://sms-numbers.co/api/public/countries — List of countries

GET https://sms-numbers.co/api/public/countries/numbers — Countries with available numbers

GET https://sms-numbers.co/api/public/services — List of services

POST https://sms-numbers.co/api/login — Login (email, password)

POST https://sms-numbers.co/api/register — Registration


Server Responses

200 - OKSuccessful
400 - Bad RequestIncorrect query parameters
401 - UnauthorizedNot authorized (invalid or missing token)
402 - Request FailedValid parameters, but request was unsuccessful
403 - ForbiddenForbidden
404 - Not FoundResource not found
429 - Too Many RequestsRequest limit exceeded
500, 502, 503, 504Server error

Success responses: {"success": true, "data": {...}, "message": "..."}

Error responses: {"success": false, "message": "...", "data": {...}}

Sign up icon

Sign Up

Register now, verify your email, and get test funds to try out phone numbers