Web首页接口


获取后台设置可滚动的Banner位信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传,登录了需要设置
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            list: [{
                // 场景WebID
                'id':1,
                // 场景名称
                'scene_name':'炫酷空间',
                // 场景简介
                'intro':'炫酷空间简介',
                // 场景详细介绍
                'details':'炫酷空间详细介绍',
                // 场景Banner图片
                'banners': [
                    'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    'https://cdn.shumaimetaverse.com/example/images/banner.png',
                ],
                // 场景Banner视频
                'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
                // 场景资源信息
                'scene_model':{
                    // 资源Id
                    "id": 10002,
                    // 显示名称
                    "show_name": "办公室",
                    // 模型名称
                    "model_name": "Office",
                    // 模型小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 模型资大图或者资源glb链接
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 14,
                    // 模型资源类别键
                    "model_category_key": "model_category_scene",
                    // 模型资源类别名称
                    "model_category_name": "场景模型",
                    // 模型资源类别值
                    "model_category_value": "scene",
                    // 模型类型ID
                    "model_type_id": 17,
                    // 模型类型键
                    "model_type_key": "model_type_map",
                    // 模型类型名称
                    "model_type_name": "单场景地图",
                    // 模型类型值
                    "model_type_value": "Map",
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // Android端加载Scene的背景图片
                'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
                // Android端加载Scene的背景图片
                'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
                // 是否已经收藏
                'is_favorite':true,
                // 收藏数量
                'favorite_count':99,
                // 是否点赞
                'is_like':true,
                // 点赞数量
                'like_count':2023,
                // 是否热门
                'is_hot':true,
                // 是否为最新
                'is_new':true,
                // 是否为模版
                'is_template':false,
                // 是否在线
                'is_online':false,
                // 是否开启直播
                'live_streaming':true,
                // 场景承载人数
                'room_member':985,
                // 场景作者
                'author':{
                    // 作者Id
                    'id': 1,
                    // 作者账户
                    'username': 'mofeng',
                    // 作者昵称
                    'nickname': '墨风',
                    // 作者手机
                    'mobile': '13888888888',
                    // 作者小头像
                    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
                    // 作者积分
                    'score': 1312
                    // 作者模型Id
                    'player_model_id': 10001
                }
            }]
        }
    }

Token接口


检测Token是否过期
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'time': '1680075231',
        "data": {
            "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
            "expires_in": 2592000,
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                // 角色选择的模型信息
                "Player_model": {
                    // Id
                    'id': 10001,                  		    
                    // 显示名称
                    'show_name': '程序猿',
                    // 显示描述
                    'show_desc'=> '',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别
                    'model_category': 'unit',
                    // 模型资源类型
                    'model_type': 'player',
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型资源名称
                    'model_name': '',
                    // 模型资源在WebGL中的路径
                    'model_path_webgl': '',
                    // 模型资源在Android中的路径
                    'model_path_android': '',
                    // 模型资源在VR中的路径
                    'model_path_vr': '',
                },
                "createtime": 1679300183,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
     }
刷新Token
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数

会员接口


会员登录
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
account string 用户Id
password string 用户密码
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
     }
手机验证码登录
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
captcha string 验证码,发送验证码时,Event使用[mobilelogin]
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
     }
注册会员
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
username string 用户名
password string 密码
email string 邮箱
mobile string 手机号
code string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
     }
退出登录
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
注销账户
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
修改会员个人信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
username string 用户名
avatar string 头像地址
gender string 性别,0:代表女,1:代表男,非0和1:代表其他
nickname string 昵称
bio string 个人简介
player_model_id integer 选用的模型Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "gender": "0",  性别,0:代表女,1:代表男,非0和1:代表其他
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                // 角色选择的模型信息
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
     }
重置密码
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
mobile string 手机号
newpassword string 新密码
captcha string 验证码
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{}
     }
账号禁用/正常间进行切换
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{}
     }
获取会员信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
user_id int 用户Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
    }
会员中心
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数

场景(作品、模板)接口


根据一定的排序规则检索数据,输出分页列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
keys string 搜索的关键字,值为空不检索
is_hot integer 只搜索热门的场景, 0:检索非,1:检索
is_new integer 只搜索最新的场景, 0:检索非,1:检索
is_livestream integer 只搜索正在直播的场景, 0:检索非,1:检索
is_system integer 只搜索系统的场景, 0:检索非,1:检索
is_recommend integer 只搜索推荐的场景, 0:检索非,1:检索
is_template integer 只搜索模板场景, 0:检索非,1:检索
allow_copy integer 只搜索允许复制的场景, 0:检索非,1:检索
page integer 每页展示数据量,页码从1开始,默认:1
offset integer 搜索位置的偏移量,默认:0
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    // 当前页
    page: 1,
    // 每页数量
    page_size: 10,
    // 总共多少页
    page_count: 3,
    // 总共多少条数据
    total_count: 30,
    // 场景列表
    list: [{
    // 场景WebID
    'id':1,
    // 场景名称
    'scene_name':'炫酷空间',
    // 场景简介
    'intro':'炫酷空间简介',
    // 场景详细介绍
    'details':'炫酷空间详细介绍',
    // 场景Banner图片
    'banners': [
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    ],
    // 场景Banner视频
    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
    // 场景资源信息
    'scene_model':{
    // 资源Id
    "id": 10002,
    // 显示名称
    "show_name": "办公室",
    // 模型名称
    "model_name": "Office",
    // 模型小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 模型资大图或者资源glb链接
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 14,
    // 模型资源类别键
    "model_category_key": "model_category_scene",
    // 模型资源类别名称
    "model_category_name": "场景模型",
    // 模型资源类别值
    "model_category_value": "scene",
    // 模型类型ID
    "model_type_id": 17,
    // 模型类型键
    "model_type_key": "model_type_map",
    // 模型类型名称
    "model_type_name": "单场景地图",
    // 模型类型值
    "model_type_value": "Map",
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    },
    // Android端加载Scene的背景图片
    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // Android端加载Scene的背景图片
    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 场景大地图图片
    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 是否已经收藏
    'is_favorite':true,
    // 收藏数量
    'favorite_count':99,
    // 是否点赞
    'is_like':true,
    // 点赞数量
    'like_count':2023,
    // 是否热门
    'is_hot':true,
    // 是否为最新
    'is_new':true,
    // 是否为模版
    'is_template':false,
    // 是否在线
    'is_online':false,
    // 是否开启直播
    'live_streaming':true,
    // 场景承载人数
    'room_member':985,
    // 场景作者
    'author':{
    // 作者Id
    'id': 1,
    // 作者账户
    'username': 'mofeng',
    // 作者昵称
    'nickname': '墨风',
    // 作者手机
    'mobile': '13888888888',
    // 作者小头像
    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
    // 作者积分
    'score': 1312
    // 作者模型Id
    'player_model_id': 10001
    }
    }]
    }
    }
根据一定的排序规则检索数据,输出分页列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 玩家登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
keys string 搜索的关键字,默认为空
is_hot int 搜索热门的场景,默认:缺省,0:检测非,1:检测真,缺省:不检测
is_new int 搜索最新的场景,默认:缺省,0:检测非,1:检测真,缺省:不检测
is_online int 搜索上线的场景,默认:缺省,0:检测非,1:检测真,缺省:不检测
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    // 当前页
    page: 1,
    // 每页数量
    page_size: 10,
    // 总共多少页
    page_count: 3,
    // 总共多少条数据
    total_count: 30,
    // 场景列表
    list: [{
    // 场景WebID
    'id':1,
    // 场景名称
    'scene_name':'炫酷空间',
    // 场景简介
    'intro':'炫酷空间简介',
    // 场景详细介绍
    'details':'炫酷空间详细介绍',
    // 场景Banner图片
    'banners': [
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    ],
    // 场景Banner视频
    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
    // 场景资源信息
    'scene_model':{
    // 资源Id
    "id": 10002,
    // 显示名称
    "show_name": "办公室",
    // 模型名称
    "model_name": "Office",
    // 模型小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 模型资大图或者资源glb链接
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 14,
    // 模型资源类别键
    "model_category_key": "model_category_scene",
    // 模型资源类别名称
    "model_category_name": "场景模型",
    // 模型资源类别值
    "model_category_value": "scene",
    // 模型类型ID
    "model_type_id": 17,
    // 模型类型键
    "model_type_key": "model_type_map",
    // 模型类型名称
    "model_type_name": "单场景地图",
    // 模型类型值
    "model_type_value": "Map",
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    },
    // Android端加载Scene的背景图片
    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // Android端加载Scene的背景图片
    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 场景大地图图片
    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 是否已经收藏
    'is_favorite':true,
    // 收藏数量
    'favorite_count':99,
    // 是否点赞
    'is_like':true,
    // 点赞数量
    'like_count':2023,
    // 是否热门
    'is_hot':true,
    // 是否为最新
    'is_new':true,
    // 是否为模版
    'is_template':false,
    // 是否在线
    'is_online':false,
    // 是否开启直播
    'live_streaming':true,
    // 场景承载人数
    'room_member':985,
    // 场景作者
    'author':{
    // 作者Id
    'id': 1,
    // 作者账户
    'username': 'mofeng',
    // 作者昵称
    'nickname': '墨风',
    // 作者手机
    'mobile': '13888888888',
    // 作者小头像
    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
    // 作者积分
    'score': 1312
    // 作者模型Id
    'player_model_id': 10001
    }
    }]
    }
    }
