@privatix-1/tempnumber-sdk
Advanced tools
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_onli
Readme
@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.
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:
In response you will get:
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).
/user/balanceGet price list by sending GET request to either:
/pricelistByService OR/pricelistByCountryIn response you will get price for each service in each country.
You must send your API key in x-api-key header for each request. To get your API key
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) |
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.
| 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:
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
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
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
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.
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
}
}
]
}
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);
});
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 |
FAQs
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_onli
We found that @privatix-1/tempnumber-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.