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

Incoming phone numbers on a Twilio account/project

Operations: `list`, `create`, `fetch`, `update`, `delete`

# `create`

```elixir
@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.IncomingPhoneNumber.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Purchase a phone-number for the account.

Operation: `CreateIncomingPhoneNumber` | Tags: Api20100401IncomingPhoneNumber

## Optional Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `AddressSid` | string | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ApiVersion` | string | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `AreaCode` | string | The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only). |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `BundleSid` | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `EmergencyAddressSid` | string | The SID of the emergency address configuration to use for emergency calling from the new phone number. |
| `EmergencyStatus` | string |  Values: `Active`, `Inactive` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `FriendlyName` | string | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `IdentitySid` | string | The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `PhoneNumber` | string (phone-number) | The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.  E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsApplicationSid` | string | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackMethod` | string (http-method) | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackUrl` | string (uri) | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsMethod` | string (http-method) | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
| `SmsUrl` | string (uri) | The URL we should call when the new phone number receives an incoming SMS message. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `StatusCallback` | string (uri) | The URL we should call using the `status_callback_method` to send status information to your application. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `StatusCallbackMethod` | string (http-method) | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `TrunkSid` | string | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceApplicationSid` | string | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceCallerIdLookup` | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceFallbackMethod` | string (http-method) | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceFallbackUrl` | string (uri) | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceMethod` | string (http-method) | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
| `VoiceReceiveMode` | string |  Values: `voice`, `fax` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceUrl` | string (uri) | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |

# `delete`

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

Delete a phone-numbers belonging to the account used to make the request.

Operation: `DeleteIncomingPhoneNumber` | Tags: Api20100401IncomingPhoneNumber

# `fetch`

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

Fetch an incoming-phone-number belonging to the account used to make the request.

Operation: `FetchIncomingPhoneNumber` | Tags: Api20100401IncomingPhoneNumber

# `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 incoming-phone-numbers belonging to the account used to make the request.

Operation: `ListIncomingPhoneNumber` | Tags: Api20100401IncomingPhoneNumber

## Query Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Beta` | boolean | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| `FriendlyName` | string | A string that identifies the IncomingPhoneNumber resources to read. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `PhoneNumber` | string (phone-number) | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Origin` | string | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. |

# `stream`

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

Stream: Retrieve a list of incoming-phone-numbers 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.IncomingPhoneNumber.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Update an incoming-phone-number instance.

Operation: `UpdateIncomingPhoneNumber` | Tags: Api20100401IncomingPhoneNumber

## Optional Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `AccountSid` | string | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update.  For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers). |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `AddressSid` | string | The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ApiVersion` | string | The API version to use for incoming calls made to the phone number. The default is `2010-04-01`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `BundleSid` | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `EmergencyAddressSid` | string | The SID of the emergency address configuration to use for emergency calling from this phone number. |
| `EmergencyStatus` | string |  Values: `Active`, `Inactive` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `FriendlyName` | string | A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `IdentitySid` | string | The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsApplicationSid` | string | The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackMethod` | string (http-method) | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsFallbackUrl` | string (uri) | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `SmsMethod` | string (http-method) | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
| `SmsUrl` | string (uri) | The URL we should call when the phone number receives an incoming SMS message. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `StatusCallback` | string (uri) | The URL we should call using the `status_callback_method` to send status information to your application. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `StatusCallbackMethod` | string (http-method) | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `TrunkSid` | string | The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceApplicationSid` | string | The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceCallerIdLookup` | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceFallbackMethod` | string (http-method) | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceFallbackUrl` | string (uri) | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceMethod` | string (http-method) | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. Values: `GET`, `POST` |
| `VoiceReceiveMode` | string |  Values: `voice`, `fax` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `VoiceUrl` | string (uri) | The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |

---

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