API Documentation on Platfone Docs

API overview

Mon, 01 Jan 0001 00:00:00 +0000

The Platfone provides a variety of APIs to cater to different use cases. Each API is designed to handle specific tasks, ensuring that you can choose the right tool for your needs.

Activation API

Mon, 01 Jan 0001 00:00:00 +0000

📝 Overview

Then Activation API is designed to automate SMS‑based service activations using temporary mobile numbers. It supports ordering new numbers, retrieving SMS text and OTP codes, retrying, and canceling activations in a sandbox or production environment. Billing applies only when an SMS is successfully received.

Retail API

Mon, 01 Jan 0001 00:00:00 +0000

📝 Overview

The Retail API enables you to embed SMS verification into your own mobile or web app while we handle customers, balances, and activations. It offers endpoints to create users, top up balances, assign phone numbers, receive OTPs, retry or cancel activations, and track usage history - all with billing triggered only upon successful SMS reception.

Alternative API

Mon, 01 Jan 0001 00:00:00 +0000

📝 Overview

The Alternative API offers a legacy-compatible API with other SMS activation providers. It supports ordering numbers, polling for SMS codes, setting price limits, and checking balance via simple GET/POST endpoints.

Rate Limits

Mon, 01 Jan 0001 00:00:00 +0000

Rate limits

There are three different types of rate limits you should be aware of:

minimum success rate
maximum active activations
API endpoints maximum requests per time period

In the event of a block, you will receive a 429 error code, along with information on when block will expire.

Sandbox Environment

Mon, 01 Jan 0001 00:00:00 +0000

Sandbox environments are essential for testing and development, allowing you to simulate real-world scenarios without affecting production data.

🔑 Key Features

Full API compatibility with the production environment.
Isolated environment for testing without impacting live data.
Fake funds top-ups to test for free.
Fake SMS delivery to test activation workflows.
Sandbox dashboard UI to see activation results in real-time.

🏖️ How to use the Sandbox

Switching to the sandbox environment is straightforward: