List SMS templates
GET
/v1/sms/templates
curl -X GET "https://us1.platform.bird.com/v1/sms/templates" \
-H "Authorization: Bearer $TOKEN"Returns the SMS templates available to your workspace, including Bird's built-in templates. Filter by scope, category, or language.
查询参数
scope
string
Filter by scope. Omit for all.
category
string
Filter by category.
locale
string
Keep only templates available in this language, as a BCP-47 tag.
响应载荷
data
array of object
必填
The templates available to your workspace. The catalogue is small and returned in full — this list is not paginated.
显示子属性
data.id
string
必填
Unique identifier for the template.
data.name
string
必填
Human-readable description of what the template is for.
data.alias
string
必填
The template's stable handle. Pass it (or the id) as the template reference when sending.
data.scope
string
必填
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
data.category
object
必填
Content classification applied to messages sent from this template.
data.body
string
必填
The template body in its default language, shown for preview.
data.variables
array of object
必填
The typed slots this template fills in from the values you supply when sending.
显示子属性
data.variables.key
string
必填
The parameters key this slot is filled with.
data.variables.type
string
必填
The value type this slot accepts. Open enum — treat any unrecognized value as a future type rather than an error. SMS templates use the typed slots (code, amount, …); email templates use text.
data.variables.required
boolean
必填
Whether the slot must be supplied when sending. Advisory for email templates, where a missing value renders as empty rather than rejecting the send.
data.variables.constraint
string
必填
A human-readable description of the accepted values.
data.available_locales
array of string
必填
The languages this template is available in, as BCP-47 tags.
data.status
string
必填
The template's lifecycle state. Built-in templates are always active.
data.draft_version_id
nullable string
必填
The current editable draft version. Always null today — SMS templates are not yet versioned; present for parity with email templates.
data.published_version_id
nullable string
The currently published version, or null if the template has never been published. Always null today — SMS templates are not yet versioned; present for parity with email templates.
data.revision
nullable integer
必填
The draft's revision counter. Always null today — SMS templates are not yet versioned; present for parity with email templates.
data.created_at
nullable string
必填
When the template was created. Null for built-in templates.
data.updated_at
nullable string
必填
When the template was last updated. Null for built-in templates.