Carrier Groups⚓︎
Path⚓︎
/v1/carrier-groups
A Carrier Group is a collection of Carriers. Carrier Groups are used within Roaming Profiles to define sets of allowed or restricted networks.
Resource Attributes⚓︎
The attributes for the carrier-groups resource are detailed below:
| Attribute | Type | Required? | Description |
|---|---|---|---|
| name | String | YES | The name of the carrier group. |
| description | String | NO | A description of the carrier group. |
Example⚓︎
{
"name": "North American Carriers",
"description": "All major carriers in US and Canada"
}
Endpoints⚓︎
Request Examples⚓︎
Get a list of all carrier groups:⚓︎
{baseUrl}/v1/carrier-groups
Get a specific carrier group:⚓︎
{baseUrl}/v1/carrier-groups/<groupID>
Get all carriers in a carrier group:⚓︎
{baseUrl}/v1/carrier-groups/<groupID>/carriers
Search for carrier groups with counts:⚓︎
{baseUrl}/v1/carrier-groups/search/findByDeepSearchWithCounts?searchString=<searchCriteria>
The