频道

本文讲述频道相关的接口。频道是一种特殊类型的会话，类似于群组和聊天室，但更适合用于一对多的内容分发场景。我们提供有Java版本的SDK，建议使用Java语言的客户使用这个SDK，其它语言可以按照本文档对接。

1. 创建频道

1.0.1. 地址

http://domain:18080/admin/channel/create

1.0.2. body

1.0.3. 响应

1.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"owner\":\"user1\",       \
    \"name\":\"官方频道\",                 \
    \"portrait\":\"http://example.com/portrait.jpg\",    \
    \"desc\":\"这是官方频道\",    \
    \"auto\":0    \
  }"                                \
  http://localhost:18080/admin/channel/create

{
  "code":0,
  "msg":"success",
  "result":{
    "targetId":"channel1",
    "secret":"secret123"
  }
}

2. 销毁频道

2.0.1. 地址

http://domain:18080/admin/channel/destroy

2.0.2. body

2.0.3. 响应

N/A

2.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"channelId\":\"channel1\"}" http://localhost:18080/admin/channel/destroy

{
  "code":0,
  "msg":"success"
}

3. 获取频道信息

3.0.1. 地址

http://domain:18080/admin/channel/get_info

3.0.2. body

3.0.3. 响应

3.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"channelId\":\"channel1\"}" http://localhost:18080/admin/channel/get_info

{
  "code":0,
  "msg":"success",
  "result":{
    "channelId":"channel1",
    "name":"官方频道",
    "owner":"user1",
    "state":0
  }
}

4. 订阅频道

让指定用户订阅频道。

4.0.1. 地址

http://domain:18080/admin/channel/subscribe

4.0.2. body

4.0.3. 响应

N/A

4.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"channelId\":\"channel1\",       \
    \"userId\":\"user1\",                 \
    \"state\":1    \
  }"                                \
  http://localhost:18080/admin/channel/subscribe

{
  "code":0,
  "msg":"success"
}

5. 取消订阅频道

让指定用户取消订阅频道。

5.0.1. 地址

http://domain:18080/admin/channel/subscribe

5.0.2. body

5.0.3. 响应

N/A

5.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"channelId\":\"channel1\",       \
    \"userId\":\"user1\",                 \
    \"state\":0    \
  }"                                \
  http://localhost:18080/admin/channel/subscribe

{
  "code":0,
  "msg":"success"
}

6. 检查用户是否订阅频道

检查指定用户是否订阅了频道。

6.0.1. 地址

http://domain:18080/admin/channel/is_subscribed

6.0.2. body

6.0.3. 响应

6.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"channelId\":\"channel1\",       \
    \"userId\":\"user1\"    \
  }"                                \
  http://localhost:18080/admin/channel/is_subscribed

{
  "code":0,
  "msg":"success",
  "result":{
    "value":true
  }
}