Retrieve a phone number

Updated

Retrieves a phone number and its SIP and inbound settings.

Preview documentation

You're reading the Conversational AI Platform (Preview) docs. Switch to Main.
GET
https://preview.ai.agora.io/conversational-ai/v1/projects/{appid}/numbers/{number_id}

Path Parameters

appidstring
Required

The App ID of your project.

number_idstring
Required

The ID of the phone number, returned in number_id when you create the number.

Response Body

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

Response Headers

Agora-Request-Idstring

A unique ID for the request. Include it when you contact Agora support.

ETagstring

The current version of the resource. Pass this value in the If-Match header of your next update or delete request for this resource.

number_idstring

The ID of the phone number, a UUID.

numberstring

The phone number in E.164 format.

descriptionstring

A description of the number's purpose. It's separate from sip_trunk.name, which names the carrier connection.

sip_trunkobject
inboundobject

What happens when someone calls this number. If you omit it, inbound calls are rejected. call_policy is required when agent isn't null.

create_tsinteger

The time the number was added, as a Unix timestamp in seconds.

Authorization

This endpoint requires authentication.

Request examples

Example Request
curl -X GET 'https://preview.ai.agora.io/conversational-ai/v1/projects/string/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response example

Example Response
{
  "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
}