第三方短信调用接口参数例子(精)

接口文档样例模板一、接口概述：本文档是针对XXX系统的接口文档，用于说明系统提供的各种接口的具体功能和使用方法。

二、接口列表：1.接口名称：用户登录接口请求方式：POST接口描述：用户使用用户名和密码进行登录验证，返回登录状态和用户信息。

请求参数：- username(string，必填)：用户输入的用户名。

- password(string，必填)：用户输入的密码。

返回参数：- status(string)：登录状态，值为"success"或"fail"。

- message(string)：登录状态描述信息。

- user_info(object)：用户信息，包括用户ID、昵称等。

请求示例：```json"username": "admin",}```返回示例：```json"status": "success","message": "登录成功","user_info":"user_id": 1,"nickname": "管理员"}}```2.接口名称：获取用户列表接口请求方式：GET接口描述：获取系统中所有用户的列表。

请求参数：无返回参数：- status(string)：获取状态，值为"success"或"fail"。

- message(string)：获取状态描述信息。

- user_list(array)：用户列表，包括用户ID、昵称等。

请求示例：无返回示例：```json"status": "success","message": "获取成功","user_list":"user_id": 1,"nickname": "管理员"},"user_id": 2,"nickname": "用户1"}}```三、接口调用说明：2. 接口调用前需确保用户已经获取到相应的access token，并将其作为请求头中的Authorization字段进行传递。

一信通企业信息服务平台接口手册目录一信通企业信息服务平台 (1)1.概述 (3)1.1编制目的 (3)1.2容概述 (3)1.3名称解释 (3)1.4参考文献 (3)2.短信 (4)2.1HTTP接口 (4)2.1.1消息协议 (4)2.1.2发送短信 (4)2.1.3回执接口 (5)2.1.4剩余短信条数查询 (6)2.1.5回复容接口 (7)2.2W EBSERVICE接口 (7)2.2.1消息协议 (7)2.2.2发送短信 (8)2.2.3回执接口 (9)2.2.4上行回复容查询接口 (9)2.2.5上行回复容确认接口 (10)2.2.6容审核 (11)修改历史1.概述1.1编制目的该接口文档手册编写在于描述易派企业信息服务平台UMS（以下简称UMS）具体的接口协议，供第三方系统能够顺利接入一信通短信网关。

1.2容概述本规主要讲了第三方系统接入短信通系统的协议要求，协议三大状态和协议指令的格式和响应信息。

1.3名称解释1.4参考文献2.短信2.1http接口2.1.1消息协议接口地址： guangdong.ums86.:8899/sms/Api/通过接口提交参数时, 参数容必须为GB2312 编码, 且经过url编码后的容。

例如:“您好”的url编码为“%C4%FA%BA%C3”接口返回的容是一些键值对的字符串集合，形式为:“k1=v1&k2=v2&k3=v3…”返回容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串。

例如:返回容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际容为“result=0&description=发送成功&faillist=”2.1.2发送短信功能描述：短信发送调用格式：对 guangdong.ums86.:8899/sms/Api/Send.do进行post返回格式: result=&description=错误描述&faillist=失败列表post参数说明：实际返回容为“result=0&description=发送成功”2.1.3回执接口功能描述：短信回执调用方式：ftp返回格式:文本文件ftp服务信息：返回文本文件格式:文件名:arrive_000139_25288_00f_6一行容：SPID=197258 MESSAGEID=910320f1 ID=2432901361 CALLMDN=2501 MDN= RESULT=0 DESC=DELIVRD ARRIVE_TIME=402Java解析这行的方法// 解析一行记录public static Properties parse(String line) {String parsePattern="([^=\t]+)=([^\t]*)";Matcher m = pile(parsePattern).matcher(line);Properties result = new Properties();while (m.find()) {String key = m.group(1).trim();String value = m.group(2).trim();result.put(key.toUpperCase(), value);}return result;}如果要获取取接受短信的则使用：String mdn= (String)result.get("MDN");即可其他字段类似方式2.1.4剩余短信条数查询功能描述：剩余短信条数查询接口调用格式：对guangdong.ums86.:8899/sms/Api/SearchNumber.do进行post返回格式: result=&description=错误描述&faillist=失败列表2.1.5回复容接口功能描述：将上行回复的容通过http协议进行post到企业方调用格式： url由企业方提供，然后对该url进行post,post的格式为xml,格式如下： <packet><reply><mdn></mdn><callmdn>111</callmdn><msg>回复容测试</msg><replytime>2012-01-01 00:00:00</replytime></reply></packet>返回格式:返回格式为xml,格式如下：<returncode>0</returncode>post参数说明：返回值:2.2Webservice接口2.2.1消息协议接口地址：guangdong.ums86.:8899/sms_hb/services/Sms?wsdl2.2.2发送短信功能描述：短信发送调用格式：利用webservice客户端进行http请求返回格式:SmsResponseSmsRequest请求参数说明：SmsResponse返回值:实际返回容为“result=0&description=发送成功”2.2.3回执接口功能描述：短信回执调用方式：利用webservice客户端进行http请求返回格式: ReportResponseReportRequest请求参数说明：ReportResponse返回值:实际返回容为“001,,0; 001,,0;001,,0;”2.2.4上行回复容查询接口功能描述：上行回复容查询调用方式：利用webservice客户端进行http请求返回格式: ReplyResponseReplyResponse返回值:2.2.5上行回复容确认接口功能描述：上行回复容查询调用方式：利用webservice客户端进行http请求返回格式: ReplyConfirmResponse ReplyConfirmRequestReplyConfirmResponse返回值:2.2.6容审核功能描述：短信发送调用格式：利用webservice客户端进行http请求返回格式:AuditingResponseAuditingRequest请求参数说明：AuditingResponse返回值:实际返回容为“result=0&description=短信容审核通过”。