自己访问场景的立即
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 玩家登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
keys string 搜索的场景关键字,默认为空
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 当前页
            page: 1,
            // 每页数量
            page_size: 10,
            // 总共多少页
            page_count: 3,
            // 总共多少条数据
            total_count: 30,
            // 场景列表
            list: [{
                scene: {
                    // 场景WebID
                    'id':1,
                    // 场景名称
                    'scene_name':'炫酷空间',
                    // 场景简介
                    'intro':'炫酷空间简介',
                    // 场景详细介绍
                    'details':'炫酷空间详细介绍',
                    // 场景Banner图片
                    'banners': [
                        'https://cdn.shumaimetaverse.com/example/images/banner1.png',
                        'https://cdn.shumaimetaverse.com/example/images/banner2.png',
                        'https://cdn.shumaimetaverse.com/example/images/banner3.png',
                        'https://cdn.shumaimetaverse.com/example/images/banner4.png',
                        'https://cdn.shumaimetaverse.com/example/images/banner5.png',
                    ],
                    // 场景Banner视频
                    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
                    // 场景资源信息
                    'scene_model':{
                        // 资源Id
                        "id": 10002,
                        // 显示名称
                        "show_name": "办公室",
                        // 模型名称
                        "model_name": "Office",
                        // 模型小图标
                        'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                        // 模型资大图或者资源glb链接
                        'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                        // 模型资源类别ID
                        "model_category_id": 14,
                        // 模型资源类别键
                        "model_category_key": "model_category_scene",
                        // 模型资源类别名称
                        "model_category_name": "场景模型",
                        // 模型资源类别值
                        "model_category_value": "scene",
                        // 模型类型ID
                        "model_type_id": 17,
                        // 模型类型键
                        "model_type_key": "model_type_map",
                        // 模型类型名称
                        "model_type_name": "单场景地图",
                        // 模型类型值
                        "model_type_value": "Map",
                        // 模型起始位置
                        "start_position": "0.5,0.27,18",
                        // 模型起始朝向
                        "start_forward": "0,-0.7,0,0.7",
                    },
                    // Android端加载Scene的背景图片
                    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    // Android端加载Scene的背景图片
                    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    // 场景大地图图片
                    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
                    // 是否已经收藏
                    'is_favorite':true,
                    // 收藏数量
                    'favorite_count':99,
                    // 是否点赞
                    'is_like':true,
                    // 点赞数量
                    'like_count':2023,
                    // 是否热门
                    'is_hot':true,
                    // 是否为最新
                    'is_new':true,
                    // 是否为模版
                    'is_template':false,
                    // 是否在线
                    'is_online':false,
                    // 是否开启直播
                    'live_streaming':true,
                    // 场景承载人数
                    'room_member':985,
                    // 场景作者
                    'author':{
                        // 作者Id
                        'id': 1,
                        // 作者账户
                        'username': 'mofeng',
                        // 作者昵称
                        'nickname': '墨风',
                        // 作者手机
                        'mobile': '13888888888',
                        // 作者小头像
                        'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
                        // 作者积分
                        'score': 1312
                        // 作者模型Id
                        'player_model_id': 10001
                    }
                },
                user: {
                    // 作者Id
                    'id': 1,
                    // 作者账户
                    'username': 'mofeng',
                    // 作者昵称
                    'nickname': '墨风',
                    // 作者手机
                    'mobile': '13888888888',
                    // 作者小头像
                    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
                    // 作者积分
                    'score': 1312
                    // 作者模型Id
                    'player_model_id': 10001
                },
                visit_show: '2023-10-01',
            }]
        }
    }
获取所有场景模版列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': [
    {
    // 场景WebID
    'id':1,
    // 场景名称
    'scene_name':'炫酷空间',
    // 场景简介
    'intro':'炫酷空间简介',
    // 场景详细介绍
    'details':'炫酷空间详细介绍',
    // 场景Banner图片
    'banners': [
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    ],
    // 场景Banner视频
    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
    // 场景资源信息
    'scene_model':{
    // 资源Id
    "id": 10002,
    // 显示名称
    "show_name": "办公室",
    // 模型名称
    "model_name": "Office",
    // 模型小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 模型资大图或者资源glb链接
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 14,
    // 模型资源类别键
    "model_category_key": "model_category_scene",
    // 模型资源类别名称
    "model_category_name": "场景模型",
    // 模型资源类别值
    "model_category_value": "scene",
    // 模型类型ID
    "model_type_id": 17,
    // 模型类型键
    "model_type_key": "model_type_map",
    // 模型类型名称
    "model_type_name": "单场景地图",
    // 模型类型值
    "model_type_value": "Map",
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    },
    // Android端加载Scene的背景图片
    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // Android端加载Scene的背景图片
    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 场景大地图图片
    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 是否已经收藏
    'is_favorite':true,
    // 收藏数量
    'favorite_count':99,
    // 是否点赞
    'is_like':true,
    // 点赞数量
    'like_count':2023,
    // 是否热门
    'is_hot':true,
    // 是否为最新
    'is_new':true,
    // 是否为模版
    'is_template':false,
    // 是否在线
    'is_online':false,
    // 是否开启直播
    'live_streaming':true,
    // 场景承载人数
    'room_member':985,
    // 场景作者
    'author':{
    // 作者Id
    'id': 1,
    // 作者账户
    'username': 'mofeng',
    // 作者昵称
    'nickname': '墨风',
    // 作者手机
    'mobile': '13888888888',
    // 作者小头像
    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
    // 作者积分
    'score': 1312
    // 作者模型Id
    'player_model_id': 10001
    }
    }
    ]
    }
根据场景Id获取指定场景的信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao/Shumai_city],默认:XuHuanQiDian
scene_id integer 场景Id,不能为空
scene_name string 场景名称,不能为空
view int 是否为查看,0:获取数据,1:查看场景,默认:0
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 场景WebID
            'id':1,
            // 场景名称
            'scene_name':'炫酷空间',
            // 场景简介
            'intro':'炫酷空间简介',
            // 场景详细介绍
            'details':'炫酷空间详细介绍',
            // 场景Banner图片
            'banners': [
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
            ],
            // 场景Banner视频
            'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
            // 场景资源信息
            'scene_model':{
                // 资源Id
                "id": 10002,
                // 显示名称
                "show_name": "办公室",
                // 模型名称
                "model_name": "Office",
                // 模型小图标
                'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                // 模型资大图或者资源glb链接
                'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                // 模型资源类别ID
                "model_category_id": 14,
                // 模型资源类别键
                "model_category_key": "model_category_scene",
                // 模型资源类别名称
                "model_category_name": "场景模型",
                // 模型资源类别值
                "model_category_value": "scene",
                // 模型类型ID
                "model_type_id": 17,
                // 模型类型键
                "model_type_key": "model_type_map",
                // 模型类型名称
                "model_type_name": "单场景地图",
                // 模型类型值
                "model_type_value": "Map",
                // 模型起始位置
                "start_position": "0.5,0.27,18",
                // 模型起始朝向
                "start_forward": "0,-0.7,0,0.7",
            },
            // Android端加载Scene的背景图片
            'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // Android端加载Scene的背景图片
            'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // 场景大地图图片
            'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // 是否已经收藏
            'is_favorite':true,
            // 收藏数量
            'favorite_count':99,
            // 是否点赞
            'is_like':true,
            // 点赞数量
            'like_count':2023,
            // 是否热门
            'is_hot':true,
            // 是否为最新
            'is_new':true,
            // 是否为模版
            'is_template':false,
            // 是否在线
            'is_online':false,
            // 是否开启直播
            'live_streaming':true,
            // 场景承载人数
            'room_member':985,
            // 场景作者
            'author':{
                // 作者Id
                'id': 1,
                // 作者账户
                'username': 'mofeng',
                // 作者昵称
                'nickname': '墨风',
                // 作者手机
                'mobile': '13888888888',
                // 作者小头像
                'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
                // 作者积分
                'score': 1312
                // 作者模型Id
                'player_model_id': 10001
            }
        }
    }
保存场景
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
scene_id int 场景Id,[提示:存在Id为修改数据,不存在或者为0时创建数据]
scene_name string 场景名称
intro string 场景介绍
details string 场景详细介绍
scene_model_id int 场景素材Id
allow_copy int 是否允许复制场景, 0:不允许,1:允许
is_online int 是否上线, 0:不上线,1:上线
banners string 作品封面,[提示:多个封面请用英文逗号隔开]
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    // 场景WebID
    'id':1,
    // 场景名称
    'scene_name':'炫酷空间',
    // 场景简介
    'intro':'炫酷空间简介',
    // 场景详细介绍
    'details':'炫酷空间详细介绍',
    // 场景Banner图片
    'banners': [
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    ],
    // 场景Banner视频
    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
    // 场景资源信息
    'scene_model':{
    // 资源Id
    "id": 10002,
    // 显示名称
    "show_name": "办公室",
    // 模型名称
    "model_name": "Office",
    // 模型小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 模型资大图或者资源glb链接
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 14,
    // 模型资源类别键
    "model_category_key": "model_category_scene",
    // 模型资源类别名称
    "model_category_name": "场景模型",
    // 模型资源类别值
    "model_category_value": "scene",
    // 模型类型ID
    "model_type_id": 17,
    // 模型类型键
    "model_type_key": "model_type_map",
    // 模型类型名称
    "model_type_name": "单场景地图",
    // 模型类型值
    "model_type_value": "Map",
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    },
    // Android端加载Scene的背景图片
    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // Android端加载Scene的背景图片
    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 场景大地图图片
    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 是否已经收藏
    'is_favorite':true,
    // 收藏数量
    'favorite_count':99,
    // 是否点赞
    'is_like':true,
    // 点赞数量
    'like_count':2023,
    // 是否热门
    'is_hot':true,
    // 是否为最新
    'is_new':true,
    // 是否为模版
    'is_template':false,
    // 是否在线
    'is_online':false,
    // 是否开启直播
    'live_streaming':true,
    // 场景承载人数
    'room_member':985,
    // 场景作者
    'author':{
    // 作者Id
    'id': 1,
    // 作者账户
    'username': 'mofeng',
    // 作者昵称
    'nickname': '墨风',
    // 作者手机
    'mobile': '13888888888',
    // 作者小头像
    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
    // 作者积分
    'score': 1312
    // 作者模型Id
    'player_model_id': 10001
    }
    }
    }
