修改應用狀態

更新時間：2022-09-02 18:08:07

介接URL

https://api.polyv.net/live/v2/app/set-status

介接說明

1、接口用于修改应用状态
2、接口支持https

支援格式

JSON

請求方式

POST

請求次數限制

TRUE

請求參數

參數名	必選	類型	說明
appId	是	string	管理員的appId
timestamp	是	long	13位當前時間戳
sign	是	String	簽名，為32位大寫的MD5值,`生成簽名的appSecret密鑰作為通訊資料安全的關鍵資訊，嚴禁保存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
userId	是	string	應用的使用者id
status	是	string	要設定的狀態值，只能是DELETE（刪除）、FORBIDDEN（停用）、RESUME（恢復使用）

回應成功JSON範例：

{
"code": 200,
"status": "success",
"message": "",
"data": "success"
}

回應失敗JSON範例：

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

欄位說明

參數名	說明
code	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	成功為success，失敗為error
message	錯誤時的錯誤提示訊息
data	成功回應

php請求範例

<?php
//引用config.php
include '/srv/http/config.php';
$params = array(
  'appId' => $appId,
  'status' => $status,
  'timestamp' => $timestamp
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

$url = "https://api.polyv.net/live/v2/app/set-status?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>