举例说明接口数据提取常用参数及其作用1. 引言接口数据提取是现代互联网应用中不可或缺的一环。

通过接口数据提取，我们可以获取到各种资源，包括文本、图片、视频、音频等，帮助我们构建丰富多样的应用程序。

在接口数据提取过程中，常用参数起着至关重要的作用，它们能够帮助我们更精确地定位和获取所需的数据。

本文将以举例的方式来说明接口数据提取常用参数及其作用，让我们更深入地理解这一重要的主题。

2. 请求方法在接口数据提取中，最常用的参数之一就是请求方法。

常见的请求方法包括GET、POST、PUT、DELETE等。

不同的请求方法对应着不同的操作，比如GET用于获取资源，POST用于提交数据，PUT用于更新资源，DELETE用于删除资源。

通过使用不同的请求方法，我们可以实现对接口数据的不同操作，保障了数据的安全和完整性。

3. 请求URL请求URL是接口数据提取中另一个非常重要的参数。

通过请求URL，我们可以指定要访问的资源的位置区域，包括主机名、路径、查询参数等。

举个例子，当我们要获取某一篇文章的内容时，就可以通过请求URL来指定这篇文章的唯一位置区域，从而精确地获取到所需的数据。

4. 查询参数查询参数是在请求URL中使用的一种参数，用于限定请求的范围、排序方式、筛选条件等。

我们可以通过查询参数来指定要获取的数据数量、分页的页数、筛选的条件等，从而精确地获取到符合要求的数据。

5. 请求头部请求头部是在执行接口数据提取时需要注意的另一个关键参数。

在请求头部中，通常会包含一些重要的信息，如授权信息、数据类型、数据格式等。

通过请求头部，我们可以告诉接口服务器我们的身份和需要的数据格式，确保我们能够顺利地获取到所需的数据。

6. 请求体对于POST和PUT请求方法，请求体是必不可少的参数。

请求体中通常包含着要提交或更新的数据，比如表单数据、JSON数据等。

通过正确地构造请求体，我们可以将需要提交或更新的数据发送给接口服务器，实现对数据的操作。

短信上行接口
一、程序调用地址：合作方提供
二、调用方式：
MO接口采用HTTP GET方式
IP：61.135.159.23和61.135.159.155和61.135.158.233(如需IP鉴权用此ip) 参数说明：字段及解释
1.mobile------手机号
2.send_time------用户上行时间（YYYY-MM-DD HH:MM:SS）
3.msg------------用户发送内容 (会做urlencode,GB2312)
4.linkid-----------内部参数,关联上下行的(如需要则提供,否则可以不用)
5.longnum---------上行长代码
6.feecode------------------- 资费（资费，以分为单位）
注：URLEncode：一般为地址栏中的中文字加密时使用，转换后，原明文的汉字将变成加密字符串，但可被浏览器识别。

因为上行内容中有可能有空格或者中文什么的，怕传输有问题，所以我们这边先做encode传输
短信MR接口
一、程序调用地址：合作方提供
二、调用方式：
MR接口采用HTTP GET方式
IP：61.135.159.23 (如需IP鉴权用此ip)
传递参数包括三个：
1. linkid 匹配下行用的linkid
2.mobile 手机号
3. status 状态报告(0成功，1失败) 成功入库返回OK。

