Operator Validation API
Operator Validation API
Method: POST
Headers:
Content-Type: application/json
API-Key: (api key shared with the partner)
Request
Request Body Parameter | Data Type | Mandatory? | Size |
---|---|---|---|
mobileNumber | String | Yes | Min = 10, Max = 10 |
operatorCode | String | Yes | Max = 5 |
circleCode | String | Yes | Max = 5 |
amount | Number | Yes | Positive, Max = 10000 Rs |
Sample Request
{
"userUid": "azHiANCiasoijvc",
"mobileNumber": "9999999999",
"operatorCode": "1",
"circleCode": "10",
"amount": 719
}
Sample Response
Success Status Code: 200
{
"validationCode": "2",
"validationMessage": "Plan Offering applicable only for Jio Phone customers",
"operatorCode": "1",
"circleCode": "10"
}
Response Body Parameter | Data Type | Size |
---|---|---|
validationCode | String | Max = 2 |
validationMessage | String | Max = 200 |
operatorCode | String | Max = 5 |
circleCode | String | Max = 5 |
Details
- The operator code and circle code in the response will be the same as the request, and will not be given the correct operator or circle if the provided one is wrong. This API will just verify whether the given request is correct or not.
Validation codes and their meanings
Code | Meaning |
---|---|
0 | Validation successful, no error in the given request |
1 | Error while calling API |
2 | Validation failed, there is an error in the given request, the relevant validation message will be provided |
4 | Exception in the validation API |
empty | Timeout while calling the API |