FoxSims API Documentation | SMS Verification API

Getting Started

All API requests must be sent to the Base URL https://foxsims.com using HTTPS. Every request requires your personal x-api-key, which can be copied from your dashboard.

Header: x-api-key: YOUR_DASHBOARD_KEY
Content-Type: application/json

Missing Key Example

{
"error": "API keys are required"
}

Plans And Services

GET /api/v1/plans

Retrieve every available plan along with its services, availability, and pricing in cents.

Query params: None.
Use case: Build selectors that let users choose a plan or service before renting numbers.

Sample Request

curl -X GET "https://foxsims.com/api/v1/plans" ^
-H "x-api-key: YOUR_DASHBOARD_KEY"

Sample Response

{
  "success": true,
  "message": "Your Plans Retrieved Successfully",
  "data": {
    "plans": [
      {
        "id": 1,
        "type": 1,
        "name": "One Time Plan",
        "description": "These numbers allow you to receive a single SMS only...",
        "subscription_time": "15 minutes",
        "services": [
          {
            "service_code": 1,
            "name": "ticketmaster",
            "available": 133,
            "amount_cents": 45,
            "is_full_access": 0
          }
          // ...more services
        ]
      }
      // ...more plans
    ]
  }
}

User Messages

GET /api/v1/messages

Retrieve paginated SMS messages routed to your FoxSims numbers.

Query params: page (integer, optional, default 1) and filter[request_id] (string, optional, match the rental's request_id to limit results). Neither parameter is required.
Use case: Pull the latest verification codes or status updates automatically.

Sample Request

curl -X GET "https://foxsims.com/api/v1/messages?page=1&filter[request_id]=8534201167703180" ^
-H "x-api-key: YOUR_DASHBOARD_KEY"

Sample Response

{
  "success": true,
  "message": "Your Messages Retrieved Successfully",
  "data": {
    "data": [
      {
        "msg": "PayPal: Your security code is 12****. Your code expires in 10 minutes. Please don't reply. www.paypal.com #12****",
        "message_created_at": "2025-12-26 00:53:35",
        "number": "14*********",
        "service_name": "PayPal"
      }
    ],
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 10,
      "current_page": 1
    }
  }
}

User Numbers

GET /api/v1/numbers

List every number currently assigned to your account along with metadata.

Query params: search (string, optional, matches number, name, or service) - this filter is not required.
Use case: Monitor active rentals, renewals, or search for a specific request ID.

Sample Request

curl -X GET "https://foxsims.com/api/v1/numbers?search=ticketmaster" ^
-H "x-api-key: YOUR_DASHBOARD_KEY"

Sample Response

{
  "success": true,
  "message": "Your Numbers Retrieved Successfully",
  "data": [
    {
      "number": "18*********",
      "service_name": "ticketmaster",
      "request_id": "76129042*******",
      "price": "0.7000",
      "type": "Rental",
      "is_renewable": 0,
      "name": null,
      "created_at": "2026-01-05 09:08:55",
      "expired_at": "2026-01-05 12:08:55"
    }
  ]
}

Old One-Time Numbers

GET /api/v1/old_one_time_numbers_list

Retrieve the list of previously used one-time numbers along with their original and current pricing.

Query params: None.
Use case: Review historic requests or surface eligible numbers for reorders.

Sample Request

curl -X GET "https://foxsims.com/api/v1/old_one_time_numbers_list" ^
-H "x-api-key: YOUR_DASHBOARD_KEY"

Sample Response

{
  "success": true,
  "message": "This Action Done Successfully",
  "data": [
    {
      "request_id": "35**************",
      "number": "13*********",
      "service": "cashapp",
      "price": 1.8,
      "old_price": 6
    }
  ]
}

User Balance

GET /api/v1/balance

Check the current wallet balance shown inside your dashboard.

Query params: None.
Use case: Display credits inside your own automation or billing tasks.

Sample Request

curl -X GET "https://foxsims.com/api/v1/balance" ^
-H "x-api-key: YOUR_DASHBOARD_KEY"

Sample Response

{
  "success": true,
  "message": "Your Balance Retrieved Successfully",
  "data": {
    "balance": 512.55
  }
}

Cancel Number

POST /api/v1/cancel_number

Cancel an active number using the request_id returned when you rented it.

Body params: request_id (string, required) and not_working (boolean, optional, 1 or 0, default 0).
Use case: Release a number early so you can rent a new one.

Sample Request

curl -X POST "https://foxsims.com/api/v1/cancel_number" ^
  -H "x-api-key: YOUR_DASHBOARD_KEY" ^
  -H "Content-Type: application/json" ^
  -d "{ \"request_id\": \"24561234*******\", \"not_working\": 0 }"

Sample Responses

{
  "success": true,
  "message": "Number Has Been Canceled",
  "data": true
}

{
  "success": false,
  "errors": "Number not found",
  "data": null
}

Toggle Auto Renew

POST /api/v1/user_numbers/auto_renew

Enable or disable auto renewal for a rental number using its request_id.

Body params: request_id (string, required) and is_renewable (boolean, required).
Use case: Automate renewals for eligible rentals or disable them when no longer needed.

Sample Request

curl -X POST "https://foxsims.com/api/v1/user_numbers/auto_renew" ^
  -H "x-api-key: YOUR_DASHBOARD_KEY" ^
  -H "Content-Type: application/json" ^
  -d "{ \"request_id\": \"24561234*******\", \"is_renewable\": true }"

Sample Responses

{
  "success": true,
  "message": "Number renewal preference updated successfully",
  "data": true
}

{
  "success": false,
  "errors": "Number not found",
  "data": null
}

Request Service Numbers

POST /api/v1/request_service

Rent one or more numbers for a selected service. Use the service code from the plans endpoint.

Body params: service (integer, required) and numbers_count (integer, required).
Use case: Automate purchasing numbers for your workflows.

Sample Request

curl -X POST "https://foxsims.com/api/v1/request_service" ^
  -H "x-api-key: YOUR_DASHBOARD_KEY" ^
  -H "Content-Type: application/json" ^
  -d "{ \"service\": 4, \"numbers_count\": 1 }"

Sample Response

{
  "success": true,
  "numbers": [
    {
      "number": "13055408624",
      "service": "cashapp",
      "price": 600,
      "request_id": "8534201167703180",
      "expired_at": "2026-02-06 12:39"
    }
  ],
  "message": "You have successfully rented 1 number"
}

{
  "success": false,
  "message": "Service is not available, Please Try Again Later"
}

{
  "success": false,
  "message": "You don't have enough balance"
}

Reuse Number

POST /api/v1/reuse_number

Reuse an eligible rental or one-time number by providing its original request_id.

Body params: request_id (string, required).
Use case: Automatically reassign previous numbers when your workflow needs the same service.

Sample Request

curl -X POST "https://foxsims.com/api/v1/reuse_number" ^
  -H "x-api-key: YOUR_DASHBOARD_KEY" ^
  -H "Content-Type: application/json" ^
  -d "{ \"request_id\": \"35**************\" }"

Sample Responses

{
  "success": true,
  "message": "Your Number Reused Successfully",
  "data": true
}

{
  "success": false,
  "errors": "Service is not available",
  "data": null
}

Best Practices

Rotate your x-api-key immediately if it is ever exposed publicly.
Use HTTPS clients that support TLS 1.2+ to avoid connection errors.
Respect pagination to avoid hitting rate limits when listing data.
Store responses securely because they may contain personal verification codes.

Manage API Settings