# `Twilio.Api.V2010.SMS.ShortCodeService`
[🔗](https://github.com/jeffhuen/twilio_elixir/blob/main/lib/twilio/api/v2010/sms/short_code_service.ex#L2)

Messaging short codes

Operations: `list`, `fetch`, `update`

# `fetch`

```elixir
@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.SMS.ShortCode.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Fetch an instance of a short code

Operation: `FetchShortCode` | Tags: Api20100401ShortCode

# `list`

```elixir
@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Retrieve a list of short-codes belonging to the account used to make the request

Operation: `ListShortCode` | Tags: Api20100401ShortCode

## Query Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `FriendlyName` | string | The string that identifies the ShortCode resources to read. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ShortCode` | string | Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. |

# `stream`

```elixir
@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()
```

Stream: Retrieve a list of short-codes belonging to the account used to make the request (lazy auto-pagination).

# `update`

```elixir
@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.SMS.ShortCode.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Update a short code with the following parameters

Operation: `UpdateShortCode` | Tags: Api20100401ShortCode

## Optional Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `ApiVersion` | string | The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `FriendlyName` | string | A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackMethod` | string (http-method) | The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackUrl` | string (uri) | The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsMethod` | string (http-method) | The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`. Values: `GET`, `POST` |
| `SmsUrl` | string (uri) | The URL we should call when receiving an incoming SMS message to this short code. |

---

*Consult [api-reference.md](api-reference.md) for complete listing*