Short Code Numbers
Last updated
Was this helpful?
Last updated
Was this helpful?
A short number (4-6 digits) used for sending and receiving SMS and MMS messages to mobile phones in a single country. Short code numbers are strictly domestic and are not recommended for sending international traffic.
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 .
In order to retrieve all short code numbers available in your workspace you can use this request.
curl "https://api.bird.com/workspaces/{workpaceId}/numbers-short-code/" \
-H 'Authorization: Bearer <your-access-key>'{
"results": [
{
"id": "uuid",
"numberString": "string",
"countryCode": "string",
"capabilities": {
"voice": {
"inbound": false,
"outbound": false
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": false,
"outbound": false
}
},
"endpointId": "uuid",
"createdAt": "2023-10-23T12:35:39.339-03:00",
"updatedAt": "2023-10-23T12:35:39.411-03:00",
"endpoint": {
"id": "uuid",
"type": "short-code-number",
"instanceId": "uuid",
"name": "string",
"createdAt": "2023-10-23T12:35:39.339-03:00",
"updatedAt": "2023-10-23T12:35:39.382-03:00",
"capabilities": [
{
"name": "sms",
"inbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
]
},
"outbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
],
"destinationStatuses": {
"active": 1
}
}
}
]
}
},
{
"id": "uuid",
"numberString": "string",
"countryCode": "string",
"capabilities": {
"voice": {
"inbound": false,
"outbound": false
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": false,
"outbound": false
}
},
"endpointId": "uuid",
"createdAt": "2023-10-23T12:35:39.246-03:00",
"updatedAt": "2023-10-23T12:35:39.246-03:00",
"endpoint": {
"id": "uuid",
"type": "short-code-number",
"instanceId": "string",
"name": "string",
"createdAt": "2023-10-23T12:35:39.246-03:00",
"updatedAt": "2023-10-23T12:35:39.318-03:00",
"capabilities": [
{
"name": "sms",
"inbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
]
},
"outbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
],
"destinationStatuses": {
"active": 1
}
}
}
]
}
}
]
}
In order to retrieve the details of a short code number available in your workspace you can use this request.
curl "https://api.bird.com/workspaces/{workpaceId}/numbers-short-code/{shorCodeNumberId}" \
-H 'Authorization: Bearer <your-access-key>'{
"id": "uuid",
"numberString": "string",
"countryCode": "string",
"capabilities": {
"voice": {
"inbound": false,
"outbound": false
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": false,
"outbound": false
}
},
"endpointId": "uuid",
"createdAt": "2023-10-23T12:35:39.339-03:00",
"updatedAt": "2023-10-23T12:35:39.411-03:00",
"endpoint": {
"id": "uuid",
"type": "short-code-number",
"instanceId": "uuid",
"name": "string",
"createdAt": "2023-10-23T12:35:39.339-03:00",
"updatedAt": "2023-10-23T12:35:39.382-03:00",
"capabilities": [
{
"name": "sms",
"inbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
]
},
"outbound": {
"status": "active",
"subscriptions": [
"main"
],
"fees": [
"setup"
],
"destinationStatuses": {
"active": 1
}
}
}
]
}
}Limits the number of results to return
10Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
falseGET /workspaces/{workspaceId}/numbers-short-code HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
OK
{
"nextPageToken": "text",
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"endpointId": "123e4567-e89b-12d3-a456-426614174000",
"type": "dedicated",
"numberString": "text",
"countryCode": "text",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"createdAt": "2025-04-18T23:38:11.714Z",
"updatedAt": "2025-04-18T23:38:11.714Z",
"endpoint": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "long-code-number",
"instanceId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"capabilities": [
{
"name": "sms",
"inbound": {
"status": "active",
"issues": [
"subscription-is-not-active"
]
},
"outbound": {
"status": "active",
"destinationStatuses": {
"active": 1,
"inactive": 1,
"available": 1,
"unavailable": 1
},
"supportsDestinations": true,
"issues": [
"subscription-is-not-active"
]
}
}
],
"dependencies": [
{
"type": "connector",
"connectorId": "123e4567-e89b-12d3-a456-426614174000",
"connectorTemplateRef": "text",
"capabilities": [
"voice"
]
}
],
"issues": [
"subscription-is-not-active"
],
"provisioningStatus": "provisioned",
"createdAt": "2025-04-18T23:38:11.714Z",
"updatedAt": "2025-04-18T23:38:11.714Z"
}
}
]
}GET /workspaces/{workspaceId}/numbers-short-code/{shortCodeNumberId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"endpointId": "123e4567-e89b-12d3-a456-426614174000",
"type": "dedicated",
"numberString": "text",
"countryCode": "text",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"createdAt": "2025-04-18T23:38:11.714Z",
"updatedAt": "2025-04-18T23:38:11.714Z",
"endpoint": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "long-code-number",
"instanceId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"capabilities": [
{
"name": "sms",
"inbound": {
"status": "active",
"issues": [
"subscription-is-not-active"
]
},
"outbound": {
"status": "active",
"destinationStatuses": {
"active": 1,
"inactive": 1,
"available": 1,
"unavailable": 1
},
"supportsDestinations": true,
"issues": [
"subscription-is-not-active"
]
}
}
],
"dependencies": [
{
"type": "connector",
"connectorId": "123e4567-e89b-12d3-a456-426614174000",
"connectorTemplateRef": "text",
"capabilities": [
"voice"
]
}
],
"issues": [
"subscription-is-not-active"
],
"provisioningStatus": "provisioned",
"createdAt": "2025-04-18T23:38:11.714Z",
"updatedAt": "2025-04-18T23:38:11.714Z"
}
}