> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Number Masking (Proxy) API

> Connect two parties through a shared masking number — for marketplaces, ride-share, classifieds. Neither side sees the other's real number.

# Number Masking (Proxy) API

Connect Party A to Party B via a third "proxy" number — both sides dial / SMS the proxy and the platform forwards. Used by marketplaces and ride-share apps where the buyer and seller shouldn't see each other's real phone number.

**Base path:** `/api/v1/proxy`

**Authentication:** API key (`X-API-Key`) or session JWT.

## Sessions

A **session** is the active mapping. While the session is open, calls and SMS to the proxy number from Party A are forwarded to Party B and vice versa.

| Method   | Path                          | Purpose                                |
| -------- | ----------------------------- | -------------------------------------- |
| `POST`   | `/api/v1/proxy/sessions`      | Create a session (book a proxy number) |
| `GET`    | `/api/v1/proxy/sessions`      | List active sessions                   |
| `GET`    | `/api/v1/proxy/sessions/{id}` | Get a session                          |
| `DELETE` | `/api/v1/proxy/sessions/{id}` | Close a session                        |

## Inbound webhook

Carrier inbound traffic to the proxy number is posted to `POST /api/v1/proxy/inbound` — platform-managed. You don't call this directly.

## Example — book a proxy session for an Uber-style ride

```bash theme={null}
curl -X POST https://api.orbit.devotel.io/api/v1/proxy/sessions \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "participant_a": "+14155551111",
    "participant_b": "+14155552222",
    "ttl_minutes": 60
  }'
```

`ttl_minutes` is optional (1–1440, defaults to 60) and sets how long the session stays open before it expires. The response includes the proxy number both parties should call/text, plus the computed expiry. Close the session early with `DELETE` when the trip ends.
