アカウント

/v1/account

オンプレミスAPIは廃止されます。このエンドポイントを使ったビジネスの電話番号の登録はできなくなり、以下のエラーが返されます。

{
  "code": 1005,
  "title": "Access denied",
  "details": "Unknown error: biz_link_on_prem_reg_blocked"
}

WhatsApp Business APIクライアントの登録には、accountノードを使用してください。

すでに別の番号が登録されているクラスターに新しい番号が登録された場合、Coreappが再起動するのでご注意ください。

エッジ

このノードには次のエッジが接続されています。

エッジ説明

/verify

指定した方法で登録コードを受け取ったら、このエッジを使用してアカウント登録を完了します。

開始する前に

以下の情報が必要です。

base64エンコードされた証明書のコピー

base64エンコードされた証明書の文字列が生成され、WhatsApp Business APIクライアント登録時の検証に使用されます。

  1. Metaビジネスマネージャ[ビジネス設定]に移動します。
  2. [アカウント]メニューの[WhatsAppアカウント]をクリックします。[WhatsAppアカウント]リストで、対象のWhatsAppアカウントがハイライトされていない場合は選択します。
  3. [設定]タブに移動し、[WhatsAppマネージャ]ボタンをクリックします。
  4. [電話番号]タブに電話番号がリスト表示されます。証明書が必要な電話番号の[表示]ボタンをクリックします。
    証明書の取得
  5. ポップアップダイアログが開き、グレーのボックスに証明書の文字列が表示されます。[証明書を取得]をクリックします。
    証明書の文字列のダウンロード
  6. この証明書の文字列は、accountエンドポイントへの登録時のcertパラメーターで使用します。

詳しくは、表示名に関するドキュメントをご覧ください。

制約

  • アプリを登録するには、必ずadminアカウントを使用します。
  • アカウントを再登録している場合は、登録の完了後にCoreappを再起動する必要があります。

リクエスト

登録コードをリクエストするには、このエンドポイントにPOST呼び出しを行います。呼び出しに、電話番号とbase64エンコードされた証明書の文字列を追加します。SMSまたは音声通話でコードを受け取ることができます。

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

受信した応答に応じて、登録手続きが完了したと見なしてよい場合と、完了するにはさらに手順を踏むことが必要な場合があります。成功した場合は、次のいずれかのHTTPステータスコードが返されます。受信した応答に応じた手順に従ってください。

  • 201 Created — アカウントがすでに存在します。すでに登録されているため、他に必要な作業はありません。
  • 202 Accepted — アカウントが存在しません。リクエストで選択した方法に応じて、SMSまたは音声番号を確認して登録コード取得します。この応答には返されたペイロードが含まれており、その中にcertパラメーターからデコードされたvnameがあります。これで、正しい表示名が設定されていることを確認できます。正しければ、アカウント登録の完了に進んで登録を完了します。
{
  "account": [{
      "vname": "decoded-vname-from-cert"
  }]
}

エラーが返された場合は、エラーおよびステータスメッセージで詳細をご覧ください。

パラメーター

名前説明

cc

必須。

登録する電話番号の数字の国コード

phone_number

必須。

国コードやプラス記号(+)を除いた、登録する電話番号。

method

必須。

登録コードの受け取り方法
オプション:voicesms

cert

必須。

base64エンコードされた証明書。

pin

任意。

既存の6桁のPIN - このアカウントで二段階認証が有効になっている場合にのみ必要です。

2段階認証PINの変更

ビジネス電話番号の2段階認証PINを変更するには、次のようにします。

  1. WhatsAppマネージャで、ビジネスポートフォリオを読み込みます。
  2. [電話番号]パネルが自動的に読み込まれない場合は、[アカウントツール] (ツールボックスのアイコン) > [電話番号]に移動します。
  3. 電話番号の設定(ギア)アイコンをクリックします。
  4. [2段階認証]をクリックします。
  5. [PINを変更する]をクリックし、フローを完了させます。

変更するには、現在のPINを入力する必要があります。APIを使用して新しいPINを設定することもできます。

2段階認証を無効にする

2段階認証を無効にするには、PINを変更する手順に従い、最後のステップで[2段階認証をオフにする]ボタンをクリックしてください。ビジネスポートフォリオに関連付けられているメールアドレスに、リンクを記載したメールが送信されます。2段階認証を無効にするにはこのリンクを使用してください。無効になったら、新しいPINを設定することで再度有効にできます。

よくある質問

はい、ライブ配信を開始する準備が整ったら、新しい電話番号を設定したり、認証済み名称を変更したりできます。

フリーダイヤル番号は、国コードが含まれていれば使用できます。これは、国コードが含まれないフリーダイヤル番号では、同じ電話番号が2つの異なる国の電話番号に該当する場合があり、固有に識別できないためです。

また、フリーダイヤル番号には、他にも注意が必要な点があります。通常、国内でその国の国コードを付けてフリーダイヤル番号に電話を掛けてもつながりません。これは、国内の顧客がビジネス連絡先に記載された番号(国コード付き)に電話を掛けようとしてもつながらない可能性があることを意味します。その点が心配な場合は、顧客に番号を明示的に知らせる必要があります。

フリーダイヤル番号について詳しくは、こちらをご覧ください。

現在の設定をバックアップして新しいマシンでそれを復元する場合、登録情報は実装のその他の部分とともに移行されるはずです。詳細については、「バックアップと復元の設定」ドキュメントをご覧ください。

FacebookビジネスマネージャのWhatsAppアカウントで新しい電話番号を登録し、古い番号を削除することができます。

  1. WhatsAppアカウントで、[設定]に移動します。
  2. [WhatsAppマネージャ]をクリックします。
  3. [電話番号]タブを選択します。ここで、このアカウントのすべての電話番号を管理できます。

登録の試行回数が多すぎて「SMS」で登録失敗し、「アクセスできません」というメッセージが表示される場合、「音声」で登録を試行してください。

Facebookから登録コードを送信できるように、SMSまたは音声通話を受信できる別の電話番号を選択してください。以前は手動登録コードを使用できましたが、現在ではサポートされていません。以前に手動登録コードを使用していた電話番号は、引き続き必要に応じて手動登録コードをサポートします。新しい電話番号の場合は、登録コードはSMSまたは音声通話でのみで配信されます。

1800またはフリーダイヤルを使用する場合は、こちらのガイドをお読みください。