# Telegent mPaaS - [Partner Onboarding](https://docs.telegent.com/onboarding/index.md): MVNO / IoT / API partner onboarding checklist — from POC kickoff through go-live and first 30 days. - [Discovery & Setup](https://docs.telegent.com/onboarding/discovery.md): Kick off the POC, confirm scope, get the NDA in place, and stand up communication channels. - [Phase 1 — Credentials & Access](https://docs.telegent.com/onboarding/phase-1.md): Get the partner into the dev environment with credentials, documentation access, and a working OAuth token. - [Phase 2 — Connectivity](https://docs.telegent.com/onboarding/phase-2.md): Collect webhook URLs and, for SIP partners, exchange SBC IPs and agree on signaling so the network is ready before testing begins. - [Phase 3 — API Walkthrough & Sandbox Testing](https://docs.telegent.com/onboarding/phase-3.md): Walk through every Intelligent API section in dependency order. By the end, the partner has built their own number end-to-end on dev. - [Phase 4 — Production Cutover](https://docs.telegent.com/onboarding/phase-4.md): Move the partner to production credentials, provision the first live number, and confirm monitoring is in place. - [Phase 5 — Post-launch](https://docs.telegent.com/onboarding/phase-5.md): Stabilize, confirm CDRs and billing are accurate, and capture anything to fix in the first 30 days. - [Conditional Add-ons](https://docs.telegent.com/onboarding/add-ons.md): A2P (10DLC), IoT, and Static IP / private APN add-ons — run these alongside the matching phase. - [API Reference](https://docs.telegent.com/api-reference/introduction.md) - [Generate API Token](https://docs.telegent.com/api-reference/oauth2/generate-api-token.md): Authenticates your account credentials and returns a Bearer token required for all subsequent API requests. Include this token in the `Authorization: Bearer ` header on every call. Tokens expire and must be refreshed. Use the optional `ApiEndpoint` field to scope a token to a specific endpoin… - [Search Available Numbers](https://docs.telegent.com/api-reference/numbers/search-available-numbers.md): Search for available phone numbers before provisioning. Filter by area code or zip code, required capabilities (voice, SMS/MMS), and message type. Returns a paginated list of matching numbers. Run this step first to confirm number availability in your target area before calling the Number Provision… - [Number Provision (Purchase/Order)](https://docs.telegent.com/api-reference/numbers/number-provision-purchaseorder.md): > **Rate limit:** This endpoint is limited to **1 request per second**, separate from the API-wide 120 requests/minute limit. Exceeding it returns HTTP `429 Too Many Requests`. - [Numbers - Get E911 Address](https://docs.telegent.com/api-reference/numbers/numbers--get-e911-address.md): Retrieve the E911 emergency address registered to a specific phone number. Returns the street address on file that will be dispatched to emergency services when a 911 call is placed from this number. - [Numbers - Update E911 Address](https://docs.telegent.com/api-reference/numbers/numbers--update-e911-address.md): Register or update the E911 emergency address for a phone number. This address is provided to emergency services when a 911 call is placed from the specified number. Ensure the address is accurate and matches a valid MSAG (Master Street Address Guide) location. - [Numbers - Port In](https://docs.telegent.com/api-reference/numbers/numbers--port-in.md): > **Rate limit:** This endpoint is limited to **1 request per second**, separate from the API-wide 120 requests/minute limit. Exceeding it returns HTTP `429 Too Many Requests`. - [Numbers - Port In Eligibility](https://docs.telegent.com/api-reference/numbers/numbers--port-in-eligibility.md): Check if a phone number is eligible for port-in before submitting a full port request. Returns carrier information and eligibility status. - [Numbers - Update Port In](https://docs.telegent.com/api-reference/numbers/numbers--update-port-in.md): Update an existing port-in order with new information such as carrier details, account credentials, or billing address before the port completes. - [Numbers - Cancel Port In](https://docs.telegent.com/api-reference/numbers/numbers--cancel-port-in.md): Cancel an existing port-in request using the order ID. This endpoint allows you to cancel a pending port-in order before it is completed. - [Numbers - Refresh NNID](https://docs.telegent.com/api-reference/numbers/numbers--refresh-nnid.md): Refresh the Network Number Identifier (NNID) for a phone number. Use this when a number’s NNID becomes stale or needs to be re-synchronized with the carrier network. - [Numbers - Port Out](https://docs.telegent.com/api-reference/numbers/numbers--port-out.md): Assign a Port Out PIN to a phone number on your Telegent account. The PIN you set here is the PIN you will be required to provide when you later initiate a port-out transfer to another carrier. - [Order ID Details](https://docs.telegent.com/api-reference/numbers/order-id-details.md): Retrieve detailed information about a number provisioning order using the order ID. Returns order status, requested numbers, provisioning results, and any error messages. - [Numbers Inventory](https://docs.telegent.com/api-reference/numbers/numbers-inventory.md): Retrieve a paginated list of all phone numbers currently provisioned in your account. Filter by number type, capabilities, and status. Includes detailed information about each number's configuration and services. - [Number Details](https://docs.telegent.com/api-reference/numbers/number-details.md): Get comprehensive details for a specific phone number including its capabilities (voice, SMS, MMS, data), message routes, voice routes, classification, and current configuration. - [Numbers Update](https://docs.telegent.com/api-reference/numbers/numbers-update.md): Update configuration settings for one or more phone numbers. Modify message routes, voice routes, capabilities, and other number attributes. Changes take effect immediately. - [Numbers Status](https://docs.telegent.com/api-reference/numbers/numbers-status.md): > **Swap limit:** A number can only be swapped **twice every 120 days**. Additional `Swap` requests for the same number within that rolling window will be rejected. - [Data Usage Limit](https://docs.telegent.com/api-reference/numbers/data-usage-limit.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Provisioned number ID (NID) with `DataEnabled: true` — `POST /v1.0/numbers/provision` - [Data Usage Settings](https://docs.telegent.com/api-reference/numbers/data-usage-settings.md): Retrieve the current data usage settings (notify value, throttle value, limit value) for one or more phone numbers. - [Data Usage Info](https://docs.telegent.com/api-reference/numbers/data-usage-info.md): Retrieve real-time data usage information for one or more phone numbers, including amount used, remaining data, and current behavior (active, throttled, etc.). - [Device Details](https://docs.telegent.com/api-reference/numbers/device-details.md): Retrieve IoT device details associated with a phone number, including IMEI, device model, device name, and TAC. AccountId is required for Distributors managing multiple accounts. - [Device Unlock Status](https://docs.telegent.com/api-reference/numbers/device-unlock-status.md): Check the carrier unlock status of a device by IMEI or by phone number. Works for any IMEI, including devices on other carriers that have never been provisioned on the Telegent network. - [Data Usage Update Renewal Info](https://docs.telegent.com/api-reference/numbers/data-usage-update-renewal-info.md): Configure the monthly or weekly data usage renewal cycle for one or more phone numbers. Use this endpoint to set the day usage resets, enable or disable auto-renew, and optionally zero out current usage immediately. - [Numbers - Reactivate](https://docs.telegent.com/api-reference/numbers/numbers--reactivate.md): > **Reactivation window:** A cancelled number is eligible for reactivation for **24 hours** after cancellation. - [Update roaming settings of a number](https://docs.telegent.com/api-reference/numbers/update-roaming-settings-of-a-number.md): Enable or disable international roaming on a provisioned phone number. Use this to allow a subscriber's device to register on partner networks outside their home country, or to disable roaming to prevent unexpected usage charges. - [Numbers - Update MMS Settings](https://docs.telegent.com/api-reference/numbers/numbers--update-mms-settings.md): Enable or disable MMS (multimedia messaging) on a provisioned phone number. Use this to turn picture, video and group messaging on for a line, or to disable it while leaving SMS in place. - [Get Voicemail Info](https://docs.telegent.com/api-reference/voicemail/get-voicemail-info.md): Retrieve current voicemail settings and configuration details for a specific phone number, including PIN status, notification email, and account association. - [Activate Voicemail](https://docs.telegent.com/api-reference/voicemail/activate-voicemail.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Provisioned phone number — `POST /v1.0/numbers/provision` - [Update Voicemail](https://docs.telegent.com/api-reference/voicemail/update-voicemail.md): Update voicemail settings for a phone number including PIN, notification email, and subscriber name details. - [Delete Voicemail](https://docs.telegent.com/api-reference/voicemail/delete-voicemail.md): Remove voicemail configuration from a phone number. After deletion, the number will no longer have voicemail enabled and unanswered calls will not be captured. - [Message Route Details](https://docs.telegent.com/api-reference/message/message-route-details.md): Retrieve detailed configuration for a specific message route using its MRID. Returns webhook URLs, HTTP methods, timeout settings, and associated phone numbers. - [Create Message Route](https://docs.telegent.com/api-reference/message/create-message-route.md): Create a new message route to configure how inbound SMS/MMS messages are handled. Specify webhook URLs for message delivery, fallback URLs, and HTTP methods. Each route is identified by a unique MRID (Message Route ID). - [Update Message Route](https://docs.telegent.com/api-reference/message/update-message-route.md): Update an existing message route's configuration including webhook URLs, HTTP methods, and timeout settings. Changes apply immediately to all numbers using this route. - [Send Outbound Message](https://docs.telegent.com/api-reference/message/send-outbound-message.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Provisioned phone number with messaging enabled (`From` field) — `POST /v1.0/numbers/provision` - [Filter Messages](https://docs.telegent.com/api-reference/message/filter-messages.md): Retrieve messages filtered by phone number with pagination support. Returns a list of inbound and outbound messages for a specific number. - [Delete Message Route](https://docs.telegent.com/api-reference/message/delete-message-route.md): Permanently delete a message route from your account. Phone numbers using this route will need to be reassigned to a different route before deletion. This action cannot be undone. - [Report Device Delivery](https://docs.telegent.com/api-reference/message/report-device-delivery.md): Submit a device-level delivery confirmation for an outbound message. This endpoint is used to record whether a specific message was successfully delivered to the recipient's handset, beyond carrier-level delivery receipts. Provide the MessageId returned from the Send Outbound Message endpoint. - [List Message Routes](https://docs.telegent.com/api-reference/accounts/list-message-routes.md): Retrieve a list of all message routes configured in your account. Returns basic information about each route including MRID, name, and webhook configuration. - [List Voice Routes](https://docs.telegent.com/api-reference/accounts/list-voice-routes.md): Retrieve a list of all voice routes configured in your account. Returns basic information about each route including CRID, name, and routing configuration. - [Get Services](https://docs.telegent.com/api-reference/accounts/get-services.md): Retrieve a list of all services available in your account. Use the optional Filter parameter to filter by service status (e.g., Active, Inactive). - [Get Products](https://docs.telegent.com/api-reference/accounts/get-products.md): Retrieve a list of all products available in your account. Use the optional Filter parameter to filter by product status (e.g., Active, All). - [Get Packages](https://docs.telegent.com/api-reference/accounts/get-packages.md): Retrieve a list of all packages available in your account. Use the optional Filter parameter to filter by package status (e.g., Active, Inactive). - [Get Subscriptions](https://docs.telegent.com/api-reference/accounts/get-subscriptions.md): Retrieve a list of all subscriptions associated with your account. Use the optional Filter parameter to filter by subscription status (e.g., Active, Inactive). - [Get Account's Workgroups](https://docs.telegent.com/api-reference/accounts/get-accounts-workgroups.md): Retrieve all workgroups associated with the authenticated account. Returns a list of workgroups with their IDs, names, and configuration status. - [Get Account Details](https://docs.telegent.com/api-reference/accounts/get-account-details.md): Retrieve details for a specific account. Accounts sit below a distributor in the hierarchy and contain subscribers along with their associated phone numbers and services. Returns the account name, total subscriber count, address details, and the parent distributor reference. - [Create New Account](https://docs.telegent.com/api-reference/accounts/create-new-account.md): Create a new account with administrator email, billing, and mailing address information. Returns the newly created account details. - [Update Account](https://docs.telegent.com/api-reference/accounts/update-account.md): Update an existing account's information including name and address details. - [Get Account Schedules](https://docs.telegent.com/api-reference/accounts/get-account-schedules.md): Retrieve a list of all schedules configured for your account. - [Get Account Webhooks](https://docs.telegent.com/api-reference/accounts/get-account-webhooks.md): Retrieves all webhooks configured on the specified account, including their target URLs, HTTP methods, authentication settings, subscribed event types, and active status. Use this to audit webhook configuration or to locate a specific `WebhookId` for updates or deletion. - [Get Voice Route Details](https://docs.telegent.com/api-reference/voice/get-voice-route-details.md): Retrieve detailed configuration for a specific voice route using its CRID. Returns SIP trunk configuration, forwarding rules, IVR settings, workgroup assignments, and schedule information. - [Create Voice Route](https://docs.telegent.com/api-reference/voice/create-voice-route.md): Create a new voice route to define how inbound calls are handled for numbers assigned to it. Routes support SIP trunk termination, webhook-based IVR, forwarding, and workgroup distribution. Each route returns a unique CRID (Call Route ID) used when provisioning or updating numbers. Workgroups and Sc… - [Update Voice Route](https://docs.telegent.com/api-reference/voice/update-voice-route.md): Update an existing voice route's configuration including SIP trunk settings, forwarding numbers, IVR menus, and workgroup assignments. Changes apply immediately to all numbers using this route. - [Delete Voice Route](https://docs.telegent.com/api-reference/voice/delete-voice-route.md): Permanently delete a voice route from your account. Phone numbers using this route will need to be reassigned to a different route before deletion. This action cannot be undone. - [Get Service Details](https://docs.telegent.com/api-reference/services/get-service-details.md): Retrieve detailed information about a specific service by its ServiceId. Returns service name, cost, billing frequency, and status. - [Create Service](https://docs.telegent.com/api-reference/services/create-service.md): Create a new service with a name, cost, and billing frequency. Services can be added to packages and assigned to subscribers. - [Update Service](https://docs.telegent.com/api-reference/services/update-service.md): Update an existing service's name, cost, or billing cycle. Changes take effect immediately and are reflected across all packages and subscriptions that include this service. Use the ServiceId returned when the service was created. - [Delete Service](https://docs.telegent.com/api-reference/services/delete-service.md): Permanently delete a service by its ServiceId. This action cannot be undone. - [Get Service Items](https://docs.telegent.com/api-reference/services/get-service-items.md): Retrieve the items (pricing tiers or components) associated with a specific service. Pass the ServiceId to get its configured items. - [Add Service Item](https://docs.telegent.com/api-reference/services/add-service-item.md): Add a new pricing item or component to an existing service. Service items define the cost and billing frequency (monthly or one-time) for the service at a specific distributor or aggregator level. - [Update Service Item](https://docs.telegent.com/api-reference/services/update-service-item.md): Update an existing service item's pricing or billing configuration. - [Delete Service Item](https://docs.telegent.com/api-reference/services/delete-service-item.md): Remove a service item from a service. - [Update SIM Status](https://docs.telegent.com/api-reference/sims/update-sim-status.md): Update the status of a SIM card using its ICCID. Use this to activate, suspend, or change the state of a physical or eSIM card in the network. - [Clear SIM Status](https://docs.telegent.com/api-reference/sims/clear-sim-status.md): Reset a SIM card's status to Empty, effectively unassigning it from any active number or subscriber. Useful when decommissioning a SIM before reassigning it. - [Product Details](https://docs.telegent.com/api-reference/products/product-details.md): Retrieve detailed information about a specific product by its ProductId. Returns SKU, description, type, cost, and billing frequency. - [Create Product](https://docs.telegent.com/api-reference/products/create-product.md): Create a new product with SKU, description, type, cost, and billing frequency. Products can be bundled into packages for subscriber offerings. - [Update Product](https://docs.telegent.com/api-reference/products/update-product.md): Update an existing product's SKU, description, type, cost, or billing cycle. Changes apply immediately and are reflected across all packages that include this product. Use the ProductId (PID-) returned when the product was created. - [Delete Product](https://docs.telegent.com/api-reference/products/delete-product.md): Permanently delete a product by its ProductId. This action cannot be undone. - [Get Package Details](https://docs.telegent.com/api-reference/packages/get-package-details.md): Retrieve detailed information about a specific package by its PackageId. Returns package name, type, price, billing frequency, and associated distributor information. - [Create Package](https://docs.telegent.com/api-reference/packages/create-package.md): Create a new package with name, description, type, price, and billing frequency. Packages bundle products together for subscriber offerings. - [Get Package Subscriptions](https://docs.telegent.com/api-reference/packages/get-package-subscriptions.md): Retrieve all subscriptions associated with a specific package. Returns subscriber details and subscription status for each subscription linked to the package. - [Update Package](https://docs.telegent.com/api-reference/packages/update-package.md): Update an existing package's name, description, type, price, or billing cycle. Changes apply immediately and affect all active subscriptions tied to this package. Use the PackageId (PID-) returned when the package was created. - [Delete Package](https://docs.telegent.com/api-reference/packages/delete-package.md): Permanently delete a package by its PackageId. This action cannot be undone. - [Get Package Items](https://docs.telegent.com/api-reference/packages/get-package-items.md): Retrieve all items (products) included in a specific package. Returns product details, pricing, and billing information for each item in the package. - [Add Package Item](https://docs.telegent.com/api-reference/packages/add-package-item.md): Add a product to an existing package. Specify the package, product, price, and billing frequency for the item. - [Update Package Item](https://docs.telegent.com/api-reference/packages/update-package-item.md): Update an existing item within a package. Modify price, type, or billing frequency for the package item. - [Delete Package Item](https://docs.telegent.com/api-reference/packages/delete-package-item.md): Remove an item from a package. This removes the product association from the package but does not delete the product itself. - [Get Subscription Details](https://docs.telegent.com/api-reference/subscriptions/get-subscription-details.md): Retrieve detailed information about a specific subscription by its SubscriptionId. Returns subscriber, package, phone number, and status information. - [Create Subscription](https://docs.telegent.com/api-reference/subscriptions/create-subscription.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Package ID (PID) — `POST /v1.0/packages` - **Required:** Subscriber ID (TSUID) — `POST /v1.0/subscribers/create` - [Update Subscription](https://docs.telegent.com/api-reference/subscriptions/update-subscription.md): Update an existing subscription's information including subscriber, package, phone number, or SIM card associations. - [Delete Subscription](https://docs.telegent.com/api-reference/subscriptions/delete-subscription.md): Permanently delete a subscription by its SubscriptionId. This removes the subscriber's access to the associated package. - [Get Threshold](https://docs.telegent.com/api-reference/subscriptions/get-threshold.md): Retrieve the details of a specific usage threshold by its `ThresholdId`. Thresholds define a resource limit (data, SMS, or voice) and the action to take when that limit is reached. - [Create Threshold](https://docs.telegent.com/api-reference/subscriptions/create-threshold.md): Create a new usage threshold that can be assigned to subscriptions. A threshold specifies a resource type, a trigger amount, and the action to take when that amount is reached — such as sending an alert or pausing service. - [Update Threshold](https://docs.telegent.com/api-reference/subscriptions/update-threshold.md): Update the configuration of an existing threshold. Only the fields you include in the request body are changed; omitted fields retain their current values. - [Delete Threshold](https://docs.telegent.com/api-reference/subscriptions/delete-threshold.md): Permanently delete a threshold by its `ThresholdId`. Deleting a threshold also removes all of its assignments from associated subscriptions. - [Get Threshold Assignments](https://docs.telegent.com/api-reference/subscriptions/get-threshold-assignments.md): Retrieve all assignments for a given threshold. Each assignment links a threshold to a subscription, enabling the threshold to trigger on that subscription's usage. - [Create Threshold Assignment](https://docs.telegent.com/api-reference/subscriptions/create-threshold-assignment.md): Assign an existing threshold to a subscription. Once assigned, the threshold monitors that subscription's resource usage and fires its configured action when the limit is reached. - [Update Threshold Assignment](https://docs.telegent.com/api-reference/subscriptions/update-threshold-assignment.md): Update an existing threshold assignment — for example, to re-point it to a different subscription or threshold. Only included fields are changed. - [Delete Threshold Assignment](https://docs.telegent.com/api-reference/subscriptions/delete-threshold-assignment.md): Remove a threshold assignment by its `ThresholdAssignmentId`. This unlinks the threshold from the associated subscription; the threshold itself is not deleted. - [Get Feature](https://docs.telegent.com/api-reference/subscriptions/get-feature.md): Retrieve the details of a specific feature by its `FeatureId`. Features represent add-on capabilities (such as roaming, VoIP, or data boosters) that can be assigned to subscriptions. - [Create Feature](https://docs.telegent.com/api-reference/subscriptions/create-feature.md): Create a new feature that can be assigned to subscriptions. Features represent optional add-on capabilities such as international roaming, VoIP, SMS bundles, or data speed tiers. - [Update Feature](https://docs.telegent.com/api-reference/subscriptions/update-feature.md): Update the details of an existing feature. Only the fields you include in the request body are changed; omitted fields retain their current values. - [Delete Feature](https://docs.telegent.com/api-reference/subscriptions/delete-feature.md): Permanently delete a feature by its `FeatureId`. Deleting a feature also removes all of its assignments from associated subscriptions. - [Get Feature Assignments](https://docs.telegent.com/api-reference/subscriptions/get-feature-assignments.md): Retrieve all assignments for a given feature. Each assignment links a feature to a subscription, enabling that subscription to use the feature's capability. - [Create Feature Assignment](https://docs.telegent.com/api-reference/subscriptions/create-feature-assignment.md): Assign an existing feature to a subscription, enabling that subscription to use the feature's capability. - [Update Feature Assignment](https://docs.telegent.com/api-reference/subscriptions/update-feature-assignment.md): Update an existing feature assignment — for example, to re-point it to a different subscription or feature. Only included fields are changed. - [Delete Feature Assignment](https://docs.telegent.com/api-reference/subscriptions/delete-feature-assignment.md): Remove a feature assignment by its `FeatureAssignmentId`. This unlinks the feature from the associated subscription; the feature itself is not deleted. - [Get Accounts](https://docs.telegent.com/api-reference/distributors/get-accounts.md): Retrieve a list of all accounts associated with the distributor. Returns account information including name, total subscribers, and address details. - [Get Subscribers](https://docs.telegent.com/api-reference/distributors/get-subscribers.md): Retrieve a paginated list of all subscribers under the distributor. Returns subscriber details including ID, name, email, phone numbers, role, and associated account information. - [Get Distributor Details](https://docs.telegent.com/api-reference/distributors/get-distributor-details.md): Retrieve details for a distributor account. Distributors sit at the top of the account hierarchy and can create and manage multiple sub-accounts (AID-) and their subscribers. Returns the distributor's account key (DID-), secret, total accounts managed, and address information. - [Create Distributor](https://docs.telegent.com/api-reference/distributors/create-distributor.md): Create a new distributor with billing and mailing address information. Returns the newly created distributor details including account key and secret. - [Update Distributor](https://docs.telegent.com/api-reference/distributors/update-distributor.md): Update an existing distributor's information including name and address details. - [Get Distributor Product List](https://docs.telegent.com/api-reference/distributors/get-distributor-product-list.md): Retrieve the list of products associated with the distributor. Filter by status (All, Active, Inactive). - [Get Distributor Package List](https://docs.telegent.com/api-reference/distributors/get-distributor-package-list.md): Retrieve the list of packages associated with the distributor. Filter by status (All, Active, Inactive). - [Get Distributor Subscription List](https://docs.telegent.com/api-reference/distributors/get-distributor-subscription-list.md): Retrieve the list of subscriptions associated with the distributor. Filter by status (All, Active, Inactive). - [Get Subscriber Details](https://docs.telegent.com/api-reference/subscribers/get-subscriber-details.md): Retrieve detailed information about a specific subscriber including name, email, phone numbers, role, and associated account details. - [Create Subscriber](https://docs.telegent.com/api-reference/subscribers/create-subscriber.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Account ID (AID) — provided by your Telegent representative - [Update Subscriber](https://docs.telegent.com/api-reference/subscribers/update-subscriber.md): Update an existing subscriber's information including name, phone numbers, role, and password. - [Transfer Subscriber](https://docs.telegent.com/api-reference/subscribers/transfer-subscriber.md): Transfer a subscriber from one account to another. Requires both origin and destination account IDs. - [Get Message Filters](https://docs.telegent.com/api-reference/subscribers/get-message-filters.md): List the message filters configured on a subscriber or phone number. - [Create Message Filter](https://docs.telegent.com/api-reference/subscribers/create-message-filter.md): Create a new message filter that controls what messages a subscriber can send and receive. - [Update Message Filter](https://docs.telegent.com/api-reference/subscribers/update-message-filter.md): Modify an existing message filter without deleting and recreating it. - [Delete Message Filter](https://docs.telegent.com/api-reference/subscribers/delete-message-filter.md): Permanently remove a message filter from a subscriber. - [Get Allowed Contacts](https://docs.telegent.com/api-reference/subscribers/get-allowed-contacts.md): View the list of phone numbers that bypass content filtering on a message filter. - [Add Allowed Contacts](https://docs.telegent.com/api-reference/subscribers/add-allowed-contacts.md): Add trusted phone numbers that bypass message filtering. - [Remove Allowed Contacts](https://docs.telegent.com/api-reference/subscribers/remove-allowed-contacts.md): Remove phone numbers from the allowed contacts list. - [Get Blocked Contacts](https://docs.telegent.com/api-reference/subscribers/get-blocked-contacts.md): View the list of phone numbers blocked from messaging a subscriber. - [Add Blocked Contacts](https://docs.telegent.com/api-reference/subscribers/add-blocked-contacts.md): Block phone numbers from messaging a subscriber. - [Remove Blocked Contacts](https://docs.telegent.com/api-reference/subscribers/remove-blocked-contacts.md): Unblock phone numbers so their messages start being delivered again. - [Get Message Filter Keywords](https://docs.telegent.com/api-reference/subscribers/get-message-filter-keywords.md): View the keyword rules attached to a message filter. - [Get Guardian Features](https://docs.telegent.com/api-reference/subscribers/get-guardian-features.md): Check whether AI Guardian is currently enabled for a subscriber. - [Configure Guardian Features](https://docs.telegent.com/api-reference/subscribers/configure-guardian-features.md): Enable or disable AI Guardian on a subscriber. This is the **first step** for every Guardian workflow — filters, keyword rules, and parent/child relationships will not function until Guardian is enabled here. - [Create Guardian Relation](https://docs.telegent.com/api-reference/subscribers/create-guardian-relation.md): Link a parent (guardian) subscriber to a child subscriber so the parent can supervise the child's communications. - [Get Guardian Relation Parent](https://docs.telegent.com/api-reference/subscribers/get-guardian-relation-parent.md): List every child subscriber that a parent is currently linked to. - [Get Guardian Relation Child](https://docs.telegent.com/api-reference/subscribers/get-guardian-relation-child.md): List every parent (guardian) linked to a specific child subscriber. - [Remove Guardian Relation](https://docs.telegent.com/api-reference/subscribers/remove-guardian-relation.md): Unlink a parent (guardian) from a child subscriber. - [Get Call Filters](https://docs.telegent.com/api-reference/subscribers/get-call-filters.md): List the call filters configured on a subscriber or phone number. - [Create Call Filter](https://docs.telegent.com/api-reference/subscribers/create-call-filter.md): Create a new call filter that controls who can place or receive calls for a subscriber. - [Update Call Filter](https://docs.telegent.com/api-reference/subscribers/update-call-filter.md): Modify an existing call filter without deleting and recreating it. - [Delete Call Filter](https://docs.telegent.com/api-reference/subscribers/delete-call-filter.md): Permanently remove a call filter from a subscriber. - [Get Allowed Numbers](https://docs.telegent.com/api-reference/subscribers/get-allowed-numbers.md): View the list of phone numbers allowed to call a subscriber. - [Add Allowed Numbers](https://docs.telegent.com/api-reference/subscribers/add-allowed-numbers.md): Add trusted phone numbers that are allowed to call a subscriber. - [Remove Allowed Numbers](https://docs.telegent.com/api-reference/subscribers/remove-allowed-numbers.md): Remove phone numbers from the allowed callers list. - [Get Blocked Numbers](https://docs.telegent.com/api-reference/subscribers/get-blocked-numbers.md): View the list of phone numbers blocked from calling a subscriber. - [Add Blocked Numbers](https://docs.telegent.com/api-reference/subscribers/add-blocked-numbers.md): Block phone numbers from calling a subscriber. - [Remove Blocked Numbers](https://docs.telegent.com/api-reference/subscribers/remove-blocked-numbers.md): Unblock phone numbers so they can call the subscriber again. - [Get Call Filter Keywords](https://docs.telegent.com/api-reference/subscribers/get-call-filter-keywords.md): View the keyword monitoring rules attached to a call filter. - [Get Workgroup Details](https://docs.telegent.com/api-reference/workgroups/get-workgroup-details.md): Retrieve configuration details for a specific workgroup by its WorkgroupId. Returns the workgroup's name, type, members, schedule, and routing settings. - [Create Workgroup](https://docs.telegent.com/api-reference/workgroups/create-workgroup.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Voice Route ID (CRID) — `POST /v1.0/voice/routes` - [Update Workgroup](https://docs.telegent.com/api-reference/workgroups/update-workgroup.md): Update an existing workgroup configuration. Requires the WorkgroupId of the workgroup to modify. - [Create Workgroup Activity](https://docs.telegent.com/api-reference/workgroups/create-workgroup-activity.md): Add a member (user or nested workgroup) to an existing workgroup. Each activity defines how calls are distributed to that member including their position (DigitOrder) and notification preferences. - [Update Workgroup Activity](https://docs.telegent.com/api-reference/workgroups/update-workgroup-activity.md): Update the configuration of a member within a workgroup. A workgroup activity represents an individual agent, destination, or nested workgroup within a ring group. Modify fields such as dial order (DigitOrder), forwarding number, or notification preferences. Requires the WorkgroupActivityId (WAID-)… - [Delete Workgroup Activity](https://docs.telegent.com/api-reference/workgroups/delete-workgroup-activity.md): Remove a member activity from a workgroup. The workgroup itself is not deleted. - [Delete Workgroup](https://docs.telegent.com/api-reference/workgroups/delete-workgroup.md): Permanently remove a workgroup. Before deleting, ensure the workgroup is not assigned to any active voice routes or numbers. - [Get Webhook](https://docs.telegent.com/api-reference/webhooks/get-webhook.md): Retrieves the full configuration of a single webhook by its `WebhookId`, including the target URL, HTTP method, data format, authentication details, and subscribed events. Use this to inspect or audit an existing webhook before updating or deleting it. - [Create Webhook](https://docs.telegent.com/api-reference/webhooks/create-webhook.md): Register a webhook endpoint to receive event notifications from your Telegent account. Use this to subscribe to events such as order updates, message status changes, or other platform activity, with optional Basic or Token authentication for callback security. - [Update Webhook](https://docs.telegent.com/api-reference/webhooks/update-webhook.md): Update the configuration of an existing webhook, including its destination URL, HTTP method, authentication credentials, and the list of subscribed events. Use this to rotate credentials, change the callback endpoint, or modify which events trigger notifications without recreating the webhook. - [Delete Webhook](https://docs.telegent.com/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook subscription, stopping all future event deliveries to its configured URL. Use this to remove webhooks that are no longer needed or to clean up obsolete event subscriptions on an account. - [Health Status](https://docs.telegent.com/api-reference/health-status/health-status.md): Check that the Telegent platform and its upstream dependencies are reachable. Use this as a pre-flight check before a batch of provisioning calls, or as the target for an uptime monitor. - [MVNO Guide Overview](https://docs.telegent.com/resources/index.md): A clean, end-to-end flow for provisioning subscribers, numbers, packages, data limits, and AI Guardian. - [Comprehensive Reference](https://docs.telegent.com/resources/reference.md): Full request/response payloads, field tables, and gotchas for all 10 API sections. - [Appendix](https://docs.telegent.com/resources/appendix.md): ID glossary and common error reference for the Telegent API. - [Elastic SIP Trunk Documentation](https://docs.telegent.com/resources/sip-documentation.md): Use-case samples, PCAP snippets, and a reference guide for SIP INVITEs and expected header-handling behavior when interworking T-Mobile, Joonto SBC/OpenSIPS, and UC partners. - [Changelog](https://docs.telegent.com/changelog/index.md): A complete record of all updates, enhancements, and bug fixes to the Telegent mPaaS API. - [v1.2.0.1](https://docs.telegent.com/changelog/v1-2-0-1.md): Forwarding number and per-line MMS state now returned on the Numbers endpoints. - [v1.2.0](https://docs.telegent.com/changelog/v1-2-0.md): Per-line MMS control and a new platform health check endpoint. - [v1.1.3](https://docs.telegent.com/changelog/v1-1-3.md): Device unlock status lookup added for any IMEI. - [v1.1.2](https://docs.telegent.com/changelog/v1-1-2.md): Number swap functionality is now live; swap limit documented on the Numbers Status endpoint. - [v1.1.1](https://docs.telegent.com/changelog/v1-1-1.md): E911 address management added with two new endpoints. - [v1.1.0](https://docs.telegent.com/changelog/v1-1-0.md): Webhook management, number reactivation, and documentation improvements across 58 endpoints. - [v1.0.2.3](https://docs.telegent.com/changelog/v1-0-2-3.md): Response payloads added throughout Best Practices and expanded number provisioning guidance. - [v1.0.2.2](https://docs.telegent.com/changelog/v1-0-2-2.md): Dedicated Postman Collection tab added with download button and import guide. - [v1.0.2.1](https://docs.telegent.com/changelog/v1-0-2-1.md): Port-in expanded to a full 5-step lifecycle, new port-out section, and onboarding checklist updated to match. - [v1.0.2](https://docs.telegent.com/changelog/v1-0-2.md): New Best Practices and Onboarding tabs added to the developer portal, replacing the Quick Start Guide. - [v1.0.1.1](https://docs.telegent.com/changelog/v1-0-1-1.md): New data usage renewal endpoint, port-in and voicemail updates, data usage default note, OAuth2 path correction, and portal improvements. - [v1.0.1](https://docs.telegent.com/changelog/v1-0-1.md): API documentation overhaul, endpoint corrections, and removal of deprecated fields. - [v1.0.0](https://docs.telegent.com/changelog/v1-0-0.md): Initial public release of the Telegent mPaaS API. - [Postman Collection](https://docs.telegent.com/postman/index.md): Download the full Telegent mPaaS API collection and start testing in Postman in minutes. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) - [swagger_baseline](/scripts/swagger_baseline.json) ## Optional - [API Portal](https://api.telegent.com)