How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Sms Messages API

Send SMS messages to recipients you address by phone number, and read their delivery status and lifecycle events. Each message is one recipient and one body; set `category` to control opt-out policy and per-country compliance.

Bird Sms Messages API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include sms-messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 5 operations across 4 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

5 operations 4 paths 31 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Sms Messages API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

sms-messages 5

Send SMS messages to recipients you address by phone number, and read their delivery status and lifecycle events. Each message is one recipient and one body; set category to contr…

POST
/v1/sms/messages
Create an SMS message
createSMSMessage 1 param body → 202400401402403422429500
GET
/v1/sms/messages
List SMS messages
listSMSMessages 12 params → 200401403422429500503
POST
/v1/sms/batches
Create a batch of SMS messages
createSMSMessageBatch 1 param body → 202400401402403422429500
GET
/v1/sms/messages/{message_id}
Get an SMS message
getSMSMessage 1 param → 200401403404422429500503
GET
/v1/sms/messages/{message_id}/events
List events for an SMS message
listSMSMessageEvents 2 params → 200401403404422429500503

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SMSMessage (24 properties), SMSMessageSendRequest (18 properties), ErrorBody (11 properties), SMSEvent (6 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
SMSSegments
object
Segment breakdown for the message body. Segment count drives billing.
3 properties 3 required
SMSErrorCode
string
Standardized failure reason: - invaliddestination: The number is unassigned, ported out, or malformed. - unreachable: The handset is off or outside coverage. -…
SMSMessageBatchResponse
object
2 properties 2 required
ErrorDetail
object
2 properties 2 required
SMSTemplateSend
object
A send-by-template reference. Identify the template by id or slug, or use the deprecated name for a legacy built-in template. Supply exactly one reference, opt…
5 properties
ErrorBody
object
11 properties 6 required
CurrencyCode
string
ISO 4217 three-letter currency code.
SMSError
objectnull
Failure detail for a message that could not be delivered or was rejected.
4 properties 3 required
SMSEventList
object
1 property 1 required
SMSMessageSendRequest
object
A message to send. Supply exactly one of text (free-text, which also requires category) or template (a stored template, whose category is derived). Supplying b…
18 properties 1 required
SMSBatchSummary
object
Aggregate result for an SMS batch.
1 property 1 required
NextAction
object
5 properties 2 required
TemplateSlug
string
A template's slug: what you send it by, for example welcome-email. Email and SMS slugs stay fixed after creation. WhatsApp slugs can change only before the fir…
SMSEvent
object
6 properties 3 required
SMSMessageCategory
string
Content classification: why you are sending. Carriers see it, and where a destination country requires the sender to be registered, that registration is approv…
SMSMessageEffectiveOptions
object
The settings Bird applied to this message. Every option is reported, whether you set it on the send or took the default that was in force at the time.
1 property 1 required
SMSMessageList
SMSSendOptions
object
Settings that change how Bird processes this message. Each option applies to this send only; omit one to use its default.
3 properties
MessageDirection
string
Whether a message was sent from the workspace (outbound) or received by it (inbound).
MessageCost
objectnull
What was charged for a message, split into the components that make it up. null until at least one component has been priced.
4 properties 4 required
SMSMessage
object
24 properties 12 required
Error
object
1 property 1 required
SMSTemplateContentHash
string
A fingerprint of SMS template text, prefixed with its algorithm. Compare it within this API version to identify the exact source without transferring it.
Tag
object
Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surf…
2 properties 2 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
SMSTemplateID
string
SMSMessageBatchRequest
object
Batch of SMS message send requests.
1 property 1 required
SMSMessageStatus
string
Delivery status: - accepted: Accepted and awaiting carrier handoff. - sent: Handed to the carrier and awaiting a delivery receipt. - delivered: Confirmed as de…
SMSTemplateVersionID
string
SMSMessageID
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-sms-messages-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Sms Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.