开始使用响应报文

响应报文

所有接口响应均使用统一的 JSON 包装格式。

统一响应结构

{
  "Response": {
    "RequestId": "abc123",
    "Error": null,
    "Data": { ... }
  }
}
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
  }
}