SY-P10-1.0.012

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

概览

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

使用 newVision/template 可以获取、创建或删除您的5G新视通模板。

newVision/templateAPI 使用 HTTP 规范中的 REST API 方法对模板进行操作，使用 GET 方法获取单个或全部模板、POST 方法创建新的5G新视通模板并提交至 SUBMAIL 人工审核，或使用 DELETE 方法删除一个模板。

5G新视通模板引擎支持 SUBHOOK 异步推送状态，模板在人工审核完成后，会使用 SUBHOOK 进行主动推送状态。

URL

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

支持格式

http 请求方式

是否需要授权

是

参阅 API 授权和验证机制

template GET 方法（获取模板列表）请求参数

template POST 方法（创建模板）请求参数

template DELETE 方法（删除模板）请求参数

代码示例

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

发送 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": "模板标题",
        "store_at":"file_path",
        "create_at": 1715386084,
        "edited_at": 1715386084,
        "template_status": "2",
        "template_status_description": "通过审核"
    }
}

使用 CURL POST方法提交模板

发送 CURL

curl --location 'https://api-v4.mysubmail.com/newVision/template' \
--form 'signature="your_appkey"' \
--form 'appid="your_appid"' \
--form 'title="模板标题"' \
--form 'file=@"/Users/MyMac/Desktop/test.mp4"'

返回

{
    "status": "success",
    "template_id": "FsoAF3"    // API 返回的模板ID，作为请求 API 的 PROJECT 参数
}

使用 CURL DELETE 方法删除模板

发送 CURL

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

返回

{
    "status":"success"
}

错误代码

参阅 API 错误代码