接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/Send
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.Send
接口描述: 发送私信,非好友也可以发送。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| other_uuid | 字符串 | 必须 | 最小:32;最大:32 | 接收私信的会员uuid | |
| chat_message_type | 枚举类型 | 必须 | text | 范围:text/html/image/link/custom | 私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义。注意,不同私信类型,需要提供的chat_message_data参数不同。 |
| chat_message_data | 字符串JSON格式 | 必须 | 私信消息数据,JSON格式。不同消息类型,参数格式不同。分别是:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6101 发送私信接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.Send`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 发送私信,非好友也可以发送。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.Send` |
| 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 |
| chat_message_type | enum | 必填 | 私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义。注意,不同私信类型,需要提供的chat_message_data参数不同。 |
| chat_message_data | array | 必填 | 私信消息数据,JSON格式。不同消息类型,参数格式不同。分别是: text普通文本:{"content":"(必须)文本消息内容"}; html富文本:{"content":"(必须)HTML消息内容"}; image图片:{"url":"必须)图片链接"}; link链接:{"url":"(必须)链接"}; custom自定义:{"xxx":"自定义结构"}。 此外,全部消息类型均支持emoji表情(例如:我 ❤ ⚽ ),且支持更多自定义扩展字段。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1不能发送给自己,2发送失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.Send&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表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1不能发送给自己,2发送失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/MultiSend
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.MultiSend
接口描述: 给多个会员批量群发私信,非好友也可以发送。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| other_uuid | 字符串用,分割 | 必须 | 最小:1;最大:200 | 接收私信的会员uuid,多个uuid用英文逗号分割 | |
| chat_message_type | 枚举类型 | 必须 | text | 范围:text/html/image/link/custom | 私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义。注意,不同私信类型,需要提供的chat_message_data参数不同。 |
| chat_message_data | 字符串JSON格式 | 必须 | 私信消息数据,JSON格式。不同消息类型,参数格式不同。分别是:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6102 群发私信接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.MultiSend`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 给多个会员批量群发私信,非好友也可以发送。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.MultiSend` |
| 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 | array | 必填 | 接收私信的会员uuid,多个uuid用英文逗号分割 |
| chat_message_type | enum | 必填 | 私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义。注意,不同私信类型,需要提供的chat_message_data参数不同。 |
| chat_message_data | array | 必填 | 私信消息数据,JSON格式。不同消息类型,参数格式不同。分别是: text普通文本:{"content":"(必须)文本消息内容"}; html富文本:{"content":"(必须)HTML消息内容"}; image图片:{"url":"必须)图片链接"}; link链接:{"url":"(必须)链接"}; custom自定义:{"xxx":"自定义结构"}。 此外,全部消息类型均支持emoji表情(例如:我 ❤ ⚽ ),且支持更多自定义扩展字段。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,1不能发送给自己,2发送失败,9表示插件未安装|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.detail | array | 批量发送结果详情|
| data.detail[].other_uuid | string | 接收私信的会员ID|
| data.detail[].chat_message_id | int | 消息ID|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.MultiSend&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表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1不能发送给自己,2发送失败,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.detail | 字符串 | 批量发送结果详情 |
| data.detail[].other_uuid | 字符串 | 接收私信的会员ID |
| data.detail[].chat_message_id | 整型 | 消息ID |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/TakeMessageList
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.TakeMessageList
接口描述: 获取与某一位会员的单人会话消息列表。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| other_uuid | 字符串 | 必须 | 最小:32;最大:32 | 私信对话的会员uuid | |
| last_id | 字符串 | 可选 | 0 | 最小:0 | 上一次的消息ID,通过传递前面的私信消息ID以保证消息的连贯性。 |
| direction | 枚举类型 | 可选 | down | 范围:up/down | 获取私信消息的方向,up表示向上滑动,即取前面的旧消息;down表示向下滑动,即获取最新的消息。 |
| perpage | 整型 | 可选 | 20 | 最小:1;最大:100 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6103 获取单人会话消息列表】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.TakeMessageList`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 获取与某一位会员的单人会话消息列表。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.TakeMessageList` |
| 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 |
| last_id | string | 可选 | 上一次的消息ID,通过传递前面的私信消息ID以保证消息的连贯性。 |
| direction | enum | 可选 | 获取私信消息的方向,up表示向上滑动,即取前面的旧消息;down表示向下滑动,即获取最新的消息。 |
| perpage | int | 可选 | 分页数量 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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时参考此提示信息|
| data.list | array | 消息列表|
| data.list[].id | int | |
| data.list[].chat_message_to_uuid | string | 当前会话的会员uuid|
| data.list[].chat_message_data | object | 消息数据结构体|
| data.list[].chat_message_type | string | 消息类型|
| data.list[].chat_message_is_read | int | 是否已读,0未读1已读|
| data.list[].chat_message_io | string | 消息方向,in表示自己发出的,out表示收到的|
| data.list[].add_time | string | 消息发送时间|
| data.unread_num | int | 未读消息数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.TakeMessageList&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表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,1不能和自己聊天,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.list | 字符串 | 消息列表 |
| data.list[].id | 整型 | |
| data.list[].chat_message_to_uuid | 字符串 | 当前会话的会员uuid |
| data.list[].chat_message_data | 对象 | 消息数据结构体 |
| data.list[].chat_message_type | 字符串 | 消息类型 |
| data.list[].chat_message_is_read | 整型 | 是否已读,0未读1已读 |
| data.list[].chat_message_io | 字符串 | 消息方向,in表示自己发出的,out表示收到的 |
| data.list[].add_time | 字符串 | 消息发送时间 |
| data.unread_num | 整型 | 未读消息数量 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/MarkAsReaded
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.MarkAsReaded
接口描述: 可以针对单人会话,把当前会话的全部消息或指定某一条消息置为已读。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| other_uuid | 字符串 | 必须 | 最小:32;最大:32 | 私信对话的会员uuid | |
| chat_message_id | 整型 | 可选 | 0 | 最小:0 | 会话消息ID,为0时表示把当前会话全部消息标记为已读,不为0时单条标记为已读。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6104 标记消息为已读】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.MarkAsReaded`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 可以针对单人会话,把当前会话的全部消息或指定某一条消息置为已读。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.MarkAsReaded` |
| 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 |
| chat_message_id | int | 可选 | 会话消息ID,为0时表示把当前会话全部消息标记为已读,不为0时单条标记为已读。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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.readed_num | int | 本次已标记为已读的数量|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.MarkAsReaded&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表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.readed_num | 整型 | 本次已标记为已读的数量 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/GetAllChatList
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.GetAllChatList
接口描述: 获取和全部人的私信会话列表。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| page | 整型 | 可选 | 1 | 最小:1;最大:100 | 第几页 |
| perpage | 整型 | 可选 | 20 | 最小:1;最大:100 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6105 获取全部会话列表】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.GetAllChatList`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 获取和全部人的私信会话列表。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.GetAllChatList` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| 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.list | array | 私信聊天列表|
| data.list[].chat_message_to_uuid | string | 当前会话的会员uuid|
| data.list[].chat_message_type | string | 消息类型|
| data.list[].chat_message_io | string | 消息方向,in表示自己发出的,out表示收到的|
| data.list[].add_time | string | 消息发送时间|
| data.list[].chat_message_data | object | 消息数据结构体|
| data.list[].chat_message_is_read | int | 是否已读,0未读1已读|
| data.list[].user | object | 用户信息|
| data.list[].user.username | string | 用户账号名|
| data.list[].user.ext_info | object | 用户扩展信息|
| data.total | int | 私信聊天人数|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.GetAllChatList&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参数错误"
}
```请求(需要登录态):
{你的接口域名}/?s=App.Market_ChatMessage.GetAllChatList&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"list": [
{
"chat_message_to_uuid": "8AEA2AF1951C0376EC668A74B8CAA64A",
"chat_message_data": {
"content": "I ❤ ⚽ "
},
"chat_message_type": "text",
"chat_message_is_read": 1,
"chat_message_io": "out",
"add_time": "2019-08-11 17:12:02",
"user": {
"username": "AB君",
"ext_info": {
"yesapi_avatar": "",
"nickname": "",
"age": "18"
}
}
},
{
"chat_message_to_uuid": "5B1CA086F3E9E86F83354191AFB41E9E",
"chat_message_data": {
"content": "I love 小白接口!"
},
"chat_message_type": "text",
"chat_message_is_read": 1,
"chat_message_io": "out",
"add_time": "2019-08-11 17:12:02",
"user": {
"username": "dogstar",
"ext_info": {
"yesapi_avatar": "",
"nickname": "",
"age": "18"
}
}
}
],
"total": 2
},
"msg": "小白开放接口:App.Market_ChatMessage.GetAllChatList"
}
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.list | 字符串 | 私信聊天列表 |
| data.list[].chat_message_to_uuid | 字符串 | 当前会话的会员uuid |
| data.list[].chat_message_type | 字符串 | 消息类型 |
| data.list[].chat_message_io | 字符串 | 消息方向,in表示自己发出的,out表示收到的 |
| data.list[].add_time | 字符串 | 消息发送时间 |
| data.list[].chat_message_data | 对象 | 消息数据结构体 |
| data.list[].chat_message_is_read | 整型 | 是否已读,0未读1已读 |
| data.list[].user | 对象 | 用户信息 |
| data.list[].user.username | 字符串 | 用户账号名 |
| data.list[].user.ext_info | 对象 | 用户扩展信息 |
| data.total | 整型 | 私信聊天人数 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Market_ChatMessage/GetAllUnreadNum
接口路径(旧):http://api.yesapi.net/?s=App.Market_ChatMessage.GetAllUnreadNum
接口描述: 获取和全部人的未读的新消息数量。使用前请先安装私信插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 6106 获取全部未读的新消息数量】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_ChatMessage.GetAllUnreadNum`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 获取和全部人的未读的新消息数量。使用前请先安装私信插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_ChatMessage.GetAllUnreadNum` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| 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时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_ChatMessage.GetAllUnreadNum&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表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,9表示插件未安装 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次