Carriers⚓︎
Path⚓︎
/v1/carriers
A Carrier represents a Mobile Network Operator (MNO) identified by its Mobile Country Code (MCC) and Mobile Network Code (MNC).
Resource Attributes⚓︎
The attributes for the carriers resource are detailed below:
| Attribute | Type | Required? | Description |
|---|---|---|---|
| mcc | String | YES | Mobile Country Code (3 digits). |
| mnc | String | YES | Mobile Network Code (2-4 digits). |
| type | String | YES | Carrier type. Options: INTERNATIONAL, NATIONAL, TEST. |
| status | String | YES | Carrier status. Options: ALLOCATED, IMPLEMENT_DESIGN, NOT_OPERATIONAL, ONGOING, OPERATIONAL, PLANNED, RESERVED, RETURNED_SPARE, TEMPORARY_OPERATIONAL, TEST_NETWORK, UNKNOWN. |
| mode | String | YES | Carrier mode. Options: PUBLIC, PRIVATE, UNKNOWN. |
| countryName | String | NO | Name of the country. |
| countryCode | String | NO | Two-letter country code (ISO 3166-1 alpha-2). |
| brand | String | NO | Carrier brand name. |
| operator | String | NO | Carrier operator name. |
| bands | String | NO | Supported frequency bands. |
| notes | String | NO | Additional notes about the carrier. |
Example⚓︎
{
"mcc": "302",
"mnc": "220",
"type": "NATIONAL",
"status": "OPERATIONAL",
"mode": "PUBLIC",
"countryName": "Canada",
"countryCode": "CA",
"brand": "Telus",
"operator": "Telus Communications",
"bands": "1, 2, 4, 5, 7, 12, 13, 17, 29, 30, 66",
"notes": "Main carrier for region"
}
Endpoints⚓︎
Request Examples⚓︎
Get a list of all carriers:⚓︎
{baseUrl}/v1/carriers
Get a specific carrier:⚓︎
{baseUrl}/v1/carriers/<carrierID>
Search for carriers using deep search:⚓︎
{baseUrl}/v1/carriers/search/findByDeepSearch?searchString=<searchCriteria>
Find carriers by operator name:⚓︎
{baseUrl}/v1/carriers/search/findByOperator?searchString=<operatorName>
The