Skip to main content

Fetch Operators API

Fetch Operators API​

Method: POST

Headers:
    Content-Type: application/json
    API-Key: (api key shared with the partner)

Request​

ParameterData TypeMandatory?Size
mobileNumberStringYesMin = 10, Max = 10

Sample Request​

{
"mobileNumber": "9999999999"
}

Sample Response​

Success Status Code: 200

{
"operatorCode": "1",
"circleCode": "10"
}

Response​

ParameterData TypeSize
operatorCodeStringMax = 5
circleCodeStringMax = 5

Sample Error Response​

Status Code: 400

{
"errorCode": 803,
"errorMessage": "invalid mobile number provided"
}

Error handling and error responses are common for all APIs provided in a separate section

Details​

  1. API will internally look for the correct operator and circle for the given mobile number.
  2. In case the operator or circle is not found, it would be 0.