API 文档

请求参数：

请求示例（使用API Key）：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "requestId": "sign-20260828-000001",
  "signatureList": [{
    "signature": "【知我云】",
    "contentExample": "【知我云】您的验证码是：123456",
    "companyName": "****有限公司",
    "creditCode": "91310****889",
    "legalPerson": "****",
    "principalName": "****",
    "principalIdCard": "3202****4324",
    "principalMobile": "153****1234",
    "signSource": 1,
    "signType": 1,
    "bizLicenseUrl": "https://****",
    "idcardFrontUrl": "https://****",
    "idcardBackUrl": "https://****"
  }]
}

signSource：1 企业名称、2 事业单位、3 商标；signType：0 全称、1 简称。商标来源还需提供 trademarkScreenshotUrl（中国商标网查询截图，JPG/PNG，最大 5MB）。材料地址须为可访问的 HTTPS 地址。成功响应包含 successList 和 failList。

请求参数：

请求示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "sign": "【知我云】"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "sign": "【知我云】",
  "signId": "123456",
  "isPublic": 0,
  "auditResult": 2,
  "auditMsg": "审核通过",
  "realNameYd": "1",
  "realNameLt": "1",
  "realNameDx": "1",
  "ydAvalibleType": "验证码,通知",
  "ltAvalibleType": "验证码,通知",
  "dxAvalibleType": "验证码,通知",
  "mergeRealNameStatus": "1"
}

仅可删除当前账号尚未完成同步的签名，单次最多 20 个。

请求示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "requestId": "sign-delete-20261002-0001",
  "signatureList": ["【知我云】"]
}

请求参数：

变量模板示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "requestId": "template-20261002-0001",
  "temName": "验证码模板",
  "temType": 1,
  "temContent": "【知我云】您的验证码是：{code}，有效期10分钟。",
  "paramJson": {
    "code": "valid_code"
  },
  "paramLengthJson": {
    "code": 6
  },
  "remark": "完整示例：【知我云】您的验证码是：123456，有效期10分钟。"
}

固定模板示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "requestId": "template-20261002-0002",
  "temName": "维护完成通知",
  "temType": 2,
  "temContent": "【知我云】系统维护已完成，服务现已恢复。",
  "remark": "用于系统维护完成后通知用户"
}

变量类型：

变量支持 {name} 和 @var(name)，变量名必须以英文字母或下划线开头，只能包含英文字母、数字和下划线。变量长度总和不能超过模板总长度的 70%。固定模板不要传 paramJson 和 paramLengthJson。

根据模板 ID 查询当前账号自己的模板，或查询已经审核通过并公开的公共模板。

请求参数：

请求示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "temId": 183
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "temId": 183,
  "upstreamTemId": "91",
  "temName": "验证码模板",
  "temType": 1,
  "temContent": "【知我云】您的验证码是：{code}，有效期10分钟。",
  "paramJson": {
    "code": "valid_code"
  },
  "paramLengthJson": {
    "code": 6
  },
  "isPublic": 0,
  "extend": "",
  "createTime": "2026-09-27 12:00:00",
  "remark": "",
  "auditResult": 2,
  "auditMsg": "审核通过"
}

auditResult：1 审核中、2 审核通过、3 审核不通过。发送短信时使用响应中的本地 temId。

请求参数：

请求示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "requestId": "sms-20261002-0001",
  "tpId": 183,
  "signature": "【知我云】",
  "records": [{
    "mobile": "13800138000",
    "tpContent": {
      "code": "123456"
    }
  }]
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "tpId": 183,
  "msgId": "20261002153000abcdef123456",
  "successCount": 1,
  "failedCount": 0,
  "pendingCount": 0,
  "totalCost": "0.0350",
  "invalidList": []
}

接口会逐条校验号码和变量，未通过的记录位于 invalidList。触发频率限制时 HTTP 状态为 429，并返回 retryAfter。

返回当前账号最近的终态回执，count 范围为 1-400，默认 100。

请求示例：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1793558852",
  "count": 100
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "reportList": [{
    "msgId": "20261002153000abcdef123456",
    "mobile": "13800138000",
    "status": "success",
    "statusCode": "DELIVRD",
    "statusMsg": "短信送达成功",
    "reportTime": "2026-10-02 15:30:08",
    "extend": ""
  }]
}

请求参数：

响应示例：

{
  "code": 200,
  "msg": "success",
  "balance": "100.50",
  "currency": "CNY"
}

状态类型：

状态码说明：