English
Русский
Integration with the Service (HTTP/HTTPS API)
API Description for SMS Campaigns and Number Integration
- Register on the website or log into your account if you have already registered;
- Go to the API page and click the "Activate API" button;
- Familiarize yourself with the API methods below;
- Copy the API key and use it for authentication in your application;
- For the "Connect Number" and "Send Message" methods, top up your balance;
API for Working with Numbers
GET List of Numbers
This method returns a list of numbers associated with your account.
GET https://sms-numbers.co/api/numbers
Parameters sent to the server:
| Parameter Name | Description |
|---|---|
| api_token (string) | Required API key obtained in the Personal Account or via the Login method. |
GET Search for Available Numbers for Connection
This method returns a list of available numbers for connection.
GET https://sms-numbers.co/api/numbers/search
Parameters sent to the server:
| Parameter Name | Description |
|---|---|
| api_token (string) | Required API key obtained in the Personal Account or via the Login method. |
| country (string) | Required Two-letter country code for filtering (ISO 3166-1 alpha-2 format). |
POST Connect a Number
This method allows you to connect a selected number.
POST https://sms-numbers.co/api/number/buy
Parameters sent to the server:
| Parameter Name | Description |
|---|---|
| api_token (string) | Required API key obtained in the Personal Account or via the Login method. |
| id (integer) | Required The ID of the number to connect, returned by the Search for Available Numbers for Connection method. |
POST Disconnect a Number
This method allows you to disconnect a selected number.
POST https://sms-numbers.co/api/number/cancel
Parameters sent to the server:
| Parameter Name | Description |
|---|---|
| api_token (string) | Required API key obtained in the Personal Account or via the Login method. |
| id (integer) | Required The ID of the number to disconnect, returned by the List of Numbers method. |
| email (string) | Required 0 - disconnect at the end of the payment period, 1 - disconnect immediately. |
POST Modify Number Settings
This method allows you to set up message forwarding for the selected number.
POST https://sms-numbers.co/api/number/update
Parameters sent to the server:
| Parameter Name | Description |
|---|---|
| api_token (string) | Required API key obtained in the Personal Account or via the Login method. |
| id (integer) | Required The ID of the number to modify, returned by the List of Numbers method. |
| email (string) | Optional Email for forwarding incoming SMS for the number with id. |
| phone (string) | Optional Phone number for forwarding incoming SMS for the number with id. |
| url (string) | Optional URL for forwarding incoming SMS for the number with id. |
| telegram_enable (integer) | Optional 0 - disable SMS forwarding to Telegram, 1 - enable SMS forwarding to Telegram. |
Server Responses:
| 200 - OK | Successful. |
|---|---|
| 400 - Bad Request | Incorrect query parameters. |
| 401 - Unauthorized | Not authorized. |
| 402 - Request Failed | Valid parameters, but request was unsuccessful. |
| 403 - Forbidden | Forbidden. |
| 404 - Not Found | Resource not found. |
| 429 - Too Many Requests | Request limit exceeded. |
| 500, 502, 503, 504 - Server Errors | Server error. |
Sign Up
Register now, confirm your email, and receive money in your account to test numbers
