SY-P10-1.0.012

API: newVision/template - 5G新視通模板管理

概覽

newVision/template 是 SUBMAIL 的5G新視通模板 API。

使用 newVision/template 可以獲取、創(chuàng)建或刪除您的5G新視通模板。

newVision/templateAPI 使用 HTTP 規(guī)范中的 REST API 方法對(duì)模板進(jìn)行操作，使用 GET 方法獲取單個(gè)或全部模板、POST 方法創(chuàng)建新的5G新視通模板并提交至 SUBMAIL 人工審核，或使用 DELETE 方法刪除一個(gè)模板。

5G新視通模板引擎支持 SUBHOOK 異步推送狀態(tài)，模板在人工審核完成后，會(huì)使用 SUBHOOK 進(jìn)行主動(dòng)推送狀態(tài)。

URL

<主> https://api-v4.mysubmail.com/newVision/template

支持格式

http 請(qǐng)求方式

是否需要授權(quán)

是

參閱 API 授權(quán)和驗(yàn)證機(jī)制

template GET 方法（獲取模板列表）請(qǐng)求參數(shù)

template POST 方法（創(chuàng)建模板）請(qǐng)求參數(shù)

template DELETE 方法（刪除模板）請(qǐng)求參數(shù)

代碼示例

使用 CURL GET方法獲取模板列表

發(fā)送 CURL

curl -s "https://api-v4.mysubmail.com/newVision/template?appid=your_appid&signature=your_appkey&template_id=FIJe14"

返回

{
    "status": "success",
    "template": {
        "template_id": "XXXXX",
        "title": "模板標(biāo)題",
        "store_at":"file_path",
        "create_at": 1715386084,
        "edited_at": 1715386084,
        "template_status": "2",
        "template_status_description": "通過審核"
    }
}

使用 CURL POST方法提交模板

發(fā)送 CURL

curl --location 'https://api-v4.mysubmail.com/newVision/template' \
--form 'signature="your_appkey"' \
--form 'appid="your_appid"' \
--form 'title="模板標(biāo)題"' \
--form 'file=@"/Users/MyMac/Desktop/test.mp4"'

返回

{
    "status": "success",
    "template_id": "FsoAF3"    // API 返回的模板ID，作為請(qǐng)求 API 的 PROJECT 參數(shù)
}

使用 CURL DELETE 方法刪除模板

發(fā)送 CURL

curl --data "appid=your_appid&signature=your_appkey&template_id=FsoAF3" -X delete http://api-v4.mysubmail.com/newVision/template

返回

{
    "status":"success"
}

錯(cuò)誤代碼

參閱 API 錯(cuò)誤代碼