User

Balance


curl "https://5sim.net/v1/user/profile" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/profile', headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/profile');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id":1,
  "email":"mail@gmail.com",
  "vendor":"demo",
  "default_forwarding_number":"447350690992",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"england","iso":"gb","prefix":"+44"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://5sim.net/v1/user/profile

Provides profile data: email, balance and rating.

Headers

Authorization: Bearer $token
Accept: application/json

Response

Status code: 200 OK

Name	Type	Description
id	number	User ID
email	string	User email
balance	number	Balance
rating	number	Rating
default_country	array	Default country
default_country.name	string	Country name
default_country.iso	string	ISO country code
default_country.prefix	string	Mobile prefix
default_operator	array	Default operator
default_operator.name	string	Operator name
frozen_balance	number	Frozen balance
default_forwarding_number	string	Default forwarding number
vendor	string	Vendor name

Status code : 401 Unauthorized

Order history


curl "https://5sim.net/v1/user/orders?category=hosting&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
category = 'hosting'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/user/orders', headers=headers, params=params)


<?php

$token = 'Your token';
$ch = curl_init();
$category = 'hosting';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Data": [
    {
      "id":53533933,
      "phone":"+447350690992",
      "operator":"vodafone",
      "product":"facebook",
      "price":2,
      "status":"BANNED",
      "expires":"2020-06-28T16:32:43.307041Z",
      "sms":[],
      "created_at":"2020-06-28T16:17:43.307041Z",
      "country":"england"
    }
  ],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://5sim.net/v1/user/orders?category=$category

Provides orders history by choosen category.

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
category	query string	Yes	Category can be 'hosting' or 'activation'
limit	query string	No	Pagination limit
offset	query string	No	Pagination offset
order	query string	No	Pagination order, should be field name
reverse	query string	No	Is reversed history, true / false

Response

Status code : 200 OK

Name	Type	Description
Data	array	Orders list
ProductNames	array	Products list
Statuses	array	Statuses list
Total	number	Orders count

Payments history


curl "https://5sim.net/v1/user/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/user/payments', headers=headers, params=params)


<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/payments?limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Data": [
    {
      "ID":30011934,
      "TypeName":"charge",
      "ProviderName":"admin",
      "Amount":100,
      "Balance":100,
      "CreatedAt":"2020-06-24T15:37:08.149895Z"
    }
  ],
  "PaymentTypes": [{"Name":"charge"}],
  "PaymentProviders":[{"Name":"admin"}],
  "Total":1
}

GET - https://5sim.net/v1/user/payments

Provides payments history.

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
limit	query string	No	Pagination limit
offset	query string	No	Pagination offset
order	query string	No	Pagination order, should be field name
reverse	query string	No	Is reversed history, true / false

Response

Status code : 200 OK

Name	Type	Description
Data	array	Payments list
PaymentProviders	array	Names of payments systems
PaymentTypes	array	Payments types
Total	number	Payments count

Prices limit

Get a list


curl "https://5sim.net/v1/user/max-prices" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/max-prices', headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/max-prices');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


[
    {
      "id": 14,
      "product": "facebook",
      "price": 11,
      "CreatedAt": "2020-06-24T15:37:08.149895Z"
    }
]

GET - https://5sim.net/v1/user/max-prices

Get a list of established price limits.

Headers

Authorization: Bearer $token
Accept: application/json

Response

Name	Type	Description
id	number	ID
product	string	Product name
price	number	Price
created_at	date string	The date and time when the object was created

Status code : 200 OK

Status code : 401 Unauthorized

Create or update the price limit per product


curl -X POST "https://5sim.net/v1/user/max-prices" \
  -d '{"product_name": "facebook", "price": 30}'\
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

data = '{"product_name": "facebook", "price": 30}'

response = requests.post('https://5sim.net/v1/user/max-prices', headers=headers, data=data)


<?php

$token = 'Your token';

$product_name = 'facebook';
$price = 30;

