麒麟云服开放平台

麒麟云服开放平台接口


查询签约信息

<h3>接口功能</h3> <p>传入企业唯一订单号或用户身份信息查询签约状态和详细信息。</p> <h3>请求URL</h3> <ul> <li><code>api/kycloud/open/v1.0/contract/query</code></li> </ul> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>queryType</td> <td>字符</td> <td>是</td> <td>4</td> <td>查询类型:1:outBizNo 2:userTask</td> <td>1</td> </tr> <tr> <td>outBizNo</td> <td>字符</td> <td>queryType=1时,必填</td> <td>50</td> <td>企业唯一订单号,由企业自定义</td> <td>2023100080808</td> </tr> <tr> <td>taskId</td> <td>字符</td> <td>queryType=2时,必填</td> <td>20</td> <td>任务编号</td> <td>85393293706</td> </tr> <tr> <td>cardNumber</td> <td>字符</td> <td>queryType=2时,必填</td> <td>18</td> <td>用户证件号码</td> <td>371726197103292594</td> </tr> <tr> <td>idCardType</td> <td>字符</td> <td>否</td> <td>4</td> <td>证件类型:1:居民身份证2:港澳来往内地通行证 3:护照4:其他,不填写默认居民身份证</td> <td>1</td> </tr> </tbody> </table> <h3>公共响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>code</td> <td>字符</td> <td>否</td> <td>-</td> <td>错误码</td> <td>open_request_expired</td> </tr> <tr> <td>success</td> <td>字符</td> <td>是</td> <td>-</td> <td>请求是否成功,成功true、失败false</td> <td>true</td> </tr> <tr> <td>message</td> <td>字符</td> <td>否</td> <td>-</td> <td>失败描述</td> <td>请求过期,请求重新发起</td> </tr> <tr> <td>object</td> <td>json</td> <td>是</td> <td>-</td> <td>请求成功后,平台响应数据</td> </tr> </tbody> </table> <h3>响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>字符</td> <td>是</td> <td>20</td> <td>签约编号</td> <td>86016141282</td> </tr> <tr> <td>taskId</td> <td>字符</td> <td>是</td> <td>20</td> <td>任务编号</td> <td>85393293706</td> </tr> <tr> <td>taskName</td> <td>字符</td> <td>是</td> <td>50</td> <td>任务名称</td> <td>电商直播推广</td> </tr> <tr> <td>userId</td> <td>字符</td> <td>是</td> <td>20</td> <td>用户ID</td> <td>52984126340489216</td> </tr> <tr> <td>signStatus</td> <td>字符</td> <td>是</td> <td>16</td> <td>签约状态</td> <td>INIT:未签约SUCCESS:签约成功FAILED:签约失败</td> </tr> <tr> <td>signTime</td> <td>字符</td> <td>否</td> <td>20</td> <td>签约时间,格式”yyyy-MM-dd HH24:mm:ss”</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>contractDetail</td> <td>数组</td> <td>是</td> <td>不限</td> <td>协议明细</td> <td></td> </tr> <tr> <td>└contractTxId</td> <td>字符</td> <td>是</td> <td>20</td> <td>签约合同号</td> <td>69687064601</td> </tr> <tr> <td>└contractUrl</td> <td>字符</td> <td>是</td> <td>255</td> <td>签约协议链接</td> <td>www.baidu.com</td> </tr> <tr> <td>└createTime</td> <td>字符</td> <td>是</td> <td>32</td> <td>签约协议生成时间,格式”yyyy-MM-dd HH24:mm:ss”</td> <td>2023-10-01 08:08:08</td> </tr> </tbody> </table> <h3>错误码</h3> <table> <thead> <tr> <th>错误码</th> <th>错误描述</th> </tr> </thead> <tbody> <tr> <td>open_out_biz_no_not_exited</td> <td>企业订单号不存在</td> </tr> <tr> <td>open_task_not_existed_error</td> <td>没有找到对应的任务信息</td> </tr> <tr> <td>open_user_not_existed_error</td> <td>没有找到对应的用户信息</td> </tr> </tbody> </table> <h3>公共错误码</h3> <p>参考:[公共错误码](<a href="https://www.showdoc.com.cn/kycloudopen/11199459988358587">https://www.showdoc.com.cn/kycloudopen/11199459988358587</a> &quot;公共错误码&quot;)</p>

页面列表

ITEM_HTML