好友关系

云通讯平台为开发者提供了一套完整的好友关系管理接口,便于开发者建立维护好友关系。好友关系相关接口包括获取好友列表,获取相关添加好友请求列表,获取个人信息,添加好友,设置好友备注,用户隐私设置,同意好友请求,拒绝好友请求,删除好友,获取好友个人信息,建立好友关系,上传用户头像,获取用户头像,获取个人隐私接口。

获取好友列表

1.  请求地址    

  • POST  /{SoftVersion}/Application/{appId}/IM/getFriends?sig={SigParameter}

       

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
timestamp String 可选 时间戳 2017-07-08 12:12:12.123

第一次调用时不用传,从第二次开始要传。

size String 可选 数量,最大100,默认20,分页
isUpdate String 必选 是否增量更新;0:非增量更新;1:增量更新 0 只给好友状态的列表;
1 好友和非好友的列表
isAllPage String 必选 0 分页查询 1全量查询 缺省0
isSimpUseracc String 必选 0: 返回完整useracc
1: 同应用返回userName,跨应用返回完整useracc 缺省0

4. 请求示例     

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/getFriends?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123","timestamp":"2017-07-08 12:12:12.123","size":"50",
  • "isUpdate":"1","isAllPage":"0","isSimpUseracc":"0"}

        

5. 响应包体

属性类型约束说明备注
statusCode ----- String 必选 请求状态码,取值000000(成功)。
statusMsg ----- String 必选 请求状态码描述,取值:success
timestamp ----- String 必选 时间戳,2017-07-08 12:12:12.123
friendsList ----- List 可选 好友信息节点
useracc String List不为空时必选 好友账号 Appid#账号
remarkName String List不为空时必选 备注名
nickName String List不为空时必选 昵称
avatar String List不为空时必选 头像URL
friendState String List不为空时必选 是否好友。0:非好友 1:好友

6. 响应示例       


  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","timestamp":"2017-07-08 12:12:12.123","friendsList":[{"useracc":"20150314000000110000000000000010#15011097123","remarkName":"备注","nickName":"测试账号","avatar":"http://url","friendState":"1"},{"useracc":"20150314000000110000000000000010#15011097124","remarkName":"备注","nickName":"测试账号","avatar":"http://url","friendState":"1"}]}
  •         

获取相关添加好友请求列表

1. 请求地址 

  • POST  /{SoftVersion}/Application/{appId}/IM/friendMessage?sig={SigParameter}

        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
timestamp String 可选 时间戳 2017-07-08 12:12:12.123

第一次调用时不用传,从第二次开始要传。

size String 可选 数量,最大100,默认20,分页
order String 可选 1 升序 2降序 缺省1
isSimpUseracc String 可选 0 返回完整useracc 1同应用返回userName,跨应用返回完整useracc 缺省0

4. 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/friendMessage?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123", "timestamp":"2017-07-08 12:12:12.123","size":"50","order":"0","isSimpUseracc":"0"}

   

5.  响应包体

属性类型约束说明备注
statusCode ----- String 必选 请求状态码,取值000000(成功)。
statusMsg ----- String 必选 请求状态码描述,取值:success
timestamp ----- String 必选 时间戳,2017-07-08 12:12:12.123
inviteList ----- List 可选 好友信息节点
friendUseracc String List不为空时必选 好友账号 Appid#账号
message String List不为空时必选 请求的信息
source String List不为空时必选 好友来源
isInvited String List不为空时必选 是否被邀请 0:邀请1:被邀请
dealState String List不为空时必选 是否好友 0:非好友 1:好友
avatarStringList不为空时必选好友头像

6. 响应示例      

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","timestamp":"2017-07-08 12:12:12.123","inviteList":[{"friendUseracc":"20150314000000110000000000000010#15011097123","message":"","source":""," isInvited ":"1","dealState":"1"},{"friendUseracc":"20150314000000110000000000000010#15011097124","message":"","source":""," isInvited ":"1","dealState":"1"}]}

        

获取个人信息

1. 请求地址     

  • POST /{SoftVersion}/Application/{appId}/IM/getPersonInfo?sig={SigParameter}

        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
searchContent String 必选 搜索内容,用户登录账号 Appid#用户登录账号
isSimpUseracc String 必选 0 返回完整useracc 1同应用返回userName,跨应用返回完整useracc 缺省 0

