Skip to content

API Endpoints Overview

This document provides a comprehensive list of all available endpoints in the TelcoAPI. For detailed information about specific protocols, please refer to their respective documentation sections.

Base URLs

  • Production: https://api.telco-sec.com
  • Staging: https://api.staging.telco-sec.com
  • Development: https://api.dev.telco-sec.com

Protocol-Specific Endpoints

Diameter Protocol

Gx Interface

  • POST /v1/diameter/gx/ccr - Credit Control Request
  • POST /v1/diameter/gx/rar - Re-Auth Request
  • GET /v1/diameter/gx/sessions - List Active Sessions

Rx Interface

  • POST /v1/diameter/rx/aar - AA Request
  • POST /v1/diameter/rx/str - Session Termination
  • GET /v1/diameter/rx/sessions - List Active Sessions

SS7 Protocol

MAP Operations

  • POST /v1/ss7/map/send-routing-info - Send Routing Info
  • POST /v1/ss7/map/update-location - Update Location
  • GET /v1/ss7/map/status - Check MAP Service Status

TCAP Operations

  • POST /v1/ss7/tcap/begin - Begin Transaction
  • POST /v1/ss7/tcap/continue - Continue Transaction
  • POST /v1/ss7/tcap/end - End Transaction

SIP Protocol

Registration

  • POST /v1/sip/register - Register SIP User
  • DELETE /v1/sip/register - Unregister SIP User
  • GET /v1/sip/registration-status - Check Registration Status

Session Management

  • POST /v1/sip/invite - Initiate Session
  • POST /v1/sip/bye - Terminate Session
  • GET /v1/sip/sessions - List Active Sessions

SIM Management

Physical SIM

  • POST /v1/sim/physical/provision - Provision New SIM
  • PUT /v1/sim/physical/update - Update SIM Profile
  • GET /v1/sim/physical/{iccid} - Get SIM Details

eSIM

  • POST /v1/sim/esim/profile - Create eSIM Profile
  • PUT /v1/sim/esim/profile/{id} - Update Profile
  • DELETE /v1/sim/esim/profile/{id} - Delete Profile

Administrative Endpoints

System Management

  • GET /v1/system/health - System Health Check
  • GET /v1/system/metrics - System Metrics
  • POST /v1/system/maintenance - Schedule Maintenance

User Management

  • POST /v1/users - Create User
  • GET /v1/users/{id} - Get User Details
  • PUT /v1/users/{id} - Update User
  • DELETE /v1/users/{id} - Delete User

Response Formats

All endpoints return responses in the following format:

{
  "status": "success|error",
  "data": {
    // Response data
  },
  "meta": {
    "timestamp": "2024-02-20T12:00:00Z",
    "requestId": "req_123456789"
  }
}

Error Handling

All endpoints use standard HTTP status codes and include detailed error messages:

{
  "status": "error",
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message",
    "details": {
      // Additional error details
    }
  }
}

Rate Limiting

  • Standard tier: 100 requests/minute
  • Enterprise tier: 1000 requests/minute
  • Custom limits available for specific endpoints

Versioning

All endpoints are versioned (v1, v2, etc.). We maintain backward compatibility and provide migration guides for major version changes.