Send OTP/PIN by SMS AI Agent / LLM

Telecom
POST /api/v1/aws/send_otp-pin Bearer

Everything an AI coding assistant needs to write a working Send OTP/PIN by SMS integration without opening another page: endpoint, authentication, parameters, a real request, both response shapes and the platform rules it cannot infer from a single example. Copy the brief below and paste it into Claude, Cursor, GitHub Copilot, ChatGPT or any other agent.

Machine-readable spec — Markdown

# Send OTP/PIN by SMS API — Way2API®

- **Endpoint:** `POST https://app.way2api.com/api/v1/aws/send_otp-pin`
- **Auth:** `Authorization: Bearer YOUR_API_KEY` (or `X-API-Key: YOUR_API_KEY`)
- **Content-Type:** `application/json`
- **Category:** Telecom
- **Availability:** Available worldwide
- **Docs:** https://app.way2api.com/documentation/send-otp-pin-sms

## What it does

Send a transactional OTP or PIN SMS to a mobile number worldwide via Text SMS. Supports strict purpose and share_with validation.

## Request body (application/json)

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `number` | string | yes | Country code + mobile number. Currently supported: +91 (India). Example: 919876543210. |
| `content` | string | yes | Content type: "OTP" or "PIN". |
| `value` | string | yes | The OTP/PIN code to send (4 to 8 digits only). |
| `purpose` | string | yes | Purpose of the SMS. Allowed: login, registration, password_reset, transaction, account_verification, two_factor_auth, payment_confirmation, order_confirmation, profile_update, withdrawal. |
| `share_with` | string | yes | Sharing instruction. Allowed: no_one, executive, manager, support_team, admin. |

## Example request

```bash
curl -X POST https://app.way2api.com/api/v1/aws/send_otp-pin \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"5289","number":"919876543210","content":"OTP","purpose":"login","share_with":"no_one"}'
```

## 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": {
            "phone": "+919876543210",
            "content_type": "OTP",
            "purpose": "login",
            "share_with": "no_one",
            "sms_status": "sent"
        }
    }
}
```

## Error response — 422

```json
{
    "status": "FAILED",
    "status_code": 422,
    "charged": false,
    "success": false,
    "message": "content must be either \"OTP\" or \"PIN\".",
    "message_code": "INVALID_INPUT",
    "data": {
        "order_id": "W2A1739512345abcdef01",
        "error_code": "VALIDATION_ERROR"
    }
}
```

## 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.

Prompts to pair it with

  • Write a production-ready Send OTP/PIN by SMS integration in PHP using this spec, with error handling and retries.
  • Given this spec, generate typed request/response models and a client class.
  • Review my existing Send OTP/PIN by SMS integration against this spec and list what I handle incorrectly.
⚠ Before you paste generated code

Never let an assistant hard-code your API key — load it from an environment variable or a secret store, and call this endpoint from your backend only. A failed verification is still a successful HTTP call, so check the success field in the body rather than treating 200 as verified.

Prefer to read it yourself?

Overview What this API does, availability, and a quick start. Request Endpoint, authentication headers, every request parameter with its type, and a sample request body. Response The full success response payload, field by field. Error Codes HTTP status codes, error payload shape, and how to handle failures. Code Examples Ready-to-run examples in cURL, PHP, JavaScript and Python. Rate Limits Per-minute and per-day request limits, and what happens on breach.