场景复制
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
copy_scene_id int 要复制的场景Id
new_scene_name string 新的场景名称
new_scene_desc string 新的场景描述
new_scene_banner string 场景封面
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',`
        'msg':'返回成功',
        'data': {
            // 场景WebID
            'id':1,
            // 场景名称
            'scene_name':'炫酷空间',
            // 场景简介
            'intro':'炫酷空间简介',
            // 场景详细介绍
            'details':'炫酷空间详细介绍',
            // 场景Banner图片
            'banners': [
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
                'https://cdn.shumaimetaverse.com/example/images/banner.png',
            ],
            // 场景Banner视频
            'banner_video': [
                'https://cdn.shumaimetaverse.com/example/video/video.mp4',
                'https://cdn.shumaimetaverse.com/example/video/upway.mp4',
            ],
            // 场景资源信息
            'scene_model':{
                // 资源Id
                "id": 10002,
                // 显示名称
                "show_name": "办公室",
                // 模型名称
                "model_name": "Office",
                // 模型小图标
                'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                // 模型资大图或者资源glb链接
                'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                // 模型资源类别ID
                "model_category_id": 14,
                // 模型资源类别键
                "model_category_key": "model_category_scene",
                // 模型资源类别名称
                "model_category_name": "场景模型",
                // 模型资源类别值
                "model_category_value": "scene",
                // 模型类型ID
                "model_type_id": 17,
                // 模型类型键
                "model_type_key": "model_type_map",
                // 模型类型名称
                "model_type_name": "单场景地图",
                // 模型类型值
                "model_type_value": "Map",
                // 模型起始位置
                "start_position": "0.5,0.27,18",
                // 模型起始朝向
                "start_forward": "0,-0.7,0,0.7",
            },
            // Android端加载Scene的背景图片
            'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // Android端加载Scene的背景图片
            'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // 场景大地图图片
            'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
            // 是否已经收藏
            'is_favorite':true,
            // 收藏数量
            'favorite_count':99,
            // 是否点赞
            'is_like':true,
            // 点赞数量
            'like_count':2023,
            // 是否热门
            'is_hot':true,
            // 是否为最新
            'is_new':true,
            // 是否为模版
            'is_template':false,
            // 是否在线
            'is_online':false,
            // 是否开启直播
            'live_streaming':true,
            // 场景承载人数
            'room_member':985,
            // 场景作者
            'author':{
                // 作者Id
                'id': 1,
                // 作者账户
                'username': 'mofeng',
                // 作者昵称
                'nickname': '墨风',
                // 作者手机
                'mobile': '13888888888',
                // 作者小头像
                'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
                // 作者积分
                'score': 1312
                // 作者模型Id
                'player_model_id': 10001
            }`
        }
    }
发布场景
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
scene_id int 场景Id,[提示:存在Id为修改数据,不存在或者为0时创建数据]
scene_name string 场景名称
intro string 场景介绍
banner_cover_id int 场景封面Id
background_music_id int 场景背景音乐Id
banner_cover json 场景封面资源的Json数据
background_music json 场景背景音乐资源的Json数据
banner_cover_url string 场景封面资源的Url
background_music_url string 场景背景音乐资源的Url
is_publish int 是否发布场景, 0:不发布,1:发布场景
is_online int 是否上线场景, 0:下架,1:上架
allow_copy int 是否允许复制场景, 0:不允许,1:允许
open_background_music int 是否开启背景音乐, 0:不开启,1:开启
background_music_loop int 是否开启背景音乐循环, 0:不循环,1:开启
theme string 主题滤镜
view_position string 视角位置,如:2.3,4.7,23
view_rotation string 视角朝向,如:0,0,1,0
camera_rotation string 初始相机角度,如:2.4,5.8,9.1
camera_first_position string 视角位置,如:2.3,4.7,23
camera_first_rotation string 视角朝向,如:2.3,4.7,23
tags string 场景标签
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        // 场景WebID
        'id':1,
        // 场景名称
        'scene_name':'炫酷空间',
        // 场景简介
        'intro':'炫酷空间简介',
        // 场景详细介绍
        'details':'炫酷空间详细介绍',
        // 场景Banner图片
        'banners': [
            'https://cdn.shumaimetaverse.com/example/images/banner.png',
            'https://cdn.shumaimetaverse.com/example/images/banner.png',
            'https://cdn.shumaimetaverse.com/example/images/banner.png',
            'https://cdn.shumaimetaverse.com/example/images/banner.png',
            'https://cdn.shumaimetaverse.com/example/images/banner.png',
        ],
        // 场景Banner视频
        'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
        // 场景资源信息
        'scene_model':{
            // 资源Id
            "id": 10002,
            // 显示名称
            "show_name": "办公室",
            // 模型名称
            "model_name": "Office",
            // 模型小图标
            'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
            // 模型资大图或者资源glb链接
            'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
            // 模型资源类别ID
            "model_category_id": 14,
            // 模型资源类别键
            "model_category_key": "model_category_scene",
            // 模型资源类别名称
            "model_category_name": "场景模型",
            // 模型资源类别值
            "model_category_value": "scene",
            // 模型类型ID
            "model_type_id": 17,
            // 模型类型键
            "model_type_key": "model_type_map",
            // 模型类型名称
            "model_type_name": "单场景地图",
            // 模型类型值
            "model_type_value": "Map",
            // 模型起始位置
            "start_position": "0.5,0.27,18",
            // 模型起始朝向
            "start_forward": "0,-0.7,0,0.7",
        },
        // Android端加载Scene的背景图片
        'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
        // Android端加载Scene的背景图片
        'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
        // 场景大地图图片
        'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
        // 是否已经收藏
        'is_favorite':true,
        // 收藏数量
        'favorite_count':99,
        // 是否点赞
        'is_like':true,
        // 点赞数量
        'like_count':2023,
        // 是否热门
        'is_hot':true,
        // 是否为最新
        'is_new':true,
        // 是否为模版
        'is_template':false,
        // 是否在线
        'is_online':false,
        // 是否开启直播
        'live_streaming':true,
        // 场景承载人数
        'room_member':985,
        // 场景作者
        'author':{
            // 作者Id
            'id': 1,
            // 作者账户
            'username': 'mofeng',
            // 作者昵称
            'nickname': '墨风',
            // 作者手机
            'mobile': '13888888888',
            // 作者小头像
            'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
            // 作者积分
            'score': 1312
            // 作者模型Id
            'player_model_id': 10001
        }
        }
    }
删除场景信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
scene_id int 场景Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    }
获取项目默认场景信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
default_var string 默认场景变量名称[default_login_scene/default_scene]
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    // 场景WebID
    'id':1,
    // 场景名称
    'scene_name':'炫酷空间',
    // 场景简介
    'intro':'炫酷空间简介',
    // 场景详细介绍
    'details':'炫酷空间详细介绍',
    // 场景Banner图片
    'banners': [
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    'https://cdn.shumaimetaverse.com/example/images/banner.png',
    ],
    // 场景Banner视频
    'banner_video': 'https://cdn.shumaimetaverse.com/V1/upway.mp4',
    // 场景资源信息
    'scene_model':{
    // 资源Id
    "id": 10002,
    // 显示名称
    "show_name": "办公室",
    // 模型名称
    "model_name": "Office",
    // 模型小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 模型资大图或者资源glb链接
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 14,
    // 模型资源类别键
    "model_category_key": "model_category_scene",
    // 模型资源类别名称
    "model_category_name": "场景模型",
    // 模型资源类别值
    "model_category_value": "scene",
    // 模型类型ID
    "model_type_id": 17,
    // 模型类型键
    "model_type_key": "model_type_map",
    // 模型类型名称
    "model_type_name": "单场景地图",
    // 模型类型值
    "model_type_value": "Map",
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    },
    // Android端加载Scene的背景图片
    'load_bk_android': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // Android端加载Scene的背景图片
    'load_bk_webgl': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 场景大地图图片
    'bigmap_picture': 'https://cdn.shumaimetaverse.com/example/images/banner.png',
    // 是否已经收藏
    'is_favorite':true,
    // 收藏数量
    'favorite_count':99,
    // 是否点赞
    'is_like':true,
    // 点赞数量
    'like_count':2023,
    // 是否热门
    'is_hot':true,
    // 是否为最新
    'is_new':true,
    // 是否为模版
    'is_template':false,
    // 是否在线
    'is_online':false,
    // 是否开启直播
    'live_streaming':true,
    // 场景承载人数
    'room_member':985,
    // 场景作者
    'author':{
    // 作者Id
    'id': 1,
    // 作者账户
    'username': 'mofeng',
    // 作者昵称
    'nickname': '墨风',
    // 作者手机
    'mobile': '13888888888',
    // 作者小头像
    'avatar': 'https://cdn.shumaimetaverse.com/example/images/face.png',  // 作者头像
    // 作者积分
    'score': 1312
    // 作者模型Id
    'player_model_id': 10001
    }
    }
    }
根据作品ID收藏或者取消收藏作品
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
scene_id string 作品Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'成功'
    }
用户收藏列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
keys string 搜索的关键字,值为空不检索
page integer 每页展示数据量,页码从1开始,默认:1
offset integer 搜索位置的偏移量,默认:0
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
    }
根据场景ID收藏或者取消点赞作品
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
scene_id string 作品Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data'
    }
用户点赞列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
keys string 搜索的关键字,值为空不检索
page integer 每页展示数据量,页码从1开始,默认:1
offset integer 搜索位置的偏移量,默认:0
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
    }
根据场景ID上架或者下架产品
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token
参数
名称 类型 必选 描述
scene_id string 作品Id
is_online int 上下架状态[0:下架,1:上架]
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data'
    }
根据场景ID开启/关闭场景直播
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
scene_id string 作品Id
live int 是否开启直播,0: 未开启,1:开启
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data'
    }
根据场景ID设置场景在线人数
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
scene_id string 作品Id
member_count int 在线人数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功',
    }
根据场景ID获取展位信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,必须登录才可以操作
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
platform string 项目分类,[web/webgl/android/ios/wxgame/wxshare_android/wxshare_ios/vrpc/vr/wxshare],默认:所有平台
scene_id string 作品Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功',
        'data': {
            list: [{
                'id':1,                   						                // 场景ID
                'scene_id': 23,     							                // 场景名称
                'scene_name':'WenDaoChangAn_DaTing',     		                // 场景名称
                'scene_desc':'问道大厅',         				                    // 场景简介
                'group_type_id':26/27,		                                    // 资源分组类型ID
                'group_type':'images/videos',			                        // 资源分组类型
                'group':'010_ziranfengguang',    		                        // 资源分组名称
                'window_name':'main_bigscreen',  				                // 展位名称
                'window_desc':'大厅大屏幕',                                       // 展位描述
                'window_type_id':'48,49,50,51,52',  				            // 展位类型ID
                'window_type':'static/hengxiangliuye/shuxiangliuye/shuxiangyiye/hengxiangyiye',                                       // 展位类型值
                'window_position':'0,0,0',      				                // 展位名称
                'window_forward':'0,0,0,1',                                     // 展位描述
                'window_src_type_id':22/23/24/25,                               // 展位展示内容类型ID
                'window_src_type':'picture/video/ppt/screenshare',              // 展位展示内容类型
                'window_src_banner_url':'',                                     // 展位展示内容的Url地址
                'window_src_url':'',                                            // 展位展示内容的Url地址
                'updatetime':'2023-03-23 16:45:11',				                // 创建时间
                'createtime':'2023-03-23 14:23:22',				                // 创建时间
            }]
        }
    }
获取根据【场景名称、资源分组、展窗名称】获取场景中展位展示内容
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
platform string 项目分类,[web/webgl/android/ios/wxgame/wxshare_android/wxshare_ios/vrpc/vr/wxshare],默认:所有平台
scene_id string 场景Id
group string 场景资源分组
window_name string 展位窗口名称
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            list: [{
                'id':1,                   						                // 场景ID
                'scene_id': 23,     							                // 场景名称
                'scene_name':'WenDaoChangAn_DaTing',     		                // 场景名称
                'scene_desc':'问道大厅',         				                    // 场景简介
                'group_type_id':26/27,		                                    // 资源分组类型ID
                'group_type':'images/videos',			                        // 资源分组类型
                'group':'010_ziranfengguang',    		                        // 资源分组名称
                'window_name':'main_bigscreen',  				                // 展位名称
                'window_desc':'大厅大屏幕',                                       // 展位描述
                'window_type_id':'48,49,50,51,52',  				            // 展位类型ID
                'window_type':'static/hengxiangliuye/shuxiangliuye/shuxiangyiye/hengxiangyiye',                                       // 展位类型值
                'window_position':'0,0,0',      				                // 展位名称
                'window_forward':'0,0,0,1',                                     // 展位描述
                'window_src_type_id':22/23/24/25/47,                            // 展位展示内容类型ID
                'window_src_type':'picture/video/ppt/screenshare/website',      // 展位展示内容类型
                'window_src_banner_url':'',                                     // 展位展示内容的Url地址
                'window_src_url':'',                                            // 展位展示内容的Url地址
                'updatetime':'2023-03-23 16:45:11',				                // 创建时间
                'createtime':'2023-03-23 14:23:22',				                // 创建时间
            }]
        }
    }
根据场景模型ID获取场景的TRTC房间
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
scene_model_id integer 场景模型Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    list: [{
    // 房间ID
    'id':1,
    // 场景模型Id
    'scene_model_id': 10001,
    // 房间名称
    'room_name': '会议室',
    // 是否未公共房间
    'is_common': false,
    // 房间区域模型名称
    'area_name': 'meeting_room',
    // 房间门名称,多个门模型名称用[,]隔开
    'doors': 'door1,door2',
    // 分享屏幕名称,多个屏幕模型名称用[,]隔开
    'sharescreens': 'screen1,screen2',
    }]
    }
    }
获取场景内的传送门列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
scene_id integer 场景Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    list: [{
    // 房间ID
    'id':1,
    // 场景模型Id
    'scene_id': 10001,
    // 房间名称
    'show_name': '会议室',
    // 是否未公共房间
    'model_name': false,
    // 房间区域模型名称
    'start_position': 'meeting_room',
    // 房间门名称,多个门模型名称用[,]隔开
    'start_forward': 'door1,door2',
    // 分享屏幕名称,多个屏幕模型名称用[,]隔开
    'jump_scene_id': '10059',
    'createtime': '1690526639',
    }]
    }
    }
获取场景内的导览点列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
scene_id integer 场景Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            list: [{
                // 导览点Id
                "id": 1,
                // 导览点Id
                "guide_id": 1
                // 所属场景Id
                "scene_id": 10158,
                // 导览点名称
                "guide_name": "测试导览点",
                // 导览点坐标
                "event_point": "57,0.2,53",
                // 导览点触发距离
                "event_distance": "1.00000",
                // 导览点图片
                "event_images": [
                    "https://cdn.xuhuan.shumaimetaverse.com/uploads/cishanzonghui/yibeitu/dierzhanting/cishanjijin/zhukunjijin/zhukunjijin01.png",
                    "https://cdn.xuhuan.shumaimetaverse.com/uploads/cishanzonghui/yibeitu/dierzhanting/cishanjijin/zhukunjijin/zhukunjijin02.jpg",
                    "https://cdn.xuhuan.shumaimetaverse.com/uploads/cishanzonghui/yibeitu/dierzhanting/cishanjijin/zhukunjijin/zhukunjijin03.jpg",
                    "https://cdn.xuhuan.shumaimetaverse.com/uploads/cishanzonghui/yibeitu/dierzhanting/cishanjijin/zhukunjijin/zhukunjijin06.jpg"
                ],
                // 导览点图片
                "event_images_scrolltime": [5,10,15,20],
                // 导览点音频
                "event_audio": "https://cdn.xuhuan.shumaimetaverse.com/temp/test.mp3",
                // 导览点视频
                "event_video": "https://cdn.xuhuan.shumaimetaverse.com/uploads/cishanzonghui/loading_hengban1.mp4",
                // 导览点排序
                "sort": 0,
                // 导览点创建时间
                "createtime_show": 1692083853,
            }]
        }
    }
统计场景数据
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 上架量
            'total_online_count': 15,
            // 点赞量
            'total_like_count': 102,
            // 收藏量
            'total_favorite_count': 98,
            // 浏览量
            'total_browse_count': 2045,
        }
    }
统计使用素材
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_id integer 场景Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 上架量
            'total_count': 15,
            // 点赞量
            'total_size': 102,
            // 收藏量
            'sub_size': 98,
            // 浏览量
            'model_count': 2045,
            // 浏览量
            'model_size': 2045,
            // 浏览量
            'pic_count': 2045,
            // 浏览量
            'pic_size': 2045,
            // 浏览量
            'audio_count': 2045,
            // 浏览量
            'audio_size': 2045,
            // 浏览量
            'video_count': 2045,
            // 浏览量
            'video_size': 2045,
            // 浏览量
            'tips': '场景信息:已使用素材共:xxx个,大小:xxMB,剩余空间:xxMB,其中模型:xx个,大小:xxMB,其中图片:xx个,大小:xxMB,其中音频:xx个,大小:xxMB,其中视频:xx个,大小:xxMB',
        }
    }

素材模型资源接口


获取所有可用玩家模型信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
group string 模型样式,[business/cartoon],默认:Null
group1 string 模型分组,[boy/girl],默认:Null
part string 模型分组,[head/body/legs/feet],默认:Null
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data':[
    {
    // Id
    'id': 10001,
    // 显示名称
    'show_name': '程序猿',
    // 模型资源名称
    'model_name': 'Role_01',
    // 显示小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 显示的模型或图片
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 15,
    // 模型资源类别键
    "model_category_key": "model_category_unit",
    // 模型资源类别名称
    "model_category_name": "对象模型",
    // 模型资源类别值
    "model_category_value": "Unit",
    // 模型类型ID
    "model_type_id": 18,
    // 模型类型键
    "model_type_key": "model_type_player",
    // 模型类型名称
    "model_type_name": "玩家",
    // 模型类型值
    "model_type_value": "Player",
    // 模型类型ID
    "review_type_id": 31,
    // 模型类型键
    "review_type_key": "review_type_wait",
    // 模型类型名称
    "review_type_name": "待审核",
    // 审核状态值
    "review_type_value": "0",
    // 模型资源样式,整体模型分散成小模型时可用
    'model_group': 'unknow/business/cartoon',
    // 模型资源分组,整体模型分散成小模型时可用
    'model_group1': 'unknow/boy/girl',
    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
    'model_part': 'unknow/head/body/legs/feet',
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    // 标签
    "tags": 所属标签,逗号隔开
    // 上传完成状态,0-1的小数,上传百分比,1为上传完成
    "upload_completed": 0
    // 素材创建时间
    "createtime": 1686566478
    }
    ]
    }
获取我的素材列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 玩家登陆的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
group string 素材分类,[scene/unit/other],默认:scene
type string 素材类型,scene包含[home/map],unit包含[player/monster/npc/other],other包含[picture/audio/video],默认:map
review string 审核状态,包含[0/1/2/3]=>[待审核/审核通过/审核失败/违规],默认:缺省
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':[
            {
                // Id
                'id': 10002,
                // 显示名称
                'show_name': '办公室',
                // 模型资源名称
                'model_name': 'Office',
                // 显示小图标
                'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                // 显示的模型或图片
                'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                // 模型资源类别ID
                "model_category_id": 14,
                // 模型资源类别键
                "model_category_key": "model_category_scene",
                // 模型资源类别名称
                "model_category_name": "场景模型",
                // 模型资源类别值
                "model_category_value": "Scene",
                // 模型类型ID
                "model_type_id": 17,
                // 模型类型键
                "model_type_key": "model_type_map",
                // 模型类型名称
                "model_type_name": "单场景地图",
                // 模型类型值
                "model_type_value": "Map",
                // 模型类型ID
                "review_type_id": 31,
                // 模型类型键
                "review_type_key": "review_type_wait",
                // 模型类型名称
                "review_type_name": "待审核",
                // 审核状态值
                "review_type_value": "0",
                // FBX模型路径
                "model_path_fbx": "0",
                // Android模型路径
                "model_path_android": "0",
                // WebGL模型路径
                "model_path_webgl": "0",
                // VR转换后模型路径
                "model_path_vr": "0",
                // 模型起始位置
                "start_position": "0.5,0.27,18",
                // 模型起始朝向
                "start_forward": "0,-0.7,0,0.7",
                // 上传完成状态,0-1的小数,上传百分比,1为上传完成
                "upload_completed": 0
                // 素材创建时间
                "createtime": 1686566478
            }
        ]
    }
根据模型Id获取模型数据
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,未登录可以不传
参数
名称 类型 必选 描述
model_id int 角色模型的WebId
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data':{
    // Id
    'id': 10001,
    // 显示名称
    'show_name': '程序猿',
    // 模型资源名称
    'model_name': 'Role_01',
    // 显示小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 显示的模型或图片
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 15,
    // 模型资源类别键
    "model_category_key": "model_category_unit",
    // 模型资源类别名称
    "model_category_name": "对象模型",
    // 模型资源类别值
    "model_category_value": "Unit",
    // 模型类型ID
    "model_type_id": 18,
    // 模型类型键
    "model_type_key": "model_type_player",
    // 模型类型名称
    "model_type_name": "玩家",
    // 模型类型值
    "model_type_value": "Player",
    // 模型类型ID
    "review_type_id": 31,
    // 模型类型键
    "review_type_key": "review_type_wait",
    // 模型类型名称
    "review_type_name": "待审核",
    // 审核状态值
    "review_type_value": "0",
    // 模型资源央视,整体模型分散成小模型时可用
    'model_group': 'unknow/business/cartoon',
    // 模型资源分组,整体模型分散成小模型时可用
    'model_group1': 'unknow/boy/girl',
    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
    'model_part': 'unknow/head/body/legs/feet',
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    // 上传完成状态,0-1的小数,上传百分比,1为上传完成
    "upload_completed": 0
    // 素材创建时间
    "createtime": 1686566478
    }
    }
获取项目的默认模型
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
default_var string 默认场景变量名称[default_player_model],默认:default_player_model
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data':{
    // Id
    'id': 10001,
    // 显示名称
    'show_name': '程序猿',
    // 模型资源名称
    'model_name': 'Role_01',
    // 显示小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 显示的模型或图片
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 15,
    // 模型资源类别键
    "model_category_key": "model_category_unit",
    // 模型资源类别名称
    "model_category_name": "对象模型",
    // 模型资源类别值
    "model_category_value": "Unit",
    // 模型类型ID
    "model_type_id": 18,
    // 模型类型键
    "model_type_key": "model_type_player",
    // 模型类型名称
    "model_type_name": "玩家",
    // 模型类型值
    "model_type_value": "Player",
    // 模型类型ID
    "review_type_id": 31,
    // 模型类型键
    "review_type_key": "review_type_wait",
    // 模型类型名称
    "review_type_name": "待审核",
    // 审核状态值
    "review_type_value": "0",
    // 模型资源央视,整体模型分散成小模型时可用
    'model_group': 'unknow/business/cartoon',
    // 模型资源分组,整体模型分散成小模型时可用
    'model_group1': 'unknow/boy/girl',
    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
    'model_part': 'unknow/head/body/legs/feet',
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    // 上传完成状态,0-1的小数,上传百分比,1为上传完成
    "upload_completed": 0
    // 素材创建时间
    "createtime": 1686566478
    }
    }
保存创建模型信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
model_id int 素材Id,[存在ID为保存,不存在则为创建]
show_name string 素材名称
model_name string 素材唯一名称
category string 素材类别,[scene/unit/other],默认:scene
type string 素材类型,scene包含[home/map],unit包含[player/monster/npc/other],other包含[picture/audio/video],默认:map
show_icon string 素材的展示图片的Url
show_model string 素材的远程地址Url
size int 素材占用空间大小
tags string 素材标签,[多个用英文逗号隔开]
upload_completed float 上传完成度,0-1
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data':{
    // Id
    'id': 10001,
    // 显示名称
    'show_name': '程序猿',
    // 模型资源名称
    'model_name': 'Role_01',
    // 显示小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 显示的模型或图片
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 15,
    // 模型资源类别键
    "model_category_key": "model_category_unit",
    // 模型资源类别名称
    "model_category_name": "对象模型",
    // 模型资源类别值
    "model_category_value": "Unit",
    // 模型类型ID
    "model_type_id": 18,
    // 模型类型键
    "model_type_key": "model_type_player",
    // 模型类型名称
    "model_type_name": "玩家",
    // 模型类型值
    "model_type_value": "Player",
    // 模型类型ID
    "review_type_id": 31,
    // 模型类型键
    "review_type_key": "review_type_wait",
    // 模型类型名称
    "review_type_name": "待审核",
    // 审核状态值
    "review_type_value": "0",
    // 模型资源央视,整体模型分散成小模型时可用
    'model_group': 'unknow/business/cartoon',
    // 模型资源分组,整体模型分散成小模型时可用
    'model_group1': 'unknow/boy/girl',
    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
    'model_part': 'unknow/head/body/legs/feet',
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    // 上传完成状态,0-1的小数,上传百分比,1为上传完成
    "upload_completed": 0
    // 素材创建时间
    "createtime": 1686566478
    }
    }
获取素材转换列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登陆的系统用户
参数
名称 类型 必选 描述
process_type string 处理类型
page int 页码
page_size int 每页查询量,默认:10条记录
update_data array 查询后变更信息
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
    }
更新转换素材信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登陆的系统用户
参数
名称 类型 必选 描述
model_id int 素材Id
model_name string 素材名称
model_path_fbx string FBX文件素材路径
model_path_webgl string WebGL的Bundle文件
model_path_android string Android的Bundle文件路径
model_path_vr string VR的Bundle文件路径
transfer_status string 转换状态
upload_completed float 上传完成度,0到1的小数,1为完成上传
uploadtime int 上传时间
transfertime int 转换时间
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
    }
更新多条转换素材
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登陆的系统用户
参数
名称 类型 必选 描述
update_data int 要更新的素材信息列表,每条信息必须包含id和type,否则则会被遗弃
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'保存素材信息更新成功',
        'data':[
            {
                'ids': [10006,10302,....],
                'process_type': 'review_media|vr360_image|video_banner|transfer_fbx_model'
                'result': false | 1  // 更新了多少条数据,false或者0为没有更新
            },
            ...
        ]
    }
素材是否使用
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
model_id int 素材Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    }
删除素材信息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
model_id int 素材Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    }
上传素材资源,支持分段上传
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登陆的系统用户
参数
名称 类型 必选 描述
file file 素材资源
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
chunkid string 分片ID,特别提示:分片上传的标志,设置此参数代表启用分片上传
action string 分片操作类型,可用参数:[clean/merge/chunk],默认:chunk,分片时有效
chunkindex string 分片的索引,分片时有效
chunkcount string 分片总片数
filename string 文件名称,注:合并[merge]分段文件时需要
category string 素材类别,[scene/unit/other],默认:scene
type string 素材类型,scene包含[home/map],unit包含[player/monster/npc/other],other包含[picture/audio/video],默认:map
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data': {
    // Id
    'id': 10001,
    // 显示名称
    'show_name': '程序猿',
    // 模型资源名称
    'model_name': 'Role_01',
    // 显示小图标
    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
    // 显示的模型或图片
    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
    // 模型资源类别ID
    "model_category_id": 15,
    // 模型资源类别键
    "model_category_key": "model_category_unit",
    // 模型资源类别名称
    "model_category_name": "对象模型",
    // 模型资源类别值
    "model_category_value": "Unit",
    // 模型类型ID
    "model_type_id": 18,
    // 模型类型键
    "model_type_key": "model_type_player",
    // 模型类型名称
    "model_type_name": "玩家",
    // 模型类型值
    "model_type_value": "Player",
    // 模型类型ID
    "review_type_id": 31,
    // 模型类型键
    "review_type_key": "review_type_wait",
    // 模型类型名称
    "review_type_name": "待审核",
    // 审核状态值
    "review_type_value": "0",
    // 模型资源央视,整体模型分散成小模型时可用
    'model_group': 'unknow/business/cartoon',
    // 模型资源分组,整体模型分散成小模型时可用
    'model_group1': 'unknow/boy/girl',
    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
    'model_part': 'unknow/head/body/legs/feet',
    // 模型起始位置
    "start_position": "0.5,0.27,18",
    // 模型起始朝向
    "start_forward": "0,-0.7,0,0.7",
    // 上传完成状态,0-1的小数,上传百分比,1为上传完成
    "upload_completed": 0
    // 素材创建时间
    "createtime": 1686566478
    }
    }

换装接口


获取套装列表以及包含的模型和材质
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
style string 模型样式,[business/cartoon],默认:business
group string 模型样式,[boy/girl],默认:boy
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':[{
            // 套装Id
            'id': 1,
            // 套装Id
            'suit_id': 1,
            // 显示名称
            'show_name': '商务套装[男]',
            // 显示小图标
            'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
            // 套装样式[商务/卡通]
            'suit_group': 'bussiness/cartoon',
            // 套装分组[男/女]
            'suit_group1': 'boy/girl',
            // 是否为默认套装
            'is_default': 1,
            // 套装排序
            'sort': 1,
            // 套装创建时间
            "createtime": 1686566478
            // 套装更新时间
            "updatetime": 1686566478
            // 套装模型列表
            'suit_models':[
            {
                // 骨骼Id
                'bone_id': 10001,
                // 骨骼显示名称
                'bone_show': '程序猿',
                // 骨骼资源名称
                'bone_name': 'Role_01',
                // 模型资源样式,整体模型分散成小模型时可用
                'group': 'unknow/business/cartoon',
                // 模型资源分组,整体模型分散成小模型时可用
                'group1': 'unknow/boy/girl',
                // 模型Id
                'model_id': 10001,
                // 显示名称
                'model_show': '程序猿',
                // 模型资源名称
                'model_name': 'Role_01',
                // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                'model_part': 'unknow/head/body/legs/feet',
                // 模型FBX文件路径
                'model_path_fbx': 'https://cdn.xuhuan.shumaimetaverse.com/modelsource/player/KT_Boy01/KT_Boy01_Head.fbx',
                // 模型材质列表
                'materials': [
                    {
                        // 材质Id
                        'id': 10001,
                        // 材质Id
                        'material_id': 10001,
                        // 材质展示名称
                        'material_show': '白色西服',
                        // 材质资源名称
                        'material_name': 'BlackShortHair',
                        // 材质分块在整体模型中所属部分,整个体模型分散成小模型时有效
                        'material_part': 'unknow/hair/head/body/legs/feet',
                    },
                ],
            },...],
        }]
     }
获取默认的套装信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
suit_id int 套装ID
正文
参数
响应输出

                                                            

                                                        
返回参数
{
    'code':'0',
    'msg':'返回成功',
    'data':{
            // 套装Id
            'id': 1,
            // 套装Id
            'suit_id': 1,
            // 显示名称
            'show_name': '商务套装[男]',
            // 显示小图标
            'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
            // 套装样式[商务/卡通]
            'suit_group': 'bussiness/cartoon',
            // 套装分组[男/女]
            'suit_group1': 'boy/girl',
            // 是否为默认套装
            'is_default': 1,
            // 套装排序
            'sort': 1,
            // 套装创建时间
            "createtime": 1686566478
            // 套装更新时间
            "updatetime": 1686566478
            // 套装模型列表
            'suit_models':[
            {
                // 骨骼Id
                'bone_id': 10001,
                // 骨骼显示名称
                'bone_show': '程序猿',
                // 骨骼资源名称
                'bone_name': 'Role_01',
                // 模型资源样式,整体模型分散成小模型时可用
                'group': 'unknow/business/cartoon',
                // 模型资源分组,整体模型分散成小模型时可用
                'group1': 'unknow/boy/girl',
                // 模型Id
                'model_id': 10001,
                // 显示名称
                'model_show': '程序猿',
                // 模型资源名称
                'model_name': 'Role_01',
                // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                'model_part': 'unknow/head/body/legs/feet',
                // 模型FBX文件路径
                'model_path_fbx': 'https://cdn.xuhuan.shumaimetaverse.com/modelsource/player/KT_Boy01/KT_Boy01_Head.fbx',
                // 模型材质列表
                'materials': [
                    {
                        // 材质Id
                        'id': 10001,
                        // 材质Id
                        'material_id': 10001,
                        // 材质展示名称
                        'material_show': '白色西服',
                        // 材质资源名称
                        'material_name': 'BlackShortHair',
                        // 材质分块在整体模型中所属部分,整个体模型分散成小模型时有效
                        'material_part': 'unknow/hair/head/body/legs/feet',
                    },
                ],
            },...],
        }
获取衣服、裤子和鞋子列表
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
style string 模型样式,[business/cartoon],默认:business
group string 模型分类,[boy/girl]
part string 模型分块,[body/legs/feet]
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{[
            {
                // 骨骼Id
                'bone_id': 10001,
                // 骨骼显示名称
                'bone_show': '程序猿',
                // 骨骼资源名称
                'bone_name': 'Role_01',
                // 模型资源样式,整体模型分散成小模型时可用
                'group': 'unknow/business/cartoon',
                // 模型资源分组,整体模型分散成小模型时可用
                'group1': 'unknow/boy/girl',
                // 模型Id
                'model_id': 10001,
                // 显示名称
                'model_show': '程序猿',
                // 模型资源名称
                'model_name': 'Role_01',
                // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                'model_part': 'unknow/head/body/legs/feet',
                // 模型FBX文件路径
                'model_path_fbx': 'https://cdn.xuhuan.shumaimetaverse.com/modelsource/player/KT_Boy01/KT_Boy01_Head.fbx',
                // 模型材质列表
                'materials': [
                    {
                        // 材质Id
                        'id': 10001,
                        // 材质Id
                        'material_id': 10001,
                        // 材质展示名称
                        'material_show': '白色西服',
                        // 材质资源名称
                        'material_name': 'BlackShortHair',
                        // 材质分块在整体模型中所属部分,整个体模型分散成小模型时有效
                        'material_part': 'unknow/hair/head/body/legs/feet',
                    },
                ],
            }
        ]}
获取五官列表,包含头发和头
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
style string 模型样式,[business/cartoon],默认:business
group string 模型样式,[boy/girl],默认:boy
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:10
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{[
            {
                // 骨骼Id
                'bone_id': 10001,
                // 骨骼显示名称
                'bone_show': '程序猿',
                // 骨骼资源名称
                'bone_name': 'Role_01',
                // 模型资源样式,整体模型分散成小模型时可用
                'group': 'unknow/business/cartoon',
                // 模型资源分组,整体模型分散成小模型时可用
                'group1': 'unknow/boy/girl',
                // 模型Id
                'model_id': 10001,
                // 显示名称
                'model_show': '程序猿',
                // 模型资源名称
                'model_name': 'Role_01',
                // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                'model_part': 'unknow/head/body/legs/feet',
                // 模型FBX文件路径
                'model_path_fbx': 'https://cdn.xuhuan.shumaimetaverse.com/modelsource/player/KT_Boy01/KT_Boy01_Head.fbx',
                // 模型材质列表
                'materials': [
                    {
                        // 材质Id
                        'id': 10001,
                        // 材质Id
                        'material_id': 10001,
                        // 材质展示名称
                        'material_show': '白色西服',
                        // 材质资源名称
                        'material_name': 'BlackShortHair',
                        // 材质分块在整体模型中所属部分,整个体模型分散成小模型时有效
                        'material_part': 'unknow/hair/head/body/legs/feet',
                    },
                ],
            }
        ]}
保存玩家信息,包头、身体、腿、脚
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,必须登陆
参数
名称 类型 必选 描述
nickname string 用户昵称
faceicon string 用户图像
params object [{bone_id:骨骼ID,model_id:模型ID,material_ids:材质Id集合,多个Id以逗号分开}]
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{
         }
获取场景中的默认变身数据信息,包头、身体、腿、脚
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_id int 所在场景Id,例如:10172
model_id int 所在场景模型Id,例如:10362
model_name string 所在场景模型名称,例如:LongNianChunJie
params object 当前模型装备,例如:[{bone_id:骨骼ID,model_id:模型ID,material_ids:材质Id集合,多个Id以逗号分开}]
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data':{
    }

编辑器


获取素材列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
category int 素材类型, [model,picture,video,audio]
is_common int 是否筛选公共资源,不筛选则不设置, 0:非公共资源,1:公共素材
name string 按名称筛选
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:20
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
获取我的场景对象列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
scene_id int 场景Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
获取场景对象列表
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
scene_id int 场景Id
page integer 每页展示数据量,页码从1开始,默认:1
offset integer 搜索位置的偏移量,默认:0
page_size integer 每页展示数据量,默认:10
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
获取一个场景对象
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_object_id int 场景对象Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
保存场景对象
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
scene_id int 场景Id
json_data string 场景对象相关数据
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
删除场景对象
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
scene_id int 场景Id
object_id int 场景对象Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
根据对象类型以及对象事件参数获取动效列表
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
object_type_id int 场景对象类型ID
event_type_id int 场景对象事件类型ID
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
根据对象类型、对象事件、动效类型参数获取资源列表
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
object_type_id int 场景对象类型ID
event_type_id int 场景对象事件类型ID
action_type_id int 场景对象动效类型ID
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
根据审核状态获取场景使用素材列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
scene_id int 场景对象ID
review_status string 审核状态[待审核/审核通过/审核不通过/审核中][wait/pass/fail/review],默认:fail
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
最近使用素材的列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
scene_id int 场景Id
model_name string 筛选素材名称
type string 筛选素材类型,[model/picture/audio/video]
page integer 每页展示数据量,页码从1开始,默认:1
page_size integer 每页展示数据量,默认:20
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
删除最近使用素材
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录的Token
参数
名称 类型 必选 描述
use_id int 使用Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
获取默认封面
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': [
            {
                "scene_source_type": {
                    "id": 22,
                    "type_group": "modelsource",
                    "type_id": 8,
                    "type_key": "shopwindow_src_type_picture",
                    "type_desc": "图片",
                    "type_value": "image/jpg,image/jpeg,image/png",
                    "sort": 0,
                    "this_id": 22
                },
                "default_banner": {
                    "id": 10313,
                    "bone_id": 0,
                    "show_name": "sdsdf",
                    "show_icon": "https://cdn.xuhuan.shumaimetaverse.com/release/modelsource/images/10019/1703727200751/1703727200751.jpg/modelbanner",
                    "show_model": "https://cdn.xuhuan.shumaimetaverse.com/release/modelsource/images/10019/1703727200751/1703727200751.jpg",
                    "model_category_id": 42,
                    "model_type_id": 43,
                    "model_name": "1703727201601",
                    "model_path_fbx": null,
                    "is_common": false,
                    "review_type_id": 31,
                    "size": 0,
                    "tags": null,
                    "transfer_status": "change_upload_success",
                    "model_category_key": "model_category_other",
                    "model_category_name": "其他资源",
                    "model_category_value": "other",
                    "model_type_key": "model_type_picture",
                    "model_type_name": "图片",
                    "model_type_value": "Pictrue",
                    "review_type_key": "review_type_wait",
                    "review_type_name": "待审核",
                    "review_type_value": "0",
                    "size_show": "0 B",
                    "model_id": 10313
                }
            }, ...
        ]
    }
场景对象json格式化
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_id int 场景Id
show_name string 显示名称
model_name string 模型名称
position string 位置信息,例如:0,0,0
rotation string 朝向信息,例如:0,0,0
scale string 缩放信息,例如:0,0,0
locked int 锁定,0:未锁定,1:已锁定
object_type_id int 对象类型[68=>普通对象,69=>热点对象,70=>导览对象]
fire_event_id int 事件类型[71=>鼠标左键单击,72=>鼠标右键单击,73=>鼠标左键双击,74=>鼠标右键双击,75=>柱形区域,76=>球形区域,77=>矩形区域]
fire_event_radius int 事件触发半径
fire_event_width int 事件触发宽
fire_event_height int 事件触发高
fire_event_length int 事件触发长
fire_event_params string 事件触发其他参数,JSON格式
static_source_id int 静态对象资源ID
guide_stay_time int 导览点停留时间,单位:秒
guide_source_id int 导览点触发资源ID
guide_skip_source_id int 导览点跳过时资源ID
guide_path_nodes string 导览点路点集合,Vector3,用;分割
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
场景动效json格式化
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_id int 场景Id
action_id int 动效Id
action_type_id int 动效类型[48=>静态动效,49=>横向六页,50=>竖向六页,51=>竖向一页,52=>横向一页,53=>水平跑马灯,54=>垂直跑马灯,56=>隐藏事件]
limit_source_type_id int 限制使用的资源类型[22=>图片,23=>视频,24=>PDF,55=>音频,79=>文本]
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }
场景资源json格式化
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
scene_id int 场景Id
object_id int 对象Id
action_id int 动效Id
source_id int 资源Id
show_name string 资源显示名称
model_name string 资源模型名称
src_type_id int 资源类型[22=>图片,23=>视频,24=>PDF,25=>屏幕分享,47=>内开网页,55=>音频,57=>Unity对话框,58=>JS对话框,64=>外开网页,78=>模型资源,79=>文本]
source_banner_id int 资源的封面资源ID
src_value string 根据资源类型取值,[文本、网站=>字符串值, 图片、音频、视频、PDF、模型=>资源ID, 对话框=>对话ID]
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
        }
    }

消息邮件


获取消息列表
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
page int 页码,默认:1
page_size int 每页数量,默认20
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
    "code": 0,
    "msg": "请求成功",
    "time": "1691146926",
    "data": {
    "list": [
    {
    // 消息ID
    "id": 2,
    // 消息显示标题
    "show_title": "默认登录场景",
    // 消息标题
    "title": "默认登录场景",
    // 消息类型ID
    "msg_type_id": 46,
    // 消息类型键名
    "msg_type_key": "msg_type_system",
    // 消息类型名称
    "msg_type_name": "系统消息",
    // 消息是否已读,0:未读,1:已读
    "is_read": 1
    // 消息发送人ID
    "from_user": {
    "id": 10001,
    "nickname": "abc",
    "avatar": “”,
    }
    // 收到时间
    "createtime": 1686566478
    // 收到时间
    "createtime_show": "2024-05-30 13:57:08"
    // 读取时间
    "readtime": 1686566478
    // 读取时间
    "readtime_show": "2024-05-30 13:57:08"
    // 消息有效时间
    "validtime": 1686566478
    // 消息有效时间
    "validtime_show": "2024-05-30 13:57:08"
    }
    ],
    "total_count": 1,
    "page_count": 1
    }
    }
根据消息Id获取消息信息,会触发已读操作
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
msg_id string 消息Id
return_type string 返回内容类型[content/page],默认:content
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        "code": 0,
        "msg": "请求成功",
        "time": "1691146926",
        "data": {
            // 消息ID
            "id": 2,
            // 消息显示标题
            "show_title": "默认登录场景",
            // 消息标题
            "title": "默认登录场景",
            // 消息类型ID
            "msg_type_id": 46,
            // 消息类型键名
            "msg_type_key": "msg_type_system",
            // 消息类型名称
            "msg_type_name": "系统消息",
            // 消息是否已读,0:未读,1:已读
            "is_read": 1
            // 消息发送人ID
            "from_user": {
                "id": 10001,
                "nickname": "abc",
                "avatar": “”,
            }
            // 收到时间
            "createtime": 1686566478
            // 收到时间
            "createtime_show": "2024-05-30 13:57:08"
            // 读取时间
            "readtime": 1686566478
            // 读取时间
            "readtime_show": "2024-05-30 13:57:08"
            // 消息有效时间
            "validtime": 1686566478
            // 消息有效时间
            "validtime_show": "2024-05-30 13:57:08"
        }
    }
是否有新消息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        "code": 0,
        "msg": "请求成功",
        "time": "1691146926",
        "data": {}
    }
删除邮件
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录玩家的Token
参数
名称 类型 必选 描述
msg_id string 消息Id
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        "code": 0,
        "msg": "请求成功",
        "time": "1691146926",
    }

验证接口


检测用户名唯一性、敏感词安全
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
username string 用户名
id integer 排除检测会员Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data': {
            'suggestion': '建议处理的结果,通过:Pass, 审查: Review',
            'keywords': '审查的关键字列表',
            'label': '审查的关键字所属范围'
        }
     }
检测昵称是否唯一、敏感词安全
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
nickname string 昵称信息
id integer 排除检测会员Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data': {
            'suggestion': '建议处理的结果,通过:Pass, 审查: Review',
            'keywords': '审查的关键字列表',
            'label': '审查的关键字所属范围'
        }
     }
检测昵称输入敏感词安全
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
nickname string 昵称信息
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data': {
            'suggestion': '建议处理的结果,通过:Pass, 审查: Review',
            'keywords': '审查的关键字列表',
            'label': '审查的关键字所属范围'
        }
     }
检测聊天输入敏感词安全
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
content string 检测内容
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data': {
            'suggestion': '建议处理的结果,通过:Pass, 审查: Review',
            'keywords': '审查的关键字列表',
            'label': '审查的关键字所属范围'
        }
    }
检测标题敏感词安全
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
content string 标题内容
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        'data': {
            'suggestion': '建议处理的结果,通过:Pass, 审查: Review',
            'keywords': '审查的关键字列表',
            'label': '审查的关键字所属范围'
        }
    }
检测手机唯一性
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
id integer 排除检测会员Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }
检测手机是否存在
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }
检测邮箱唯一性
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
id integer 排除检测会员Id
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }
检测邮箱是否存在
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }
检测手机验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
captcha string 验证码
event string 事件(login/mobilelogin/register
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }
检测邮箱验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
captcha string 验证码
event string 事件(login/mobilelogin/register
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
     }

系统配置接口


获取系统文本配置
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
platform string 平台[android/web]
about_var string 默认场景变量名称[agreement/privacy]=>[用户协议/隐私声明]
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': '文本内容'
    }
获取版本信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
platform string 平台[android/webgl/vr]
current_version string 客户端当前版本
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 版本ID
            "id": 1,
            // 项目ID
            "project_id": 28,
            // 平台
            "platform": "android",
            // 是否为当前版本
            "is_current": 1,
            // 服务器版本
            "server_version": null,
            // 包版本
            "package_version": "1.0.000",
            // 资源版本
            "source_version": "1.0.000",
            // 中继服许可证
            "router_license": null,
            // 资源Url连接
            "source_url": null,
            // 发布版本包下载链接
            "publish_url": "https://cdn.shumaimetaverse.com/package/舒迈科技培训平台_2022_12_9_Android_001.apk",
            // 是否需要强制更新
            "force_update": 0,
            // APK版本号
            "apk_version_code": null,
            // 版本更新描述
            "apk_version_description": null,
            // 版本创建时间
            "createtime": null,
            // 版本删除时间
            "deletetime": null
        }
    }
设置新版本
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统或者测试账号可用
参数
名称 类型 必选 描述
id int 要修改的版本ID,为空或者0的情况下代表新增版本,否则为修改版本
project_id int 项目ID,默认:28,为虚幻奇点项目,此字段和project字段必须有其一
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian,此字段和project_id字段必须有其一
platform string 平台[android/webgl/vr]
is_current int 是否为当前版本,0:非当前版本,1:是当前版本,默认:0,非当前版本
server_version string 对应的服务器版本
package_version string 对应的包版本
source_version string 对应的包资源版本
router_license string 中继服许可证
source_url string 热更新资源Url连接
publish_url string 发布包的Url连接
force_update int 是否为强制更新包,0:非强制,1:强制,默认:0,非强制
is_publish int 是否为发布版本,0:非发布,1:发布,默认:0,非发布
apk_version_code string 版本比对的版本号,例如1.0.001,版本比对号为1000001
apk_version_description string 版本更新内容的详细描述,以后后去回溯
update_content string 更新内容,显示给用户
remarks string 版本备注
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            // 版本ID
            "id": 1,
            // 项目ID
            "project_id": 28,
            // 平台
            "platform": "android",
            // 是否为当前版本
            "is_current": 1,
            // 服务器版本
            "server_version": null,
            // 包版本
            "package_version": "1.0.000",
            // 资源版本
            "source_version": "1.0.000",
            // 中继服许可证
            "router_license": null,
            // 资源Url连接
            "source_url": null,
            // 发布版本包下载链接
            "publish_url": "https://cdn.shumaimetaverse.com/package/舒迈科技培训平台_2022_12_9_Android_001.apk",
            // 是否需要强制更新
            "force_update": 0,
            // APK版本号
            "apk_version_code": null,
            // 版本更新描述
            "apk_version_description": null,
            // 版本创建时间
            "createtime": null,
            // 版本删除时间
            "deletetime": null
        }
    }
开启客户日志
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': 0, // 是否开启客户日志,0:不开启,1:开启
        }
临时过审隐私政策
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': '文本内容'
    }
获取项目配置
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
project string 项目分类,[XuHuanQiDian/HaiKouDaJiangTang/WenDao],默认:XuHuanQiDian
platform string 平台,[android/ios/web/webgl/wxshare/vr],默认:android
group string 参数所属组,var为空时将根据group内容读取一组参数和值的集合,group和var不能同时为空,默认:空
var string 参数名称,group和var不能同时为空,默认:空
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            'var1': 'value1',
            'var2': 'value2',
            'var3': 'value3',
            'var_n': 'value_n'
        }
    }
调试日志
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登录系统的Token,非必须,用以记录日志操作者
参数
名称 类型 必选 描述
level int 日志等级
content string 日志内容
platform string 平台,[android/ios/web/webgl/wxshare_android/vr]
scene string 当前使用场景数据
unit string 场景对象数据
params string 臆测自定参数或者Json数据
remarks string 记录日志的特殊标记,默认:空
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': null
    }
系统信息
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': null
    }

飞书相关接口


通过手机号或邮箱获取用户 ID
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
user_id_type string 用户Id类型,[open_id/union_id/user_id], 默认:open_id
mobiles string[] 要查询的用户手机号,多个数据用[,]隔开,最多50条,emails与mobiles相互独立,每条用户手机号返回对应的用户ID
emails string[] 要查询的用户邮箱(不支持企业邮箱),多个数据用[,]隔开,最多50条,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {
            "user_list": [
                {
                    "user_id": "ou_979112345678741d29069abcdef089d4",
                    "email": "zhangsan@a.com"
                },{
                    "user_id": "ou_919112245678741d29069abcdef096af",
                    "email": "lisi@a.com"
                },
                {
                    "user_id": "ou_46a087654321a1dc920ffab8fedc823f",
                    "mobile": "13812345678"
                },
                {
                    "user_id": "ou_01b081675121a1dc920ffab97cdc017a",
                    "mobile": "13812345679"
                }
            ]
        }
    }
给指定接受者发送消息
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 请求的Token,系统账号可用
参数
名称 类型 必选 描述
receive_id_type string 用户Id类型,[open_id/union_id/user_id/email/chat_id], 默认:open_id
receive_id string 根据receive_id_type获取的接受者Id
msg_type string 消息体的类型【文本/富文本/图片/消息卡片/分享群名片/分享个人名片/语音/视频/文件/表情包】=>【text/post/image/interactive/share_chat/share_user/audio/media/file/sticker】,默认:text
content string 消息内容,JSON结构序列化后的字符串。不同msg_type对应不同内容
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'返回成功',
        'data': {}
    }

微信小程序


获取小程序Token
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        // 消息编号,[0:请求成功; 87009:invalid signature 签名错误]
        'code':'0',
        // 消息描述
        'msg':'返回成功'
        // 获取的Token数据
        'data': {
            // 获取Token数据时,返回的Code错误码
            'errcode': 40013,
            // 获取Token数据时,返回的Code错误信息
            'errmsg': 'invalid appid',
            // 获取到的凭证
            'access_token': ACCESS_TOKEN,
            // 凭证的过期时间,默认:7200(秒)
            'expires_in': 7200,
            // 获取凭证的请求Unixtime时间点
            'request_time': 1723444889,
            // 凭证的有效Unixtime时间点
            'valid_time': 1723444889,
            // 是否从Session中获取
            'from_session': 0,
        }
    }
检测SessionKey
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
openid string 用户唯一标识符
signature string 用户登录态签名
sig_method string 用户登录态签名的哈希方法,目前只支持 hmac_sha256,默认:hmac_sha256
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
{
        // 消息编号,[0:请求成功; 87009:invalid signature 签名错误]
        'code':'0',
        // 消息描述
        'msg':'返回成功'
    }
根据Code获取SessionKey
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
code string 登录获取的Code
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data object 扩展数据返回
{
        // 消息编号,[-1:系统繁忙,此时请开发者稍候再试; 0:请求成功; 40029:code 无效; 45011:频率限制,每个用户每分钟100次; 40226:高风险等级用户,小程序登录拦截]
        'code':'0',
        // 消息描述
        'msg':'返回成功'
        // 返回的数据
        {
            // 用户唯一标识
            'openid':'1',
            // 会话密钥
            'session_key':'dh0a29knb1092nb9bd78f'
            // 用户在开放平台的唯一标识符,若当前小程序已绑定到微信开放平台账号下会返回
            'unionid':'1',
            // 错误码,[-1:系统繁忙,此时请开发者稍候再试; 0:请求成功; 40029:code 无效; 45011:频率限制,每个用户每分钟100次; 40226:高风险等级用户,小程序登录拦截]
            'errcode':'返回成功'
            // 错误信息
            'errmsg':'返回成功'
        }
     }
重置用户的SessionKey
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
openid string 用户唯一标识符
signature string 用户登录态签名
sig_method string 用户登录态签名的哈希方法,目前只支持 hmac_sha256
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data object 扩展数据返回
{
        // 消息编号,[-1:系统繁忙,此时请开发者稍候再试; 0:请求成功; 40029:code 无效; 45011:频率限制,每个用户每分钟100次; 40226:高风险等级用户,小程序登录拦截]
        'code':'0',
        // 消息描述
        'msg':'返回成功'
        // 返回的数据
        {
            // 用户唯一标识
            'openid':'1',
            // 会话密钥
            'session_key':'dh0a29knb1092nb9bd78f'
            // 错误码,[-1:系统繁忙,此时请开发者稍候再试; 0:请求成功; 40029:code 无效; 45011:频率限制,每个用户每分钟100次; 40226:高风险等级用户,小程序登录拦截]
            'errcode':'返回成功'
            // 错误信息
            'errmsg':'返回成功'
        }
    }
解密UserInfo中的encryptedData信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
session_key string 会话密钥
encrypted_data string 包括敏感数据在内的完整用户信息的加密数据
iv string 加密算法的初始向量
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        // 消息编号,[0:解密成功; -41001:encodingAesKey 非法; -41002:非法的iv初始向量; -41003:aes 解密失败; -41004:解密后得到的buffer非法; -41005:base64加密失败; -41006:base64解密失败]
        'code':'0',
        // 消息描述
        'msg':'返回成功'
        // 返回的数据
        {
            // 用户唯一标识
            'openid':'1',
            // 会话密钥
            'session_key':'dh0a29knb1092nb9bd78f'
            // 错误码,[-1:系统繁忙,此时请开发者稍候再试; 0:请求成功; 40029:code 无效; 45011:频率限制,每个用户每分钟100次; 40226:高风险等级用户,小程序登录拦截]
            'errcode':'返回成功'
            // 错误信息
            'errmsg':'返回成功'
        }
    }
获取微信用户信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
openid string 用户唯一标识符
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
    }
注册微信用户信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
openid string 用户唯一标识符
mobile string 用户绑定手机
captcha string 用户手机绑定Code
avatar string 用户图像
nickname string 用户昵称
gender int 用户性别,0:女,1:男
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        'code':'0',
        'msg':'成功'
        "time": "1679300182",
        "data": {
            "userinfo": {
                "id": 10001,
                "username": "example",
                "nickname": "艾AA",
                "mobile": "13888888888",
                "avatar": "http://admin.shumaimetaverse.com/assets/img/avatar.png",
                "score": 0,
                "token": "2ce87d94-5830-42d5-aa45-66cd47184dc5",
                "user_id": 10001,
                "player_model_id": 0,
                "player_model": {
                    // Id
                    'id': 10001,
                    // 显示名称
                    'show_name': '程序猿',
                    // 模型资源名称
                    'model_name': 'Role_01',
                    // 显示小图标
                    'show_icon': 'https://cdn.shumaimetaverse.com/example/images/face-male.png',
                    // 显示的模型或图片
                    'show_model': 'https://cdn.shumaimetaverse.com/example/images/body-male.png',
                    // 模型资源类别ID
                    "model_category_id": 15,
                    // 模型资源类别键
                    "model_category_key": "model_category_unit",
                    // 模型资源类别名称
                    "model_category_name": "对象模型",
                    // 模型资源类别值
                    "model_category_value": "Unit",
                    // 模型类型ID
                    "model_type_id": 18,
                    // 模型类型键
                    "model_type_key": "model_type_player",
                    // 模型类型名称
                    "model_type_name": "玩家",
                    // 模型类型值
                    "model_type_value": "Player",
                    // 模型资源分组,整体模型分散成小模型时可用
                    'model_group': '',
                    // 模型资源在整体模型中所属部分,整个体模型分散成小模型时有效
                    'model_part': '',
                    // 模型起始位置
                    "start_position": "0.5,0.27,18",
                    // 模型起始朝向
                    "start_forward": "0,-0.7,0,0.7",
                },
                // 创建时间
                "createtime": 1679300183,
                // 上次登录时间
                "prevtime": 1696823049,
                // Token过期时间点的UnixTime
                "expiretime": 1681892183,
                // Token过期倒计时(秒)
                "expires_in": 2592000,
            }
        }
    }

手机短信接口


发送验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号码
event string 事件名称
正文
参数
响应输出

                                                            

                                                        
返回参数
检测验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号码
event string 事件名称
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

腾讯云接口


获取QCUpload的TempKey
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
allow_prefix string 平台[modelsource/scene]
正文
参数
响应输出

                                                            

                                                        
返回参数
获取微信公众平台的Token
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        code:0,
        msg:'获取成功',
        data: {
            // 正确情况
            "access_token":"ACCESS_TOKEN",
            "expires_in":7200,
            // 错误情况
            "errcode":40013,
            "errmsg":"invalid appid",
        }
     }
获取微信公众平台的签名
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
access_url string 访问的Url
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        code:0,
        msg:'获取成功',
        data: {
            // 正确情况
            "noncestr":"ACCESS_TOKEN",
            "timestamp":1491635035,
            "signature":"0f9de62fce790f9a083d5c99e95740ceb90c27ed",
            // 错误情况
            "errcode":40013,
            "errmsg":"invalid appid",
        }
    }
测试腾讯云存储桶上传
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
prefix string 对象的key以prefix开始
marker string 起始对象键标记
max_keys string 设置最大遍历出多少个对象, 一次listObjects最大支持1000,默认:50
delimiter string Delimiter表示分隔符, 设置为/表示列出当前目录下的object, 设置为空表示列出所有的object
bucket string 存储桶名称,由BucketName-Appid组成
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        code:0,
        msg:'获取成功',
        data: {
        }
    }
腾讯云存储桶上传
权限
登录
鉴权
Headers
名称 类型 必选 描述
token string 登陆的系统用户
参数
名称 类型 必选 描述
file file 资源数据
chunkid string 分片ID,特别提示:分片上传的标志,设置此参数代表启用分片上传
action string 分片操作类型,可用参数:[clean/merge/chunk],默认:chunk,分片时有效
chunkindex string 分片的索引,分片时有效
chunkcount string 分片总片数
filename string 文件名称,注:合并[merge]分段文件时需要
正文
Headers
参数
响应输出

                                                            

                                                        
返回参数
{
        code:0,
        msg:'获取成功',
        data: {
        }
    }
数智人api访问链接
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
api string 访问数智人接口API
正文
参数
响应输出

                                                            

                                                        
返回参数
{
        code:0,
        msg:'获取成功',
        data: {
            access_url: https://gw.tvs.qq.com/v2/ivh/api?appkey=example_appkey×tamp=1717639699&signature=aCNWYzZdplxWVo%2BJsqzZc9%2BJ9XrwWWITfX3eQpsLVno%3D
        }
    }

错误码信息查询接口


获取所有Code错误码信息
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数