Retrieve number information

Retrieve number information

GET

https://api.agora.io/api/conversational-ai-agent/v2/phone-numbers/{phone_number}

Use this endpoint to retrieve detailed information for a specific phone number.

phone_number stringrequired

Telephone number in E.164 format. For example, +11234567890.

• If the returned status code is 200, the request was successful. The response body contains the result of the request.

  Response Body

  • provider string

    Possible values: byo, twilio

    Number provider:

    • byo: BYO (Bring Your Own)
    • twilio: Twilio
  • phone_number string

    A telephone number in E.164 format, used as a unique identifier.

  • label string

    A label used to identify the number.

  • inbound boolean

    Whether the number supports inbound calls.

  • outbound boolean

    Whether the number supports outbound calls.

  • associated_pipeline object

    The associated pipeline information. Returns null if no pipeline is associated.

    Show propertiesHide properties

    • pipeline_id string

      Pipeline ID.

    • pipeline_name string

      Pipeline name.

  • inbound_config object

    SIP inbound call configuration details. Returns null if not configured.

  • outbound_config object

    SIP outbound call configuration details. Returns null if not configured.

  Common error codes:

  • 401 unauthorized: Authentication failed, please check your credentials.
  • 404 not_found: The specified phone number was not found.
  • 409 phone_number_exists: Phone number already exists, duplicate import not allowed.
  • 409 conflict: Concurrent modification conflict or resource locked.
  • 422 unprocessable_content: Request format error or parameter validation failed.
  • 500 internal_server_error: Internal server error.

Authorization

This endpoint requires Basic Auth.

Request example

• curl
• Python
• Node.js

_3

curl --request GET \

_3

--url https://api.agora.io/api/conversational-ai-agent/v2/phone-numbers/:phone_number \

_3

--header 'Authorization: Basic <credentials>'

Response example

• 200
• Non-200

_11

{

_11

"provider": "byo",

_11

"phone_number": "+11234567890",

_11

"label": "Customer Support Line",

_11

"inbound": true,

_11

"outbound": true,

_11

"associated_agent": {

_11

"agent_id": "agent_0987654321fedcba",

_11

"agent_name": "Support Bot"

_11

}

_11

}