Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

List SMS messaging profiles

GET
/v1/sms/messaging-profiles
bird sms messaging-profiles list
Odpowiedź200
{
  "data": [
    {
      "id": "mpr_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "device-activation",
      "senders": [
        {
          "country_code": "US",
          "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg"
        }
      ],
      "inbound": {
        "numbers": [
          {
            "country_code": "US",
            "number": "34001"
          }
        ],
        "callback_url": "https://receipts.example.com/bird/sms/inbound",
        "outbound_matching": {
          "enabled": false,
          "time_window": "1d"
        }
      },
      "default_category": "authentication",
      "validity_period": 3600,
      "cost_center": "CC001234",
      "options": {
        "smart_encoding": false,
        "ignore_suppression": false,
        "callback_url": "https://receipts.example.com/bird/sms/activation"
      },
      "callback_events": [
        "sms.delivered",
        "sms.failed"
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns your workspace's messaging profiles, newest first. A profile holds the senders, reply numbers, and sending defaults for one program.

Parametry zapytania

sortstring

Field to sort by.

Possible values: created_at

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor 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_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Treść odpowiedzi

data
array of object
wymagane

Your workspace's messaging profiles, newest first.

Pokaż atrybuty podrzędne
next_cursor
nullable string
wymagane

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
wymagane

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
wymagane

Refresh 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.

total
nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed, and omitted otherwise.

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy