添加好友
1. 前言:
2. 交互时序图:
3. 请求场景:
添加好友
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | im-app-api |
URL | 测试环境:https://api.test.laiyifen.com/im/friend 生产环境:https://api.test.laiyifen.com/im/friend |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
功能描述(适用场景) | 添加好友 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
lyfuid | String | 是 | 第三方应用用户授权id |
lyfToid | String | 是 | 所要添加好友的用户授权id |
5.4 入参示例
{
"lyfuid": "2BBFA5XXXXXXXXXXXXXXXXXX89E90",
"lyfToid": "2BBFA5XXXXXXXXXXXXXXXXXX89E90"
}
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
5.7 返回示例
{
"code": "0",
"msg": "success"
}