AGagentphone
numbers

Get Number

Changed on

Get a single phone number owned by this account.

Returns the number regardless of status (including released) so detail pages still load for numbers that are no longer active. ext:<externalId> in place of the id looks the number up by the tag you set.

get/v1/numbers/{number_id}

Request

  • Base URL
    https://api.agentphone.ai
  • URL
    https://api.agentphone.ai/v1/numbers/{number_id}
  • Auth
    HTTP bearer

Path parameters

number_idstring required

Response

Successful Response

idstring required
phoneNumberstring required
countrystring required
statusstring required
typestring
agentIdstring nullable
outboundSms'enabled' | 'activating' | 'registration_required'
inboundCallsEnabledboolean
readReceiptsEnabledboolean
whatsappEnabledboolean
externalIdstring nullable
rcsFallbackForAliasstring nullable
expiresAtstring nullable
createdAtstring date-time required
purchasedAtstring date-time nullable
renewsAtstring nullable

Scheduled renewal of this number's monthly fee, ISO 8601 UTC. Null when no renewal is scheduled or its date is not known.

Changes