$data = array(
    'product_name' => $product_name,
    'price' => $price,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/user/max-prices',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://5sim.net/v1/user/max-prices

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
product_name	query string	Yes	Product name
price	query number	Yes	Price

Status code : 200 - success

Status code : 400 - record not found

Status code : 400 - any error

Status code : 400 - product_name is empty

Delete the price limit per product


curl -X DELETE "https://5sim.net/v1/user/max-prices" \
  -d '{"product_name": "facebook"}'\
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

data = '{"product_name": "facebook"}'

response = requests.delete('https://5sim.net/v1/user/max-prices', headers=headers, data=data)


<?php

$token = 'Your token';

$product_name = 'facebook';

$data = array(
    'product_name' => $product_name,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/user/max-prices',
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

DELETE - https://5sim.net/v1/user/max-prices

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
product_name	query string	Yes	Product name

Status code : 200 - success

Status code : 400 - record not found

Status code : 400 - any error

Status code : 400 - product_name is empty

Products and prices

Products request


curl "https://5sim.net/v1/guest/products/$country/$operator" \
  -H "Accept: application/json"


import requests

country = 'england'
operator = 'any'

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/products/' + country + '/' + operator, headers=headers)


<?php

$ch = curl_init();
$country = 'england';
$operator= 'any';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/products/' . $country . '/' . $operator);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "1day":{"Category":"hosting","Qty":14,"Price":80},
  "facebook":{"Category":"activation","Qty":133,"Price":21}
}

GET - https://5sim.net/v1/guest/products/$country/$operator

To receive the name, the price, quantity of all products, available to buy.

Headers

Accept: application/json

Request parameters

Name	Type	Required	Description
country	query string	Yes	The country, "any" - any country
operator	query string	Yes	The operator, "any" - any operator

Response

Status code : 200 OK

Name	Type	Description
Category	string	activation/hosting
Qty	number	Available quantity
Price	number	Price

Prices request


curl "https://5sim.net/v1/guest/prices" \
  -H "Accept: application/json"


import requests

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers)


