# `KapsoEx.WhatsApp.PhoneNumbers`
[🔗](https://github.com/rocket4ce/kapso_ex/blob/v0.1.0/lib/kapso_ex/whatsapp/phone_numbers.ex#L1)

Phone number details and settings, as returned by Meta.

To connect, list or delete numbers in your Kapso project, use
`KapsoEx.Platform.PhoneNumbers`.

# `result`

```elixir
@type result() :: {:ok, map()} | {:error, KapsoEx.Error.t()}
```

# `get`

```elixir
@spec get(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()
```

Gets phone number details (quality rating, name status, throughput, ...). Params: `fields`.

# `list`

```elixir
@spec list(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()
```

Lists the phone numbers of a WhatsApp Business Account. Params: `fields`.

# `update`

```elixir
@spec update(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()
```

Updates phone number settings, most commonly the two-step verification PIN:

    PhoneNumbers.update(client, phone_number_id, %{pin: "123456"})

---

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