短信sms接口文档

短信SMS接口文档

  • 1. 用户相关
    • 1.1 获取用户余额
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
  • 2. 短信模板
    • 2.1 添加
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
    • 2.2 修改
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
    • 2.3 列表
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
      • 2.4 删除
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
  • 3. 短信签名
    • 3.1 添加
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
    • 3.2 修改
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
    • 3.3 列表
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
    • 3.4 删除
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
  • 4. 短信发送
    • 4.1 短信发送
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
  • 5. 短信状态
    • 5.1 短信状态获取
      • 请求
      • 请求参数
      • 响应
      • Json响应示例
  • 6. 上行
    • 6.1 上行获取
      • 请求
      • 请求参数
      • 响应
      • Json响应示例

1. 用户相关

1.1 获取用户余额

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/user/balance.json
  • 请求方式：GET

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb

注意事项：

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataLong账号余额40

Json响应示例

{"data": 400,"code": 0,"msg": "ok"
}

2. 短信模板

2.1 添加

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/tpl/add.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
typetrueString模板类型 1：验证码, 2：通知, 4：营销1
contenttrueString内容【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。

注意事项：

  • content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名
  • 模板内容中变量必须是系统指定的形式，如{变量1}{变量2}，且把{变量1}{变量2}当成一个整体。

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

2.2 修改

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/tpl/modify.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
templateIdtrueLong模板ID10
typetrueString模板类型 1：验证码, 2：通知, 4：营销1
contenttrueString内容【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。

注意事项：

  • content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名
  • 模板内容中变量必须是系统指定的形式，如{变量1}{变量2}，且把{变量1}{变量2}当成一个整体。

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

2.3 列表

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/tpl/list.json
  • 请求方式：GET

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
typefalseString模板类型 1：验证码, 2：通知, 4：营销1
statusfalseString状态：0-待审核、1-审核通过、2-审核未通过1

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataList模板数据
idLong模板ID12
signString签名阿里云
contentString模板内容【阿里云】您正在登录验证，验证码{变量1}，切勿将验证码泄露于他人，本条验证码有效期15分钟。
statusInteger状态：0-待审核、1-审核通过、2-审核未通过1
verifyTsLong审核时间 毫秒1713148732000
verifyRemarkString审核信息
typeInteger模板类型 1：验证码, 2：通知, 4：营销1

Json响应示例

{"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"
}

2.4 删除

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/tpl/del.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
templateIdtrueLong模板ID10

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

3. 短信签名

3.1 添加

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/sign/add.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
signtrueString签名阿里云
productUrlfalseString产品链接
authorizationTypefalseInteger授权类型
authorizationUrlfalseString授权文件

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

3.2 修改

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/sign/modify.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
signIdtrueLong签名ID19
signtrueString签名阿里云
productUrlfalseString产品链接
authorizationTypefalseInteger授权类型
authorizationUrlfalseString授权文件

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

3.3 列表

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/sign/list.json
  • 请求方式：GET

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
statusfalseInteger状态： 0:待审核，1：审核通过，2：审核未通过1

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataList签名数据
idLong签名ID19
signString签名阿里云
productUrlString产品链接
authorizationTypeInteger授权类型
authorizationUrlString授权文件
verifyTsLong审核时间 毫秒1713148732000
verifyRemarkString审核信息

Json响应示例

{"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"
}

3.4 删除

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/sign/del.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
signIdtrueLong签名ID19

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok

Json响应示例

{"code": 0,"msg": "ok"
}

4. 短信发送

4.1 短信发送

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/send.json
  • 请求方式：POST

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
mobileListtrueString手机号 一次最多1000个 多个手机号用英文分号;连接15380403940;15942305452;15369848521
contenttrueString短信内容【阿里云】您正在登录验证，验证码687520，切勿将验证码泄露于他人，本条验证码有效期15分钟。

注意事项：

  • content中的【阿里云】签名阿里云 必须是你所申请并审核通过的签名

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataString消息mid 与手机号mobile组成唯一 对于短信状态获取或上行获取YJ1L3AvnyWAZRrlG

Json响应示例

{"data": "YJ1L3AvnyWAZRrlG","code": 0,"msg": "ok"
}

5. 短信状态

5.1 短信状态获取

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms/pull_status.json
  • 请求方式：GET

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
pageSizefalseString每次可获取短信状态的号码数量 默认20 最大10050

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataList返回数据结果
midString消息IDYJ1L3AvnyWAZRrlG
mobileString手机号18968192960
receiveTimeString状态时间2024-04-10 15:49:22
reportStatusString发送状态值, SUCCESS, FAILSUCCESS
reportDetailString发送状态详情DELIVRD

Json响应示例

{"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"
}

6. 上行

6.1 上行获取

请求

  • URL：https://api.xingkongqixin.com/api/v1/sms//pull_reply.json
  • 请求方式：GET

请求参数