<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "england":{
    "facebook":{
      "vodafone":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "virtual60":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "virtual52":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices

Returns product prices

Headers

Accept: application/json

Response

Status code : 200 OK

Name	Type	Description
cost	float	Virtual number price, two decimal places
count	number	Available quantity
rate	float	Delivery percentage, two decimal places, omitted less than 20% or too few orders

Prices by country


curl "https://5sim.net/v1/guest/prices?country=$country" \
  -H "Accept: application/json"


import requests

country = 'england'

headers = {
    'Accept': 'application/json',
}

params = (
    ('country', country),
)

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers, params=params)


<?php

$ch = curl_init();
$country = 'england';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices?country=' . $country);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "england":{
    "facebook":{
      "vodafone":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "virtual60":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "virtual52":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?country=$country

Returns product prices by country

Headers

Accept: application/json

Request parameters

Name	Type	Required	Description
country	query string	Yes	Country name

Response

Status code : 200 OK

Status code : 400 country is incorrect

Name	Type	Description
cost	float	Virtual number price, two decimal places
count	number	Available quantity
rate	float	Delivery percentage, two decimal places, omitted less than 20% or too few orders

Prices by product


curl "https://5sim.net/v1/guest/prices?product=$product" \
  -H "Accept: application/json"


import requests

product = 'facebook'

headers = {
    'Accept': 'application/json',
}

params = (
    ('product', product),
)

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers, params=params)


<?php

$ch = curl_init();
$product = 'facebook';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices?product=' . $product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "facebook":{
    "afghanistan":{
      "virtual18":{
        "cost":4,
        "count":1260,
        "rate": 99.99
      },
      "virtual23":{
        "cost":4,
        "count":935,
        "rate": 99.99
      },
      "virtual4":{
        "cost":4,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?product=$product

Returns product prices for a specific product

Headers

Accept: application/json

Request parameters

Name	Type	Required	Description
product	query string	Yes	Product name

Response

Status code : 200 OK

Status code : 400 product is incorrect

Name	Type	Description
cost	float	Virtual number price, two decimal places
count	number	Available quantity
rate	float	Delivery percentage, two decimal places, omitted less than 20% or too few orders

Prices by country and product


curl "https://5sim.net/v1/guest/prices?country=$country&product=$product" \
  -H "Accept: application/json"


import requests

country = 'england'
product = 'facebook'

headers = {
    'Accept': 'application/json',
}

params = (
    ('country', country),
    ('product', product),
)

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers, params=params)


<?php

$ch = curl_init();
$country = 'england';
$product = 'facebook';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices?country=' . $country . '&product=' . $product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "england":{
    "facebook":{
      "vodafone":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "matrix":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "virtual60":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "virtual52":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "ee":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "virtual59":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "virtual15":{
        "cost":8,
        "count":0,
        "rate": 99.99
      },
      "vodafone":{
        "cost":8,
        "count":0,
        "rate": 99.99
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?country=$country&product=$product

Returns product prices by country and specific product

Headers

Accept: application/json

Request parameters

Name	Type	Required	Description
country	query string	Yes	Country name
product	query string	Yes	Product name

Response

Status code : 200 OK

Status code : 400 country is incorrect

Status code : 400 product is incorrect

Name	Type	Description
cost	float	Virtual number price, two decimal places
count	number	Available quantity
rate	float	Delivery percentage, two decimal places, omitted less than 20% or too few orders

Purchase

Buy activation number


curl "https://5sim.net/v1/user/buy/activation/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
country = 'england'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/buy/activation/' + country + '/' + operator + '/' + product, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$country = 'england';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/buy/activation/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id":11631253,
  "phone":"+447350690992",
  "operator":"vodafone",
  "product":"facebook",
  "price":21,
  "status":"PENDING",
  "expires":"2018-10-13T08:28:38.809469028Z",
  "sms":null,
  "created_at":"2018-10-13T08:13:38.809469028Z",
  "forwarding":false,
  "forwarding_number":"",
  "country":"england"
}

GET - https://5sim.net/v1/user/buy/activation/$country/$operator/$product

GET - https://5sim.net/v1/user/buy/activation/$country/$operator/$product?forwarding=$forwarding&number=$number&reuse=$reuse&voice=$voice&ref=$ref

Headers

Authorization: Bearer $token
Accept: application/json

URL parameters

Name	Type	Required	Description
country	query string	Yes	The country, "any" - any country
operator	query string	Yes	The operator, "any" - any operator
product	query string	Yes	Product name

Query parameters

Name	Type	Required	Description
forwarding	query string	No	Whether or not to enable forwarding
number	query string	No	Number for which the call will be forwarded, 11 digits, without the + sign
reuse	query string	No	If equal to "1" buy with the ability to reuse the number, if available
voice	query string	No	If equal to "1" buy with the ability to receive a call from the robot, if available
ref	query string	No	Your referral key if you have it, if you are developer of the software, you can read terms here
maxPrice	query string	No	Max price specified in the Purchase method parameters shall have priority over the settings adjusted in the Max purchase price section and shall work only if the operator value is set as "any"

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
phone	string	Phone number
operator	string	Operator
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
created_at	date string	When the order was created
forwarding	boolean	Whether or not to enable forwarding
forwarding_number	string	Call forwarding number
country	string	Name of country of number

Status code : 200 no free phones

Status code : 400

not enough user balance
not enough rating
select country
select operator
bad country
bad operator
no product
server offline

Status code : 500 internal error

Request limits

Maximum waiting time is 15 minutes. Timeout no sms 5 minute

Buy hosting number


curl "https://5sim.net/v1/user/buy/hosting/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
country = 'england'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/buy/hosting/' + country + '/' + operator + '/' + product, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$country = 'england';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/buy/hosting/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id": 1,
  "phone": "+447350690992",
  "product": "facebook",
  "price": 1,
  "status": "PENDING",
  "expires": "1970-12-01T03:00:00.000000Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"1970-12-01T17:23:25.106597Z",
        "date":"1970-12-01T17:23:15Z",
        "sender":"Facebook",
        "text":"Use 415127 as your login code",
        "code":"415127"
      }
    ],
  "created_at": "1970-12-01T00:00:00.000000Z"
}

