• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 数据统计模块 剩余流量
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 配置模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • API开发
    • 接口源码库 推荐
    • 接口DIY (低代码开发)
  • 登录
  • 注册



YesApi 接口文档

6601 添加好友接口

接口路径(新):http://hn.api.yesapi.net/api/App/Market_Friend/AddNewFriend

接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Friend.AddNewFriend

接口描述: 根据账号或uuid添加好友。使用前请先安装好友插件

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串可选最小:32;最大:32好友UUID
other_username字符串可选最小:1好友账号
friend_note字符串可选最大:20好友备注
friend_group字符串可选默认分组最大:20好友分组
friend_message字符串可选最大:80好友留言

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 6601 添加好友接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Friend.AddNewFriend`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  根据账号或uuid添加好友。使用前请先安装好友插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Friend.AddNewFriend` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};         return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 可选 | 好友UUID |
| other_username | string | 可选 | 好友账号 |
| friend_note | string | 可选 | 好友备注 |
| friend_group | string | 可选 | 好友分组 |
| friend_message | string | 可选 | 好友留言 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1已经是好友,不需要重复添加,2账号不存在,3不能加自己,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Friend.AddNewFriend&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,1已经是好友,不需要重复添加,2账号不存在,3不能加自己,9表示插件未安装
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

6602 删除好友接口

接口路径(新):http://hn.api.yesapi.net/api/App/Market_Friend/RemoveMyFriend

接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Friend.RemoveMyFriend

接口描述: 根据uuid删除好友。使用前请先安装好友插件

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
other_uuid字符串必须最小:32;最大:32需要删除的好友uuid

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 6602 删除好友接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Friend.RemoveMyFriend`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  根据uuid删除好友。使用前请先安装好友插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Friend.RemoveMyFriend` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};         return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| other_uuid | string | 必填 | 需要删除的好友uuid |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1表示不需要重复删除,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Friend.RemoveMyFriend&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,1表示不需要重复删除,9表示插件未安装
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

6603 获取我的新好友接口

接口路径(新):http://hn.api.yesapi.net/api/App/Market_Friend/GetMyNewFriends

接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Friend.GetMyNewFriends

接口描述: 获取最近添加我的新好友,获取最近100位新好友,按添加时间降序。使用前请先安装好友插件

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
is_return_ext_info布尔型可选false是否补充返回会员的扩展信息,1返回0不返回
total整型可选100最小:1;最大:5000

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 6603 获取我的新好友接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Friend.GetMyNewFriends`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  获取最近添加我的新好友,获取最近100位新好友,按添加时间降序。使用前请先安装好友插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Friend.GetMyNewFriends` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};         return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| is_return_ext_info | boolean | 可选 | 是否补充返回会员的扩展信息,1返回0不返回 |
| total | int | 可选 |  |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.friends | array | 新好友列表|
| data.friends[].friend_uuid | string | 好友UUID|
| data.friends[].friend_status | int | 好友的状态(以当前最新的状态为准),0新好友,1已同意,2已拉黑|
| data.friends[].friend_username | string | 好友账号|
| data.friends[].friend_message | string | 好友留言|
| data.friends[].add_time | string | 对方添加我为好友的时间|
| data.friends[].ext_info | object | 仅当is_return_ext_info=1时才返回此字段|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Friend.GetMyNewFriends&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,9表示插件未安装
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.friends字符串新好友列表
data.friends[].friend_uuid字符串好友UUID
data.friends[].friend_status整型好友的状态(以当前最新的状态为准),0新好友,1已同意,2已拉黑
data.friends[].friend_username字符串好友账号
data.friends[].friend_message字符串好友留言
data.friends[].add_time字符串对方添加我为好友的时间
data.friends[].ext_info对象仅当is_return_ext_info=1时才返回此字段
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

YesApi 接口文档

6604 获取我的好友列表接口

接口路径(新):http://hn.api.yesapi.net/api/App/Market_Friend/GetMyAllFriends

接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Friend.GetMyAllFriends

接口描述: 获取我已经添加的好友列表。使用前请先安装好友插件

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册。
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取。
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
friend_group字符串可选搜索分组,不传时显示全部
sort_type枚举类型可选1范围:1/2/3/4排序类型,1好友账号字典升序,2好友账号字典降序,3好友添加时间升序,4好友添加时间降序
page整型可选1最小:1第几页
perpage整型可选100最小:1;最大:500分页数量

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 6604 获取我的好友列表接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Friend.GetMyAllFriends`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  获取我已经添加的好友列表。使用前请先安装好友插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Friend.GetMyAllFriends` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};         return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| friend_group | string | 可选 | 搜索分组,不传时显示全部 |
| sort_type | enum | 可选 | 排序类型,1好友账号字典升序,2好友账号字典降序,3好友添加时间升序,4好友添加时间降序 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.friends | array | 新好友列表|
| data.friend_uuid | string | 好友UUID|
| data.friend_username | string | 好友账号|
| data.friend_message | string | 好友留言|
| data.add_time | string | 对方添加我为好友的时间|
| data.ext_info | object | 好友的扩展信息,注意没有时为null|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Friend.GetMyAllFriends&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,9表示插件未安装
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.friends字符串新好友列表
data.friend_uuid字符串好友UUID
data.friend_username字符串好友账号
data.friend_message字符串好友留言
data.add_time字符串对方添加我为好友的时间
data.ext_info对象好友的扩展信息,注意没有时为null
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次