媒体提供方

/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 链接(这些链接依靠基本身份验证或 Bearer 口令身份验证)的媒体消息。

示例

以下示例将展示如何添加具有基本身份验证的 WWW(HTTP/HTTPS 链接)提供方和具有 Bearer 口令身份验证的提供方。系统目前仅支持上述提供方格式。

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{}

若请求失败,响应会包含错误消息。如需获取关于错误的更多信息,请参阅错误和状态代码