GET - https://5sim.net/v1/user/buy/hosting/$country/$operator/$product

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
country	query string	Yes	The country, "any" - any country
operator	query string	Yes	The operator, "any" - any operator
product	query string	Yes	Product name, {3hours, facebook}

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
phone	string	Phone number
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
created_at	date string	When the order was created

Status code : 400

no free phones
not enough user balance
not enough rating
select country
select operator
bad country
bad operator
no product
server offline

Status code : 500 internal error

Re-buy number


curl "https://5sim.net/v1/user/reuse/$product/$number" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
product = 'amazon'
number = '79006665544'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/reuse/' + product + '/' + number, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$product = 'amazon';
$number = '79006665544';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/reuse/' . product . '/' . number);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

GET - https://5sim.net/v1/user/reuse/$product/$number

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
product	query string	Yes	Product name
number	query string	Yes	Phone number, 4-15 digits (without the + sign)

Response

Status code : 200 OK

Status code : 400

no free phones
select operator
not enough user balance
bad country
bad operator
server offline
not enough rating
no product
reuse not possible
reuse false
reuse expired

Status code : 500 internal error

Order management

Check order (Get SMS)


curl "https://5sim.net/v1/user/check/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/check/' + id, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/check/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+447350690992",
  "product": "facebook",
  "price": 21,
  "status": "RECEIVED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"Facebook",
        "text":"Facebook: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"england"
}

GET - https://5sim.net/v1/user/check/$id

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
id	query string	Yes	Order ID

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
created_at	date string	When the order was created
phone	string	Phone number
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
forwarding	boolean	Whether or not to enable forwarding
forwarding_number	string	Call forwarding number
country	string	Name of country of number

Status code : 404 order not found

Status code : 500 internal error

Finish order


curl "https://5sim.net/v1/user/finish/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/finish/' + id, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/finish/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+447350690992",
  "product": "facebook",
  "price": 21,
  "status": "FINISHED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"Facebook",
        "text":"Facebook: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"england"
}

GET - https://5sim.net/v1/user/finish/$id

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
id	query string	Yes	Order ID

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
created_at	date string	When the order was created
phone	string	Phone number
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
forwarding	boolean	Whether or not to enable forwarding
forwarding_number	string	Call forwarding number
country	string	Name of country of number

Cancel order


curl "https://5sim.net/v1/user/cancel/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/cancel/' + id, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/cancel/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+447350690992",
  "product": "facebook",
  "price": 21,
  "status": "CANCELED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"Facebook",
        "text":"Facebook: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"england"
}

GET - https://5sim.net/v1/user/cancel/$id

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
id	query string	Yes	Order ID

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
created_at	date string	When the order was created
phone	string	Phone number
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
forwarding	boolean	Whether or not to enable forwarding
forwarding_number	string	Call forwarding number
country	string	Name of country of number

Status code : 400 order not found

Status code : 400 order expired

Status code : 400 order has sms

Status code : 400 hosting order

Ban order


curl "https://5sim.net/v1/user/bn/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests
token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/ban/' + id, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/ban/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+447350690992",
  "product": "facebook",
  "price": 21,
  "status": "BANNED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"Facebook",
        "text":"Facebook: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"england"
}

GET - https://5sim.net/v1/user/ban/$id

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
id	query string	Yes	Order ID

Response

Status code : 200 OK

Name	Type	Description
id	number	Order ID
created_at	date string	When the order was created
phone	string	Phone number
product	string	Product
price	number	Price
status	string	Order's status
expires	date string	When the order expires
sms	sms array	SMS list
forwarding	boolean	Whether or not to enable forwarding
forwarding_number	string	Call forwarding number
country	string	Name of country of number

Status code : 400 order not found

Status code : 400 order expired

Status code : 400 order has sms

Status code : 400 hosting order

SMS inbox list


curl "https://5sim.net/v1/user/sms/inbox/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
_id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/sms/inbox/' + _id, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/sms/inbox/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Data": [
    {
      "ID":844928,
      "created_at":"2017-09-05T15:48:33.763297Z",
      "date":"2017-09-05T15:48:27Z",
      "sender":"+447350690992",
      "text":"12345",
      "code":"",
      "is_wave":false,
      "wave_uuid":""
    }
  ],
  "Total":1
}

