Mobile R-Offer Fetch AI Agent / LLM

# Mobile R-Offer Fetch API — Way2API®

- **Endpoint:** `POST https://app.way2api.com/api/v1/mobile/r-offer`
- **Auth:** `Authorization: Bearer YOUR_API_KEY` (or `X-API-Key: YOUR_API_KEY`)
- **Content-Type:** `application/json`
- **Category:** Telecom
- **Availability:** Available in India
- **Docs:** https://app.way2api.com/documentation/mobile-r-offer

## What it does

Mobile R-Offer Fetch API — Retrieve the R-Offers (special, number-specific recharge offers) that a telecom operator has loaded against one prepaid mobile number. Unlike a generic plan list, R-Offers are personalised per number, so the same recharge amount can carry different benefits for different subscribers. Returns an offers array where each entry has the price, a customer-friendly description, and the operator log_description (the exact benefit text). Ideal for recharge platforms and retailer apps that want to surface the best available offer before a top-up. Currently supported for Airtel and VI (Vodafone Idea) prepaid numbers only.

## Request body (application/json)

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `mobile_number` | string | yes | 10-digit Indian mobile number — format: [6-9][0-9]{9} (e.g. 9876543210) |
| `operator` | string | yes | Prepaid operator of the number. Accepted values: airtel, vi (Vodafone Idea). Other operators (jio, bsnl) are not supported by the source yet and are rejected without charge. |

## Example request

```bash
curl -X POST https://app.way2api.com/api/v1/mobile/r-offer \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mobile_number":"9876543210","operator":"airtel"}'
```

## Success response — 200

```json
{
    "status": "SUCCESS",
    "status_code": 200,
    "charged": true,
    "success": true,
    "message": "",
    "message_code": "OK",
    "order_id": "W2A1739512345abcdef01",
    "data": {
        "order_id": "W2A1739512345abcdef01",
        "result": {
            "mobile_number": "9876543210",
            "operator": "airtel",
            "offers": [
                {
                    "price": "29",
                    "description": "Stay connected with 2GB data at just Rs29",
                    "log_description": "RC29=Payein 2GB data 1 din ke liye."
                },
                {
                    "price": "65",
                    "description": "Stay connected with 4GB data at just Rs65",
                    "log_description": "65=4GB aapke maujooda pack ki vaidhta tak manya"
                }
            ]
        }
    }
}
```

## Error response — 400

```json
{
    "status": "FAILED",
    "status_code": 400,
    "charged": false,
    "success": false,
    "message": "No offer found for this number",
    "message_code": "REQUEST_FAILED",
    "order_id": "W2A1739512345abcdef01",
    "data": {
        "order_id": "W2A1739512345abcdef01",
        "error_code": "1"
    }
}
```

## Integration rules

- Every response is JSON carrying `status`, `status_code`, `charged`, `success`, `message`, `message_code` and (once a call reaches the provider) `order_id`. The verification payload is under `data.result`.
- `charged` (boolean) is the authority on billing. Do NOT infer it from the HTTP status: `422` is returned both for input we rejected (not charged) and for a lookup the provider ran and billed us for that returned a negative result (charged).
- `message_code` is a fixed vocabulary — branch on it instead of parsing `message`. Values: `OK`, `ACCEPTED`, `PROVIDER_NO_RESPONSE`, `VERIFICATION_FAILED`, `NO_RECORD_FOUND`, `INVALID_INPUT`, `REQUEST_FAILED`, `MISSING_API_KEY`, `INVALID_API_KEY`, `INSUFFICIENT_BALANCE`, `NO_API_ACCESS`, `NOT_FOUND`, `RATE_LIMITED`, `INTERNAL_ERROR`, `PROVIDER_UNAVAILABLE`.
- `success` reports the verification outcome; `status` reports the ORDER lifecycle (`SUCCESS`/`PENDING`/`FAILED`). They differ on a charged negative result: the order completed and was billed while the verification did not pass.
- A failed verification is still a successful HTTP call — the outcome lives in the response body, so do not treat `200` as "verified".
- Status codes: `200` result returned, `202` pending or provider did not respond (both charged — quote the `order_id`), `401` missing/invalid key, `402` insufficient balance, `403` no access to this service, `422` see `charged`, `429` rate limited (honour the `Retry-After` header), `503` temporarily unavailable.
- Rate limits are per API key, per service, on a 1-minute sliding window.
- Load the API key from an environment variable or secret store. Never hard-code it, never commit it, and never ship it in client-side code — calls must be made from your backend.