List alpha sender

GET /v1/Services/{ServiceSid}/AlphaSenders

A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.

Path parameters

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • alpha_senders array[object]
      Hide alpha_senders attributes Show alpha_senders attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • alpha_sender string | null

        The Alphanumeric Sender ID string

      • capabilities array[string] | null

        An array of values that describe whether the number can receive calls or messages

      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was last updated

      • service_sid string | null

        The SID of the Service that the resource is associated with

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AI[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The absolute URL of the AlphaSender resource

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Services/{ServiceSid}/AlphaSenders 
curl \
 -X GET https://messaging.twilio.com/v1/Services/{ServiceSid}/AlphaSenders \
 --user "username:password"
Response examples (200) 
{
  "alpha_senders": [
    {
      "account_sid": "string",
      "alpha_sender": "string",
      "capabilities": [
        "string"
      ],
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "service_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}