参数名是否必填类型描述示例
apikeytrueString短信账号keye5d692ecdfbb6cd4f21ae7a92cc2a2bb
pageSizefalseString每次可获取短信状态的号码数量 默认20 最大10050

响应

名称类型描述示例
codeIntegercode为0，表示成功，其他请参考返回值说明0
msgString返回结果说明ok
dataList返回数据结果
midString消息IDYJ1L3AvnyWAZRrlG 注意（mid+mobile组成唯一）
mobileString手机号15380403942
contentString状态回复内容1712738071639
replyTsLong回复时间SUCCESS

Json响应示例

{"data": [{"mid": "YJ1L3AvnyWAZRrlG","mobile": "15380403942","content": "YlH2T4","replyTs": 1712738071639},{"mid": "YJ1L3AvnyWAZRrlG","mobile": "18968192968","content": "YlH2T4","replyTs": 1712738071639}],"code": 0,"msg": "ok"
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/820620.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

说说你对集合的理解？常见的操作有哪些？

说说你对集合的理解？常见的操作有哪些？

一、是什么 集合（Set），指具有某种特定性质的事物的总体，里面的每一项内容称作元素 在数学中，我们经常会遇到集合的概念： 有限集合：例如一个班集所有的同学构成的集合无限集合：例如…
阅读更多...
LangChain入门：19.探索结构化工具对话

LangChain入门：19.探索结构化工具对话

引言 在人工智能的浪潮中，对话代理技术正逐渐成为企业和开发者关注的焦点。LangChain，作为对话代理领域的一颗新星，自2021年9月诞生以来，以其强大的功能和灵活的应用场景迅速赢得了市场的认可。本文将带你深入了解LangChain中的S…
阅读更多...
智慧公厕厂家，众多智慧公厕精品工程解读

智慧公厕厂家，众多智慧公厕精品工程解读

智慧公厕，作为现代城市建设中的重要组成部分，正以其智能化、信息化的特点逐渐引起人们的关注。 一、什么是智慧公厕？ 智慧公厕是什么？智慧公厕通过物联网、大数据、云计算、网络通信、自动化控制等技术，监测公厕内部…
阅读更多...
深度学习知识点：卷积神经网络（CNN）

深度学习知识点：卷积神经网络（CNN）

深度学习知识点：卷积神经网络（CNN） 前言卷积神经网络（CNN）卷积神经网络的结构Keras搭建CNN经典网络分类LeNetAlexNetAlexNet 对比LeNet 的优势？ VGGVGG使用2个33卷积的优势在哪里？每层卷积是否只…
阅读更多...
pip如何查看Python某个包已发行所有版本号？

pip如何查看Python某个包已发行所有版本号？

以matplotlib包为例子， pip install matplotlib6666 6666只是胡乱输入的一个数，反正输入任意一个不像版本号的数字都可以～ matplotlib所有版本号如下， 0.86, 0.86.1, 0.86.2, 0.91.0, 0.91.1, 1.0.1, 1.1.0, 1.1.1, 1.2.0, 1.2.1…
阅读更多...
Web前端开发——Ajax，Axios概述及在Vue框架中的使用

Web前端开发——Ajax，Axios概述及在Vue框架中的使用

前言： 整理下学习笔记，打好基础，daydayup!!! Ajax Ajax是什么？ Ajax全称Asynchromous JavaScript And Xml，是异步的JavaScript和Xml。 Ajax的作用？ 1，数据交换：通过Ajax可以给服务器…
阅读更多...
Python统计分析库之statsmodels使用详解

Python统计分析库之statsmodels使用详解

概要 Python statsmodels是一个强大的统计分析库，提供了丰富的统计模型和数据处理功能，可用于数据分析、预测建模等多个领域。本文将介绍statsmodels库的安装、特性、基本功能、高级功能、实际应用场景等方面。 安装 安装statsmodels库非常简单，可以使用pip命令进行安装：…
阅读更多...
交通部 JT/T 808（809 1076 1078 ）车辆卫星定位系统 通信协议介绍

交通部 JT/T 808（809 1076 1078 ）车辆卫星定位系统 通信协议介绍

1 行业标准协议 1.1 官方网站 交通运输标准化信息系统 (mot.gov.cn) 附上官方下载地址： JT/T 808-2019 道路运输车辆卫星定位系统 终端通信协议及数据格式 JT/T 809-2019 道路运输车辆卫星定位系统 平台数据交换 JT/T 1076-2016 道路运输车辆卫星定位系统 车…
阅读更多...
zehpyr环境搭建和demo的编译

zehpyr环境搭建和demo的编译

qemu可执行固件编译的探索 环境demo的模拟SDK构建zephyr环境设置安装依赖项下载 Aspeed Zephyr 软件包 安装工具链配置 环境 ubuntu22.04、 qemu9.0.0-rc1、cmake 3.25.2、python 3.8.10、dtc 1.5.0、west 1.2.0、zephyr-sdk-0.16.1 demo的模拟 首先先尝试一个可以正常跑起来…
阅读更多...
C#学习笔记11：winform上位机与西门子PLC网口通信_下篇

C#学习笔记11：winform上位机与西门子PLC网口通信_下篇

今日终于到了winform上位机与西门子PLC网口通信的系列收为阶段了，一直没一口气更新完，手头上也没有可以测试用的PLC设备，虚拟仿真用到的博图软件也不想下载（会让我电脑变卡）。 于是等了些日子购买西门子PLC&#xff0…
阅读更多...
软件测试的4个职业阶段，你在哪个阶段？

软件测试的4个职业阶段，你在哪个阶段？

最近一直在忙的项目刚刚上线交付完成，让自己有了些许喘息的时间。人总是这样，在忙碌的时候，能心无旁骛关注并做好一件事，已是万幸。而全力而为之后的闲暇总是如此的珍贵，在这难得的空隙中，不自觉的开始对自…
阅读更多...
自动化测试-如何优雅实现方法的依赖

自动化测试-如何优雅实现方法的依赖

在复杂的测试场景中，常常会存在用例依赖，以一个接口自动化平台为例，依赖关系： 创建用例 --> 创建模块 --> 创建项目 --> 登录。 用例依赖的问题 • 用例的依赖对于的执行顺序有严格的要求，比如让被依赖的方…
阅读更多...
市面上加密混淆软件的比较和推荐

市面上加密混淆软件的比较和推荐

引言 市面上有许多加密混淆软件可供开发者使用，但哪些软件是最好用的？哪些软件受到开发者的喜爱？本文将根据一次在CSDN上的投票结果，为大家介绍几款在程序员中普及度较高的加密软件。以下是投票结果，希望能对大家的选择…
阅读更多...
JSON数据格式讲解与cJSON库的使用

JSON数据格式讲解与cJSON库的使用

文章目录 写在前面一、安装cJSON二、使用cJSON1、使用的文件2、如何传输数据：**** 三、JSON语法四、cJSON函数讲解1、cJSON结构体 **2、cJSON结构体与字符串之间的转换（重要）2.1、标题将cJSON结构体转换为字符串(常用)2.2、将字符串转为cJSON…
阅读更多...
看看《MATLAB科研绘图与学术图表绘制从入门到精通》示例：绘制山鸢尾萼片长度和萼片宽度的小提琴图

看看《MATLAB科研绘图与学术图表绘制从入门到精通》示例：绘制山鸢尾萼片长度和萼片宽度的小提琴图

使用MATLAB绘制鸢尾花数据集（ fisheriris）中山鸢尾（ Iris Setosa）的萼片长度和 萼片宽度的小提琴图。这将帮助我们更好地了解山鸢尾的这两个特征的数据分布情况，包括它们的 中位数、四分位范围及密度估计。这种可视化工…
阅读更多...
华为配置路由式Proxy ARP示例

华为配置路由式Proxy ARP示例

配置路由式Proxy ARP示例 组网图形 图1 配置路由式Proxy ARP组网图 路由式Proxy ARP简介配置注意事项组网需求配置思路操作步骤配置文件 路由式Proxy ARP简介 企业内部进行子网划分时，可能会出现两个子网网络属于同一网段，但是却不属于同一物理网络的情…
阅读更多...
C++ 类模板分文件编写

C++ 类模板分文件编写

类模板分文件编写： 类模板成员函数 分文件编写 产生的问题以及解决方式是什么呢？ 问题描述 类模板中**成员函数**创建时机是在**调用**阶段，导致分文件编写时**链接**不到 解决方案： 1、直接包含.cpp源文件： person…
阅读更多...
【重磅更新】开源表单系统填鸭表单v5版发布！

【重磅更新】开源表单系统填鸭表单v5版发布！

亲爱的TDucker，你们好。 真诚感谢您对填鸭表单的关注与支持。今天我们将为您带来新版本的更新说明，以便您更好的使用我们的产品。 社区版版V5更新概览： ✅ 增加WebHook数据推送功能，集成TReport实现数据大屏展示。 ✅ 增加主题…
阅读更多...
LeetCode-Java：303、304区域检索（前缀和）

LeetCode-Java：303、304区域检索（前缀和）

文章目录 题目303、区域和检索（数组不可变）304、二维区域和检索（矩阵不可变） 解①303，一维前缀和②304，二维前缀和 算法前缀和一维前缀和二维前缀和 题目 303、区域和检索（数组不可变&#xff…
阅读更多...
DateTimeFormat 和 JsonFormat 应用场景详解

DateTimeFormat 和 JsonFormat 应用场景详解

博主猫头虎的技术世界 🌟 欢迎来到猫头虎的博客 — 探索技术的无限可能！ 专栏链接： 🔗 精选专栏： 《面试题大全》 — 面试准备的宝典！《IDEA开发秘籍》 — 提升你的IDEA技能！《100天精通鸿蒙》 …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站