List your SMS senders
/v1/sms/sendersawait bird.smsSenders.list();client.sms_senders.list()for sender, err := range client.SmsSenders.List(ctx, bird.SmsSendersListParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(sender.Id)
}foreach ($bird->smsSenders->list() as $sender) {
echo $sender->getId(), PHP_EOL;
}bird sms senders listcurl -X GET "https://us1.platform.bird.com/v1/sms/senders" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"{
"data": [
{
"id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
"source_kind": "number",
"sender_type": "long_code",
"country_code": "US",
"number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
"status": "active",
"next": [
{
"kind": "operation"
}
],
"destinations": {
"active": [
"US"
],
"pending": [
"US"
],
"needs_attention": [
"US"
]
}
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the dedicated numbers and alphanumeric senders your workspace holds, newest first, with each sender's per-country registration status.
Query Parameters
typestringFilter senders by source type: a dedicated number, shared shortcode, or alphanumeric sender string.
Possible values (may grow over time): number, shared_number, alpha
number_idstringReturn the sender for one number you hold, using the ID from List workspace numbers. Exactly one sender exists per number, so this returns at most one result.
sortstringField to sort by. created_at (the default) sorts newest first with the default order. sender sorts alphabetically by the sender's own value (phone number, short code, or alphanumeric sender string), all treated as plain text.
Possible values: created_at, sender
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.
include_totalbooleanWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
Response Payload
dataYour workspace's dedicated numbers and alphanumeric senders, newest first.
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.
totalTotal number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.
Related resources
Continue with the documentation, guides and examples for this topic.