This operation from Phone Number-based Service queries an international phone number to identify its country and carrier, and returns the corresponding MCC and MNC.
Operation description
Before you call this operation, understand the billing of Phone Number-based Service.
Billing method: Each request that returns OK for the Code parameter incurs a charge.
The MCC and MNC fields in the response may be empty depending on data availability.
Try it now
Test
RAM authorization
Request parameters
Parameter | Type | Required | Description | Example |
PhoneNumber | string | No | The phone number, which must be prefixed with a country code. For example, a phone number in China (Hong Kong) must be in the | 86123434345 |
AuthCode | string | No | The authorization code. Note To obtain an authorization code, log on to the Phone Number-based Service console, go to Tag Plaza, select a tag, and submit an application. You will receive the authorization code after your application is approved. | example |
Response elements
Element | Type | Description | Example |
object | |||
AccessDeniedDetail | string | Details about the access denial. This parameter is returned only if the RAM permission check fails. | - |
RequestId | string | The request ID. | CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47 |
Message | string | The returned message. | OK |
| Data | object | The returned data object. | |
Mnc | string | The Mobile Network Code (MNC) of the carrier. | 123 |
Ported | boolean | Indicates whether the number has been ported (number portability). | true |
CountryIso3 | string | The ISO-3166-1 alpha-3 country code. | USA |
Mcc | string | The Mobile Country Code (MCC) of the carrier. | 123 |
Code | string | The status code of the request. A value of OK indicates a successful request. | OK |
This service is available in the following countries and regions: United States, Spain, Malaysia, Japan, Thailand, South Korea, Brazil, Russia, Vietnam, France, the Philippines, Germany, the United Kingdom, Italy, Pakistan, Singapore, India, and China (Hong Kong).
Examples
Success response
JSON format
{
"AccessDeniedDetail": "-",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Message": "OK",
"Data": {
"Mnc": "123",
"Ported": true,
"CountryIso3": "USA",
"Mcc": "123"
},
"Code": "OK"
}Error codes
HTTP status code | Error code | Error message | Description |
200 | RequestNumberNotSupported | NotSupported this RequestNumber. | |
200 | PhoneNumberNotfound | The requested number cannot find result. | |
500 | RequestSupplierError | Request supplier error. | Request supplier error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.