> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telegent.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

## Overview

The Telegent mPaaS API gives you programmatic control over the full mobile communications
lifecycle — from provisioning and porting phone numbers, to routing voice calls
and sending messages, to managing subscribers, accounts, packages, and AI-powered filtering.

All requests are made over HTTPS to the base URL:

```text theme={null}
https://api.telegent.com/v1.0
```

Responses are JSON and always include a `Successful` field:

```json theme={null}
{
  "Successful": true,
  "Data": { ... }
}
```

***

## Quick Start

<Steps>
  <Step title="Get Your Credentials">
    Obtain your `AccountKey` and `AccountSecret` from your Telegent representative or
    the [API Portal](https://api.telegent.com).
  </Step>

  <Step title="Authenticate">
    Exchange your credentials for a Bearer token via `POST /v1.0/oauth2/tokens`.
    See the [OAuth2 endpoint](/api-reference/oauth2) for details.
  </Step>

  <Step title="Make Your First Call">
    Include the token in the `Authorization` header on every request:

    ```http theme={null}
        Authorization: Bearer YOUR_TOKEN_HERE
    ```
  </Step>
</Steps>

***

## API Categories

<CardGroup cols={2}>
  <Card title="OAuth2" icon="key" href="/api-reference/oauth2">
    Exchange credentials for a Bearer token
  </Card>

  <Card title="Numbers" icon="phone" href="/api-reference/numbers">
    Search availability, provision numbers, manage inventory, and configure data usage
  </Card>

  <Card title="Number Porting" icon="arrows-left-right" href="/api-reference/numbers">
    Port numbers in or out, check eligibility, and manage port requests
  </Card>

  <Card title="Message" icon="message" href="/api-reference/message">
    Create message routes, send outbound SMS/MMS, and query message history
  </Card>

  <Card title="Voice" icon="phone-volume" href="/api-reference/voice">
    Configure voice routes and manage outbound/inbound call handling
  </Card>

  <Card title="Workgroups" icon="microphone" href="/api-reference/workgroups">
    Manage workgroups, activities, and call handling logic
  </Card>

  <Card title="Products, Packages & Subscriptions" icon="box" href="/api-reference/products">
    Define services and products, bundle into packages, and manage subscriptions
  </Card>

  <Card title="AI Guardian" icon="shield" href="/api-reference/ai-guardian">
    Configure per-subscriber call and message filters, blocked contacts, and
    guardian relationships
  </Card>

  <Card title="Accounts & Subscribers" icon="users" href="/api-reference/accounts">
    Create and manage accounts, subscribers, aggregators, and distributors
  </Card>
</CardGroup>

***

## Need Help?

<CardGroup cols={2}>
  <Card title="Quick Start Guide" icon="rocket" href="/quick-start-guide">
    Step-by-step authentication and first API call
  </Card>

  <Card title="API Portal" icon="globe" href="https://api.telegent.com">
    Access the API management console
  </Card>

  <Card icon="life-ring" href="https://support.telegent.com/support/home" title="Support">
    Visit our support portal for help and resources
  </Card>
</CardGroup>