Medienanbieter

/v1/settings/application/media/providers

Verwende den Endpunkt /v1/settings/application/media/providers, um eine Liste der Medienanbieter zum Senden von Medienlinks zusammenzustellen. Mit einer Anbieterliste kannst du über verschiedene Medienanbieter für denselben Typ verfügen. Gleichzeitig kannst du einen Anbieter auswählen, der auf Anfrage verwendet werden soll.

Abrufen

Rufe die Anbieterliste mit dieser API-Anfrage ab.

Beispiel

GET /v1/settings/application/media/providers

Die erfolgreiche Antwort enthält die Liste der Anbieter:

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

Wenn der Vorgang fehlgeschlagen ist, enthält die Antwort eine Fehlermeldung. Weitere Informationen zu Fehlern findest du unter Fehler- und Statuscodes.

Aktualisieren

Verwende zum Konfigurieren der Anbieter für den WhatsApp Business API-Client den Endpunkt /v1/settings/application/media/providers mit den Informationen des Anbieters. Derzeit kannst du nur jeweils einen Anbieter einrichten. Darüber hinaus kannst du diese Anbieterobjekte derzeit nur für das Senden von Mediennachrichten mittels HTTP/HTTPS-Links verwenden, die auf der Basisauthentifizierung oder der Bearer-Token-Authentifizierung basieren.

Beispiel

In den folgenden Beispielen werden ein WWW-Anbieter (HTTP-/HTTPS-Links) mit Basisauthentifizierung und ein Anbieter mit Bearer-Token-Authentifizierung hinzugefügt. Derzeit sind das die einzigen unterstützten Anbieterformate.

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

Eine erfolgreiche Anfrage gibt den HTTP-Statuscode 200 OK und entweder null oder {} zurück.

Wenn der Vorgang fehlgeschlagen ist, enthält die Antwort eine Fehlermeldung. Weitere Informationen zu Fehlern findest du unter Fehler- und Statuscodes.

Gib jedem Anbieter einen eindeutigen Namen. Wenn du nämlich einen Namen wiederverwendest, wird der vorherige Eintrag überschrieben.

Parameter

Name Beschreibung

Name	Beschreibung
`name`	Erforderlich. Der Name des Anbieters
`type`	Erforderlich. Der Typ des Anbieters
`config`	Erforderlich. Das Objekt `config`

name

Erforderlich.

Der Name des Anbieters

type

Erforderlich.

Der Typ des Anbieters

config

Erforderlich.

Das Objekt config

Löschen

Sende den API-Aufruf DELETE mit dem name eines Anbieters an den Endpunkt /v1/settings/application/media/providers, um diesen Anbieter aus der Liste zu löschen.

Beispiel

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

Eine erfolgreiche Anfrage gibt den HTTP-Statuscode 200 OK und entweder null oder {} zurück.

Wenn der Vorgang fehlgeschlagen ist, enthält die Antwort eine Fehlermeldung. Weitere Informationen zu Fehlern findest du unter Fehler- und Statuscodes.