メディアプロバイダー
/v1/settings/application/media/providers
メディアリンクを送信するためのメディアプロバイダーのリストをコンパイルするには、/v1/settings/application/media/providersエンドポイントを使用します。
プロバイダーのリストを使用することにより、同じプロバイダータイプに対してさまざまなメディアプロバイダーを使い分け、リクエストごとに使用するプロバイダーを選択することができます。
このドキュメントでは、以下について説明します:
プロバイダーリストの更新
WhatsApp Business APIクライアントのプロバイダーを構成するには、/v1/settings/application/media/providersエンドポイント、およびプロバイダーの情報を使用します。現在のところ、一度に1つのプロバイダーのみ設定できます。また、現時点でそれらのプロバイダーオブジェクトは、基本認証またはベアラートークン認証のいずれかによるHTTP/HTTPSリンクを使用したメディアメッセージの送信にのみ使用できます。
リクエスト
以下に、基本認証によるWWW (つまりHTTP/HTTPSリンク)プロバイダーとベアラートークン認証によるプロバイダーを追加する例を示します。現在のところ、サポートされているのはこのプロバイダー形式のみです。
POST /v1/settings/application/media/providers
[{
"name": "your-first-provider",
"type": "www",
"config": {
"basic": {
"username": "your-username",
"password": "your-password"
}
}
}
]
POST /v1/settings/application/media/providers
[{
"name": "your-second-provider",
"type": "www",
"config": {
"bearer": "your-bearer-token"
}
}
]
注:各プロバイダーの名前はユニークなものにしてください。同じ名前を再利用すると、以前のエントリが上書きされます。
パラメーター
| 名前 | 必須かどうか | 説明 |
|---|---|---|
| 必須 | プロバイダーの名前 |
| 必須 | プロバイダーのタイプ |
| 必須 |
|
応答
リクエストが成功すると、HTTPステータスコードである200 OKとnullまたは{}のいずれかが返ります。
失敗した場合の応答には、エラーメッセージが含まれます。エラーについて詳しくは、エラーおよびステータスコードをご覧ください。
プロバイダーリストの取得
リクエスト
GET /v1/settings/application/media/providers
応答
成功した場合の応答には、プロバイダーのリストが含まれます。
"settings": {
"application": {
"media": {
"providers": [
{
"name": "your-first-provider",
"type": "www",
"config": {
"basic": {
"username": "your-username",
"password": "your-password"
}
}
},
{
"name": "your-second-provider",
"type": "www",
"config": {
"bearer": "your-bearer-token"
}
}
]
}
}
}
失敗した場合の応答には、エラーメッセージが含まれます。エラーについて詳しくは、エラーおよびステータスコードをご覧ください。
プロバイダーリストの削除
プロバイダーのnameを指定したDELETE API呼び出しを/v1/settings/application/media/providersエンドポイントに送信すると、そのプロバイダーがプロバイダーリストから削除されます。
リクエスト
DELETE /v1/settings/application/media/providers/your-config-name
応答
リクエストが成功すると、HTTPステータスコードである200 OKとnullまたは{}のいずれかが返ります。
失敗した場合の応答には、エラーメッセージが含まれます。エラーについて詳しくは、「エラーおよびステータスコード」をご覧ください。