DocumentationEngagement Platform API
Sign inGet started
Guides
API

Long Code Numbers

Overview

The current concept of Number represents the so-called Long Code Number. Long Code Number always relates to the Number purchased or ordered from the Inventory. This is any number, that has a country prefix at the beginning. The term Number is renamed to LongCodeNumber.

API Access

The following API requests can only be made using a valid access key, and attached to an access role, with an access policy that at least specifies the permissions to the resources outlined in each section below. Learn more about API access.

List Long Code Numbers

In order to retrieve a list of long code numbers available in your workspace you can use this request.
GET
/workspaces/{workspaceId}/numbers-long-code
Get a list of all Long code numbers assigned to your workspace. You can filter your list of numbers by country code, types (e.g. a local, mobile, or toll-free number), supported capabilities and the number leading digits. The results can be paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.
Paramètres de requête
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
numberString
string
Used to filter numbers by their leading digits. The "+" prefix is optional, but the country code is required.
types
array
The number type depending on its purpose. Local for regional use, national for countrywide use, mobile for mobile networks, or toll-free for caller-free charging.
countryCodes
array
providerIds
array
capabilities
array
Corps de la réponse
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display. To know more, refer to the pagination section.
results
array of object
obligatoire
Afficher les attributs enfants
results.id
string
obligatoire
The unique identifier of the long code number. The endpoint ID is the same.
results.endpointId
string
obligatoire
The unique identifier of the endpoint. The long conde ID is the same.
results.numberString
string
obligatoire
The phone number in E.164 format.
results.countryCode
string
obligatoire
The country code in ISO 3166-1 alpha-2 format.
results.type
string
The type of long code number.
Possible values: local, national, toll-free, mobile
results.capabilities
object
obligatoire
Capabilities of the phone number. It shows if the phone number supports voice, sms and/or mms.
Afficher les attributs enfants
results.capabilities.voice
object
obligatoire
Afficher les attributs enfants
results.capabilities.voice.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
results.capabilities.voice.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
results.capabilities.sms
object
obligatoire
Afficher les attributs enfants
results.capabilities.sms.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
results.capabilities.sms.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
results.capabilities.mms
object
obligatoire
Afficher les attributs enfants
results.capabilities.mms.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
results.capabilities.mms.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
results.capabilities.whatsapp
object
Afficher les attributs enfants
results.capabilities.whatsapp.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
results.capabilities.whatsapp.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
results.createdAt
string
obligatoire
results.updatedAt
string
obligatoire
results.order
object
The order that created this long code number. It contains information such as the capabilities, order status and type.
Afficher les attributs enfants
results.order.countryCode
string
obligatoire
The country code in ISO 3166-1 alpha-2 format.
results.order.type
string
obligatoire
The type of long code number.
Possible values: local, national, toll-free, mobile
results.order.capabilities
array of string
obligatoire
results.order.prefix
string
results.order.status
string
obligatoire
Possible values: draft, submitted, processing, fulfilled, rejected, cancelled
results.order.createdAt
string
obligatoire
results.order.updatedAt
string
obligatoire
results.deprovisionAt
string
The date and time when the long code number should be deprovisioned.
results.endpoint
object
obligatoire
A representation of an endpoint. It contains details such as the capabilities, dependencies, and more.
Afficher les attributs enfants
results.endpoint.id
string
obligatoire
The ID of the endpoint.
results.endpoint.type
string
obligatoire
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
results.endpoint.instanceId
string
obligatoire
The unique identifier of the instance.
results.endpoint.name
string
obligatoire
The name of the endpoint. For some cases it will be the number in international format as string.
results.endpoint.capabilities
array of object
obligatoire
Afficher les attributs enfants
results.endpoint.capabilities.name
string
obligatoire
Possible values: sms
results.endpoint.capabilities.inbound
object
Afficher les attributs enfants
results.endpoint.capabilities.inbound.status
string
obligatoire
Possible values: active, inactive, available, unavailable
results.endpoint.capabilities.inbound.issues
array of string
results.endpoint.capabilities.outbound
object
Afficher les attributs enfants
results.endpoint.capabilities.outbound.status
string
obligatoire
Possible values: active, inactive, available, unavailable
results.endpoint.capabilities.outbound.destinationStatuses
object
Afficher les attributs enfants
results.endpoint.capabilities.outbound.destinationStatuses.active
number
results.endpoint.capabilities.outbound.destinationStatuses.inactive
number
results.endpoint.capabilities.outbound.destinationStatuses.available
number
results.endpoint.capabilities.outbound.destinationStatuses.unavailable
number
results.endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
results.endpoint.capabilities.outbound.issues
array of string
results.endpoint.dependencies
array of object
The dependencies of the endpoint. It shows the connectors that the endpoint is connected to.
Afficher les attributs enfants
results.endpoint.dependencies.type
string
Possible values: connector
results.endpoint.dependencies.connectorId
string
obligatoire
results.endpoint.dependencies.connectorTemplateRef
string
obligatoire
results.endpoint.dependencies.capabilities
array of string
results.endpoint.issues
array of string
results.endpoint.provisioningStatus
string
obligatoire
Possible values: provisioned, provisioning, deprovisioned, deprovisioning
results.endpoint.whatsApp
object
WhatsApp pre-verification details for this endpoint, if applicable. Only present for long code numbers from WhatsApp-capable providers.
Afficher les attributs enfants
results.endpoint.whatsApp.whatsAppId
string
results.endpoint.whatsApp.status
string
WhatsApp number status
Possible values: unknown, already-exists, installed, verified, not-verified, expired
results.endpoint.whatsApp.stage
string
results.endpoint.whatsApp.attempt
integer
results.endpoint.whatsApp.nextAttemptAt
string
results.endpoint.whatsApp.verificationExpiresAt
string
results.endpoint.whatsApp.requestedCodeAt
string
results.endpoint.whatsApp.createdAt
string
results.endpoint.whatsApp.updatedAt
string
results.endpoint.createdAt
string
obligatoire
results.endpoint.updatedAt
string
obligatoire
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/numbers-long-code' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
Exemple de code
curl "https://api.bird.com/workspaces/{workpaceId}/numbers-long-code/"
-H 'Authorization: Bearer '