GET - https://5sim.net/v1/user/sms/inbox/$id

Get SMS inbox list by order's id.

Important: This endpoint is available only for rented numbers. It does not work with one-time numbers used for service activations.

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
id	query string	Yes	Order ID

Response

Status code : 200 OK

Name	Type	Description
Data	array	SMS list
Total	number	SMS count

Status code : 400 order not found

Status code : 404 record not found

Status code : 500 internal error

Notifications

Get notifications


curl "https://5sim.net/v1/guest/flash/$lang" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
lang = 'en'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/flash/' + lang, headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();
$lang = 'en';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/flash/' . lang);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "text":"...notification text..."
}

GET - https://5sim.net/v1/guest/flash/$lang

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
lang	query string	Yes	Language of notification, en

Response

Status code : 200 OK

Name	Type	Description
text	string	Notification text

Vendor

Vendor statistic


curl "https://5sim.net/v1/user/vendor" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/vendor', headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/vendor');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "id":1,
  "email":"mail@gmail.com",
  "vendor":"demo",
  "default_forwarding_number":"447350690992",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"england","iso":"gb","prefix":"+44"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://5sim.net/v1/user/vendor

Headers

Authorization: Bearer $token
Accept: application/json

Response

Status code : 200 OK

Name	Type	Description
id	number	Vendor ID
email	string	Vendor email
balance	number	Balance
rating	number	Rating
default_country	array	Default country
default_country.name	string	Country name
default_country.iso	string	ISO country code
default_country.prefix	string	Mobile prefix
default_operator	array	Default operator
default_operator.name	string	Operator name
frozen_balance	number	Frozen balance
default_forwarding_number	string	Default forwarding number
vendor	string	Vendor name

Status code : 401 Unauthorized

Wallets reserve


curl "https://5sim.net/v1/vendor/wallets" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/vendor/wallets', headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/wallets');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "fkwallet":43339.55,
  "payeer":2117.32,
  "unitpay":97.6
}

GET - https://5sim.net/v1/vendor/wallets

Available reserves currency for partner.

Headers

Authorization: Bearer $token
Accept: application/json

Response

Status code : 200 OK

Name	Type	Description
fkwallet	number
payeer	number
unitpay	number

Status code : 401 Unauthorized

Vendor orders history


curl "https://5sim.net/v1/vendor/orders?category=activation&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
category = 'activation'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/vendor/orders', headers=headers, params=params)


<?php

$token = 'Your token';
$ch = curl_init();
$category = 'activation';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Data": [],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://5sim.net/v1/vendor/orders?category=$category

Provides vendor's orders history by chosen category.

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
category	query string	Yes	Category can be 'hosting' or 'activation'
limit	query string	No	Pagination limit
offset	query string	No	Pagination offset
order	query string	No	Pagination order, should be field name
reverse	query string	No	Is reversed history, true / false

Response

Status code : 200 OK

Name	Type	Description
Data	array	Orders list
ProductNames	array	Products list
Statuses	array	Statuses list
Total	number	Orders count

Vendor payments history


curl "https://5sim.net/v1/vendor/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/vendor/payments', headers=headers, params=params)


<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/payments?&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Data": [],
  "PaymentProviders":null,
  "PaymentStatuses":null,
  "PaymentTypes":null,
  "Total":3
}

GET - https://5sim.net/v1/vendor/payments

Provides vendor's payments history.

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
limit	query string	No	Pagination limit
offset	query string	No	Pagination offset
order	query string	No	Pagination order, should be field name
reverse	query string	No	Is reversed history, true / false

Response

Status code : 200 OK

Name	Type	Description
Data	array	Payments list
PaymentProviders	array	Names of payments systems
PaymentStatuses	array	Payments statuses
PaymentTypes	array	Payments types
Total	number	Payments count

Create payouts


