---
title: "POST /phone/provision"
method: POST
path: "/phone/provision"
---

# POST /phone/provision

`POST /phone/provision`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/phone/provision`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Request body

- object: Request body for provisioning a new phone number for an agent
  - `agentId` union, required: Agent to assign the provisioned phone number to
    - string
    - string
  - `countryCode` string: ISO 3166-1 alpha-2 country code for number selection
  - `numberType` 'local' | 'mobile' | 'national' | 'toll_free' | 'shared_cost': Phone number type to provision (treated as local when omitted)
  - `areaCode` string: Preferred area code for the phone number
  - `capabilities` string[]: Required capabilities for the phone number

## Response `200`

OK

- object: Provisioned phone number resource with provider and compliance details
  - `id` string, required: Unique identifier for the provisioned phone record
  - `phoneNumber` string, required: E.164 formatted phone number that was provisioned
  - `providerId` string, nullable, required: Opaque carrier-side identifier for the number
  - `capabilities` object, required: Active communication capabilities for this number
    - `sms` boolean, required: Whether SMS messaging is enabled
    - `mms` boolean, required: Whether MMS messaging is enabled
    - `voice` boolean, required: Whether voice calls are enabled
  - `tenDlcStatus` 'PENDING' | 'REGISTERED' | 'REJECTED' | 'NOT_REQUIRED' | 'UNREGISTERED', required: 10DLC campaign registration status for A2P SMS compliance
  - `isPrimary` boolean, required: Whether this is the primary phone number for the agent
  - `createdAt` string, date-time, required: ISO 8601 timestamp when the number was provisioned

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)