编辑 Webhook 事件推送设置

编辑 Webhook 事件推送设置，包括 Webhook URL、密钥、请求方式等。

请求 URL

POST {base_url}/{api_path}/webhook/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
webhook_event_push_list 否 Array<Webhook_Entry> Webhook 事件推送功能的设置。
webhook_event_push_timeout 否 Integer 指定等待第三方应用的 HTTP 响应的最长时间。

取值范围：3 - 10
webhook_event_push_retry_count 否 Integer 指定在推送失败或未收到成功响应时，PBX 可重新发送请求的次数。

取值范围：1 - 5
Webhook_Entry
参数 是否必填 类型 说明
url 是 String Webhook URL。
secret 是 String 与指定的 Webhook URL 对应的密钥。

此密钥用于为 Webhook 消息生成 HMAC-SHA256 签名。

消息接收者可使用此密钥验证消息的真实性和完整性。
request_method 是 String 向 Webhook URL 发送请求的 HTTP 请求方法。
取值范围：
  • GET
  • POST
event_ids 是 Array<Integer> 需要监控的事件 ID 列表。
注：

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/extension_status_monitor/update?access_token=QytWnoLcod7RFB5f0S5oX4ORMbKPbU5t HTTP/1.1 
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "webhook_event_push_list": [
        {
            "event_ids": [
                30014,
                30032,
                30033
            ],
            "request_method": "POST",
            "secret": "mvM5JZeCqxDCMUdpgGzCTPGGbOcOouDr",
            "url": "https://webhook.site/070cb947-4ccf-40e3-a03c-a004ff05ad58"
        },
        {
            "event_ids": [
                30022
            ],
            "request_method": "GET",
            "secret": "qnIdTBxyGgn2LckZrFw7IVeTRMJf3XfM",
            "url": "https://webhook.site/38e9dea1-be68-4381-8a8c-f0623517f513"
        }
    ],
    "webhook_event_push_timeout": 3,
    "webhook_event_push_retry_count": 4
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}