4. 请求示例    

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/getPersonInfo?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123","searchContent":"20150314000000110000000000000010#15011097111","isSimpUseracc":"0"}

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
useracc String 必选 用户账号(Appid#账号)
phoneNumber String 可选 用户手机号码
nickName String 可选 昵称
region String 可选 地区
sign String 可选 签名
avatar String 可选 头像URL
state String 可选 是否好友。0:非好友 1:好友
birthDay String 可选 生日
sex String 可选 性别 1:男 2:女
remarkName String 可选 备注

6. 响应示例       

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","useracc":"20150314000000110000000000000010#15011097123","phoneNumber":"","nickName":"","region":"1","sign":"1","avatar":"http://url","state":"1"}        

添加好友

1. 请求地址       

  • POST  /{SoftVersion}/Application/{appId}/IM/addFriend?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 被添加者账号 Appid#被添加者账号
message String 必选 请求的消息内容
source String 必选 好友来源

4. 请求示例        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/addFriend?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •       "friendUseracc":"20150314000000110000000000000010#15011097101","message":"","source":""}    

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

6. 响应示例       

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}        

设置好友备注

1. 请求地址        

  • POST  /{SoftVersion}/Application/{appId}/IM/setFriendRemark?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束时间备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 好友账号 Appid#好友账号
remarkName String 必选 好友备注

4. 请求示例      

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/setFriendRemark?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •         "friendUseracc":"20150314000000110000000000000010#15011097101","remarkName":"备注"}        

5.响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
timestamp String 必选 更新时间,格式"yyyy-MM-dd HH:mm:ss"

6. 响应示例        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","timestamp":"2017-07-20 08:00:00"}       

用户隐私设置

1. 请求地址        

  • POST  /{SoftVersion}/Application/{appId}/IM/setUserVerify?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束时间备注
useracc String 必选 操作者账号 Appid#操作者账号
addVerify String 必选 是否需要验证 别人添加自己为好友时,是否需要通过自己的验证 0:无需验证 1:需要认证

4. 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/setUserVerify?sig=C1F20E7A9733CABCDE HTTP/1.1Host:192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123","addVerify":"0"}        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

6. 响应示例      

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}       

同意好友请求

1. 请求地址

  • POST  /{SoftVersion}/Application/{appId}/IM/friendAgree?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束时间备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 被添加者账号 Appid#被添加者账号

4. 请求示例        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/friendAgree?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •         "friendUseracc":"20150314000000110000000000000010#15011097101"}

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

6. 响应示例       

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}        

拒绝好友请求

1. 请求地址        

  • POST  /{SoftVersion}/Application/{appId}/IM/friendRefuse?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束时间备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 添加者账号 Appid#添加者账号
message String 可选 拒绝原因

4. 请求示例        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/friendRefuse?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •     "friendUseracc":"20150314000000110000000000000010#15011097101","message":"拒绝原因"}

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

6. 响应示例        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}        

删除好友

1. 请求地址      

  • POST  /{SoftVersion}/Application/{appId}/IM/delFriend?sig={SigParameter}

      

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束时间备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 好友账号 Appid#好友账号
allDel String 必选 是否同时删除 0不同时 1同时

4. 请求示例       

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/delFriend?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •   "friendUseracc":"20150314000000110000000000000010#15011097101","allDel":"0" }

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

6. 响应示例        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}        

获取好友个人信息

1. 请求地址        

  • POST  /{SoftVersion}/Application/{appId}/IM/getFriendInfo?sig={SigParameter}        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 好友账号 Appid#好友账号
isSimpUseracc String 必选 好友账号 0 返回完整useracc,1 同应用返回userName,跨应用返回完整useracc 缺省0

4. 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/getFriendInfo?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host:192.168.0.1:8883;
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •     "friendUseracc":"20150314000000110000000000000010#15011097101","isSimpUseracc":"0"}

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
useracc String 可选 用户账号(Appid#账号)
phoneNumber String 可选 手机号
nickName String 可选 昵称
region String 可选 地区
sign String 可选 签名
remarkName String 可选 备注
avatar String 可选 头像URL
birthDay String 可选 生日
sex String 可选 性别 1 男 2 女

6. 响应示例        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","useracc":"20150314000000110000000000000010#15011097236","phoneNumber ":"15011031254","nickName":"昵称","region":"北京市朝阳区","sign":"12345","remarkName":"备注名称","avatar":"http://url"}        

建立好友关系

1. 请求地址       

  • POST  /{SoftVersion}/Application/{appId}/IM/importFriends?sig={SigParameter}        

注:该接口用于服务器处理,相当于直接导入好友关系

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
friendsList ------ list 必选 好友集合节点
useracc String 必选 操作者账号 Appid#操作者账号
friendUseracc String 必选 好友账号 Appid#好友账号

11.4 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/importFriends?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"friendsList":[{"useracc":"20150314000000110000000000000010#15011097123","friendUseracc":"20150314000000110000000000000010#15011097101"},{"useracc":"20150314000000110000000000000010#15011097124","friendUseracc":"20150314000000110000000000000010#15011097102"}]}
  •         

