オンプレミスAPIを終了します。詳細と次世代クラウドAPIへの移行方法については、オンプレミスAPIの終了のドキュメントを参照してください。
ログアウト
/v1/users/logout
/v1/users/logoutエンドポイントを使用して、WhatsApp Business APIクライアントからログアウトします。ログアウトすると、認証トークンが取り消されます。
開始する前に
- WhatsApp Business APIクライアントからログアウトすると、リクエストと共に送信された認証トークンが明示的に取り消されます。同じユーザーネームに関連付けられているその他のトークンはすべて有効なままです。
- ユーザーをログアウトさせるか、そのユーザーのトークンを取り消す場合は、DELETE /v1/usersエンドポイントを代わりに使用します。このアクションにより、ユーザーはシステムから削除されます。
作成
ユーザーは、このエンドポイントにPOST呼び出しを実行することにより、ログアウトリクエストを作成できます。
例
POST /v1/users/logout Authorization: Bearer your-auth-token
ログアウトリクエストに対する応答の本文には、metaオブジェクトが含まれます。
| HTTP応答コード | 結果 |
|---|---|
| 成功 — リクエストが承認され、ユーザーはアカウントからログアウトされます。 |
| エラー — リクエストは承認されず、ユーザーはアカウントからログアウトされません。エラーコードと説明に、エラーの考えられる原因(認証情報が無効など)が示されます。 |
エラー
応答にエラーがある場合は、以下の資料を参照して詳細を確認してください。