知我云 SMS
登录 开始使用

开发者中心

API 文档

查看认证方式、接口参数、响应示例和状态码。

提示

请先 登录 或 注册 以查看您的API认证信息。

签名新增

POST https://sms.zevost.com/api/v1/sign/report/proxy

请求参数：

参数名 必选 类型 说明
username Y String 用户名
apiKey Y String API密钥
tKey Y Long Unix 时间戳（10位，5分钟内）
signatureList Y List 签名集合（限制1个）

请求示例（使用API Key）：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1577352217",
  "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://****"
  }]
}

签名查询

POST https://sms.zevost.com/api/v1/sign/query

请求参数：

参数名 必选 类型 说明
username Y String 用户名
apiKey Y String API密钥
tKey Y Long Unix 时间戳（10位，5分钟内）
sign Y String 签名（含【】）

模板报备

POST https://sms.zevost.com/api/v1/template

请求示例（使用API Key）：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1529981190",
  "requestId": "template-20260828-000001",
  "temName": "验证码模板",
  "temType": 1,
  "temContent": "【知我云】您的验证码是：{code}，有效期10分钟。",
  "paramJson": {
    "code": "valid_code"
  },
  "paramLengthJson": {
    "code": 6
  }
}

模板类型支持：1 验证码、2 行业通知、3 会员营销。行业通知和会员营销不能使用 valid_code，可使用 other_number、amount、date、chinese、others、int_number。

模板短信发送

POST https://sms.zevost.com/api/v1/sendSmsTp

请求示例（使用API Key）：

{
  "username": "your_username",
  "apiKey": "your_api_key",
  "tKey": "1552633427",
  "requestId": "sms-20260828-000001",
  "tpId": "183",
  "signature": "【知我云】",
  "records": [{
    "mobile": "138****0000",
    "tpContent": {
      "code": "123456"
    }
  }]
}

下行回执抓取

POST https://sms.zevost.com/api/v1/batchReport

请求示例（使用API Key）：

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

余额查询

POST https://sms.zevost.com/api/v1/user/balance

请求参数：

参数名 必选 类型 说明
username Y String 用户名
apiKey Y String API密钥
tKey Y Long Unix 时间戳（10位，5分钟内）

响应示例：

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

短信状态说明

状态类型：

状态值 状态名称 说明
2 等待回执 短信已提交到运营商，等待送达
1 已送达 短信已成功送达用户手机
0 发送失败 短信发送失败，费用已自动退回
3 回执超时 超过 24 小时未收到运营商最终回执，状态未知且不自动退款

状态码说明：

状态码 说明
DELIVRD 短信送达成功
UNDELIV 短信未送达（号码不存在、停机等）
REJECTD 短信被拒绝（内容违规、黑名单等）
EXPIRED 短信已过期（超时未送达）

注意：发送失败的短信会自动退回费用到账户余额。

常见错误码

错误码 说明
200 成功
4001 用户名错误
4003 余额不足
4004 手机号码无效
4007 用户已禁用
4008 tKey错误（时间戳超过5分钟）
4009 密码错误
4011 缺少必填参数
4014 模板错误或未审核通过
4023 签名错误或未审核通过
4026 手机号码数量超过限制（固定模板最多2000个，变量模板最多200个）
4029 请求方法错误（需使用POST）
5000 服务器内部错误
9998 JSON解析错误

重要提示

  • 所有API接口均使用POST方法，Content-Type为application/json
  • 认证方式：使用 apiKey 参数传入API密钥
  • tKey 为当前 Unix 时间戳，精确到秒，10 位长度，有效期 5 分钟
  • 写接口请传 8 至 128 位唯一 requestId；重复请求会返回首次结果，不会重复扣费或创建资源
  • 签名必须带中文中括号【】
  • 模板类型：1=验证码，2=行业通知，3=会员营销