Plan Fetch AP
To provide users with available recharge or tariff plans for a specific mobile operator and telecom circle. This helps customers select the best plan for prepaid or postpaid connections.
Input Parameters
- operator_name: Name of the telecom operator (e.g., Airtel, Jio, Vodafone).
- circle: Telecom circle or region (e.g., Delhi, Maharashtra).
- connection_type: “Prepaid” or “Postpaid” (optional; defaults to both).
- plan_category: Type of plan requested (e.g., data, talktime, SMS, full talktime, special recharge) (optional).
amount_range: Minimum and maximum recharge amount filter (optional).
Process
- The API accesses the latest plans database aggregated from telecom operators or authorized data providers.
- Filters plans based on input parameters such as operator, circle, and connection type.
- Returns detailed plan information.
Output Data
- plan_id: Unique identifier for each plan.
- plan_name: Name or title of the recharge plan.
- operator_name: Telecom operator offering the plan.
- circle: Telecom circle applicable.
- connection_type: Prepaid or Postpaid.
- plan_category: Category/type of the plan (data, talktime, combo, etc.).
- price: Recharge amount in local currency.
validity: Plan validity period (e.g., 28 days, 1 year).
- benefits: Details of benefits like data allowance, talktime, SMS, etc.
- description: Additional info or special terms.
Key Considerations
- Keep the plan database updated frequently due to frequent telecom plan changes.
- Include filters for popular plans, price ranges, and validity periods.
- Ensure clear distinction between prepaid and postpaid plans.
- Support localization by telecom circle/region for accurate plan applicability.
Security and Performance
- API access should be secured with authentication tokens or API keys.
- Use HTTPS for secure communication.
- Implement caching mechanisms to reduce load and improve response time.
Rate limiting to avoid abuse.
