173799761 hace 1 año
padre
commit
540c9f6eaf
Se han modificado 1 ficheros con 135 adiciones y 30 borrados
  1. 135 30
      ic1101_cocos_API.md

+ 135 - 30
ic1101_cocos_API.md

@@ -459,7 +459,6 @@ http://127.0.0.1:7379/new_battle/passwordForget?account=test1111&newPwd=2&email=
 | emailCode  | string | 是       | 是           | 验证码,万能验证码见文档第一章 |
 | sign       | string | 是       | 否           | md5加密值                     |
 | timestamp  | string | 是       | 是           | 时间戳 毫秒                   |
-| loginType  | int    | 是       | 是           | 登录类型,具体见LoginEnum结构 |
 | inviteCode | string | 否       | 否           | 上级邀请码                    |
 
 请求
@@ -653,13 +652,13 @@ account=a1|email=guoliang@gliangliang.com|emailcode=null|logintype=null|pwd=1232
 
 请求
 
-| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                                           |
-| --------- | ------ | -------- | ------------ | ---------------------------------------------- |
-| token     | string | 否       | 是           | 登录成功后获取的令                             |
-| objId     | int    | 否       | 是           | 点赞的实例ID                                   |
-| objType   | int    | 否       | 是           | 1.房间 2.房间里的slot,包括(画 ,家具) 3.avatar |
-| sign      | string | 否       | 否           | md5加密值                                      |
-| timestamp | string | 是       | 是           | 时间戳 毫秒                                    |
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                                                  |
+| --------- | ------ | -------- | ------------ | ----------------------------------------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令                                    |
+| objId     | int    | 否       | 是           | 点赞的实例ID                                          |
+| objType   | int    | 否       | 是           | 1.房间 2.房间里的slot,包括(画 ,家具) 3.avatar 4.user |
+| sign      | string | 否       | 否           | md5加密值                                             |
+| timestamp | string | 是       | 是           | 时间戳 毫秒                                           |
 
 ##### 14.是否可以给别人点赞 `/thumbUpAuth`
 
@@ -667,17 +666,17 @@ account=a1|email=guoliang@gliangliang.com|emailcode=null|logintype=null|pwd=1232
 
 请求
 
-| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                                           |
-| --------- | ------ | -------- | ------------ | ---------------------------------------------- |
-| token     | string | 否       | 是           | 登录成功后获取的令                             |
-| objId     | int    | 否       | 是           | 点赞的实例ID                                   |
-| objType   | int    | 否       | 是           | 1.房间 2.房间里的slot,包括(画 ,家具) 3.avatar |
-| sign      | string | 否       | 否           | md5加密值                                      |
-| timestamp | string | 是       | 是           | 时间戳 毫秒                                    |
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                                                  |
+| --------- | ------ | -------- | ------------ | ----------------------------------------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令                                    |
+| objId     | int    | 否       | 是           | 点赞的实例ID                                          |
+| objType   | int    | 否       | 是           | 1.房间 2.房间里的slot,包括(画 ,家具) 3.avatar 4.user |
+| sign      | string | 否       | 否           | md5加密值                                             |
+| timestamp | string | 是       | 是           | 时间戳 毫秒                                           |
 
 
 
-##### 15.给别人取消点赞 `/thumbUpCancel`
+##### 15.给别人取消点赞 `/thumbUpCancel` --废弃
 
 请求
 
@@ -815,8 +814,6 @@ account=a1|email=guoliang@gliangliang.com|emailcode=null|logintype=null|pwd=1232
 | account   | string | 是       | 是           | 账号名      |
 | oldPwd    | string | 是       | 是           | 老密码      |
 | newPwd    | string | 是       | 是           | 新密码      |
-| email     | string | 是       | 是           | 邮箱地址    |
-| emailCode | string | 是       | 是           | 验证码      |
 | sign      | string | 是       | 否           | md5加密值   |
 | timestamp | string | 是       | 是           | 时间戳 毫秒 |
 
@@ -1260,7 +1257,7 @@ http://127.0.0.1:7379/new_battle/zhSmsCode?mobile=13816510467
 | sign      | string | 是       | 否           | md5加密值   |
 | timestamp | string | 是       | 是           | 时间戳 毫秒 |
 
-##### 4.重置密码`/zhPwdReset`
+##### 4.重置密码 -- 通过手机号来重置密码  `/zhPwdReset`
 
 | 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
 | --------- | ------ | -------- | ------------ | ----------- |
@@ -1270,7 +1267,7 @@ http://127.0.0.1:7379/new_battle/zhSmsCode?mobile=13816510467
 | sign      | string | 是       | 否           | md5加密值   |
 | timestamp | string | 是       | 是           | 时间戳 毫秒 |
 
-##### 5.绑定密码 `/zhPwdUpdate`
+##### 5.重置密码 `/zhPwdUpdate`
 
 | 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
 | --------- | ------ | -------- | ------------ | ----------- |
@@ -1279,6 +1276,18 @@ http://127.0.0.1:7379/new_battle/zhSmsCode?mobile=13816510467
 | sign      | string | 是       | 否           | md5加密值   |
 | timestamp | string | 是       | 是           | 时间戳 毫秒 |
 
