### Example Response JSON Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This is an example of a successful JSON response when retrieving the account balance. ```json { "balance": "5.00" } ``` -------------------------------- ### Example Request Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#auth-info-b2f10c80-0e84-45b9-a156-ebe58326e6b6 This is an example of how to make a POST request to the retrieve_valid endpoint using curl. ```curl curl --location 'https://api.smspool.net/pool/retrieve_valid' \ --form 'service="395"' \ --form 'country="2"' \ --form 'web="1"' ``` -------------------------------- ### Example Response Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#auth-info-b2f10c80-0e84-45b9-a156-ebe58326e6b6 This is an example of a successful JSON response from the retrieve_valid endpoint. ```json [ { "pool": 7, "name": "Foxtrot", "custom_area": 1, "price": "0.30" }, { "pool": 12, "name": "Mike", "custom_area": 0, "price": "0.30" }, { "pool": 4, "name": "Delta", "custom_area": 0, "price": "0.32" }, { "pool": 2, "name": "Bravo", "custom_area": 0, "price": "1.16" }, { "pool": 3, "name": "Charlie", "custom_area": 0, "price": "0.48" } ] ``` -------------------------------- ### Example Request using cURL Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This cURL command demonstrates how to request your account balance from the SMSPool API. ```shell curl --location 'https://api.smspool.net/request/balance' \ --form 'key=""' ``` -------------------------------- ### Example Request for Generating a Voucher Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This cURL command shows how to generate a voucher with a specified amount using the SMSPool API. ```curl curl --location 'https://api.smspool.net/voucher/generate' \ --form 'amount="1"' ``` -------------------------------- ### Example Request for Suggested Countries Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This cURL command demonstrates how to request suggested countries from the SMSPool API. ```curl curl --location 'https://api.smspool.net/request/suggested_countries' \ --form 'service="1"' ``` -------------------------------- ### Active Orders Request Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example request to retrieve active SMS orders. ```curl curl --location 'https://api.smspool.net/request/active' \ --form 'key=""' ``` -------------------------------- ### Check SMS Response Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example JSON response for a successful SMS check. ```json { "status": 1, "resend": 0, "expiration": 1704562249, "time_left": 1173 } ``` -------------------------------- ### Active Orders Response Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example JSON response for active SMS orders. ```json [ { "timestamp": "2024-01-06 18:03:15", "cost": "0.24", "order_code": "ABCDEFGH", "phonenumber": "1234567890", "code": "0", "full_code": "", "short_name": "US", "service": "Test", "status": "pending", "expiry": 1704561795, "time_left": 1126 } ] ``` -------------------------------- ### Check SMS Request Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example request to check the status of an SMS order. ```curl curl --location 'https://api.smspool.net/sms/check' \ --form 'orderid="16GJCFZA"' \ --form 'key=""' ``` -------------------------------- ### Example Response for Suggested Countries Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This JSON represents a successful response from the suggested countries endpoint, listing available pools, country IDs, names, short names, and prices. ```json [ { "pool": 1, "country_id": 1, "name": "United States", "short_name": "US", "price": "0.24" }, { "pool": 7, "country_id": 2, "name": "United Kingdom", "short_name": "GB", "price": "0.10" }, { "pool": 7, "country_id": 3, "name": "Netherlands", "short_name": "NL", "price": "0.24" }, { "pool": 12, "country_id": 4, "name": "Russia", "short_name": "RU", "price": "0.10" }, { "pool": 12, "country_id": 6, "name": "Sweden", "short_name": "SE", "price": "0.10" }, { "pool": 12, "country_id": 7, "name": "Kazakhstan", "short_name": "KZ", "price": "0.10" }, { "pool": 7, "country_id": 9, "name": "Indonesia", "short_name": "ID", "price": "0.24" }, { "pool": 12, "country_id": 13, "name": "Romania", "short_name": "RO", "price": "0.10" }, { "pool": 12, "country_id": 18, "name": "Kyrgyzstan", "short_name": "KG", "price": "0.10" }, { "pool": 12, "country_id": 23, "name": "France", "short_name": "FR", "price": "0.10" }, { "pool": 12, "country_id": 29, "name": "Israel", "short_name": "IL", "price": "0.10" }, { "pool": 12, "country_id": 32, "name": "Ireland", "short_name": "IE", "price": "0.10" }, { "pool": 12, "country_id": 34, "name": "Laos", "short_name": "LA", "price": "0.10" }, { "pool": 12, "country_id": 48, "name": "Croatia", "short_name": "HR", "price": "0.10" }, { "pool": 12, "country_id": 52, "name": "Thailand", "short_name": "TH", "price": "0.10" }, { "pool": 12, "country_id": 53, "name": "Mexico", "short_name": "MX", "price": "0.10" }, { "pool": 7, "country_id": 54, "name": "Taiwan", "short_name": "TW", "price": "0.10" }, { "pool": 12, "country_id": 62, "name": "Pakistan", "short_name": "PK", "price": "0.10" }, { "pool": 12, "country_id": 72, "name": "Cyprus", "short_name": "CY", "price": "0.10" }, { "pool": 12, "country_id": 149, "name": "Czech Republic", "short_name": "CZ", "price": "0.10" } ] ``` -------------------------------- ### Cancel SMS Response Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example JSON response for a successful SMS cancellation. ```json { "success": 1, "message": "The order has been cancelled, and you have been refunded 0.24 dollars." } ``` -------------------------------- ### Cancel SMS Request Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Example request to cancel a specific SMS order. ```curl curl --location 'https://api.smspool.net/sms/cancel' \ --form 'orderid="ABCDEFGH"' \ --form 'key=""' ``` -------------------------------- ### Retrieve country success rates per service Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#intro This API endpoint is used to retrieve success per country for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/success_rate`. Please use either the service ID, or the service name as service param. ```curl curl --location 'https://api.smspool.net/request/success_rate?service=1' \ --form 'service="1"' ``` -------------------------------- ### Activate SMS Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Forcefully activates an SMS to set it available for future resends. Orders activated are not eligible for a refund. ```curl curl --location 'https://api.smspool.net/sms/activate' \ --form 'orderid="Y1IZFGYI"' \ --form 'key=""' ``` -------------------------------- ### POSTOrder SMS Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 This request is using Bearer Token from collectionSMSPool API ```cURL curl --location 'https://api.smspool.net/purchase/sms' \ --form 'key=""' \ --form 'country="US"' \ --form 'service="1"' \ --form 'pool=""' \ --form 'max_price=""' \ --form 'pricing_option=""' \ --form 'quantity=""' \ --form 'areacode="[123]"' \ --form 'exclude=""' \ --form 'create_token=""' ``` -------------------------------- ### Cancel All SMS Orders Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 This endpoint cancels all active SMS orders and refunds them. ```curl curl --location 'https://api.smspool.net/sms/cancel_all' \ --form 'key=""' ``` -------------------------------- ### Clear SMS Cache Source: https://documenter.getpostman.com/view/30155063/2s9YXmZ1JY#a60a3013-ff98-42a2-999f-aed895c37ca2 Clears the previous SMS cache to allocate previous numbers again. ```curl curl --location --request POST 'https://api.smspool.net/sms/clear_cache' ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.