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

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Purchase SMS number

> Purchase SMS number: purchaseSmsNumber in the TypeScript, Python and Rust clients.

`POST /v1/projects/{id}/platforms/sms/numbers`

Buys one US local number from the provider and records it as a resource with SMS enabled. Requires countryCode (US) and accepts an optional three-digit geographic areaCode. The server selects an exact matching number. Empty inventory keeps the operation running until a number is available or the caller cancels before ordering begins. Always answers 202 with an operation: the work runs behind the response, and the Location points at the operation to poll. New area-specific requests must appear in current provider coverage; discover it with GET /sms/numbers/area-codes?countryCode=US. Coverage and subscription checks run before operation creation. Billing follows delivery. Replays return the original operation without checking current coverage. The Idempotency-Key is required and permanent: repeating it returns the same operation forever, never a second number. A further number always needs a NEW key, including while others are still running. Requires the platforms:write permission bound to the project resource in the path.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.projects.platforms.purchaseSmsNumber(input: PurchaseSmsNumberInput, options?: RequestOptions): Promise<PurchaseSmsNumberOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.projects.platforms.purchase_sms_number(input: PurchaseSmsNumberInput) -> models.Operation
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.purchase_sms_number(idempotency_key: String, id: String, body: &types::PurchaseSmsNumberRequest).await -> Result<ResponseValue<types::Operation>, Error<PurchaseSmsNumberError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.projects.platforms.purchaseSmsNumber({
    path: {
      id: "id",
    },
    headers: {
      idempotencyKey: "idempotencyKey",
    },
    body: {
      countryCode: "US",
    },
  });
  ```

  ```python Python theme={null}
  import os

  from photon_api import Photon
  from photon_api.rpc_generated import PurchaseSmsNumberInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.projects.platforms.purchase_sms_number(
      PurchaseSmsNumberInput.model_validate({
          "path": {
              "id": "id",
          },
          "headers": {
              "Idempotency-Key": "idempotencyKey",
          },
          "body": {
              "countryCode": "US",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .purchase_sms_number(
          "idempotencyKey".to_owned(),
          "id".to_owned(),
          &serde_json::from_value(serde_json::json!({
              "countryCode": "US",
          }))?,
      )
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

<ResponseExample>
  ```json 202 theme={null}
  {
    "cancellable": true,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "detail": {},
    "endedAt": "2026-01-01T00:00:00.000Z",
    "error": {
      "code": "string",
      "detail": "string"
    },
    "operationId": "string",
    "projectId": "string",
    "reason": "charge_refused",
    "resourceId": "string",
    "resourceType": "string",
    "startedAt": "2026-01-01T00:00:00.000Z",
    "state": "pending",
    "type": "resource.provision",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
  ```
</ResponseExample>

## Parameters

<ParamField header="Idempotency-Key" type={"string"} required>
  Identifies one logical mutation across retries.
</ParamField>

<ParamField path="id" type={"string"} required />

## Body

<ParamField body="areaCode" type={"string"} />

<ParamField body="countryCode" type={"\"US\""} required />

## Returns

**`202`** The purchase was accepted and is running. GET the Location after the Retry-After interval until `state` is terminal; the response there carries the number once it exists. Operation

Headers: `Location`. The raw response carries these headers; see [Raw responses](/docs/beta/api-client/raw-responses).

<ResponseField name="cancellable" type={"boolean"} required />

<ResponseField name="createdAt" type={"string (date-time)"} required />

<ResponseField name="detail" type={"object"} />

<ResponseField name="endedAt" type={"string (date-time)"} />

<ResponseField name="error" type={"OperationError"} />

<ResponseField name="operationId" type={"string"} required />

<ResponseField name="projectId" type={"string"} required />

<ResponseField name="reason" type={"OperationReason"} />

<ResponseField name="resourceId" type={"string"} />

<ResponseField name="resourceType" type={"string"} required />

<ResponseField name="startedAt" type={"string (date-time)"} />

<ResponseField name="state" type={"OperationState"} required />

<ResponseField name="type" type={"OperationType"} required />

<ResponseField name="updatedAt" type={"string (date-time)"} required />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.