媒體供應商

/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 物件

刪除

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

範例

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

成功的要求會傳回 HTTP 狀態代碼 200 OK,以及 null{}

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