クラウドAPI

WhatsApp Businessプラットフォーム > クラウドAPI > リファレンス

登録

クラウドAPIでビジネス電話番号を使用するには、その番号を登録する必要があります。次のシナリオではビジネス電話番号を登録してください。

  • アカウント作成: このAPIを実装する際、メッセージを送信するために使用するビジネス電話番号を登録する必要があります。Metaはアカウント作成中に2段階認証の設定を強制することで、アカウントのセキュリティレイヤーを追加しています。
  • 名前の変更: これは、電話番号はすでに登録済みで、表示名を変更したいという場合です。そのためには、まずWhatsAppマネージャで名前変更を申請する必要があります。名前が承認されたら、新しい名前で電話番号を再度登録する必要があります。
  • 番号をオンプレミスAPIからクラウドAPIに移行する場合。移行の例外をご覧ください。

ビジネス電話番号を登録する前に、まずその番号の持ち主であることを確認する必要があります。

移行の例外

電話番号をオンプレミスAPIからクラウドAPIに移行する場合、クラウドAPIに電話番号を登録する前に行う必要がある追加の手順があります。全プロセスについては、オンプレミスAPIとクラウドAPI間の移行をご覧ください。

ビジネス電話番号を登録する

認証済みビジネスの電話番号を登録するには、POST呼び出しをPHONE_NUMBER_ID/registerに対して行います。以下にリストするパラメーターを含めます。

エンドポイント認証

PHONE_NUMBER_ID/register

(電話番号IDの取得をご覧ください)

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

制限

登録エンドポイントへのリクエストは、72時間の移動枠内でビジネス電話番号あたり10のリクエストに制限されます。

登録リクエストを行うと、過去72時間にその電話番号を登録するために行った登録リクエストの数が確認されます。すでに10のリクエストを行っている場合、APIはエラーコード133016を返し、その電話番号は次の72時間登録できなくなります。

パラメーター

名前説明

messaging_product

必須。

使用するメッセージサービス。これは"whatsapp"に設定してください。

pin

必須。

認証済みビジネスの電話番号ですでに2段階認証が有効になっている場合は、この値を、電話番号の6桁の2段階認証PINに設定してください。PINを思い出せない場合は、更新することができます。


認証済みビジネスの電話番号で2段階認証が有効になっていない場合は、この値を6桁の番号に設定してください。これが、新しく認証されたビジネスの電話番号の2段階認証PINになります。

data_localization_region

任意。


含まれている場合、そのビジネス電話番号でローカルストレージが有効になります。値は、データを保管する国を示す2文字のISO 3166の国コード(例: IN)でなければなりません。


使用できる値:


APAC

  • オーストラリア: AU
  • インドネシア: ID
  • インド: IN
  • 日本: JP
  • シンガポール: SG
  • 韓国: KR

ヨーロッパ

  • 欧州連合(ドイツ): DE
  • スイス: CH
  • イギリス: GB

ラテンアメリカ

  • ブラジル: BR

MEA

  • バーレーン: BH
  • 南アフリカ: ZA
  • アラブ首長国連邦: AE

NORAM

  • カナダ: CA

一度有効にすると、無効にしたり、直接変更したりすることはできません。その代わりに、電話番号を登録解除して、このパラメーターを付けずに再度登録する(無効にする)か、新しい国コードを指定したパラメーターを含める(変更する)必要があります。


すでに登録済みの番号でローカルストレージを有効にするには、その番号を登録解除してから再度登録し、このパラメーターを含める必要があります。

ローカルストレージなしのリクエストの例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834"
}

ローカルストレージありのリクエストの例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834",
  "data_localization_region": "CH"
}

All API calls require authentication with access tokens.

Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup.

Solution Partners must authenticate themselves with an access token with the whatsapp_business_messaging and whatsapp_business_management permissions. See System User Access Tokens for information.

ビジネス電話番号を登録解除する

ビジネス電話番号を登録解除すると、クラウドAPIでは使えなくなり、有効になっている場合、その番号のローカルストレージも無効になります。

登録解除しても、番号やメッセージ履歴は削除されません。番号や履歴を削除するには、WABAから電話番号を削除するを参照してください。

ビジネス電話番号の登録を解除するには、POST呼び出しをPHONE_NUMBER_ID/deregisterに対して行います。

エンドポイント認証

PHONE_NUMBER_ID/deregister

(電話番号IDの取得をご覧ください)

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

制限

登録解除エンドポイントへのリクエストは、72時間の移動枠内でビジネス電話番号あたり10のリクエストに制限されます。

登録解除リクエストを行うと、過去72時間にその電話番号を登録解除するために行った登録解除リクエストの数が確認されます。すでに10のリクエストを行っている場合、APIはエラーコード133016を返し、その電話番号は今後72時間登録解除できなくなります。

例

リクエストの例:

curl -X POST \  
 'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/deregister' \  
 -H 'Authorization: Bearer ACCESS_TOKEN'

成功した場合の応答は次のようになります。

{
  "success": true
}

参考情報