+##### 5.重置密码 -- 通过邮箱来重置密码密码(用于海外版本)   `/zhPwdForget`
+
+| 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| email     | string | 是       | 是           | email号     |
+| emailCode | string | 是       | 是           | 验证码      |
+| pwd       | string | 是       | 是           | 新的密码    |
+| sign      | string | 是       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
+
+
 ##### 6.解绑邮箱`/zhUnbindEmail`
 
 | 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
@@ -1304,6 +1313,15 @@ http://127.0.0.1:7379/new_battle/zhSmsCode?mobile=13816510467
 | sign      | string | 是       | 否           | md5加密值   |
 | timestamp | string | 是       | 是           | 时间戳 毫秒 |
 
+##### 8.其他用户面板信息 `/zhUserPannelOther`
+
+| 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| token     | string | 是       | 是           | 手机号      |
+| dstUserId | int    | 是       | 是           | 用户id      |
+| sign      | string | 是       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
 ##### 9.商城道具 `/zhShopPannel`
 
 | 参数名    | 类型   | 是否必填 | 是否参与加密 | 说明        |
@@ -1503,16 +1521,17 @@ shopCartJson 格式如下
 
 请求
 
-| 参数名     | 类型   | 是否必填 | 是否参与加密 | 说明        |
-| ---------- | ------ | -------- | ------------ | ----------- |
-| roomObjId  | int    | 是       | 是           | room实例ID  |
-| userObjId  | int    | 是       | 是           |             |
-| roomName   | string | 是       | 是           |             |
-| dictItemId | int    | 是       | 是           |             |
-| sceneName  | string | 是       | 是           |             |
-| icon       | string | 是       | 是           |             |
-| sign       | string | 是       | 否           | md5加密值   |
-| timestamp  | string | 是       | 是           | 时间戳 毫秒 |
+| 参数名     | 类型   | 是否必填 | 是否参与加密 | 说明            |
+| ---------- | ------ | -------- | ------------ | --------------- |
+| roomObjId  | int    | 是       | 是           | room实例ID      |
+| userObjId  | int    | 是       | 是           |                 |
+| roomName   | string | 是       | 是           |                 |
+| dictItemId | int    | 是       | 是           |                 |
+| sceneName  | string | 是       | 是           |                 |
+| icon       | string | 是       | 是           |                 |
+| isDisplay  | int    | 是       | 是           | 0:不显示 1 显示 |
+| sign       | string | 是       | 否           | md5加密值       |
+| timestamp  | string | 是       | 是           | 时间戳 毫秒     |
 
 ##### 22.获取声网TOKEN`/zhGetShengWangToken`
 
@@ -1618,6 +1637,92 @@ shopCartJson 格式如下
 | sign      | string | 否       | 否           | md5加密值            |
 | timestamp | string | 是       | 是           | 时间戳 毫秒          |
 
+##### 31.房间流媒体地址 ` /zhRoomMediaInfo`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| roomId    | int    | 否       | 是           | 房间实例id  |
+| sign      | string | 否       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
+##### 32.ai改名 ` /zhUserAiNickNameUpdate`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                 |
+| --------- | ------ | -------- | ------------ | -------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令牌 |
+| itemId    | int    | 否       | 是           | 道具实例id           |
+| nickName  | string | 否       | 是           | 昵称名字             |
+| sign      | string | 否       | 否           | md5加密值            |
+| timestamp | string | 是       | 是           | 时间戳 毫秒          |
+
+##### 33 传送门列表 ` /zhEntryPotList`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                 |
+| --------- | ------ | -------- | ------------ | -------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令牌 |
+| sign      | string | 否       | 否           | md5加密值            |
+| timestamp | string | 是       | 是           | 时间戳 毫秒          |
+
+##### 34 新手引导完成 `/zhUserGuideFinish`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                 |
+| --------- | ------ | -------- | ------------ | -------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令牌 |
+| sign      | string | 否       | 否           | md5加密值            |
+| timestamp | string | 是       | 是           | 时间戳 毫秒          |
+
+##### 34 新手步骤步骤ID更新 `/zhUserGuideStepUpdate`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明                 |
+| --------- | ------ | -------- | ------------ | -------------------- |
+| token     | string | 否       | 是           | 登录成功后获取的令牌 |
+| stepId    | int    | 否       | 是           | 步骤ID               |
+| sign      | string | 否       | 否           | md5加密值            |
+| timestamp | string | 是       | 是           | 时间戳 毫秒          |
+
+##### 35 房间流媒体设置 `/zhRoomStreamMediaUpdate`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| roomId    | int    | 否       | 是           | 房间ID      |
+| mediaType | int    | 否       | 是           |             |
+| address   | string | 否       | 是           |             |
+| sign      | string | 否       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
+##### 36 房间流媒体查询 `/zhRoomStreamMediaList`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| sign      | string | 否       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
+##### 37 房间流媒体创建 `/zhRoomStreamMediaAdd`
+
+请求
+
+| 参数名    | 类型   | 可否为空 | 是否参与加密 | 说明        |
+| --------- | ------ | -------- | ------------ | ----------- |
+| roomId    | int    | 否       | 是           | 房间ID      |
+| mediaType | int    | 否       | 是           |             |
+| address   | string | 否       | 是           |             |
+| sign      | string | 否       | 否           | md5加密值   |
+| timestamp | string | 是       | 是           | 时间戳 毫秒 |
+
 #### 八、AI接口
 
 - [API接口](https://console-docs.apipost.cn/preview/a8cfea10d973a37f/672f95fc04cdaa42)