YesApi 接口文档

使用情况记录统计 v1.1

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/AAndyUseRecordStatistics

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.AAndyUseRecordStatistics

接口描述： 使用情况记录统计

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：10000分页数量
assistant_type字符串可选助手类型：1内容产品售卖、2平台合作客户、3内容打单方案、4内容客户案例
user_dd_nick字符串可选使用者钉钉昵称
consult_content字符串可选咨询内容
conversation_type字符串可选会话类型：1单聊、2群聊

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.items字符串数据列表，失败时返回空数组
data.total整型总数
data.items[].assistant_type字符串助手类型：1内容产品售卖、2平台合作客户、3内容打单方案、4内容客户案例
data.items[].dd_group_name字符串钉钉群名称
data.items[].user_dd_nick字符串使用者钉钉昵称
data.items[].consult_content字符串咨询内容
data.items[].conversation_type字符串会话类型：1单聊、2群聊
data.items[].use_time字符串使用时间
data.items[].use_date字符串使用日期
data.items[].assistant_name字符串助手名称
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

保存过程数据存储表 v1.11

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ASaveAndyVardDtas

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ASaveAndyVardDtas

接口描述： 保存过程数据存储表

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
id整型可选待更新的数据ID
user_id字符串可选用户id
user_name字符串可选用户姓名
sys_survey_report字符串可选系统-需求调研报告
sys_activity_need字符串可选系统-活动方案-活动需求
sys_content_select字符串可选系统-活动方案-内容选择
user_content_select字符串可选用户-活动方案-内容选择
sys_content_tuij字符串可选系统-活动方案-内容推荐
sys_activity_name字符串可选系统-活动方案-活动名称
user_activity_name字符串可选用户-活动方案-活动名称
sys_activity_ideas字符串可选系统-活动方案-活动思路
sys_activity_plan字符串可选系统-活动方案-活动策划
sys_activity_enroll字符串可选系统-活动方案-活动报名
sys_activity_xuanc字符串可选系统-活动方案-活动宣传
sys_incentive_plan字符串可选系统-活动方案-激励措施
sys_yuqi_result字符串可选系统-活动方案-预期效果
sys_refine_merge字符串可选方案合并
sys_activity_simplify字符串可选方案精简
fansan_mothed字符串可选发散方式
yixiang_course字符串可选意向课程
activity_type字符串可选活动类型
operate_type整型可选1操作方式，1-创建，2-更新。默认为1创建。
block_index整型可选1分块索引，默认0
total_tokens字符串可选总Token数
total_rmb字符串可选总人民币
current_model字符串可选当前模型
activity_beijing字符串可选活动背景
activity_mubiao字符串可选活动目标
enterprise_name字符串可选企业名称

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

内容售卖案例想查就查 v1.16

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ACpsReceiveSearch

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ACpsReceiveSearch

接口描述： 内容售卖案例想查就查

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
senderPlatform字符串可选消息发送平台。
conversationId字符串可选会话ID。
atUsers字符串JSON格式可选被@人的信息： dingtalkId：加密的发送者ID。
chatbotCorpId字符串可选加密的机器人所在的企业corpId。
chatbotUserId字符串可选加密的机器人ID。
msgId字符串可选加密的机器人ID。
senderNick字符串可选发送者昵称。
isAdmin字符串可选是否为管理员： true：是 false：否
senderStaffId字符串可选企业内部群中@该机器人的成员 userId。
createAt字符串可选消息的时间戳，单位毫秒。
senderCorpId字符串可选企业内部群的发送者当前群的企业corpId。
conversationType字符串可选会话类型： 1：单聊 2：群聊
senderId字符串可选加密的发送者ID。
conversationTitle字符串可选群聊时才有的会话标题。
isInAtList字符串可选是否在@列表中。
sessionWebhook字符串可选当前会话的Webhook地址。
text字符串JSON格式可选消息文本： content：机器人接收的消息内容。
msgtype字符串可选消息类型： text：文本消息 richText：富文本消息 picture：图片消息 audio：语音消息 video：视频消息 file：文件消息
robotCode字符串可选机器人编码。
sessionWebhookExpiredTime字符串可选当前会话的Webhook地址过期时间。

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

内容客户案例明细数据列表 v1.1

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ANrkhCaseDetail

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ANrkhCaseDetail

