@privatix-1/tempnumber-sdk

@privatix-public/tempnumber-sdk

@PrivatixPublicTempnumberSdk - JavaScript client for @privatix-public/tempnumber-sdk Get temporary mobile numbers and receive SMS with API for online accounts verification and QA tests. Most of TempNumber phone numbers are real mobile numbers (not virtual) coming from physical SIM cards. This greatly increases chances to receive SMS for online account verification. You can find out more about the service at https://temp-number.org.

Basic usage

Get number and receive SMS

• Get temporary mobile phone number by sending POST request to /activations while passing both service and country as request parameters. For example, in order to request activation code for Facebook using Germany phone number set:

  • "serviceId": "facebook"
  • "countryId": "de"

  In response you will get:

  • phone number
  • activation id

• Use phone number

• Get SMS by sending GET request to /acivations/<activation_id>. Continue polling endpoint while status=smsRequested or retryRequested until you get sms. Please, note that rate limits applies (see below).

Balance management

• Top up your funds balance through UI:

• https://temp-number.org
• Apple App Store
• Google Play

• Check balance by sending request to GET /user/balance

Pricing

Get price list by sending GET request to either:

• /pricelistByService OR
• /pricelistByCountry

In response you will get price for each service in each country.

Authentication

You must send your API key in x-api-key header for each request. To get your API key

• Login into your account.
• In side menu, click on API button.
• Generate your API key.

Servers

All requests are relative to following base URLs:

Base URL	Environment
https://tn-api.com/api/v1	production
https://mock.temp-number.org/v1	mock (no funds required)

Rate limits

In order to protect service from excessive use whether intended or unintended we are rate limiting request to API endpoints to maintain service availability. Rates apply to each endpoint separately.

See rate limits

endpoint	method	rate
/activations	GET	10 request per minute
/activations	POST	80 requests per 2 minutes
/activations/:activation_id	GET	80 requests per 2 minutes
/activations	PUT	10 requests per minute
/services/:serviceId/countries/:countryId	GET	80 requests per 2 minutes
/services/pricelistByService	GET	3 requests per minute
/services/pricelistByCountry	GET	3 requests per minute
/user/balance	GET	10 requests per minute

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.6
• Package version: 1.2.6
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://temp-number.org/app/contact-us

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @privatix-public/tempnumber-sdk --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @privatix-public/tempnumber-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @PrivatixPublicTempnumberSdk = require('@privatix-public/tempnumber-sdk');

var defaultClient = @PrivatixPublicTempnumberSdk.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['x-api-key'] = "Token"

var api = new @PrivatixPublicTempnumberSdk.ActivationApi()
var activationId = 25687; // {Number} ID of activation
api.getActivation(activationId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://tn-api.com/api/v1

Class	Method	HTTP request	Description
@PrivatixPublicTempnumberSdk.ActivationApi	getActivation	GET /activations/{activation_id}	Get activation data
@PrivatixPublicTempnumberSdk.ActivationApi	getActivationsHistory	GET /activations	Get activations history
@PrivatixPublicTempnumberSdk.ActivationApi	newActivation	POST /activations	Request new activation
@PrivatixPublicTempnumberSdk.ActivationApi	updateActivation	PUT /activations/{activation_id}	Retry activation with new sms
@PrivatixPublicTempnumberSdk.ServicesApi	getPricelistByCountry	GET /services/pricelistByCountry	Get pricelist by countries
@PrivatixPublicTempnumberSdk.ServicesApi	getPricelistByService	GET /services/pricelistByService	Get pricelist by services
@PrivatixPublicTempnumberSdk.ServicesApi	getSingleService	GET /services/{service_id}/countries/{country_id}	Get single service price and availability in specific country
@PrivatixPublicTempnumberSdk.UserApi	getUserBalance	GET /user/balance	Get user's balance

Documentation for Models

• @PrivatixPublicTempnumberSdk.AccountOnHold
• @PrivatixPublicTempnumberSdk.ActivationData
• @PrivatixPublicTempnumberSdk.ActivationHistory
• @PrivatixPublicTempnumberSdk.ActivationNumber
• @PrivatixPublicTempnumberSdk.BadRequest
• @PrivatixPublicTempnumberSdk.Gone
• @PrivatixPublicTempnumberSdk.InlineResponse200
• @PrivatixPublicTempnumberSdk.InlineResponse409
• @PrivatixPublicTempnumberSdk.InlineResponse4091
• @PrivatixPublicTempnumberSdk.LowSuccessRate
• @PrivatixPublicTempnumberSdk.NotFound
• @PrivatixPublicTempnumberSdk.PaymentRequired
• @PrivatixPublicTempnumberSdk.PriceByCountry
• @PrivatixPublicTempnumberSdk.PriceByCountryServices
• @PrivatixPublicTempnumberSdk.PriceByService
• @PrivatixPublicTempnumberSdk.PriceByServiceCountries
• @PrivatixPublicTempnumberSdk.PricelistByCountry
• @PrivatixPublicTempnumberSdk.PricelistByService
• @PrivatixPublicTempnumberSdk.Service
• @PrivatixPublicTempnumberSdk.ServiceUnavailable
• @PrivatixPublicTempnumberSdk.SingleService
• @PrivatixPublicTempnumberSdk.TooManyActivationsPending
• @PrivatixPublicTempnumberSdk.Unauthorized
• @PrivatixPublicTempnumberSdk.UsersBalance

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header