媒體供應商

/v1/settings/application/media/providers

使用 /v1/settings/application/media/providers 端點,編譯媒體供應商清單以傳送媒體連結。供應商清單讓您可以獲得屬於相同供應商類型的不同媒體供應商,同時可以根據每個要求選擇想採用的供應商。

檢索

使用此 API 要求檢索供應商清單。

範例

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"
                        }
                    }
                ]
            }
        }
    }

不成功的回應會包含錯誤訊息。如需更多有關錯誤的資訊,請參閱錯誤和狀態代碼

更新

如要為 WhatsApp Business API 用戶端配置供應商,請使用包含供應商資訊的 /v1/settings/application/media/providers 端點。目前,您每次只能設定一位供應商。此外,您只能在使用採用基本驗證或持有人憑證驗證的 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{} 的其中一項。

不成功的回應會包含錯誤訊息。如需更多有關錯誤的資訊,請參閱錯誤和狀態代碼

請確保為每個供應商取一個不重複的名稱,因為重用名稱會覆蓋較舊的條目。

參數

名稱說明

name

此為必要項目。

供應商的名稱

type

此為必要項目。

供應商的類型

config

此為必要項目。

config 物件

刪除

/v1/settings/application/media/providers 端點傳送包含供應商 nameDELETE API 呼叫,將該供應商從供應商清單中刪除。

範例

DELETE /v1/settings/application/media/providers/your-config-name

要求成功的話,系統將會傳回 HTTP 狀態代碼 200 OK,以及 null{} 的其中一項。

不成功的回應會包含錯誤訊息。如需更多有關錯誤的資訊,請參閱錯誤和狀態代碼