List SMS templates
/v1/sms/templatesfor await (const tpl of bird.smsTemplates.list({ scope: "system" })) {
console.log(tpl.id, tpl.slug);
}for template in client.sms_templates.list(scope="system"):
print(template.id, template.slug)for tpl, err := range client.SmsTemplates.List(context.Background(), bird.SMSTemplateListParams{
Scope: "system",
}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(tpl.Id, *tpl.Slug)
}foreach ($bird->smsTemplates->list(['scope' => 'system']) as $template) {
echo $template->getId(), ' ', $template->getSlug(), "\n";
}bird sms templates listcurl -X GET "https://us1.platform.bird.com/v1/sms/templates" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25"{
"data": [
{
"id": "smt_01krdgeqcxet5s7t44vh8rt9mg",
"workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
"slug": "welcome-email",
"scope": "system",
"status": "active",
"category": "transactional",
"draft_version_id": "smv_01krdgeqcxet5s7t44vh8rt9mg",
"live_version_id": "smv_01krdgeqcxet5s7t44vh8rt9mg",
"published_version_id": "smv_01krdgeqcxet5s7t44vh8rt9mg",
"default_language": "pt-BR",
"available_languages": [
"pt-BR"
]
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns SMS templates as a cursor-paginated list. The workspace's templates
come first, newest first, followed by our built-in templates by default.
Set order=asc to reverse this order.
Filter by scope, category, status, or language. Use q for a
case-insensitive substring match against slug, name, and description. The
response is shallow; read a version to retrieve its content and variables.
Paramètres de requête
scopestringFilter by who owns the template. Use system for built-in templates and workspace for templates your workspace created.
Possible values: system, workspace
categorystringReturn templates in this category.
Possible values: transactional, marketing, authentication
statusstringReturn templates with this lifecycle status.
Possible values: draft, pending, active, rejected, inactive
languagestringReturn templates whose published content contains this language, after the tag is canonicalized. Draft-only languages do not match.
qstringA case-insensitive substring search across slug, name, and description.
sortstringField to sort by.
Possible values: created_at
orderstringSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
Possible values: asc, desc
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
Contenu de la réponse
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.