响应报文
信封签署等业务接口的响应均使用统一的 JSON 包装格式。文件管理接口的响应格式略有不同(业务数据不经过 Data 字段包装,直接返回在 Response 下),详见文件管理接口文档。
统一响应结构
{
"Response": {
"RequestId": "abc123",
"Error": null,
"Data": { ... }
}
}Response 字段说明
RequestIdstring
请求唯一标识,用于问题排查。每次请求都会返回
Errorobject | null
错误信息。成功时为 null
Codestring
错误码,如 INVALID_REQUEST
Messagestring
错误描述信息
Dataobject | null
业务数据。错误时为 null
成功响应示例
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEVa1b2c3d4e5f6",
"Status": "sent"
}
}
}错误响应示例
{
"Response": {
"RequestId": "req-abc123",
"Error": {
"Code": "INVALID_REQUEST",
"Message": "Title is required"
},
"Data": null
}
}