XXX短信二次开发接口说明（HTTP接口）用户：XXX密码：XXXX更改密码ChangePassword输入参数输出参数：调用方式：http://XXXXX:8080/ChangePassword.asp?Account=***&Password=***&NewPassword=*** 查询余额GetBalance输入参数输出参数：调用方式：http://XXXX:8080/GetBalance.asp?Account=***&Password=***&Channel=*** Channel代码：1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道群发短信 SendSMS（返回状态报告ID）输入参数：输出参数：备注：这个功能执行成功返回的id号作为批号，记录后，使用GetReport功能可以获取到该发送批号和这批内的各手机号的状态报告。

调用方式：http://XXXX:8000/SendSms.asp?Account=***&Password=***&Phones=***&Content=***&Channel=***& SendTime=*Channel代码：1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道接收短信发送状态报告接口 GetReport输入参数输出参数：返回格式为：ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||' ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||'……调用方式：http://XXXX:8000/GetReport.asp?Account=***&Password=***接收短信 GetMessage输入参数输出参数：返回格式为：手机号$$$$上行内容$$$$发送时间||||手机号$$$$上行内容$$$$发送时间||||……调用方式：http://XXX:8000/GetMessage.asp?Account=***&Password=***。

发送短信稳定的短信API来啦稳定的短信API，99%到达率，及时响应，请务必添加图片验证码等防恶意攻击的机制，以防短信轰炸。

！注意：同1个号码同1个签名的内容30秒内只能发1条，1分钟内只能发2条，30分钟内只能发3条，详细请参考：/news/index/id/50接口名称：短信api接口平台：聚合数据接口地址：/sms/send支持格式：json/xml请求方式：http get请求示例：/sms/send?mobile=手机号码&tpl_id=短信模板ID&tpl_value=%23code%23%3D654654&key=请求参数说明：名称类型必填说明mobile string 是接收短信的手机号码tpl_id int 是短信模板ID，请参考个人中心短信模板设置tpl_value string 是变量名和变量值对，如：#code#=431515，整串值需要urlencode。

如果你的变量名或者变量值中带有#&=中的任意一个特殊符号，请先分别进行utf-8 urlencode编码后再传递key string 是应用APPKEY(应用详细页查询)dtype string 否返回数据的格式,xml或json，默认json 返回参数说明：名称类型说明error_code int 返回码reason string 返回说明短信api调用JSON返回示例：/****失败示例**/{"reason": "错误的短信模板ID,请通过后台确认!!!","result": [],"error_code": 205402}/****成功示例**/{"reason": "短信发送成功","result": {"count": 1, /*发送数量*/"fee": 1, /*扣除条数*/"sid": 2029865577 /*短信ID*/ },"error_code": 0 /*发送成功*/}。

短信验证码接⼝（腾讯云接⼝）短信验证码接⼝（腾讯云接⼝）# 需要安装 pip3 install qcloudsms_py#验证码调⽤格式 MSM("⼿机号",'⽤户名','验证码')def MSM(phone,name,number):from qcloudsms_py import SmsSingleSenderfrom qcloudsms_py.httpclient import HTTPError# 短信应⽤SDK AppIDappid = 1400199796 # SDK AppID是1400开头# 短信应⽤SDK AppKeyappkey = "bd689fdebed71444e976e29ae7fc5df8"# 需要发送短信的⼿机号码phone_numbers = [phone]# 短信模板ID，需要在短信应⽤中申请template_id = 999999 #312472# 欢迎使⽤个⼈购物车系统您的⽤户名为{3}，如果不是请重新注册，{1}为您的验证码，请于{2}分钟内填写，谢谢使⽤！# 签名sms_sign = "李强⽯头剪⼑布"ssender = SmsSingleSender(appid, appkey)params = [number,'2',name] # 当模板没有参数时，`params = []`，数组具体的元素个数和模板中变量个数必须⼀致，例如事例中templateId:5678对应⼀个变量，参数数组中元素个数也必须是⼀个 result = ssender.send_with_param(86, phone_numbers[0],template_id, params, sign=sms_sign, extend="",ext="") # 签名参数未提供或者为空时，会使⽤默认签名发送短信return Trueif __name__ == '__main__':MSM("188********", '⽤户名', '142345')。

