API Doccumentation

Getting Started:

The NumberLLC API is a tool for automating the SMS verification process.

The API is accessed using GET requests to the API endpoint (https://numberllc.com/api). The API requires an API key to be included as a parameter in the request. The response is in JSON format.

The NumberLLC API provides several requests that allow users to perform various operations, such as checking their account balance, renting a phone number, and retrieving SMS verification messages.

To get the API Key:

  1. Log in to your account on NumberLLC.
  2. Go to the "Settings" page in your account and copy your API key.

Get Balance

This request allows you to check your current balance on NumberLLC.

Request URL:
https://numberllc.com/api?key=<your_key>&action=balance

Request Parameters:

  • key (required): Your NumberLLC API key.
Response Parameters:
  • status: A string indicating whether the request was successful or not.
  • balance: A float indicating your current account balance.

Example Request:

https://numberllc.com/api?key=123456789&action=balance
Example Response:
 {
    "status": "success",
    "balance": 12.34
 }
Possible Errors:
  • wrong api key: Your API key is invalid or not provided. Check that the API key is correct and included as a parameter in the request.

Get Prices

This request enables you to access information regarding the availability of countries for phone numbers, along with the rental prices associated with each country. The prices depend on your membership level.

Request URL:
https://numberllc.com/api?key=<your_key>&action=price

Request Parameters:

  • key (required): Your NumberLLC API key.
Response Parameters:
  • status: A string indicating whether the request was successful or not.
  • countries: An array of objects containing information about available countries for phone number rentals. Each object contains the following properties:
    • country_code: A string indicating the two-letter country code for the country.
    • day_price: A float indicating the rental price for one day for the country.
    • month_price: A float indicating the rental price for one month for the country.
    • year_price: A float indicating the rental price for one year for the country.
Example Request:
https://numberllc.com/api?key=123456789&action=price
Example Response:
{
    "status":"success",
    "countries":[
       {
          "country_code":"US",
          "day_price":0.9,
          "month_price":24,
          "year_price":96
       },
       {
          "country_code":"GB",
          "day_price":1.5,
          "month_price":35,
          "year_price":150
       }
    ]
}
Possible Errors:
  • wrong api key: Your API key is invalid or not provided. Check that the API key is correct and included as a parameter in the request.

Get Phone Number

This request allows you to obtain a phone number from your account. Alternatively, if you set the 'buy' parameter to 1, a new phone number will be purchased for you.

Request URL:
https://numberllc.com/api?key=<your_key>&action=number&country=<country_code>&buy=<buy>

Request Parameters:

  • key (required): Your NumberLLC API key.
  • country (optional): Country code of the desired phone number. If not set, the country will be "us".
  • buy (optional): Set to 1 to buy a new phone number. Default is 0.
Response Parameters:
  • status: A string indicating whether the request was successful or not.
  • country_code: The country code of the requested phone number as a string.
  • calling_code: The calling code (e.g., 1) of the requested phone number as a string.
  • phone_number: The requested phone number without the calling code as a string.
Example Request:
https://numberllc.com/api?key=123456789&action=number&country=us&buy=1
Example Response:
{
    "status": "success",
    "country_code": "US",
    "calling_code": "1",
    "phone_number": "234567890"
}
Possible Errors:
  • wrong api key: Your API key is invalid or not provided. Please ensure that the API key is correct and included as a parameter in the request.
  • no available numbers in the specified country in your account: If you have provided a country code, but there are no unused phone numbers available in your account for that country.
  • insufficient balance: If your account balance is not enough to purchase a new phone number. Please add sufficient funds to your account.
  • no available numbers for purchase in the specified country: If you have provided a country code, but there are no available phone numbers for purchase in that country.

Get SMS

This request allows you to retrieve the first SMS message received after your last "Get Phone Number" request. If no SMS message has been received after the "Get Phone Number" request, the response will indicate "waiting".

Request URL:
https://numberllc.com/api?key=<your_key>&action=sms

Request Parameters:

  • key (required): Your NumberLLC API key.
  • number (optional): The phone number to check for SMS messages. If not set, make sure that you have already made a "Get Phone Number" request.
Response Parameters:
  • status: A string indicating whether the request was successful or not.
  • time: The date and time the SMS message was received.
  • to: The phone number the SMS message was received on.
  • from: The name of the service associated with the SMS message (e.g., Facebook, Google).
  • sms: The text of the SMS message.
  • code: The verification code extracted from the SMS message, if applicable.
Example Request:
https://numberllc.com/api?key=123456789&action=sms
Example Response (SMS received):
{
    "status": "success",
    "time": "2023-05-25 10:30:45",
    "to": "1234567890",
    "from": "Facebook",
    "sms": "Your verification code is 123456. Please enter this code to verify your account.",
    "code": "123456"
}
Example Response (No SMS received):
{
    "status": "waiting",
}
Possible Errors:
  • wrong api key: Your API key is invalid or not provided. Please ensure that the API key is correct and included as a parameter in the request.