How to use the SMSPool API

• By Admin
• 2021-12-20 22:53:57

What is an API?

An API (application programming interface) can easily communicate with our servers. You can connect it to your desired program and create your functionality within our APIs using the API. 

How do I use the SMSPool API?

Our endpoint is usually: https://api.smspool.net/ and is free of charge to use. It does not cost any money. SMSPool will provide you with a 32-character long API key attached to all your purchases, orders, and rentals upon registering. Please do NOT share this with anyone, as it could give users access to all your orders and balance.

All API requests can be done in both GET or POST, unless said otherwise and all responses are in JSON

What are the API endpoints?

All API endpoints are listed below, and it's listed logically from step one to get your SMS verifications.

Overview

• Informative endpoints

1. Country
2. Balance
3. Active orders
4. Pricing
5. All prices
6. Suggested countries
7. Look up phone number

• Endpoints for orders

1. Order SMS
2. Check SMS
3. Resend SMS
4. Cancel SMS
5. Archive SMS

• Endpoints for rentals

1. Retrieve all rentals
2. Order rental
3. Rental messages
4. Retrieve rental status
5. Refund rental
6. Extend rental

• Endpoints for preorders
  1. Create a preorder
  2. Check preorder
  3. View all preorders
  4. Cancel preorder

List of all informative endpoints

Country endpoint - https://api.smspool.net/country/retrieve_all

Responses

Service endpoint - https://api.smspool.net/service/retrieve_all

Responses

Balance endpoint - https://api.smspool.net/request/balance

Responses

Order history endpoint - https://www.api.smspool.net/request/history

Responses

My active orders endpoint - https://api.smspool.net/request/active

Responses

Price endpoint - https://api.smspool.net/request/price

Responses

Suggested countries endpoint - https://api.smspool.net/request/suggested_countries

Responses

[{"pool":1,"country_id":1,"name":"United States","short_name":"US","price":"0.31"},{"pool":7,"country_id":2,"name":"United Kingdom","short_name":"GB","price":"0.10"}]

Retrieve carrier of phone number - https://api.smspool.net/carrier/paid_lookup

Keep in mind that using this endpoint will charge you 0.01 cents for every successful lookup

Responses

{"success":true,"phonenumber":" 1234567890","country":"US","carrier":"Carrier","carrier_type":"mobile","charge":0.01}

List of all endpoints for ordering

Order SMS endpoint - https://api.smspool.net/purchase/sms

Orders that do not receive an SMS will be refunded automatically.

Responses

{"success":0,"errors":[{"message":"Missing or invalid param: country"},{"message":"Missing or invalid param: service"},{"message":"Missing or invalid param: key","description":"Your API key which can be found on your settings page at /my/settings"}]}

Check SMS endpoint - https://api.smspool.net/sms/check

Responses

Resend SMS endpoint - https://api.smspool.net/sms/resend

Responses

Cancel SMS endpoint - https://api.smspool.net/sms/cancel

Responses

Archive SMS orders endpoint - https://www.api.smspool.net/request/archive

Responses

Rental endpoints

Retrieve all rentals - https://api.smspool.net/rental/retrieve_all

Responses

The 0 represents the rental ID, this is the ID you need to select in order to order this specific rental.

Order rental - https://api.smspool.net/purchase/rental

Responses

Note: the `rental_code` you get from this endpoint is important, make sure to save it somewhere..

Retrieve rental messages - https://api.smspool.net/rental/retrieve_messages

Responses

Retrieve rental status - https://api.smspool.net/rental/retrieve_status.php

Responses

Needs to be called every time when activeFor expires for certain rentals.

Note: the available must be 1 before you send a code. Please run this endpoint every time before retrieving your rental messages.

Refund rental - https://api.smspool.net/rental/refund.php

Responses

Extend rental - https://api.smspool.net/rental/extend

Responses

List of all endpoints for preordering

Create preorder endpoint - https://api.smspool.net/preorder/create

Preorders that are not completed will be refunded automatically

Responses

{"success":0,"errors":[{"message":"Missing or invalid param: country"},{"message":"Missing or invalid param: service"},{"message":"Missing or invalid param: key","description":"Your API key which can be found on your settings page at /my/settings"}]}

Check preorder endpoint - https://api.smspool.net/preorder/check

Responses

Retrieve all preorders endpoint - https://api.smspool.net/preorder/retrieve

Retrieve all preorders that you have open at the moment.

Responses

Cancel preorder endpoint - https://api.smspool.net/preorder/cancel

Responses