Fetch Operators API
Fetch Operators API
Method: POST
Headers:
Content-Type: application/json
API-Key: (api key shared with the partner)
Request
Parameter | Data Type | Mandatory? | Size |
---|---|---|---|
mobileNumber | String | Yes | Min = 10, Max = 10 |
Sample Request
{
"mobileNumber": "9999999999"
}
Sample Response
Success Status Code: 200
{
"operatorCode": "1",
"circleCode": "10"
}
Response
Parameter | Data Type | Size |
---|---|---|
operatorCode | String | Max = 5 |
circleCode | String | Max = 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
- API will internally look for the correct operator and circle for the given mobile number.
- In case the operator or circle is not found, it would be 0.