接口描述： 内容客户案例明细数据列表

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page字符串可选第几页
perpage字符串可选分页数量
train_target字符串可选培训对象
yxt_industry_1字符串可选行业
enterprise_type字符串可选企业性质
case_name字符串可选案例名称
yxt_industry_more字符串可选行业，传入的是拆好词的文本
content_product字符串可选内容产品
case_time字符串可选案例时间
product_series字符串可选产品系列
kh_name字符串可选客户名称
kh_industry_1字符串可选客户行业
xm_crowd字符串可选项目人群
xm_name字符串可选项目名称
kh_industry_more字符串可选客户行业，传入的是拆好词的文本

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

内容打单方案明细数据列表 v1.3

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ANrdadanCaseDetail

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ANrdadanCaseDetail

接口描述： 内容打单方案明细数据列表

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page字符串可选第几页
perpage字符串可选分页数量
kh_name字符串可选客户名称
kh_industry_1字符串可选客户行业
xm_crowd字符串可选项目人群
xm_name字符串可选项目名称
case_url字符串可选方案链接
kh_industry_more字符串可选行业，传入的是拆好词的文本
params_more字符串可选综合参数
enterprise_type字符串可选企业性质
content_product字符串可选内容产品
case_time字符串可选案例时间
product_series字符串可选产品系列

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu字符串总数
data.lie_biao[].kh_name字符串客户名称
data.lie_biao[].kh_industry_1字符串客户行业
data.lie_biao[].xm_crowd字符串项目人群
data.lie_biao[].xm_name字符串项目名称
data.lie_biao[].case_url字符串方案链接
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

平台竞对切换案例明细数据列表 v1.4

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/APtjdCaseDetail

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.APtjdCaseDetail

接口描述： 根据搜索条件，分页获取平台竞对切换案例明细数据列表，支持排序、搜索

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：10000分页数量
kh_industry_1字符串可选客户行业
area字符串可选地区
staff_size字符串可选人员规模
staff_size_min字符串可选人员规模-最小值
staff_size_max字符串可选人员规模-最大值
competitor_name字符串可选竞品名称
kh_name字符串可选客户名称
replace_year字符串可选替换年份
replace_reason字符串可选替换原因
enterprise_type字符串可选企业性质
sign_sales字符串可选签约销售
kh_industry_more字符串可选行业，传入的是拆好词的文本

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu整型总数
data.lie_biao[].kh_industry_1字符串客户行业
data.lie_biao[].area字符串地区
data.lie_biao[].staff_size字符串人员规模
data.lie_biao[].staff_size_begin字符串人员规模-开始
data.lie_biao[].staff_size_end字符串人员规模-结束
data.lie_biao[].competitor_name字符串竞品名称
data.lie_biao[].kh_name字符串客户名称
data.lie_biao[].replace_year字符串替换年份
data.lie_biao[].replace_reason字符串替换原因
data.lie_biao[].enterprise_type字符串企业性质
data.lie_biao[].sign_sales字符串签约销售
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

接收消息 v1.127

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/AReceiveMsg

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.AReceiveMsg

接口描述： 接收来自群里@机器人的消息回调

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
senderPlatform字符串可选消息发送平台。
conversationId字符串可选会话ID。
atUsers字符串JSON格式可选被@人的信息： dingtalkId：加密的发送者ID。
chatbotCorpId字符串可选加密的机器人所在的企业corpId。
chatbotUserId字符串可选加密的机器人ID。
msgId字符串可选加密的消息ID。
senderNick字符串可选发送者昵称。
isAdmin字符串可选是否为管理员： true：是 false：否
senderStaffId字符串可选企业内部群中@该机器人的成员 userId。
sessionWebhookExpiredTime字符串可选当前会话的Webhook地址过期时间。
createAt字符串可选消息的时间戳，单位毫秒。
senderCorpId字符串可选企业内部群的发送者当前群的企业corpId。
conversationType字符串可选会话类型： 1：单聊 2：群聊
senderId字符串可选加密的发送者ID。
conversationTitle字符串可选群聊时才有的会话标题。
isInAtList字符串可选是否在@列表中。
sessionWebhook字符串可选当前会话的Webhook地址。
text字符串JSON格式可选消息文本： content：机器人接收的消息内容。
msgtype字符串可选消息类型： text：文本消息 richText：富文本消息 picture：图片消息 audio：语音消息 video：视频消息 file：文件消息
robotCode字符串可选机器人编码。
customType字符串可选自定义 类型，1-图片，2-报告，3-打单，4-客户案例，5-运营活动设计，6-使用次数统计，7-平台竞对切换案例，rcfz-人才发展，hyps-会议评审
content字符串JSON格式可选消息内容： downloadCode：文件的下载码，用于换取下载文件的二进制文件。 企业内部应用，调用服务端API-下载机器人接收消息的文件内容接口，获取临时下载链接。 第三方企业应用，调用服务端API-下载机器人接收消息的文件内容接口，获取临时下载链接。 fileName：文件名。
modelType字符串可选模型类型：trigger、openapi

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

