KapsoEx.WhatsApp.PhoneNumbers (kapso_ex v0.1.0)

Copy Markdown View Source

Phone number details and settings, as returned by Meta.

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

Summary

Functions

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

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

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

Types

result()

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

Functions

get(client, phone_number_id, params \\ [])

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

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

list(client, business_account_id, params \\ [])

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

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

update(client, phone_number_id, attrs)

@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"})