合同催签

请求地址

/v2/contract/notice

请求方法

POST

请求格式

application/json;charset=UTF-8

请求参数

参数 类型 必须 描述
contractId String 合同ID,合同ID与业务ID二选一,不能同时为空
bizId String 业务ID,合同ID与业务ID二选一,不能同时为空
tenantName String 子公司名称,若使用业务ID催签,且合同是以子公司身份创建的,则需要传递该值,用于确定合同主体
signatoryId String 签署方ID;不指定签署方时,对所有签署方进行催签(不包含发起方)
onlySigning Boolean 是否只催签签署中的合同,默认为true; signing传参false时,除签署中合同外,可催签拟定中、作废待确认的合同

返回参数

参数 类型 描述
responseCode String 响应码
message String 响应消息

响应码

(全局响应码请查看文档末“全局响应码”):

响应码 描述
11990005 无效的参数:参数格式错误,必传参数未传,参数超出取值范围,参数类型不正确;
11011126 合同未找到
14990002 权限不匹配
11011101 无效的合同状态
11101003 合同不存在

请求示例

Http示例

POST /v2/contract/notice HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的TimeStamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: application/json
{
    "contractId": "2591540368898105360",
    "bizId": "123456789",
    "signatoryId": "2591540371314024472"
}
Java示例

// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
// 合同催签
ContractNoticeRequest request = new ContractNoticeRequest(contractId);
String response = sdkClient.service(request);
SdkResponse responseObj = JSONUtils.toQysResponse(response);
if(responseObj.getResponseCode().equals("00000000")) {
  logger.info("合同催签成功");
} else {
  logger.info("请求失败,错误码:{},错误信息:{}", responseObj.getCode(), responseObj.getMessage());
}
C#示例

// 初始化sdkClient
string serverUrl = "https://openapi.qiyuesuo.cn";
string accessKey = "替换为您申请的开放平台App Token";
string accessSecret = "替换为您申请的开放平台App Secret";
SDKClient client = new SDKClient(accessKey, accessSecret, serverUrl);
ContractNoticeRequest request = new ContractNoticeRequest();
request.ContractId = "2588924049895063561";
string response = null;
try
{
  response = client.Service(request);
}
catch (Exception e)
{
  throw new Exception(e.Message);
}
// 解析返回内容
SdkResponse<Object> responseObject = HttpJsonConvert.DeserializeResponse<Object>(response);
if (!responseObject.ResponseCode.Equals("00000000"))
{
  throw new Exception("合同催签失败,失败原因:" + responseObject.Message);
}
Console.WriteLine(“合同催签成功”);
PHP示例

// 初始化$sdkClient
class Util {
    const     url = "https://openapi.qiyuesuo.cn";
    const     accessKey = "替换为您申请的开放平台App Token";
    const     accessSecret = "替换为您申请的开放平台App Secret";
}
$sdkClient = Util::getSDk();
$contractNoticeRequest = new ContractNoticeRequest();
$contractNoticeRequest->setContractId('2590804900506210559');
$contractNoticeRequest->setBizId('123456789');
$contractNoticeRequest->setSignatoryId('2590804962716127509');
$result = $sdkClient->service($contractNoticeRequest);
print_r($result);
Python示例

# 初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
# 签署通知
notice_request = ContractNoticeRequest()
notice_request.set_contractId('2589643804158468448')
notice_response = sdkClient.request(notice_request)
print('发送签署通知成功:\n', str(notice_response), '\n')
Go示例

sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
req := request.ContractNoticeRequest{}
req.ContractId = "3121656555125154667"
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)

合同催签

请求地址

/v2/contract/notice

请求方法

POST

请求格式

application/json;charset=UTF-8

请求参数

参数 类型 必须 描述
contractId String 合同ID,合同ID与业务ID二选一,不能同时为空
bizId String 业务ID,合同ID与业务ID二选一,不能同时为空
tenantName String 子公司名称,若使用业务ID催签,且合同是以子公司身份创建的,则需要传递该值,用于确定合同主体
signatoryId String 签署方ID;不指定签署方时,对所有签署方进行催签(不包含发起方)
onlySigning Boolean 是否只催签签署中的合同,默认为true; signing传参false时,除签署中合同外,可催签拟定中、作废待确认的合同

返回参数

参数 类型 描述
responseCode String 响应码
message String 响应消息

响应码

(全局响应码请查看文档末“全局响应码”):

响应码 描述
11990005 无效的参数:参数格式错误,必传参数未传,参数超出取值范围,参数类型不正确;
11011126 合同未找到
14990002 权限不匹配
11011101 无效的合同状态
11101003 合同不存在

请求示例

Http示例

POST /v2/contract/notice HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的TimeStamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: application/json
{
    "contractId": "2591540368898105360",
    "bizId": "123456789",
    "signatoryId": "2591540371314024472"
}
Java示例

// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
// 合同催签
ContractNoticeRequest request = new ContractNoticeRequest(contractId);
String response = sdkClient.service(request);
SdkResponse responseObj = JSONUtils.toQysResponse(response);
if(responseObj.getResponseCode().equals("00000000")) {
  logger.info("合同催签成功");
} else {
  logger.info("请求失败,错误码:{},错误信息:{}", responseObj.getCode(), responseObj.getMessage());
}
C#示例

// 初始化sdkClient
string serverUrl = "https://openapi.qiyuesuo.cn";
string accessKey = "替换为您申请的开放平台App Token";
string accessSecret = "替换为您申请的开放平台App Secret";
SDKClient client = new SDKClient(accessKey, accessSecret, serverUrl);
ContractNoticeRequest request = new ContractNoticeRequest();
request.ContractId = "2588924049895063561";
string response = null;
try
{
  response = client.Service(request);
}
catch (Exception e)
{
  throw new Exception(e.Message);
}
// 解析返回内容
SdkResponse<Object> responseObject = HttpJsonConvert.DeserializeResponse<Object>(response);
if (!responseObject.ResponseCode.Equals("00000000"))
{
  throw new Exception("合同催签失败,失败原因:" + responseObject.Message);
}
Console.WriteLine(“合同催签成功”);
PHP示例

// 初始化$sdkClient
class Util {
    const     url = "https://openapi.qiyuesuo.cn";
    const     accessKey = "替换为您申请的开放平台App Token";
    const     accessSecret = "替换为您申请的开放平台App Secret";
}
$sdkClient = Util::getSDk();
$contractNoticeRequest = new ContractNoticeRequest();
$contractNoticeRequest->setContractId('2590804900506210559');
$contractNoticeRequest->setBizId('123456789');
$contractNoticeRequest->setSignatoryId('2590804962716127509');
$result = $sdkClient->service($contractNoticeRequest);
print_r($result);
Python示例

# 初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
# 签署通知
notice_request = ContractNoticeRequest()
notice_request.set_contractId('2589643804158468448')
notice_response = sdkClient.request(notice_request)
print('发送签署通知成功:\n', str(notice_response), '\n')
Go示例

sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
req := request.ContractNoticeRequest{}
req.ContractId = "3121656555125154667"
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
常见
问题
在线
客服
电话
咨询