生成多Sheet的Excel文件 v1.0

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ABuildExcel

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ABuildExcel

接口描述： 生成多Sheet的Excel文件

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

获取21-24年内容产品采购明细数据列表 v1.12

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ALieBiaoProductprocuredetail

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ALieBiaoProductprocuredetail

接口描述： 根据搜索条件，分页获取21-24年内容产品采购明细数据列表，支持排序、搜索

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：10000分页数量
org_name字符串可选机构名称
yxt_industry_1字符串可选行业分类
enterprise_type字符串可选企业类型
staff_size字符串可选人员规模
money字符串可选金额
class_type字符串可选班型
product_name字符串可选产品名称
source_type字符串可选来源类型
staff_size_min字符串可选人员规模_最小值
staff_size_max字符串可选人员规模_最大值
yxt_industry_more字符串可选行业，传入的是拆好词的文本

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu整型总数
data.lie_biao[].org_name字符串机构名称
data.lie_biao[].yxt_industry_1字符串行业分类
data.lie_biao[].enterprise_type字符串企业类型
data.lie_biao[].staff_size字符串人员规模
data.lie_biao[].class_type字符串班型
data.lie_biao[].product_name字符串产品名称
data.lie_biao[].source_type字符串来源类型
data.lie_biao[].staff_size_min字符串人员规模_最小值
data.lie_biao[].staff_size_max字符串人员规模_最大值
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

获取报告解读提示词步骤表数据列表 v1.0

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ALieBiaoAndyReportPromts

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ALieBiaoAndyReportPromts

接口描述： 根据搜索条件，分页获取报告解读提示词步骤表数据列表，支持排序、搜索

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：10000分页数量
app_catalog字符串可选应用分类
app_name字符串可选应用名称
app_id字符串可选应用id

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu整型总数
data.lie_biao[].app_catalog字符串应用分类
data.lie_biao[].app_name字符串应用名称
data.lie_biao[].app_id字符串应用id
data.lie_biao[].app_url字符串应用地址
data.lie_biao[].currNodeInstanceId字符串节点实例id
data.lie_biao[].order_index整型排序
data.lie_biao[].prompt字符串主提示词
data.lie_biao[].step1字符串步骤1
data.lie_biao[].step2字符串步骤2
data.lie_biao[].step3字符串步骤3
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

获取提示词步骤表数据列表 v1.0

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ALieBiaoAndypromptsteps

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ALieBiaoAndypromptsteps

接口描述： 根据搜索条件，分页获取提示词步骤表数据列表，支持排序、搜索

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选1最小：1第几页
perpage整型可选10最小：1；最大：10000分页数量
version字符串必须1.0提示词版本
step_type字符串可选步骤类型（qymc-企业名称....等等）

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu整型总数
data.lie_biao[].version字符串提示词版本
data.lie_biao[].step_type字符串步骤类型（qymc-企业名称....等等）
data.lie_biao[].prompt字符串提示词
data.lie_biao[].step1字符串步骤1
data.lie_biao[].step2字符串步骤2
data.lie_biao[].step3字符串步骤3
data.lie_biao[].step4字符串步骤4
data.lie_biao[].step5字符串步骤5
data.lie_biao[].step6字符串步骤6
data.lie_biao[].step7字符串步骤7
data.lie_biao[].step8字符串步骤8
data.lie_biao[].step9字符串步骤9
data.lie_biao[].step10字符串步骤10
data.lie_biao[].step11字符串步骤11
data.lie_biao[].step12字符串步骤12
data.lie_biao[].step_name字符串步骤名称（企业名称、企业概述...）
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

获取过程数据存储表数据 v1.6

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/AGetAndyVarDatas

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.AGetAndyVarDatas