11.5 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success

11.6 响应示例

        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success"}

        

上传用户头像

12.1 请求地址

        

  • POST  /{SoftVersion}/Application/{appId}/IM/uploadAvatar?
  • sig={SigParameter}&useracc=20150314000000110000000000000010#15011031478&fileName=1.jpg

        

注:url中的#需要转义为%23 

注: 请求包体为图片二进制文件流; 

包头需设置:Content-Type = application/octet-stream

支持图片格式:jpg、jpeg、gif、png、bmp

12.2 请求包头

请参阅《鉴权说明

12.3 请求包体

        

  • 文件二进制流
  •         

12.4 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/uploadAvatar?
  • sig=C1F20E7A9733CABCDE&useracc=15011031478&fileName=1.jpg
  • HTTP/1.1
  • Host: 192.168.0.1:8883
  • Accept:application/json;
  • Content-Type: application/octet-stream;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=
  • 文件二进制流

        

12.5 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
avatar String 必选 头像URL
updateTime String 必选 用于获取头像信息时判断是否为最新头像

时间格式:"yyyy-MM-dd HH:mm:ss.SSS"

12.6 响应示例

        

  • HTTP/1.1 200 OK 
  • Content-Length: 641
  •  
  • {"statusCode":"000000","statusMsg":"success","avatar":"http://url",
  •    "updateTime":"2017-07-21 12:00:00.123"}

        

获取用户头像

1. 请求地址

        

  • POST  /{SoftVersion}/Application/{appId}/IM/getUserAvatar?sig={SigParameter}

       

2. 请求包头

请参阅《鉴权说明

3. 请求包体

属性类型约束说明备注
useracc String 必选 操作者账号 Appid#操作者账号
updateTime String 可选 头像更新时间 时间格式:"yyyy-MM-dd HH:mm:ss.SSS"

4. 请求示例       

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/getUserAvatar?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123",
  •    "updateTime":"2017-07-21 12:00:00.123"}

        

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
avatar String 可选 头像URL

6. 响应示例

        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","avatar":"http://url"}

 

批量获取用户头像

1.请求地址

  • POST  /{SoftVersion}/Application/{appId}/IM/batchGetUserAvatar?sig={SigParameter}

2.请求包体

请参阅《鉴权说明

3.请求包体

属性类型约束说明备注
useraccListList必选用户账号集合
isSimpUseraccString必选缺省0 返回完整useracc,1 同应用返回userName,跨应用返回完整useracc

4.请求示例

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/batchGetUserAvatar?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=
  •  
  • {"useraccList":["20150314000000110000000000000010#1","20150314000000110000000000000010#2","20150314000000110000000000000010#3"],"isSimpUseracc":"1"}

5.响应包体

属性类型约束说明
statusCodeString必选请求状态码,取值:000000(成功)
statusMsgString必选请求状态码描述,取值:sucess(成功)
avatarListList可选头像信息节点
useraccstringavatarList不为空时必选Appid#账号
avatarstringavatarList不为空时必选头像
updateTimestringavatarList不为空时必选更新时间

6.响应示例

  • HTTP/1.1 200 OK 
  • Content-Length: 641 
  •  
  • {"statusCode":"000000","friendsList":[{"useracc","1","avatar":"url","updateTime":"2017-10-25 10:00:00.123"}]}

获取个人隐私

1. 请求地址

        

  • POST  /{SoftVersion}/Application/{appId}/IM/getUserVerify?sig={SigParameter}

        

2. 请求包头

请参阅《鉴权说明

3. 请求包体

  

属性类型约束说明属性
useracc String 必选 操作者账号 Appid#操作者账号

4. 请求示例

        

  • POST /2013-12-26/Application/20150314000000110000000000000010/IM/getUserVerify?sig=C1F20E7A9733CABCDE 
  • HTTP/1.1
  • Host: 192.168.0.1:8883
  • Accept:application/json;
  • Content-Type:application/json;charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE=

  • {"useracc":"20150314000000110000000000000010#15011097123"}
  •         

5. 响应包体

属性类型约束说明
statusCode String 必选 请求状态码,取值000000(成功)。
statusMsg String 必选 请求状态码描述,取值:success
addVerify String 必选 0:不需要验证 1:需要验证

6. 响应示例        

  • HTTP/1.1 200 OK 
  • Content-Length: 641 

  • {"statusCode":"000000","statusMsg":"success","addVerify":"1"}