# Retrieve a phone number (/en/api-reference/api-ref/conversational-ai/platform/retrieve-number)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

> Documentation: Conversational AI API.
> Documentation version: Preview.
> This document describes only this version. [Version index](/llms/doc-versions-convoai-api-v2.txt).


Retrieves a phone number and its SIP and inbound settings.

- OpenAPI: /openapi/conversational-ai/rest-api-platform.en.yaml
- Operation ID: retrieve-number
- Method: GET
- Path: /v1/projects/{appid}/numbers/{number_id}
- Endpoint: https://preview.ai.agora.io/conversational-ai/v1/projects/{appid}/numbers/{number_id}

## Servers

- https://preview.ai.agora.io/conversational-ai

## Authorization

This endpoint requires authentication.

- `tokenAuth`
- `basicAuth`

## Parameters

- `appid` (path, required, string) - The App ID of your project.
- `number_id` (path, required, string) - The ID of the phone number, returned in `number_id` when you create the number.
  - Format: `uuid`

## Request body

No request body.

## Responses

### 200

The request was successful. The response body contains the number. SIP credentials are never returned.

- `number_id` (string) - The ID of the phone number, a UUID.
  - Format: `uuid`
- `number` (string) - The phone number in E.164 format.
- `description` (string) - A description of the number's purpose. It's separate from `sip_trunk.name`, which names the carrier connection.
- `sip_trunk` (object)
  - `sip_trunk.name` (string) - The name of the carrier connection.
  - `sip_trunk.hostname` (string) - The carrier's SIP hostname.
  - `sip_trunk.port` (integer) - The SIP signaling port.
  - `sip_trunk.transport` (string) - The transport protocol for the carrier connection.
    - Allowed: `udp` | `tcp` | `tls`
  - `sip_trunk.allowed_ips` (array) - The addresses allowed to send inbound SIP traffic.
    - `sip_trunk.allowed_ips.items` (string)
- `inbound` (object) - What happens when someone calls this number. If you omit it, inbound calls are rejected. `call_policy` is required when `agent` isn't `null`.
  - `inbound.agent` (string | null | null, required) - The ID of the agent that answers inbound calls. Set to `null` to reject inbound calls.
  - `inbound.call_policy` (object) - Limits and behavior for inbound calls to this number. Each limit you omit adds no limit.
    - `inbound.call_policy.max_call_duration_seconds` (integer) - The maximum length of a call in seconds, measured from when it's answered.
      - Minimum: `1`
    - `inbound.call_policy.max_silence_duration_ms` (integer) - Hang up when nobody on the call has spoken for this many milliseconds.
      - Minimum: `1`
    - `inbound.call_policy.end_call` (object) - Conditions under which the agent can end the call itself. Every condition is off unless you set it to `true`.
      - `inbound.call_policy.end_call.on_user_request` (boolean) - End the call when the caller clearly says goodbye or asks to hang up.
        - Default: `false`
      - `inbound.call_policy.end_call.on_voicemail` (boolean) - End the call when the agent reaches voicemail, such as a "please leave a message after the tone" announcement.
        - Default: `false`
      - `inbound.call_policy.end_call.on_ai_assistant` (boolean) - End the call when the call is answered by an AI assistant, a voice secretary, or another automated answering system.
        - Default: `false`
- `create_ts` (integer) - The time the number was added, as a Unix timestamp in seconds.
### 401

Authentication is missing or invalid. The reason is `InvalidPermission`.

- `detail` (string, required) - A human-readable description of the error. It names the field or resource involved, when there is one. Don't parse it; branch on `reason` instead.
- `reason` (string, required) - A machine-readable error reason, such as `InvalidFieldValue` or `ResourceNotFound`. For all reasons, see [Status codes](/en/api-reference/api-ref/conversational-ai/platform/status-codes).
### 404

The resource in the path doesn't exist. The reason is `ResourceNotFound`.

- `detail` (string, required) - A human-readable description of the error. It names the field or resource involved, when there is one. Don't parse it; branch on `reason` instead.
- `reason` (string, required) - A machine-readable error reason, such as `InvalidFieldValue` or `ResourceNotFound`. For all reasons, see [Status codes](/en/api-reference/api-ref/conversational-ai/platform/status-codes).
### default

The request failed. The response body contains the `reason` and `detail` of the failure. For possible reasons, see [Status codes](/en/api-reference/api-ref/conversational-ai/platform/status-codes).

- `detail` (string, required) - A human-readable description of the error. It names the field or resource involved, when there is one. Don't parse it; branch on `reason` instead.
- `reason` (string, required) - A machine-readable error reason, such as `InvalidFieldValue` or `ResourceNotFound`. For all reasons, see [Status codes](/en/api-reference/api-ref/conversational-ai/platform/status-codes).

## Response examples

### 200

```json
{
  "number_id": "92e68758-3d3a-4f27-8b93-3fd8d834467c",
  "number": "+14155550100",
  "description": "Primary customer support line for North America.",
  "sip_trunk": {
    "name": "support-line",
    "hostname": "acme.pstn.example.com",
    "port": 5061,
    "transport": "tls"
  },
  "inbound": {
    "agent": "3f6c2a9e-8d1b-4e7a-9c55-0b2f7d1e4a10",
    "call_policy": {
      "max_call_duration_seconds": 1800,
      "max_silence_duration_ms": 60000,
      "end_call": {
        "on_user_request": true
      }
    }
  },
  "create_ts": 1787223852
}
```