curl -X POST "https://5sim.net/v1/vendor/withdraw" \
  -d '{"receiver":"1","method":"qiwi","amount":"1","fee":"unitpay"}' \
  -H "Authorization: Bearer $token" \
  -H "Content-Type: application/json"


import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Content-type': 'application/json',
}

data = '{"receiver":"123456","method":"qiwi","amount":"10","fee":"unitpay"}'

response = requests.post('https://5sim.net/v1/vendor/withdraw', headers=headers, data=data)


<?php

$token = 'Your token';

$receiver = '1';
$method = 'qiwi';
$amount = '1';
$fee = 'unitpay';

$data = array(
    'receiver' => $receiver,
    'method' => $method,
    'amount' => $amount,
    'fee' => $fee,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/vendor/withdraw',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://5sim.net/v1/vendor/withdraw

Create payouts for a partner.

Headers

Authorization: Bearer $token
Content-Type: application/json

Request parameters

Name	Type	Required	Description
receiver	string	Yes	Receiver
method	string	Yes	Output method visa
amount	string	Yes	Amount
fee	string	Yes	Payment system fkwallet / payeer / unitpay

Response

Status code : 200 OK

Vendor Prices

Get prices list


curl "https://5sim.net/v1/vendor/prices" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/vendor/prices', headers=headers)


<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/prices');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);


{
  "Prices": [
    {
      "Count":0,
      "CountryName":"england",
      "ID":333567,
      "OperatorName":"virtual16",
      "Price":22,
      "ProductName":"facebook"
    }
  ],
  "Products": ["facebook"],
  "Country": ["england"],
  "Operators": ["virtual16"],
  "Total":1
}

GET - https://5sim.net/v1/vendor/prices

GET - https://5sim.net/v1/vendor/prices?_filters={"ID":"$ID","ProductName":"$ProductName","CountryName":"$CountryName","OperatorName":"$OperatorName","Enabled":"$Enabled","Count":"$Count","AutoDisabled":"$AutoDisabled"}&_sortDir=$sortDir&_sortField=$sortField&_page=$page&_perPage=$perPage

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
_filter.ID	query string	No	Filter by record ID
_filter.CountryName	query string	No	Filter by country
_filter.ProductName	query string	No	Filter by product
_filter.OperatorName	query string	No	Filter by mobile operator
_filter.Count	query string	No	Filter by available numbers count
_filter.Rate	query string	No	Filter by rate value
_filter.Price	query string	No	Filter by current price
_filter.Hours	query string	No	Filter by time validity
_filter.DeletedAt	query string	No	Filter by deletion date
_filter.NewPrice	query string	No	Filter by new/updated price
_filter.NewPriceUpdatedAt	query string	No	Filter by last update date of new price
_sortDir	query string	No	Sorting direction, can be ASC or DESC
_sortField	query string	No	Field name to sort by (e.g., Price, Rate, Count)
_page	query string	No	Page number for pagination
_perPage	query string	No	Number of items per page

Response

Status code : 200 OK

Name	Type	Description
Prices	array	Prices list
Products	array	Products list
Countries	array	Countries list
Operators	array	Operators list
Total	number	Total prices count

Status code : 401 Unauthorized

Create price


curl -X PUT "https://5sim.net/v1/vendor/prices" \
  -d '{"Price": 30, "ProductName": "facebook", "CountryName": "england", "OperatorName": "virtual52"}'\
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

data = '{"Price": 30, "ProductName": "facebook",  "CountryName": "england",  "OperatorName": "virtual52"}'

response = requests.put('https://5sim.net/v1/vendor/prices', headers=headers, data=data)


<?php

$token = 'Your token';

$productName = 'facebook';
$countryName = 'england';
$operatorName = 'virtual52';
$price = 30;

$data = array(
    'ProductName' => $productName,
    'CountryName' => $countryName,
    'OperatorName' => $operatorName,
    'Price' => $price,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/vendor/prices',
    CURLOPT_PUT => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_PUTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

PUT - https://5sim.net/v1/vendor/prices

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required
Price	number	Yes
ProductName	string	Yes
CountryName	string	Yes
OperatorName	string	Yes

Status code : 200 - success

Status code : 400 - ProductName is empty

Change price


curl -X POST "https://5sim.net/v1/vendor/prices" \
  -d '{"Price": 30, "Product": "facebook", "Country": "england", "Operator": "virtual52"}'\
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

data = '{"Price": 30, "Product": "facebook",  "Country": "england", "Operator": "virtual52"}'

response = requests.post('https://5sim.net/v1/vendor/prices', headers=headers, data=data)


<?php

$token = 'Your token';

$product = 'facebook';
$country = 'england';
$operator = 'virtual52';
$price = 30;

$data = array(
    'Product' => $product,
    'Country' => $country,
    'Operator' => $operator,
    'Price' => $price,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/vendor/prices',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://5sim.net/v1/vendor/prices

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required
Price	number	Yes
Product	string	Yes
Country	string	Yes
Operator	string	Yes

Status code : 200 - success

Status code : 400 - Product is empty

Enable/Disable price


curl -X POST "https://5sim.net/v1/vendor/prices/disable" \
  -d '{"Disable": true, "List": [333567]}'\
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"


import requests

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

data = '{"Disable": true, "List": [333567]}'

response = requests.post('https://5sim.net/v1/vendor/prices/disable', headers=headers, data=data)


<?php

$token = 'Your token';

$disable = true;
$ids = [333567];

$data = array(
    'Disable' => $disable,
    'List' => $ids,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/vendor/prices/disable',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://5sim.net/v1/vendor/prices/disable

Headers

Authorization: Bearer $token
Accept: application/json

Request parameters

Name	Type	Required	Description
Disable	boolean	Yes	Disable numbers if value is true
List	array	No	An array of price ids. If not specified, it will apply to all prices

Status code : 200 - success

Status code : 400 - Product is empty

Countries list

Get countries list


{
  "afghanistan":{
    "iso":{
      "af":1
    },
    "prefix":{
      "+93":1
    },
    "text_en":"Afghanistan",
    "virtual18":{
      "activation":1
    },
    "virtual21":{
      "activation":1
    },
    "virtual23":{
      "activation":1
    },
    "virtual4":{
      "activation":1
    }
  }
}

GET - https://5sim.net/v1/guest/countries

Returns a list of countries with available operators for purchase.

Headers

Authorization: Bearer $token
Accept: application/json

Response

Status code : 200 OK

Name	Type	Description
iso	array	ISO country code
text_en	string	Country name in English

Countries list

Country	API 5SIM

Order statuses

PENDING - Preparation
RECEIVED - Waiting of receipt of SMS
CANCELED - Is cancelled
TIMEOUT - A timeout
FINISHED - Is complete
BANNED - Number banned, when number already used

Products list

Activation:

Service	API 5SIM

Hosting:

3hours
1day
10days
1month

Operators list

In order to get a list of operators, you need authorization.

Structure of SMS


{
    "sms": [
        {
            "created_at":"1970-12-01T17:23:25.106597Z",
            "date":"1970-12-01T17:23:15Z",
            "sender":"Facebook",
            "text":"Use 415127 as your login code",
            "code":"415127"
        }
    ]
}

Name	Type	Description
created_at	date string	When SMS was created
date	date string	When SMS received
sender	string	Sender name
text	string	Text of SMS
code	string	Received activation code

Limits

100 requests per second by IP address, http error code 503

100 requests per second by API_KEY, http error code 429

100 requests per second buy number, http error code 503

If requests reach limit within 10 minutes 5 times then ban 10 minutes

Rating

Description of the rating system.

The user's current rating is displayed in the account settings, the "General" tab.

The initial rating for new users is 96 points.

The maximum possible rating is 96 points.

The rating is formed from the following parameters:

Actions	Rating (points)
Account replenishment	+8
Completed Purchase Before Code Elapsed Time	+0.5
Automatically Completed Purchase After Time Allowed To Get Code	+0.4
Timeout	-0.15
Canceled purchase	-0.1
The number was sent to the ban	-0.1

If the rating drops to zero, then you will not be able to place an order on the site within 24 hours. After 24 hours, the rating will return to the initial value - 96 points.