Локальный API платформы WhatsApp Business

Media Providers

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

В случае сбоя ответ содержит сообщение об ошибке. Дополнительную информацию об ошибках см. в разделе Сообщения об ошибках и коды статусов.

Обновление

Чтобы настроить поставщиков для клиента API WhatsApp Business, используйте конечную точку /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.

Удаление

Чтобы удалить поставщика из списка, отправьте вызов API DELETE к конечной точке /v1/settings/application/media/providers и укажите в параметре name имя поставщика.

Пример

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

В случае успеха возвращается код статуса HTTP 200 OK и значение null или {}.

В случае сбоя ответ содержит сообщение об ошибке. Дополнительную информацию об ошибках см. в разделе Сообщения об ошибках и коды статусов.