PHP开发调⽤阿⾥云短信验证码的代码-直接可⽤1：最低要求 PHP 5.62：安装了composer3：阿⾥云composer镜像地址命令（如果设置过就不需要）:composer config -g repo.packagist composer https:///composer/4：安装 SDK 核⼼库 OpenAPI ： Alibaba Cloud SDK for PHP 作为依赖项：composer require alibabacloud/darabonba-openapi5：阿⾥云短信SDK安装包命令（官⽅地址：https:///api-tools/sdk/Dysmsapi）：composer require alibabacloud/dysmsapi-20170525 2.0.8<?php// This file is auto-generated, don't edit it. Thanks.namespace lib;use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;use Darabonba\OpenApi\Models\Config;class aliyunSms{private static $accessKeyId = 'LTAI5t7AC3RH3333pZTDCaA3';//accessKeyIdprivate static $accessKeySecret = 'ihDUcyqNZvNYXASfLtijI33333NSk';//accessKeySecretprivate static $signName = 'xxxx技有限公司';//签名private static $templateCode = 'SMS_228533331';//模板代码/*** 使⽤AK&SK初始化账号Client* @param string $accessKeyId* @param string $accessKeySecret* @return Dysmsapi Client*/private static function createClient($accessKeyId, $accessKeySecret){$config = new Config([// 您的AccessKey ID"accessKeyId" => $accessKeyId,// 您的AccessKey Secret"accessKeySecret" => $accessKeySecret]);// 访问的域名$config->endpoint = "";return new Dysmsapi($config);}/*** @param string $phoneNumbers ⼿机号* @param string $code 验证码* @return void*/// public static function main($args)private static function main($phoneNumbers, $code){$client = self::createClient(self::$accessKeyId, self::$accessKeySecret);$sendSmsRequest = new SendSmsRequest(["templateParam" => "{\"code\":\"{$code}\"}","phoneNumbers" => "{$phoneNumbers}","signName" => self::$signName,"templateCode" => self::$templateCode]);$ali_res = $client->sendSms($sendSmsRequest);if ($ali_res->body->code == 'OK' && $ali_res->body->bizId != NULL) {return true;}switch ($ali_res->body->code) {case 'isv.BUSINESS_LIMIT_CONTROL':exception('短信发送频繁，请稍候再试');//tp的抛出错误，换成你⾃⼰的报错break;case 'isv.TEMPLATE_PARAMS_ILLEGAL':exception('短信验证码不符合变量规范');//tp的抛出错误，换成你⾃⼰的报错break;case 'isv.MOBILE_NUMBER_ILLEGAL':exception('⼿机号不正确，⽆法发送短信');//tp的抛出错误，换成你⾃⼰的报错break;}//少见的错误，记录下来//log_err($ali_res->body, '发送短信发⽣错误', 'ali_sms');//换成你的exception($ali_res->body->message);//tp的抛出错误，换成你⾃⼰的报错// 以下是阿⾥云短信正确和失败返回的数据，以作参考// 失败演⽰返回数据/* object(AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsResponseBody)#81 (6) {["bizId"] => NULL["code"] => string(24) "isv.SMS_TEMPLATE_ILLEGAL"["message"] => string(38) "模板不合法(不存在或被拉⿊)"["requestId"] => string(36) "21A90D61-2D5E-533D-BFE7-9D16F8312A0E"["_name":protected] => array(4) {["bizId"] => string(5) "BizId"["code"] => string(4) "Code"["message"] => string(7) "Message"["requestId"] => string(9) "RequestId"}["_required":protected] => array(0) {}}*/// 成功返回数据演⽰/* object(AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsResponseBody)#81 (6) {["bizId"] => string(20) "839015438514162136^0"["code"] => string(2) "OK"["message"] => string(2) "OK"["requestId"] => string(36) "EA37C2B7-E427-59F8-8B7C-06AD846A5439"["_name":protected] => array(4) {["bizId"] => string(5) "BizId"["code"] => string(4) "Code"["message"] => string(7) "Message"["requestId"] => string(9) "RequestId"}["_required":protected] => array(0) {}}*/}//发短信public static function sendSms($phoneNumbers, $code){$res = self::main($phoneNumbers, $code);return $res;}}此代码只需要修改命名空间和阿⾥云accessKeyId等相关信息，即可使⽤~exception是TP的错误异常抛出，我是做了全局的异常托管，并且在所有报错的地⽅调⽤此⽅法就能终端代码，报出错误，你只需要换成你的中断代码返回错误即可。

http短信接口
HTTP短信接口是一种通过HTTP协议发送和接收短信的方式。

它可以实现在互联网上用HTTP通信协议发送短信，并且可以接收短信服务商返回的状态报告。

使用HTTP短信接口发送短信，通常需要提供以下参数：
1. 请求URL：短信服务商提供的API接口地址。

2. 账号和密码：短信服务商提供的账号和密码，用于进行身份验证。

3. 手机号码：短信的接收者手机号码。

4. 短信内容：需要发送的短信内容。

发送短信时，需要将以上参数以指定的格式组装成HTTP 请求，发送到短信服务商的接口地址。

短信服务商接收到请求后，会根据提供的账号和密码进行身份验证，并将短
信内容发送给指定的手机号码。

发送成功后，短信服务商会返回一个接口响应，通知发送结果。

需要注意的是，不同的短信服务商可能有不同的HTTP请求参数和参数格式，具体使用方法需要参考短信服务商提供的接口文档或示例代码。