Skip to main content

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.

Goal: Walk the partner through every Intelligent API section in dependency order. By the end, the partner has built their own number end-to-end on dev.
Work the sections in order. Each one depends on the previous: you can’t create a Subscription without a Subscriber, a Number, and a Package; you can’t provision a Number without Routes. Skip optional sections (Voice, Data) if they’re out of scope.

​
Checklist

​
Intelligent Accounts — Child Accounts Under the Distributor

Skip if operating under a single account.
#TaskOwnerID to Save
1Partner creates a child Account under their Distributor via the API.PartnerAID-...

​
Intelligent Products — SKUs That Will Be Billed

#TaskOwnerID to Save
2Partner creates one or more Products via POST /v1.0/products.PartnerPID-...

​
Intelligent Packages — Bundle Products into Priced Offerings

#TaskOwnerID to Save
3Partner creates a Package bundling one or more Products via POST /v1.0/packages.PartnerPKID-...

​
Intelligent Routes — Message and Voice Routing Infrastructure

#TaskOwnerID to Save
4Partner creates a Message Route (MRID) via API. First-time setup can be a joint call.PartnerMRID-...
5Partner creates a Voice Route (CRID) via API. For SIP partners, this is a SIP-enabled route pointing to the partner’s SBC. First-time setup can be a joint call.PartnerCRID-...

​
Intelligent Subscribers — The End-User Record

#TaskOwnerID to Save
6Partner creates a Subscriber via POST /v1.0/subscribers.PartnerTSUID-...

​
Intelligent Mobile Numbers — Number Provisioning and Lifecycle

#TaskOwnerID to Save
7Partner provisions a test number via POST /v1.0/numbers/provision.PartnerTNID-...
8Partner tests number status changes (suspend / restore / deactivate / reactivate) via /v1.0/numbers/status.Partner—

​
Intelligent Port-In — Full Lifecycle (if porting is in scope)

#TaskOwnerNotes
8aEligibility checked via POST /v1.0/numbers/portin/eligibility before collecting any subscriber details.PartnerConfirm number is portable to target classification
8bPort-in submitted via POST /v1.0/numbers/portin after LOA signed and current-carrier details confirmed.PartnerSave OrderId (JNUOID-…) from the response
8cPort-in update tested via POST /v1.0/numbers/portin/update using the OrderId — simulate a carrier rejection correction.PartnerTest PortInDate for wireline scenarios
8dPort-in cancel tested via POST /v1.0/numbers/portin/cancel using the OrderId.PartnerConfirm cancel is final — a fresh submit is required to retry
8eOrder status monitored via GET /v1.0/numbers/order?OrderId=… and partner can read all statuses (Submitted, Pending Carrier Approval, Scheduled, Completed, Rejected, Cancelled).Partner—

​
Intelligent Port-Out — PIN Issuance (if porting out is in scope)

#TaskOwnerNotes
8fPort-out PIN issued via POST /v1.0/numbers/portout for a test number.PartnerConfirm PIN reaches the gaining carrier simulation
#TaskOwnerID to Save
9Partner creates a Subscription via POST /v1.0/subscriptions referencing SubscriberId, TNID, ICCID, and PackageId.PartnerSUB-...

​
Intelligent Messaging — SMS and MMS Round-Trip

#TaskOwnerNotes
10Outbound SMS sent via /v1.0/message/outbound and DLR received on partner webhook.PartnerPath is singular: message
11Inbound SMS received on partner webhook with correct JSON schema.Partner—
12Outbound and inbound MMS tested with MMS_Media_URL populated. (If MMS in scope.)Partner—

​
Intelligent Voice — Call Placement and Receipt

Skip if voice is not in scope.
#TaskOwnerNotes
13Partner numbers assigned to the correct Voice Route via API (SIP-enabled route for SIP partners). Allow up to 10 minutes for propagation.Partner—
14OPTIONS keepalive confirmed both directions. (SIP partners only.)Joint—
15Outbound call placed from the test number and connected. SIP partners verify it lands on their SBC.Partner—
16Inbound call received on the test number. SIP partners verify the Request-URI and headers match the agreed format.Partner—

​
Intelligent Data — Data Attach and Session

Skip if data is not in scope.
#TaskOwnerNotes
17Data session attached on the assigned APN (e.g., iot.joonto for IoT, wireless.mobi for MVNO).Partner—

​
CDRs — Call Detail Records

#TaskOwnerNotes
18Sample CDR delivered (via configured method: webhook / email) and parsed by the partner.PartnerVoice + SMS split

​
Sign-off

#TaskOwner
19End-to-end happy path signed off by both teams.Joint
Voice-route propagation: Voice-route changes propagate via a 10-minute automation cycle. For urgent moves during testing, ping Telegent on-call for a manual flip.
Phase complete when: Every relevant Intelligent API category has been tested on dev. The partner can provision, message, and (if applicable) call from a number they created themselves.

Previous: Phase 2 — Connectivity

Webhooks and SIP interconnect

Next: Phase 4 — Production Cutover

Move to production credentials and go live