Skip to content

模板管理

首先从平台获取 appidappsecret

API 域名为 //socket.dagouzhi.com

1. 获取模板列表

  1. 接口描述

    接口请求域名: //socket.dagouzhi.com/open/api/template

    请求方式: GET

    接口说明:获取模板列表。

  2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称必选类型描述
    pagenumber每页数量 默认: 1
    pageSizenumber页数 默认: 10
  3. 输出参数

    参数名称必选类型描述
    pageSizenumber每页数量
    pagenumber页数
    totalnumber房间总数
    listTemplateItem[]数据列表

    房间详情字段 TemplateItem

    参数名称必选类型描述
    _idstring模板id
    configobject模板配置
    configSchemaobject模板配置Schema
    createdstring创建时间
    iconstring房间模板图标
    namestring模板名称
    pathstring模板路径
    platformobject支持平台
    rtcNumberstringrtcNumber
    statusstring状态
    updatedstring更新时间
    urlstring域名
    userSchemaobject用户Schema
  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/template' \
     -H 'authority: socket.dagouzhi.com' \
     -H 'pragma: no-cache' \
     -H 'cache-control: no-cache' \
     -H 'sec-ch-ua: "Google Chrome";v="95", "Chromium";v="95", ";Not A Brand";v="99"' \
     -H 'accept: */*' \
     -H 'hty-appsecret: appsecret' \
     -H 'sec-ch-ua-mobile: ?0' \
     -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36' \
     -H 'hty-appid: appid' \
     -H 'sec-ch-ua-platform: "macOS"' \
     -H 'sec-fetch-site: same-origin' \
     -H 'sec-fetch-mode: cors' \
     -H 'sec-fetch-dest: empty' \
     -H 'accept-language: zh-CN,zh;q=0.9,en;q=0.8,zh-TW;q=0.7' \
     -H 'cookie: _ga=GA1.1.749175164.1631793722; _ga_RQWP1YTMMW=GS1.1.1636881908.484.0.1636881908.0' \
     --compressed
    

2. 获取单个模板

  1. 接口描述

    接口请求域名: //socket.dagouzhi.com/open/api/template/:id

    请求方式: GET

    接口说明:获取单个模板。

  2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称必选类型描述
    idstring模板id
  3. 输出参数

    参数名称必选类型描述
    _idstring模板id
    configobject模板配置
    configSchemaobject模板配置Schema
    createdstring创建时间
    iconstring房间模板图标
    namestring模板名称
    pathstring模板路径
    platformobject支持平台
    rtcNumberstringrtcNumber
    statusstring状态
    updatedstring更新时间
    urlstring域名
    userSchemaobject用户Schema
  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/template/xxxx' \
     -H 'authority: socket.dagouzhi.com' \
     -H 'pragma: no-cache' \
     -H 'cache-control: no-cache' \
     -H 'sec-ch-ua: "Google Chrome";v="95", "Chromium";v="95", ";Not A Brand";v="99"' \
     -H 'accept: */*' \
     -H 'hty-appsecret: appsecret' \
     -H 'sec-ch-ua-mobile: ?0' \
     -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36' \
     -H 'hty-appid: appid' \
     -H 'sec-ch-ua-platform: "macOS"' \
     -H 'sec-fetch-site: same-origin' \
     -H 'sec-fetch-mode: cors' \
     -H 'sec-fetch-dest: empty' \
     -H 'accept-language: zh-CN,zh;q=0.9,en;q=0.8,zh-TW;q=0.7' \
     -H 'cookie: _ga=GA1.1.749175164.1631793722; _ga_RQWP1YTMMW=GS1.1.1636881908.484.0.1636881908.0' \
     --compressed
    

3. 添加模板(暂不开放)

  1. 接口描述

    接口请求域名: //socket.dagouzhi.com/open/api/template

    请求方式: POST

    接口说明:添加模板。

  2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称必选类型描述
    configobject模板配置
    configSchemaobject模板配置Schema
    iconstring房间模板图标
    namestring模板名称
    pathstring模板路径
    platformobject支持平台
    rtcNumberstringrtcNumber
    statusstring状态
    urlstring域名
    userSchemaobject用户Schema
  3. 输出参数

    参数名称必选类型描述
    xnumberx
  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/template' \
     -H 'authority: socket.dagouzhi.com' \
     -H 'pragma: no-cache' \
     -H 'cache-control: no-cache' \
     -H 'sec-ch-ua: "Google Chrome";v="95", "Chromium";v="95", ";Not A Brand";v="99"' \
     -H 'accept: */*' \
     -H 'hty-appsecret: appsecret' \
     -H 'sec-ch-ua-mobile: ?0' \
     -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36' \
     -H 'hty-appid: appid' \
     -H 'sec-ch-ua-platform: "macOS"' \
     -H 'sec-fetch-site: same-origin' \
     -H 'sec-fetch-mode: cors' \
     -H 'sec-fetch-dest: empty' \
     -H 'accept-language: zh-CN,zh;q=0.9,en;q=0.8,zh-TW;q=0.7' \
     -H 'cookie: _ga=GA1.1.749175164.1631793722; _ga_RQWP1YTMMW=GS1.1.1636881908.484.0.1636881908.0' \
     --compressed
    

4. 更新模板(暂不开放)

  1. 接口描述

    接口请求域名: //socket.dagouzhi.com/open/api/template/:id

    请求方式: PUT

    接口说明:更新模板。

  2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称必选类型描述
    idobject房间id
    configobject模板配置
    configSchemaobject模板配置Schema
    iconstring房间模板图标
    namestring模板名称
    pathstring模板路径
    platformobject支持平台
    rtcNumberstringrtcNumber
    statusstring状态
    urlstring域名
    userSchemaobject用户Schema
  3. 输出参数

    参数名称必选类型描述
    xnumberx
  4. 示例

    curl
    

5. 删除模板(暂不开放)

  1. 接口描述

    接口请求域名: //socket.dagouzhi.com/open/api/template/:id

    请求方式: DELETE

    接口说明:删除面试房间。

  2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称必选类型描述
    idobject房间id
  3. 输出参数

    参数名称必选类型描述
    xnumberx
  4. 示例

    curl
    
反馈