Mobile Data Pool Flow

Overview

Use this flow to create and manage data pools. Note that you must first provision mobile services on a valid Data Pool Consumer plan using either the Activate Mobile (New) or the Activate Mobile (Port In) flows before you can use this flow to create a data pool and add services to the pool.

📌

IMPORTANT: Please note that we have a limited number of eSIM test sim cards in our test environment and data pools are automatically created with eSIMs. If you receive an error that resources are not available, please contact us so we can recycle some previously used eSIMs.

Please also note that we may need to disconnect test eSIM services from your test environment to recycle eSIMs so that they can be used for our own testing.

Key

Icon	Description
	Telcoinabox
	Service Provider / Website

API Sequence

Step	Action	API Guide	M/O	Comments/Other Info	Type
1	Create Data Pool	Create a Data Pool	Mandatory	Note that you must provide a Datapool provider PlanId. There is currently no way to find this via API. Please copy the Data Pool Provider Plan template in Octane or contact the Billing team if you need assistance.	Legacy SOAP
2	Query Order	Query an Order	Mandatory	Find the serviceNumber of the newly created pool	Legacy SOAP
3	Get Data Pool Details	Get Data Pool	Mandatory	Retrieve ProviderId of the pool required to add consumers	REST API
4	Add Consumers to Data Pool	Add Consumers to Data Pool	Mandatory	Use providerId to add serviceNumber to the pool. Note that service to be added to the pool must be on a valid Data Pool consumer plan to be added to the pool. Please contat the billing team if you need assistance with determining your valid data pool plans	Legacy SOAP
5	Transfer Service to Another Pool	Tranfer Services to Another Pool	Optional	Use this API to transfer a service from one pool to another. Mandatory to create the additional pool first and provide the newProviderId in the request	REST API
6	Get Data Pool	Get Data Pool	Optional	Use this API to get details of a data pool, including the count and detail of consumers within the pool, the total data usage of the pool and any data limits set on consumers	Legacy SOAP
7	Update Data Limit	Update Data Limit	Optional	Use this API to add a data limit to an individual consumer within the pool. Note that once a data limit is set it cannot be removed only increased or decreased	Legacy SOAP
8	Remove Consumers from Pool	Remove Consumers From Data Pool	Optional	Use this API to remove services from a data pool. Note that you may want to perform a plan change after this action to a non pooling plan if you no longer wish the service to remain in a pool	REST API
9	Disconnect a Data Pool	Disconnect a Data Pool	Optional	Use this API to disconnect a data pool. Note that in order to disconnect a data pool, it must be empty. All consumers must first be removed from the pool in order to disconnect it	REST API

Overview#

Key#

API Sequence#

Overview

Key

API Sequence