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.
Overview
This guide is your companion to the Telegent API. It covers the full provisioning lifecycle — from authentication through AI Guardian — written specifically for MVNOs building on the Telegent mPaaS platform.What this guide covers:
- A Quick Start summary of the seven provisioning phases in order
- A deep-dive reference for each phase with request/response payloads, field tables, and gotchas
- An appendix with the full ID glossary and common errors
https://api.telegent.com/v1.0
Full API Reference: docs.telegent.com
Postman: Telegent Core APIs.json (provided by your rep)How to read this guideThe Quick Start below tells you what to do and in what order. The Reference gives you the request and response payloads, field tables, and gotchas for each phase. If you ever see an ID name you don’t recognize (PRID, PID, PIID, MRID, CRID), check the Appendix or docs.telegent.com.
Quick Start Flow
Seven short phases, in order, that take an MVNO from zero to a live, billable subscriber on a Telegent-provisioned number. Each phase links to its deep-dive in the Reference.Phase 1 — Authenticate
Trade your
AccountKey and AccountSecret for a short-lived Bearer token, scoped to a specific endpoint URL.→ Section 1 — AuthenticationPhase 2 — Account
Create the Account. An Account is a family or a business — it sits under a Distributor, which sits under the Aggregator. Every Subscriber and every Number you provision lives under exactly one Account.→ Section 2 — Account
Phase 3 — Subscribers and Roles
Create the Manager and Subscribers under the Account. One Manager per Account is the convention; Subscribers can hold one or many Numbers each. Every Number must be assigned to both an Account and a Subscriber.→ Section 3 — Subscribers and Roles
Phase 4 — Message Route and Voice Route
Set up where SMS lands (MRID) and where calls go (CRID). Numbers cannot be provisioned without a Message Route. Voice Route is required only if you are offering voice.→ Section 4 — Routes
Phase 5 — Products, Packages, Subscriptions
Define what you sell (Products), bundle them into Packages, and tie a Package to a Subscriber with a Subscription. Telegent can pre-load common Products (eSIM, data plans) to get you started — ask your rep.→ Section 6 — Products and Packages
→ Section 7 — Subscriptions
Phase 6 — Provision or Port a Number
Either provision a brand-new mobile, IoT, or VoIP number, or port one in from another carrier. Port-ins are a multi-step lifecycle — eligibility, submit, update, cancel, and monitor — that can stay open for days while the losing carrier responds. When a subscriber leaves, issue a port-out PIN so the gaining carrier can complete the transfer.→ Section 5 — ICCID
→ Section 8 — Provisioning or Porting
Phase 7 — Data Usage and AI Guardian
Set notify, throttle, and hard-limit thresholds per number. Enable AI Guardian per subscriber for allow-list / block-list control on SMS and Voice, plus SMS-only filter levels (CHILD / ADOLESCENT / TEENAGER).→ Section 9 — Data Usage
→ Section 10 — AI Guardian
What’s Next?
Comprehensive Reference
Full request/response payloads, field tables, and gotchas for all 10 sections
Appendix
ID glossary and common error reference
API Reference
Full OpenAPI spec with interactive playground
Partner Onboarding
Step-by-step onboarding plan for new partners