接口描述： 根据UserID，获取过程数据存储表数据详情

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
user_id整型必须过程数据存储表数据UserID

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.datas字符串数据列表，失败时返回空数组
data.datas[].user_id字符串用户id
data.datas[].user_name字符串用户姓名
data.datas[].sys_survey_report字符串系统-需求调研报告
data.datas[].sys_activity_need字符串系统-活动方案-活动需求
data.datas[].sys_content_select字符串系统-活动方案-内容选择
data.datas[].user_content_select字符串用户-活动方案-内容选择
data.datas[].sys_content_tuij字符串系统-活动方案-内容推荐
data.datas[].sys_activity_name字符串系统-活动方案-活动名称
data.datas[].user_activity_name字符串用户-活动方案-活动名称
data.datas[].sys_activity_ideas字符串系统-活动方案-活动思路
data.datas[].sys_activity_plan字符串系统-活动方案-活动策划
data.datas[].sys_activity_enroll字符串系统-活动方案-活动报名
data.datas[].sys_activity_xuanc字符串系统-活动方案-活动宣传
data.datas[].sys_incentive_plan字符串系统-活动方案-激励措施
data.datas[].sys_yuqi_result字符串系统-活动方案-预期效果
data.datas[].sys_refine_merge字符串方案合并
data.datas[].sys_activity_simplify字符串方案精简
data.datas[].fansan_mothed字符串发散方式
data.datas[].yixiang_course字符串意向课程
data.datas[].activity_type字符串活动类型
data.datas[].block_index字符串分块索引，默认0
data.datas[].activity_beijing字符串活动背景
data.datas[].activity_mubiao字符串活动目标
data.datas[].enterprise_name字符串企业名称
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

获取阶段运营报告数据 v1.5

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/AJdyyReportData

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.AJdyyReportData

接口描述： 获取阶段运营报告数据

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
input_type字符串可选输入类型，1-kng，2-...
webhook字符串可选回送

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

软件客户售卖案例明细数据列表 v1.10

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ARjkhSaleCaseDetail

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ARjkhSaleCaseDetail

接口描述： 软件客户售卖案例明细数据列表

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
page整型可选第几页
perpage整型可选分页数量
archive_name字符串可选档案名称
yxt_industry_1字符串可选一级行业
yxt_industry_2字符串可选二级行业
enterprise_type字符串可选企业类型
staff_size_min字符串可选人员规模_最小值
staff_size_max字符串可选人员规模_最大值
customer_province字符串可选客户所在省
customer_keywords字符串可选客户关键字
account_count_gt字符串可选帐号数大于
account_count_lt字符串可选帐号数小于
yxt_industry_more字符串可选二级行业，传入的是拆好词的文本

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.lie_biao字符串数据列表，失败时返回空数组
data.zong_shu整型总数
data.lie_biao[].archive_name字符串档案名称
data.lie_biao[].yxt_industry_1字符串一级行业
data.lie_biao[].yxt_industry_2字符串二级行业
data.lie_biao[].enterprise_type字符串企业性质
data.lie_biao[].staff_size字符串人员规模
data.lie_biao[].customer_province字符串客户所在省
data.lie_biao[].customer_keywords字符串客户关键字
data.lie_biao[].account_count字符串帐号数
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

软件客户售卖案例查询 v1.9

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Swxiryan0788_MyApi/ARjkhSaleCaseReceiveSearch

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Swxiryan0788_MyApi.ARjkhSaleCaseReceiveSearch

接口描述： 软件客户售卖案例查询

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
senderPlatform字符串可选消息发送平台。
conversationId字符串可选会话ID。
atUsers字符串JSON格式可选被@人的信息： dingtalkId：加密的发送者ID。
chatbotCorpId字符串可选加密的机器人所在的企业corpId。
chatbotUserId字符串可选加密的用户ID。
msgId字符串可选加密的机器人ID。
senderNick字符串可选发送者昵称。
isAdmin字符串可选是否为管理员： true：是 false：否
createAt字符串可选消息的时间戳，单位毫秒。
senderCorpId字符串可选企业内部群的发送者当前群的企业corpId。
conversationType字符串可选会话类型： 1：单聊 2：群聊
senderId字符串可选加密的发送者ID。
conversationTitle字符串可选群聊时才有的会话标题。
isInAtList字符串可选是否在@列表中。
sessionWebhook字符串可选当前会话的Webhook地址。
text字符串JSON格式可选消息文本： content：机器人接收的消息内容。
msgtype字符串可选消息类型： text：文本消息 richText：富文本消息 picture：图片消息 audio：语音消息 video：视频消息 file：文件消息
robotCode字符串可选机器人编码。
sessionWebhookExpiredTime字符串可选当前会话的Webhook地址过期时间。

客户端请求示例

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

HTTP通用示例 
null

接口返回及数据结构

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

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

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