Get a Long Code Number

In order to retrieve the details of a long code number available in your workspace you can use this request.
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.
Corps de la réponse
id
string
obligatoire
The unique identifier of the long code number. The endpoint ID is the same.
endpointId
string
obligatoire
The unique identifier of the endpoint. The long conde ID is the same.
numberString
string
obligatoire
The phone number in E.164 format.
countryCode
string
obligatoire
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
obligatoire
Capabilities of the phone number. It shows if the phone number supports voice, sms and/or mms.
Afficher les attributs enfants
capabilities.voice
object
obligatoire
Afficher les attributs enfants
capabilities.voice.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
capabilities.voice.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
capabilities.sms
object
obligatoire
Afficher les attributs enfants
capabilities.sms.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
capabilities.sms.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
capabilities.mms
object
obligatoire
Afficher les attributs enfants
capabilities.mms.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
capabilities.mms.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
capabilities.whatsapp
object
Afficher les attributs enfants
capabilities.whatsapp.inbound
boolean
obligatoire
Whether the number supports inbound use cases.
capabilities.whatsapp.outbound
boolean
obligatoire
Whether the number supports outbound use cases.
createdAt
string
obligatoire
updatedAt
string
obligatoire
order
object
The order that created this long code number. It contains information such as the capabilities, order status and type.
Afficher les attributs enfants
order.countryCode
string
obligatoire
The country code in ISO 3166-1 alpha-2 format.
order.type
string
obligatoire
The type of long code number.
Possible values: local, national, toll-free, mobile
order.capabilities
array of string
obligatoire
order.prefix
string
order.status
string
obligatoire
Possible values: draft, submitted, processing, fulfilled, rejected, cancelled
order.createdAt
string
obligatoire
order.updatedAt
string
obligatoire
deprovisionAt
string
The date and time when the long code number should be deprovisioned.
endpoint
object
obligatoire
A representation of an endpoint. It contains details such as the capabilities, dependencies, and more.
Afficher les attributs enfants
endpoint.id
string
obligatoire
The ID of the endpoint.
endpoint.type
string
obligatoire
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
obligatoire
The unique identifier of the instance.
endpoint.name
string
obligatoire
The name of the endpoint. For some cases it will be the number in international format as string.
endpoint.capabilities
array of object
obligatoire
Afficher les attributs enfants
endpoint.capabilities.name
string
obligatoire
Possible values: sms
endpoint.capabilities.inbound
object
Afficher les attributs enfants
endpoint.capabilities.inbound.status
string
obligatoire
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Afficher les attributs enfants
endpoint.capabilities.outbound.status
string
obligatoire
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Afficher les attributs enfants
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.
Afficher les attributs enfants
endpoint.dependencies.type
string
Possible values: connector
endpoint.dependencies.connectorId
string
obligatoire
endpoint.dependencies.connectorTemplateRef
string
obligatoire
endpoint.dependencies.capabilities
array of string
endpoint.issues
array of string
endpoint.provisioningStatus
string
obligatoire
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.
Afficher les attributs enfants
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
obligatoire
endpoint.updatedAt
string
obligatoire
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
Exemple de code
curl "https://api.bird.com/workspaces/{workspaceId}/numbers-long-code/{longCodeId}" \
     -H 'Authorization: Bearer <your-access-key>'