Get Number | AgentPhone

const url = 'https://api.agentphone.ai/v1/numbers/number_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "string",
  "phoneNumber": "string",
  "country": "string",
  "status": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "type": "sms",
  "agentId": "string",
  "outboundSms": "enabled",
  "inboundCallsEnabled": true,
  "readReceiptsEnabled": true,
  "whatsappEnabled": false,
  "dailyNewContacts": {
    "used": 1,
    "limit": 1
  },
  "externalId": "string",
  "rcsFallbackForAlias": "string",
  "expiresAt": "string",
  "purchasedAt": "2024-01-15T09:30:00Z",
  "renewsAt": "string"
}

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

number_idstringRequired

Response

Successful Response

idstring

phoneNumberstring

countrystring

statusstring

createdAtdatetime

typestringOptionalDefaults to sms

agentIdstring or nullOptional

outboundSmsenumOptionalDefaults to enabled

Outbound SMS readiness for this exact number: activating means campaign attachment is in progress; enabled means confirmed; registration_required means registration or attachment is still needed. Check the number and registration in the same account/sub-account scope. See /sms-registration.

Allowed values:

inboundCallsEnabledbooleanOptionalDefaults to true

readReceiptsEnabledbooleanOptionalDefaults to true

whatsappEnabledbooleanOptionalDefaults to false

dailyNewContactsobject or nullOptional

externalIdstring or nullOptional

rcsFallbackForAliasstring or nullOptional

expiresAtstring or nullOptional

purchasedAtdatetime or nullOptional

renewsAtstring or nullOptional

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

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors