IM-开发平台WIKI (b0ff4be5) | Commits | OPEN-API / WIKI

Authored by 国亚奇 2017-03-01 10:33:48 +0800

1 parent 777eb2d4

Showing 11 changed files with 145 additions and 0 deletions

05.互动云/5.3.IM聊天室JS GetToken.md renamed to 05.互动云/4.1 获取Token.md

05.互动云/4.2 刷新用户信息.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :----------- \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true \| 应用ID\|
		5	+\| sid \| String \| true \| 用户ID，最大长度 64 字节.<br>App中的唯一标识码，必须保证在同一个App内不重复，<br>重复的用户ID将被当作是同一用户。\|
		6	+\| nickName \| String \| true \| 用户昵称,最大长度 128 字节.<br>在Push推送时显示用户的名称.\|
		7	+\| faceUrl\| String \| true\| 用户头像,最大长度 1024 字节.<br>在Push推送时显示用户的头像。\|
		8	+-----
		9	+#### 返回格式说明:
		10	+```
		11	+{
		12	+ "errorCode": "0",
		13	+ "errorMessage": "刷新用户信息成功",
		14	+ "data": {
		15	+ }
		16	+}
		17	+```
0	\ No newline at end of file	18	\ No newline at end of file

05.互动云/4.3 创建聊天室.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true\| 应用ID\|
		5	+\| chatroomId\| String \| true \| 聊天室ID \|
		6	+\| name\| String \| true \| 聊天室名字\|
		7	+-----
		8	+#### 返回格式说明:
		9	+```
		10	+{
		11	+ "errorCode": "0",
		12	+ "errorMessage": "创建聊天室成功",
		13	+ "data": {}
		14	+}
		15	+```
0	\ No newline at end of file	16	\ No newline at end of file

05.互动云/4.4 销毁聊天室.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true \| 应用ID \|
		5	+\| chatroomId\| String \| true \| 聊天室ID\|
		6	+-----
		7	+#### 返回格式说明:
		8	+```
		9	+{
		10	+ "errorCode": "0",
		11	+ "errorMessage": "销毁聊天室成功",
		12	+ "data": {}
		13	+}
		14	+```
0	\ No newline at end of file	15	\ No newline at end of file

05.互动云/4.5 发送消息.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true \| 应用ID \|
		5	+\| fromSid\| String \| true \| 用户ID \|
		6	+\| toChatroomId\| String \| true \| 聊天室ID,多个参数可以实现向多个聊天室发送消息\|
		7	+\| msgType\| String \| true\| 消息类型（仅支持文本和图片消息）<br/>(文本消息: RC:TxtMsg; 图片消息:RC:ImgMsg；<br>图文消息：RC:ImgTextMsg；位置消息：RC:LBSMsg；<br>提示条（小灰条）通知消息：RC:InfoNtf；<br>语音消息：RC:VcMsg；资料通知消息：RC:ProfileNtf\|
		8	+\| msg\| String \| true\| 消息内容\|
		9	+\| imageUrl\| String \| false\| 图片URL,消息类型为图片消息（RC:ImgMsg）时，此参数必须传\|
		10	+-----
		11	+#### 返回格式说明:
		12	+```
		13	+{
		14	+ "errorCode": "0",
		15	+ "errorMessage": "发送聊天室消息成功",
		16	+ "data": {}
		17	+}
		18	+```
0	\ No newline at end of file	19	\ No newline at end of file

05.互动云/4.6 查询敏感信息.md 0 → 100644

05.互动云/4.7 查询欢迎词.md 0 → 100644

05.互动云/4.8 查询聊天室用户.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true \| 应用ID \|
		5	+\| chatroomId\| String \| true \| 聊天室ID \|
		6	+\| count\| String \| false\| 聊天室成员数；上限为 500 ，超过 500 时最多返回 500 个成员 \|
		7	+\| order\| String \| false\| 加入聊天室的先后顺序； 1：加入时间正序， 2：加入时间倒序 \|
		8	+-----
		9	+#### 返回格式说明:
		10	+```
		11	+{
		12	+ "errorCode": "0",
		13	+ "errorMessage": "查询聊天室内用户数成功",
		14	+ "data": {}
		15	+}
		16	+```
0	\ No newline at end of file	17	\ No newline at end of file

05.互动云/4.9 用户鉴权.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true\| 应用ID，暂不启用后期扩展业务使用 \|
		5	+\| chatroomId\| String \| true\| 聊天室ID，暂不启用后期扩展业务使用 \|
		6	+\| sid\| String \| true\| 用户ID\|
		7	+-----
		8	+#### 返回格式说明:
		9	+```
		10	+{
		11	+ "errorCode": "0",
		12	+ "errorMessage": "鉴权成功",
		13	+ "data": {
		14	+ }
		15	+}
		16	+```
0	\ No newline at end of file	17	\ No newline at end of file

05.互动云/5.2.IM聊天室JSSDK鉴权.md renamed to 05.互动云/5.2 JSSDK使用鉴权.md

05.互动云/5.3 JSSDK GetToken.md 0 → 100644

		1	+#### 请求参数说明:
		2	+\| 参数名 \| 参数类型 \| 必选 \| 参数说明 \|
		3	+\| :-----------: \| :------: \| :------: \| :------: \|
		4	+\| appId\| String \| true \| 应用ID\|
		5	+\| sid \| String \| true \| 用户ID，最大长度 64 字节.<br>App中的唯一标识码，必须保证在同一个App内不重复，<br>重复的用户ID将被当作是同一用户。\|
		6	+\| nickName \| String \| true \| 用户昵称,最大长度 128 字节.<br>在Push推送时显示用户的名称.\|
		7	+\| faceUrl\| String \| true\| 用户头像,最大长度 1024 字节.<br>在Push推送时显示用户的头像。\|
		8	+-----
		9	+#### 返回格式说明:
		10	+```
		11	+{
		12	+ "errorCode": "0",
		13	+ "errorMessage": "获取token成功",
		14	+ "data": {
		15	+ "sid": "00001",
		16	+ "token": "rl44evQpMXRxHAUHs7qAXOgtybvep8oFEYE0MJdlnAQHl5MTxCSGqMZYUaolykas080RJvNmhte97XZY08DVVw=="
		17	+ }
		18	+}
		19	+```
0	\ No newline at end of file	20	\ No newline at end of file

OPEN-API / WIKI · Commits