# Telegent mPaaS ## Docs - [Get Packages](https://docs.telegent.com/api-reference/account/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 Products](https://docs.telegent.com/api-reference/account/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 Services](https://docs.telegent.com/api-reference/account/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 Subscriptions](https://docs.telegent.com/api-reference/account/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). - [Add Allowed Contacts](https://docs.telegent.com/api-reference/ai-guardian/add-allowed-contacts.md): Add phone numbers to the allowed contacts list of a message filter. - [Add Allowed Numbers](https://docs.telegent.com/api-reference/ai-guardian/add-allowed-numbers.md): Add phone numbers to the allowed list of a call filter. - [Add Blocked Contacts](https://docs.telegent.com/api-reference/ai-guardian/add-blocked-contacts.md): Add phone numbers to the blocked contacts list of a message filter. - [Add Blocked Numbers](https://docs.telegent.com/api-reference/ai-guardian/add-blocked-numbers.md): Add phone numbers to the blocked list of a call filter. - [Configure Guardian Features](https://docs.telegent.com/api-reference/ai-guardian/configure-guardian-features.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Existing subscriber with a provisioned number — `POST /v1.0/subscribers/create` then `POST /v1.0/numbers/provision` - [Create Call Filter](https://docs.telegent.com/api-reference/ai-guardian/create-call-filter.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Subscriber ID (TSUID) — `POST /v1.0/subscribers/create` - **Required:** Subscriber must have a provisioned number with `VoiceEnabled: true` - [Create Guardian Relation](https://docs.telegent.com/api-reference/ai-guardian/create-guardian-relation.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Parent subscriber ID (TSUID) — `POST /v1.0/subscribers/create` - **Required:** Child subscriber ID (TSUID) — `POST /v1.0/subscribers/create` - [Create Message Filter](https://docs.telegent.com/api-reference/ai-guardian/create-message-filter.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Subscriber ID (TSUID) — `POST /v1.0/subscribers/create` - [Delete Call Filter](https://docs.telegent.com/api-reference/ai-guardian/delete-call-filter.md): Permanently delete a call filter. This action cannot be undone. - [Delete Message Filter](https://docs.telegent.com/api-reference/ai-guardian/delete-message-filter.md): Permanently delete a message filter. This action cannot be undone. The subscriber will no longer have filtering applied. - [Get Allowed Contacts](https://docs.telegent.com/api-reference/ai-guardian/get-allowed-contacts.md): Retrieve the list of allowed contacts for a specific message filter. - [Get Allowed Numbers](https://docs.telegent.com/api-reference/ai-guardian/get-allowed-numbers.md): Retrieve the list of allowed phone numbers for a specific call filter. - [Get Blocked Contacts](https://docs.telegent.com/api-reference/ai-guardian/get-blocked-contacts.md): Retrieve the list of blocked contacts for a specific message filter. - [Get Blocked Numbers](https://docs.telegent.com/api-reference/ai-guardian/get-blocked-numbers.md): Retrieve the list of blocked phone numbers for a specific call filter. - [Get Call Filter Keywords](https://docs.telegent.com/api-reference/ai-guardian/get-call-filter-keywords.md): Retrieve the keyword filter configuration for a specific call filter. - [Get Call Filters](https://docs.telegent.com/api-reference/ai-guardian/get-call-filters.md): Retrieve call filters by subscriber ID or phone number. Returns an array of all configured call filters matching the criteria. - [Get Guardian Features](https://docs.telegent.com/api-reference/ai-guardian/get-guardian-features.md): Retrieve the current AI Guardian feature settings for a subscriber. - [Get Guardian Relation Child](https://docs.telegent.com/api-reference/ai-guardian/get-guardian-relation-child.md): Retrieve all guardians associated with a child subscriber. - [Get Guardian Relation Parent](https://docs.telegent.com/api-reference/ai-guardian/get-guardian-relation-parent.md): Retrieve all children associated with a parent/guardian subscriber. - [Get Message Filter Keywords](https://docs.telegent.com/api-reference/ai-guardian/get-message-filter-keywords.md): Retrieve the keyword filter configuration for a specific message filter. - [Get Message Filters](https://docs.telegent.com/api-reference/ai-guardian/get-message-filters.md): Retrieve message filters by subscriber ID or phone number. Returns an array of all configured filters matching the criteria. - [Remove Allowed Contacts](https://docs.telegent.com/api-reference/ai-guardian/remove-allowed-contacts.md): Remove phone numbers from the allowed contacts list of a message filter. - [Remove Allowed Numbers](https://docs.telegent.com/api-reference/ai-guardian/remove-allowed-numbers.md): Remove phone numbers from the allowed list of a call filter. - [Remove Blocked Contacts](https://docs.telegent.com/api-reference/ai-guardian/remove-blocked-contacts.md): Remove phone numbers from the blocked contacts list of a message filter. - [Remove Blocked Numbers](https://docs.telegent.com/api-reference/ai-guardian/remove-blocked-numbers.md): Remove phone numbers from the blocked list of a call filter. - [Remove Guardian Relation](https://docs.telegent.com/api-reference/ai-guardian/remove-guardian-relation.md): Delete a guardian relationship between a parent and child subscriber. - [Update Call Filter](https://docs.telegent.com/api-reference/ai-guardian/update-call-filter.md): Update an existing call filter configuration. All filter settings can be modified including mode, numbers, transcription, and restrictions. - [Update Message Filter](https://docs.telegent.com/api-reference/ai-guardian/update-message-filter.md): Update an existing message filter configuration. All filter settings can be modified including mode, contacts, keywords, and restrictions. - [Generate API Token](https://docs.telegent.com/api-reference/authentication/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… - [Create New Account](https://docs.telegent.com/api-reference/intelligent-account/create-new-account.md): Create a new account with administrator email, billing, and mailing address information. Returns the newly created account details. - [Get Account Details](https://docs.telegent.com/api-reference/intelligent-account/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. - [Update Account](https://docs.telegent.com/api-reference/intelligent-account/update-account.md): Update an existing account's information including name and address details. - [Create Distributor](https://docs.telegent.com/api-reference/intelligent-distributor/create-distributor.md): Create a new distributor with billing and mailing address information. Returns the newly created distributor details including account key and secret. - [Get Accounts](https://docs.telegent.com/api-reference/intelligent-distributor/get-accounts.md): Retrieve a list of all accounts associated with the distributor. Returns account information including name, total subscribers, and address details. - [Get Distributor Details](https://docs.telegent.com/api-reference/intelligent-distributor/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. - [Get Distributor Package List](https://docs.telegent.com/api-reference/intelligent-distributor/get-distributor-package-list.md): Retrieve the list of packages associated with the distributor. Filter by status (All, Active, Inactive). - [Get Distributor Product List](https://docs.telegent.com/api-reference/intelligent-distributor/get-distributor-product-list.md): Retrieve the list of products associated with the distributor. Filter by status (All, Active, Inactive). - [Get Distributor Subscription List](https://docs.telegent.com/api-reference/intelligent-distributor/get-distributor-subscription-list.md): Retrieve the list of subscriptions associated with the distributor. Filter by status (All, Active, Inactive). - [Get Subscribers](https://docs.telegent.com/api-reference/intelligent-distributor/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. - [Update Distributor](https://docs.telegent.com/api-reference/intelligent-distributor/update-distributor.md): Update an existing distributor's information including name and address details. - [Create Message Route](https://docs.telegent.com/api-reference/intelligent-messaging/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). - [Delete Message Route](https://docs.telegent.com/api-reference/intelligent-messaging/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. - [List Message Routes](https://docs.telegent.com/api-reference/intelligent-messaging/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. - [Message Details](https://docs.telegent.com/api-reference/intelligent-messaging/message-details.md): Retrieve comprehensive details for a specific message using its message ID. Includes delivery status, timestamps, content, sender/recipient information, and any error codes. - [Message Route Details](https://docs.telegent.com/api-reference/intelligent-messaging/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. - [Message Search](https://docs.telegent.com/api-reference/intelligent-messaging/message-search.md): Search your message history with filters for date range, phone numbers, direction (inbound/outbound), message status, and content. Returns paginated results with message details and delivery information. - [Report Device Delivery](https://docs.telegent.com/api-reference/intelligent-messaging/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. - [Send Outbound Message](https://docs.telegent.com/api-reference/intelligent-messaging/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` - [Update Message Route](https://docs.telegent.com/api-reference/intelligent-messaging/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. - [Data Usage Info](https://docs.telegent.com/api-reference/intelligent-mobile-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.). - [Data Usage Limit](https://docs.telegent.com/api-reference/intelligent-mobile-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/intelligent-mobile-numbers/data-usage-settings.md): Retrieve the current data usage settings (notify value, throttle value, limit value) for one or more phone numbers. - [Device Details](https://docs.telegent.com/api-reference/intelligent-mobile-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. - [Number Details](https://docs.telegent.com/api-reference/intelligent-mobile-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. - [Number Provision (Purchase/Order)](https://docs.telegent.com/api-reference/intelligent-mobile-numbers/number-provision-purchaseorder.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Message Route ID (MRID) — `POST /v1.0/message/routes` - **Optional:** Voice Route ID (CRID) — `POST /v1.0/voice/routes` *(only needed if `VoiceEnabled: true`)* - **Optional:** Subscriber ID (TSUID) — `POST /… - [Numbers - Cancel Port In](https://docs.telegent.com/api-reference/intelligent-mobile-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 - Port In](https://docs.telegent.com/api-reference/intelligent-mobile-numbers/numbers--port-in.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Recommended:** Confirm the number is portable first — `POST /v1.0/numbers/portin/eligibility` - **Required:** Losing carrier name, account number, account password, and subscriber billing address - [Numbers - Port In Eligibility](https://docs.telegent.com/api-reference/intelligent-mobile-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 - Port Out](https://docs.telegent.com/api-reference/intelligent-mobile-numbers/numbers--port-out.md): Process a port-out request to transfer phone numbers from your Telegent account to another carrier. Includes validation of port-out authorization and compliance with regulatory requirements. - [Numbers - Update Port In](https://docs.telegent.com/api-reference/intelligent-mobile-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 Inventory](https://docs.telegent.com/api-reference/intelligent-mobile-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. - [Numbers Status](https://docs.telegent.com/api-reference/intelligent-mobile-numbers/numbers-status.md): Check the current status of one or more phone numbers including provisioning state, active services, and any pending changes or issues. - [Numbers Update](https://docs.telegent.com/api-reference/intelligent-mobile-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. - [Order ID Details](https://docs.telegent.com/api-reference/intelligent-mobile-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. - [Search Available Numbers](https://docs.telegent.com/api-reference/intelligent-mobile-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… - [Create Subscriber](https://docs.telegent.com/api-reference/intelligent-subscriber/create-subscriber.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Account ID (AID) — provided by your Telegent representative - [Get Subscriber Details](https://docs.telegent.com/api-reference/intelligent-subscriber/get-subscriber-details.md): Retrieve detailed information about a specific subscriber including name, email, phone numbers, role, and associated account details. - [Transfer Subscriber](https://docs.telegent.com/api-reference/intelligent-subscriber/transfer-subscriber.md): Transfer a subscriber from one account to another. Requires both origin and destination account IDs. - [Update Subscriber](https://docs.telegent.com/api-reference/intelligent-subscriber/update-subscriber.md): Update an existing subscriber's information including name, phone numbers, role, and password. - [Account Schedules List](https://docs.telegent.com/api-reference/intelligent-voice-routing/account-schedules-list.md): Retrieve a list of all schedules configured for your account. - [Create Schedule](https://docs.telegent.com/api-reference/intelligent-voice-routing/create-schedule.md): Create a business hours schedule to control when workgroups are active. Define start and end times for each day of the week. Returns a ScheduleId for use with workgroups. - [Create Voice Route](https://docs.telegent.com/api-reference/intelligent-voice-routing/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… - [Create Workgroup](https://docs.telegent.com/api-reference/intelligent-voice-routing/create-workgroup.md): **Prerequisites:** - **Required:** Bearer token — `POST /v1.0/oauth2/tokens` - **Required:** Voice Route ID (CRID) — `POST /v1.0/voice/routes` - [Create Workgroup Activity](https://docs.telegent.com/api-reference/intelligent-voice-routing/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. - [Delete Schedule](https://docs.telegent.com/api-reference/intelligent-voice-routing/delete-schedule.md): Permanently delete a schedule. Schedules currently assigned to workgroups cannot be deleted until unassigned. - [Delete Voice Route](https://docs.telegent.com/api-reference/intelligent-voice-routing/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. - [Delete Workgroup Activity](https://docs.telegent.com/api-reference/intelligent-voice-routing/delete-workgroup-activity.md): Remove a member activity from a workgroup. The workgroup itself is not deleted. - [List Voice Routes](https://docs.telegent.com/api-reference/intelligent-voice-routing/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. - [Schedule Details](https://docs.telegent.com/api-reference/intelligent-voice-routing/schedule-details.md): Retrieve the configuration of a specific schedule by its ScheduleId. - [Update Schedule](https://docs.telegent.com/api-reference/intelligent-voice-routing/update-schedule.md): Update the business hours configuration for an existing schedule. Changes apply immediately to all voice routes and workgroups currently using this schedule, which may affect live call routing behavior. Use the ScheduleId (SID-) returned when the schedule was created. - [Update Voice Route](https://docs.telegent.com/api-reference/intelligent-voice-routing/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. - [Update Workgroup](https://docs.telegent.com/api-reference/intelligent-voice-routing/update-workgroup.md): Update an existing workgroup configuration. Requires the WorkgroupId of the workgroup to modify. - [Update Workgroup Activity](https://docs.telegent.com/api-reference/intelligent-voice-routing/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-)… - [Voice Route Details](https://docs.telegent.com/api-reference/intelligent-voice-routing/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. - [API Reference](https://docs.telegent.com/api-reference/introduction.md) - [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. - [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. - [Delete Package](https://docs.telegent.com/api-reference/packages/delete-package.md): Permanently delete a package by its PackageId. This action cannot be undone. - [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 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. - [Package Details](https://docs.telegent.com/api-reference/packages/package-details.md): Retrieve detailed information about a specific package by its PackageId. Returns package name, type, price, billing frequency, and associated distributor information. - [Package Subscriptions](https://docs.telegent.com/api-reference/packages/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. - [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. - [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. - [Delete Product](https://docs.telegent.com/api-reference/products/delete-product.md): Permanently delete a product by its ProductId. This action cannot be undone. - [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. - [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. - [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. - [Delete Service](https://docs.telegent.com/api-reference/services/delete-service.md): Permanently delete a service by its ServiceId. This action cannot be undone. - [Service Details](https://docs.telegent.com/api-reference/services/service-details.md): Retrieve detailed information about a specific service by its ServiceId. Returns service name, cost, billing frequency, and status. - [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. - [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` - [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. - [Subscription Details](https://docs.telegent.com/api-reference/subscriptions/subscription-details.md): Retrieve detailed information about a specific subscription by its SubscriptionId. Returns subscriber, package, phone number, and status information. - [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. - [API Quick Start Guide](https://docs.telegent.com/quick-start-guide.md): Complete walkthrough: From authentication to your first working setup ## OpenAPI Specs - [openapi](https://docs.telegent.com/api-reference/openapi.json) ## Optional - [API Portal](https://api.telegent.com)