Skip to content

房间管理

首先从平台获取 appid 和 appsecret

API 域名为 //socket.dagouzhi.com

1. 获取房间列表

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room

    请求方式： GET

    接口说明：获取房间列表。

  2. 输入参数

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

    参数名称必选类型描述
    page否number每页数量 默认: 1
    pageSize否number页数 默认: 10

  3. 输出参数

    参数名称必选类型描述
    pageSize是number每页数量
    page是number页数
    total是number房间总数
    list是RoomItem[]数据列表

    房间详情字段 RoomItem

    参数名称必选类型描述
    _id是string房间id
    rtcType是agoral / tencentwebrtc服务商
    name是string房间名称
    roomTempId是string房间模板
    roomTempConfig是string模板配置
    creatorId是string创建用房
    users是userData[]用户列表
    created是string创建时间
    updated是string更新时间

    用户字段 userData

    参数名称必选类型描述
    id是number用户id
    name是string用户名称
    avatar是string用户头像

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room' \
 -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: xxxxxxxxxx' \
 -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: aaaaaaaa' \
 -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.1636824650.483.0.1636824650.0' \
 --compressed

2. 获取单个房间详情

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room/:roomid

    请求方式： GET

    接口说明：获取单个房间详情。

  2. 输入参数

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

    参数名称必选类型描述
    roomid是string房间ID

  3. 输出参数

    参数名称必选类型描述
    _id是string房间id
    rtcType是agoral / tencentwebrtc服务商
    name是string房间名称
    roomTempId是string房间模板
    roomTempConfig是string模板配置
    creatorId是string创建用房
    users是userData[]用户列表
    created是string创建时间
    updated是string更新时间

    用户字段 userData

    参数名称必选类型描述
    id是number用户id
    name是string用户名称
    avatar是string用户头像

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room/adsfadf' \
 -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: xxxxxxxxxx' \
 -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: aaaaaaaa' \
 -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.1636824650.483.0.1636824650.0' \
 --compressed

3. 创建房间

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room

    请求方式： GET

    接口说明：创建房间。

    创建房间要获取房间模板，并且房间模板不可再更改

  2. 输入参数

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

    参数名称必选类型描述
    _id是string房间id
    rtcType是agoral / tencentwebrtc服务商
    name是string房间名称
    roomTempId是string房间模板
    roomTempConfig是string模板配置
    creatorId是string创建用房
    users是userData[]用户列表
    created是string创建时间
    updated是string更新时间

    用户字段 userData

    参数名称必选类型描述
    id是number用户id
    name是string用户名称
    avatar是string用户头像

  3. 输出参数

    参数名称必选类型描述
    page否number每页数量 默认: 1

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room' \
 -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 '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 'content-type: application/json' \
 -H 'accept: */*' \
 -H 'hty-appid: appid' \
 -H 'sec-ch-ua-platform: "macOS"' \
 -H 'origin: https://socket.dagouzhi.com' \
 -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' \
 --data-raw $'{\n  "creatorId": "123123",\n  "name": "123123",\n  "roomTempId": "123123",\n  "rtcType": "agoral",\n  "roomTempConfig": "{}"\n}' \
 --compressed

4. 复制房间

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room/:roomid/copy

    请求方式： GET

    接口说明：复制房间。

    创建房间要获取房间模板，并且房间模板不可再更改

  2. 输入参数

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

    参数名称必选类型描述
    roomid是string房间id

  3. 输出参数

    参数名称必选类型描述

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room' \
 -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 '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 'content-type: application/json' \
 -H 'accept: */*' \
 -H 'hty-appid: appid' \
 -H 'sec-ch-ua-platform: "macOS"' \
 -H 'origin: https://socket.dagouzhi.com' \
 -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' \
 --data-raw $'{\n  "creatorId": "123123",\n  "name": "123123",\n  "roomTempId": "123123",\n  "rtcType": "agoral",\n  "roomTempConfig": "{}"\n}' \
 --compressed

5. 更新房间

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room/:roomid

    请求方式： PUT

    接口说明：更新房间。

    创建房间后房间模板不可再更改

  2. 输入参数

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

    参数名称必选类型描述
    _id是string房间id
    rtcType是agoral / tencentwebrtc服务商
    name是string房间名称
    roomTempId是string房间模板
    roomTempConfig是string模板配置
    creatorId是string创建用房
    users是userData[]用户列表
    created是string创建时间
    updated是string更新时间

    用户字段 userData

    参数名称必选类型描述
    id是number用户id
    name是string用户名称
    avatar是string用户头像

  3. 输出参数

    参数名称必选类型描述
    page否number每页数量 默认: 1

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room/adfadf' \
 -X 'PUT' \
 -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 '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 'content-type: application/json' \
 -H 'accept: */*' \
 -H 'hty-appid: appid' \
 -H 'sec-ch-ua-platform: "macOS"' \
 -H 'origin: https://socket.dagouzhi.com' \
 -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' \
 --data-raw $'{\n  "creatorId": "123123",\n  "name": "123123",\n  "roomTempId": "123123",\n  "rtcType": "agoral",\n  "roomTempConfig": "{}"\n}' \
 --compressed

6. 删除房间

  1. 接口描述

    接口请求域名： //socket.dagouzhi.com/open/api/room/:roomid

    请求方式： DELETE

    接口说明：删除房间。

  2. 输入参数

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

    参数名称必选类型描述
    roomid是string房间ID

  3. 输出参数

    参数名称必选类型描述
    page否number每页数量 默认: 1

  4. 示例

    curl 'https://socket.dagouzhi.com/open/api/room/aaaa' \
 -X 'DELETE' \
 -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 'origin: https://socket.dagouzhi.com' \
 -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
反馈