短信SMS接口文档 1. 用户相关 2. 短信模板 2.1 添加 2.2 修改 2.3 列表 请求 请求参数 响应 Json响应示例 2.4 删除 请求 请求参数 响应 Json响应示例 3. 短信签名 3.1 添加 3.2 修改 3.3 列表 3.4 删除 4. 短信发送 5. 短信状态 6. 上行
URL：https://api.xingkongqixin.com/api/v1/sms/user/balance.json 请求方式：GET 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb
注意事项：
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data Long 账号余额 40
{"data": 400,"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/tpl/add.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb type trueString 模板类型 1：验证码, 2：通知, 4：营销 1 content trueString 内容 【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。
注意事项：
content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名 模板内容中变量必须是系统指定的形式，如{变量1}{变量2}，且把{变量1}{变量2}当成一个整体。 名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/tpl/modify.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey true String 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb templateId trueLong 模板ID 10 type trueString 模板类型 1：验证码, 2：通知, 4：营销 1 content trueString 内容 【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。
注意事项：
content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名 模板内容中变量必须是系统指定的形式，如{变量1}{变量2}，且把{变量1}{变量2}当成一个整体。 名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/tpl/list.json 请求方式：GET 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb type false String 模板类型 1：验证码, 2：通知, 4：营销 1 status false String 状态：0-待审核、1-审核通过、2-审核未通过 1
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data List 模板数据 id Long 模板ID 12 sign String 签名 阿里云 content String 模板内容 【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。 status Integer 状态：0-待审核、1-审核通过、2-审核未通过 1 verifyTs Long 审核时间 毫秒 1713148732000 verifyRemark String 审核信息 type Integer 模板类型 1：验证码, 2：通知, 4：营销 1
{"data": [{"id": 12,"sign": "阿里云","content": "【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。","status": 1,"verifyTs": 1713148732000,"verifyRemark": "","type": 1},{"id": 11,"sign": "腾讯云","content": "【腾讯云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。","status": 0,"verifyTs": 0,"verifyRemark": "","type": 1}],"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/tpl/del.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb templateId trueLong 模板ID 10
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/sign/add.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb sign trueString 签名 阿里云 productUrl false String 产品链接 authorizationType false Integer 授权类型 authorizationUrl false String 授权文件
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/sign/modify.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb signId trueLong 签名ID 19 sign trueString 签名 阿里云 productUrl false String 产品链接 authorizationType false Integer 授权类型 authorizationUrl false String 授权文件
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/sign/list.json 请求方式：GET 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb status false Integer 状态： 0:待审核，1：审核通过，2：审核未通过 1
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data List 签名数据 id Long 签名ID 19 sign String 签名 阿里云 productUrl String 产品链接 authorizationType Integer 授权类型 authorizationUrl String 授权文件 verifyTs Long 审核时间 毫秒 1713148732000 verifyRemark String 审核信息
{"data": [{"id": 19,"sign": "阿里云","productUrl": "","authorizationType": 0,"authorizationUrl": "","status": 1,"verifyTs": 0,"verifyRemark": ""},{"id": 10,"sign": "叮咚云","productUrl": "","authorizationType": 0,"authorizationUrl": "","status": 0,"verifyTs": 0,"verifyRemark": ""}],"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/sign/del.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb signId trueLong 签名ID 19
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok
{"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/send.json 请求方式：POST 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb mobileList trueString 手机号 一次最多1000个 多个手机号用英文分号;连接 15380403940;15942305452;15369848521 content trueString 短信内容 【阿里云】您正在登录验证，验证码687520，切勿将验证码泄露于他人，本条验证码有效期15分钟。
注意事项：
content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名 名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data String 消息mid 与手机号mobile组成唯一 对于短信状态获取或上行获取 YJ1L3AvnyWAZRrlG
{"data": "YJ1L3AvnyWAZRrlG","code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms/pull_status.json 请求方式：GET 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb pageSize false String 每次可获取短信状态的号码数量 默认20 最大100 50
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data List 返回数据结果 mid String 消息ID YJ1L3AvnyWAZRrlG mobile String 手机号 18968192960 receiveTime String 状态时间 2024-04-10 15:49:22 reportStatus String 发送状态值, SUCCESS, FAIL SUCCESS reportDetail String 发送状态详情 DELIVRD
{"data": [{"mid": "YJ1L3AvnyWAZRrlG","mobile": "18968192960","receiveTime": "2024-04-10 15:49:22","reportStatus": "FAIL","reportDetail": "BLACK"},{"mid": "YJ1L3AvnyWAZRrlG","mobile": "13656656493","receiveTime": "2024-04-10 15:49:22","reportStatus": "SUCCESS","reportDetail": "DELIVRD"}],"code": 0,"msg": "ok"
}
URL：https://api.xingkongqixin.com/api/v1/sms//pull_reply.json 请求方式：GET 参数名 是否必填 类型 描述 示例 apikey trueString 短信账号key e5d692ecdfbb6cd4f21ae7a92cc2a2bb pageSize false String 每次可获取短信状态的号码数量 默认20 最大100 50
名称 类型 描述 示例 code Integer code为0，表示成功，其他请参考返回值说明 0 msg String 返回结果说明 ok data List 返回数据结果 mid String 消息ID YJ1L3AvnyWAZRrlG 注意（mid+mobile组成唯一） mobile String 手机号 15380403942 content String 状态回复内容 1712738071639 replyTs Long 回复时间 SUCCESS
{"data": [{"mid": "YJ1L3AvnyWAZRrlG","mobile": "15380403942","content": "YlH2T4","replyTs": 1712738071639},{"mid": "YJ1L3AvnyWAZRrlG","mobile": "18968192968","content": "YlH2T4","replyTs": 1712738071639}],"code": 0,"msg": "ok"
}
