Path parameters

• ServiceSid string Required

  The SID of the Service to read the resources from.

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

Query parameters

• IsoCountryCode string

  Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.

• PageSize integer(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • alpha_senders array[object]
    Hide alpha_senders attributes Show alpha_senders attributes object

    • sid string | null

      The unique string that we created to identify the AlphaSender resource.

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

    • account_sid string | null

      The SID of the Account that created the AlphaSender resource.

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

    • service_sid string | null

      The SID of the Service 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}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • 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. Can be: SMS.

    • url string(uri) | null

      The absolute URL of the AlphaSender resource.

    • iso_country_code string | null

      The Two Character ISO Country Code the Alphanumeric Sender ID will be used for. For Default Alpha Senders that work across countries, this value will be an empty string

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)