GETGet Operator Code and Circle
Auto-detect a mobile number's recharge operator code and telecom circle.
Detects the telecom operator and circle for a customer mobile number, returned as name/value pairs under dependent_params at the top level of the response (not under data).
Watch the rename: this endpoint returns circle_area, but Get Recharge Plans expects that value as the circleid query parameter. The phone_operator_code value carries over under the same name.
- BBPS — Prepaid Mobile / DTH Recharge — Detect the operator and circle from the customer's mobile number, read the operator's input fields, list the available plans, then submit the chosen plan as a payment.
Request
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_mobile | string | required | Customer's mobile number.e.g. 9876543210 |
customer_mobilestringRequiredCustomer's mobile number.
example: 9876543210
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
client_ref_id | string | optional | Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
client_ref_idstringoptionalUnique reference ID per API call, generated by your system (max 20 characters).
example: 2026010100123456789
These headers authenticate and sign every request. See How Auth Works for details.
| Field | Type | Required | Description |
|---|---|---|---|
developer_key | string | required | Static API key issued to your account after KYC. |
secret-key | string | required | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
secret-key-timestamp | string | required | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
content-type | string | required | application/jsone.g. application/json |
developer_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Response types
| response_type_id | Meaning | Next step |
|---|---|---|
1804 | Operator and circle detected — list the plans available for them. | Get Recharge Plans |
Responses
1804Operator and circle detected — list the plans available for them.Next:Get Recharge Plans
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
dependent_paramsarrayResolved operator/circle as name-value pairs (`phone_operator_code`, `circle_area`) — returned at the top level, not under `data`.
namestringParameter name (`phone_operator_code` or `circle_area`).
valuenumberParameter value. Pass `circle_area`'s value on as `circleid` to Get Recharge Plans.