TelcoAPI Reference¶

Welcome to the TelcoAPI reference documentation. This guide provides comprehensive information about the TelcoAPI REST APIs, including authentication, rate limiting, error handling, and detailed endpoint references.

Core Concepts¶

Authentication¶

TelcoAPI supports two authentication methods:

1. API Key Authentication

   curl -X GET "https://api.telco-sec.com/v1/sim/inventory" \
     -H "X-API-Key: your_api_key_here"
   

2. OAuth 2.0

   curl -X POST "https://api.telco-sec.com/v1/oauth/token" \
     -d "grant_type=client_credentials" \
     -d "client_id=your_client_id" \
     -d "client_secret=your_client_secret"
   

Rate Limiting¶

Rate limit headers included in responses: - X-RateLimit-Limit: Rate limit ceiling for the current time window - X-RateLimit-Remaining: Number of requests remaining in the current window - X-RateLimit-Reset: Time when the rate limit will reset (Unix timestamp)

Error Handling¶

TelcoAPI follows the RFC 7807 specification for error responses:

{
  "type": "https://api.telco-sec.com/errors/rate-limit-exceeded",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "detail": "Request quota exceeded. Please wait before retrying.",
  "instance": "/sim/inventory"
}

Common HTTP Status Codes: - 200 OK: Request successful - 201 Created: Resource created successfully - 400 Bad Request: Invalid request parameters - 401 Unauthorized: Invalid or missing authentication - 403 Forbidden: Valid authentication but insufficient permissions - 404 Not Found: Resource not found - 429 Too Many Requests: Rate limit exceeded - 500 Internal Server Error: Server-side error

Available APIs¶

SIM Management¶

• Physical SIM Management
• eSIM Management
• SIM Inventory

Diameter Protocol¶

• Gx Interface
• Rx Interface
• Ro/Gy Interface
• Rf Interface

SS7 Protocol¶

• MAP Operations
• CAMEL Application
• INAP Services
• TCAP Messaging

IPX/GRX¶

• Routing Management
• Signaling
• Data Services

SIP Protocol¶

• Registration Services
• Session Management
• Messaging Services

System Management¶

• Monitoring
• Alerts
• Configuration

Common Features¶

Pagination¶

curl "https://api.telco-sec.com/v1/sim/inventory?page=2&per_page=100"

Response headers: - X-Total-Count: Total number of items - Link: Links for first, prev, next, and last pages

Filtering¶

curl "https://api.telco-sec.com/v1/sim/inventory?state=ACTIVE&vendor=GEMALTO"

Sorting¶

curl "https://api.telco-sec.com/v1/sim/inventory?sort=created_at:desc,iccid:asc"

Field Selection¶

curl "https://api.telco-sec.com/v1/sim/inventory?fields=iccid,imsi,state"

Webhooks¶

Subscribe to events:

curl -X POST "https://api.telco-sec.com/v1/webhooks" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["sim.activated", "sim.deactivated"]
  }'

SDKs and Libraries¶

Official SDKs are available for: - Python - Node.js - Java - Go - .NET

Support¶

For API support: - Email: api-support@telcoapi.com - Documentation: https://docs.telcoapi.com - Status Page: https://status.telcoapi.com