Get Long Code Number Details

Get the details of a specific Long code nnumber that you own.

GET

/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}

This endpoint returns the information of a Long Code Number assigned to the workspace given its ID. You may use the EndpointID as well to search for your long code number.

Treść odpowiedzi

string

wymagane

The unique identifier of the long code number. The endpoint ID is the same.

endpointId

string

wymagane

The unique identifier of the endpoint. The long conde ID is the same.

numberString

string

wymagane

The phone number in E.164 format.

countryCode

string

wymagane

The country code in ISO 3166-1 alpha-2 format.

type

string

The type of long code number.

Possible values: local, national, toll-free, mobile

capabilities

object

wymagane

Capabilities of the phone number. It shows if the phone number supports voice, sms and/or mms.

Pokaż atrybuty podrzędne

capabilities.voice

object

wymagane

Pokaż atrybuty podrzędne

capabilities.voice.inbound

boolean

wymagane

Whether the number supports inbound use cases.

capabilities.voice.outbound

boolean

wymagane

Whether the number supports outbound use cases.

capabilities.sms

object

wymagane

Pokaż atrybuty podrzędne

capabilities.sms.inbound

boolean

wymagane

Whether the number supports inbound use cases.

capabilities.sms.outbound

boolean

wymagane

Whether the number supports outbound use cases.

capabilities.mms

object

wymagane

Pokaż atrybuty podrzędne

capabilities.mms.inbound

boolean

wymagane

Whether the number supports inbound use cases.

capabilities.mms.outbound

boolean

wymagane

Whether the number supports outbound use cases.

capabilities.whatsapp

object

Pokaż atrybuty podrzędne

capabilities.whatsapp.inbound

boolean

wymagane

Whether the number supports inbound use cases.

capabilities.whatsapp.outbound

boolean

wymagane

Whether the number supports outbound use cases.

createdAt

string

wymagane

updatedAt

string

wymagane

order

object

The order that created this long code number. It contains information such as the capabilities, order status and type.

Pokaż atrybuty podrzędne

order.countryCode

string

wymagane

The country code in ISO 3166-1 alpha-2 format.

order.type

string

wymagane

The type of long code number.

Possible values: local, national, toll-free, mobile

order.capabilities

array of string

wymagane

order.prefix

string

order.status

string

wymagane

Possible values: draft, submitted, processing, fulfilled, rejected, cancelled

order.createdAt

string

wymagane

order.updatedAt

string

wymagane

deprovisionAt

string

The date and time when the long code number should be deprovisioned.

endpoint

object

wymagane

A representation of an endpoint. It contains details such as the capabilities, dependencies, and more.

Pokaż atrybuty podrzędne

endpoint.id

string

wymagane

The ID of the endpoint.

endpoint.type

string

wymagane

The type of the endpoint. It can be a long code number, short code number, alpha number, ip pool, or rcs google agent.

Possible values: long-code-number, short-code-number, alpha-number, ip-pool, rcs-google-agent

endpoint.instanceId

string

wymagane

The unique identifier of the instance.

endpoint.name

string

wymagane

The name of the endpoint. For some cases it will be the number in international format as string.

endpoint.capabilities

array of object

wymagane

Pokaż atrybuty podrzędne

endpoint.capabilities.name

string

wymagane

Possible values: sms

endpoint.capabilities.inbound

object

Pokaż atrybuty podrzędne

endpoint.capabilities.inbound.status

string

wymagane

Possible values: active, inactive, available, unavailable

endpoint.capabilities.inbound.issues

array of string

endpoint.capabilities.outbound

object

Pokaż atrybuty podrzędne

endpoint.capabilities.outbound.status

string

wymagane

Possible values: active, inactive, available, unavailable

endpoint.capabilities.outbound.destinationStatuses

object

Pokaż atrybuty podrzędne

endpoint.capabilities.outbound.destinationStatuses.active

number

endpoint.capabilities.outbound.destinationStatuses.inactive

number

endpoint.capabilities.outbound.destinationStatuses.available

number

endpoint.capabilities.outbound.destinationStatuses.unavailable

number

endpoint.capabilities.outbound.supportsDestinations

boolean

Whether the number supports destinations

endpoint.capabilities.outbound.issues

array of string

endpoint.dependencies

array of object

The dependencies of the endpoint. It shows the connectors that the endpoint is connected to.

Pokaż atrybuty podrzędne

endpoint.dependencies.type

string

Possible values: connector

endpoint.dependencies.connectorId

string

wymagane

endpoint.dependencies.connectorTemplateRef

string

wymagane

endpoint.dependencies.capabilities

array of string

endpoint.issues

array of string

endpoint.provisioningStatus

string

wymagane

Possible values: provisioned, provisioning, deprovisioned, deprovisioning

endpoint.whatsApp

object

WhatsApp pre-verification details for this endpoint, if applicable. Only present for long code numbers from WhatsApp-capable providers.

Pokaż atrybuty podrzędne

endpoint.whatsApp.whatsAppId

string

endpoint.whatsApp.status

string

WhatsApp number status

Possible values: unknown, already-exists, installed, verified, not-verified, expired

endpoint.whatsApp.stage

string

endpoint.whatsApp.attempt

integer

endpoint.whatsApp.nextAttemptAt

string

endpoint.whatsApp.verificationExpiresAt

string

endpoint.whatsApp.requestedCodeAt

string

endpoint.whatsApp.createdAt

string

endpoint.whatsApp.updatedAt

string

endpoint.createdAt

string

wymagane

endpoint.updatedAt

string

wymagane

Przykład kodu

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'