PhoneCall AI - API Documentation

Health Check

GET /api/health Public

Check if the API is running

Try it

Send OTP

Generate and send a 6-digit verification code to a phone number via SMS.

POST /api/otp/send Public

Send verification code to phone number

Request Body

Field	Type	Required	Description
phone_number	string	required	Phone with country code (e.g., +85512345678)
purpose	string	optional	`register`, `reset_password`, or `login` (default: register)
site_name	string	optional	Your website/app name (included in SMS)

// Request
POST /api/otp/send
{
    "phone_number": "+85512345678",
    "purpose": "register",
    "site_name": "MyShop"
}

// Success Response
{
    "success": true,
    "message": "OTP sent",
    "expires_in": 300
}

// Error Response
{
    "error": "Rate limit exceeded"
}

Try it

Phone: +855

Verify OTP

Verify the 6-digit code sent to the phone number.

POST /api/otp/verify Public

Verify the OTP code

Request Body

Field	Type	Required	Description
phone_number	string	required	Phone number used in send request
otp_code	string	required	6-digit verification code
purpose	string	optional	Must match the purpose used in send (default: register)

// Request
POST /api/otp/verify
{
    "phone_number": "+85512345678",
    "otp_code": "123456",
    "purpose": "register"
}

// Success Response
{
    "success": true,
    "message": "Phone verified",
    "purpose": "register",
    "site_name": "MyShop"
}

Try it

Status Codes

200 Success

400 Bad request / Invalid input

401 Unauthorized (invalid token)

429 Rate limit exceeded

500 Server error

Rate Limits

To prevent abuse, the following rate limits apply:

Global: 3 requests per 15 minutes
Login: 5 attempts per 15 minutes
OTP Send: 3 requests per minute
Per Phone: 5 OTP requests per hour

Need more requests? Contact admin to increase your limits.

Code Examples

Integrate with your favorite language.

// Node.js - Install: npm install axios
const axios = require('axios');

const API = 'https://backend-lime-three-82.vercel.app';

// Send OTP
async function sendOtp(phone) {
    const { data } = await axios.post(API + '/api/otp/send', {
        phone_number: phone,
        purpose: 'register',
        site_name: 'MyApp'
    });
    return data;
}

// Verify OTP
async function verifyOtp(phone, code) {
    const { data } = await axios.post(API + '/api/otp/verify', {
        phone_number: phone,
        otp_code: code,
        purpose: 'register'
    });
    return data;
}

// Usage
sendOtp('+85512345678').then(console.log);
verifyOtp('+85512345678', '123456').then(console.log);

# Python - Install: pip install requests
import requests

API = 'https://backend-lime-three-82.vercel.app'

# Send OTP
def send_otp(phone):
    response = requests.post(f'{API}/api/otp/send', json={
        'phone_number': phone,
        'purpose': 'register',
        'site_name': 'MyApp'
    })
    return response.json()

# Verify OTP
def verify_otp(phone, code):
    response = requests.post(f'{API}/api/otp/verify', json={
        'phone_number': phone,
        'otp_code': code,
        'purpose': 'register'
    })
    return response.json()

# Usage
print(send_otp('+85512345678'))
print(verify_otp('+85512345678', '123456'))

<?php
// PHP - No dependencies needed

$API = 'https://backend-lime-three-82.vercel.app';

// Send OTP
function sendOtp($phone) {
    global $API;
    $ch = curl_init($API . '/api/otp/send');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
        'phone_number' => $phone,
        'purpose' => 'register',
        'site_name' => 'MyApp'
    ]));
    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    return json_decode(curl_exec($ch), true);
}

// Verify OTP
function verifyOtp($phone, $code) {
    global $API;
    $ch = curl_init($API . '/api/otp/verify');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
        'phone_number' => $phone,
        'otp_code' => $code,
        'purpose' => 'register'
    ]));
    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    return json_decode(curl_exec($ch), true);
}

// Usage
print_r(sendOtp('+85512345678'));
print_r(verifyOtp('+85512345678', '123456'));
?>

// Java - Uses HttpURLConnection (no dependencies)
import java.net.http.*;
import java.net.URI;

public class OtpClient {
    static String API = "https://backend-lime-three-82.vercel.app";
    
    // Send OTP
    public static String sendOtp(String phone) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        String json = "{\"phone_number\":\"" + phone + 
            "\",\"purpose\":\"register\",\"site_name\":\"MyApp\"}";
        
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API + "/api/otp/send"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(json))
            .build();
        
        return client.send(request, HttpResponse.BodyHandlers.ofString()).body();
    }
    
    // Verify OTP
    public static String verifyOtp(String phone, String code) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        String json = "{\"phone_number\":\"" + phone + 
            "\",\"otp_code\":\"" + code + "\",\"purpose\":\"register\"}";
        
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API + "/api/otp/verify"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(json))
            .build();
        
        return client.send(request, HttpResponse.BodyHandlers.ofString()).body();
    }
}

# cURL - Works in terminal

# Send OTP
curl -X POST https://backend-lime-three-82.vercel.app/api/otp/send \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+85512345678",
    "purpose": "register",
    "site_name": "MyApp"
  }'

# Verify OTP
curl -X POST https://backend-lime-three-82.vercel.app/api/otp/verify \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+85512345678",
    "otp_code": "123456",
    "purpose": "register"
  }'

PhoneCall AI API

SMS OTP Verification API

Health Check

Try it

Send OTP

Request Body

Try it

Verify OTP

Request Body

Try it

Status Codes

Rate Limits

Code Examples