API详情
所有文档

          简单消息服务 SMS

          API详情

          如果您是初次调用百度智能云产品的API,可以观看API入门视频指南,快速掌握调用API的方法。

          短信发送和状态回调

          短信下发

          描述

          实现短信下发功能,一次支持提交多个手机号。

          注意:

          下发短信前,需要先申请签名和短信模板,并通过审核。

          URL

          /api/v3/sendSms

          HTTP Method

          POST

          请求Body参数

          参数名称 类型 是否必需 描述 示例
          mobile String 手机号码,支持单个或多个手机号,多个手机号之间以英文逗号分隔,一次请求最多支持200个手机号。国际/港澳台号码请按照E.164规范表示,例如台湾手机号以+886开头,”+“不能省略。 13800138000,13800138001,+886951234567
          template String 短信模板ID,模板申请成功后自动创建,全局内唯一 sms-tmpl-KyAUkV64619
          signatureId String 短信签名ID,签名表申请成功后自动创建,全局内唯一 sms-signQxkiwz88470
          contentVar JsonObject 模板变量内容,用于替换短信模板中定义的变量 {"param1":"123","param2":"abc"}
          custom String 用户自定义参数,格式为字符串,状态回调时会回传该值 -
          userExtId String 通道自定义扩展码,上行回调时会回传该值,其格式为纯数字串。默认为不开通,请求时无需设置该参数。如需开通请联系SMS帮助申请 123

          请求Query参数

          参数名称 类型 是否必需 描述 示例
          clientToken String 幂等性参数,避免client在http响应超时而重试时出现同一条短信多次发送的情况 -

          什么是E.164?

          E.164是由国际电信联盟(International Telecommunication Union,简称ITU)发布的一种国际号码表示方法。一个完整的E.164规范号码由[+][国家或地区码][地区内号码]三部分组成。

          示例:

          国家或地区 国家或地区码 地区内号码 E.164表示
          中国台湾 886 7751875413 +8867751875413
          美国 1 4155552971 +14155552971
          英国 44 2071236750 +442071236750

          响应参数

          参数名称 类型 描述
          requestId String 发送请求的唯一流水ID
          code String 请求提交状态,1000表示成功
          message String 请求提交状态描述
          data List SendMessageItem数组,一个SendMessageItem对应一个手机号的响应结果

          SendMessageItem定义

          参数名称 类型 描述
          mobile String 手机号
          code String 对应手机号的提交状态,1000表示成功
          messgage String 对应手机号的响应结果描述
          messageId String 对应手机号的消息ID

          HTTP请求示例

          POST http://smsv3.bj.baidubce.com/api/v3/sendSms?clientToken=e325ea68-02c1-47ad-8844-c7b93cafaeba
          Authorization: bce-auth-v1/626e6a284eac4e3f97cc30b38ffea6a4/2019-12-04T06:53:12Z/3600/host;x-bce-console-rpc-id;x-bce-date/d3a5b16483e4d999ce705cb3a8a2f30b728adcd422787a4bd2618b4e215c0327
          Content-Type: application/json
          Host: smsv3.bj.baidubce.com
          x-bce-date: 2019-12-04T06:53:12Z
          
          {
            "mobile": "13800138000",
            "template": "sms-tmpl-awKvRY85349",
            "signatureId": "sms-signQxkiwz88470",
            "contentVar": {
              "code": "23456",
              "minute": "1"
            }
          }

          成功响应示例

          HTTP/1.1 200 OK
          Content-Length: 218
          Content-Type: application/json;charset=UTF-8
          Date: Wed, 04 Dec 2019 06:53:13 GMT
          X-Bce-Request-Id: 5e6dacd5-8815-4183-8255-4ff079bf24e6
          
          {
            "requestId": "5e6dacd5-8815-4183-8255-4ff079bf24e6",
            "code": "1000",
            "message": "成功",
            "data": [
              {
                "code": "1000",
                "message": "成功",
                "mobile": "13800138000",
                "messageId": "e325ea68-02c1-47ad-8844-c7b93cafaeba_13800138000"
              }
            ]
          }

          状态回调

          描述

          将短信下发的状态报告通过回调业务方服务地址的方式告知业务方。

          URL

          由业务方提供。用户可以在“开发配置“中设置自己的上行回调地址

          HTTP Method

          POST

          HTTP Header

          头域(Header) 示例值 说明
          Content-Type application/json;charset=utf-8 -
          requestId 54eb30d9-fead-4048-bb8b-200cf12ab8e9 本次推送对应的消息id.客户端可以根据该字段去重
          timestamp 1462774903112 推送时间戳
          signature 693b669f77f9c19030466263144646a 该字段为推送时的认证字段。客户端可以根据该字段进行认证。算法:md5(token + timestamp + body),其中body为状态推送请求的request body token为客户对应的唯一标示,若为空则不参与签名的生成。加密过程请参考:MD5加密代码示例

          请求参数

          名称 类型 是否必需 备注
          code String 0-发送成功,2-发送失败
          requestId String 请求id,与短信发送请求中的requestId对应
          messageId String 短信消息id
          mobile String 手机号
          carrierCode String 运营商原生状态码
          custom String 用户在发送请求中自定义的参数
          attemptCount int 尝试推送的次数,推送失败时会重试3次。无重试则为1
          segmentCount int 短信拆分后的条数
          deliverTime String 抵达时间,UTC时间
          requestTime String 请求时间,UTC时间

          响应参数

          响应参数由业务方自定义。百度云SMS会根据回调响应中的HTTP Status来判断是否回调成功,Status为200表示回调成功,非200表示回调失败。

          回调重试策略

          由于网络原因导致的推送失败(如连接超时等),SMS会启动重试策略。重试策略:推送失败,立即重试3次,失败后,间隔一个小时重试一次,最大重试次数是10次,超过最大重试次数停止重试。基于此重试策略,对于同一个messageId可能会重复推送,建议用户忽略第二次收到的状态推送请求,以避免重复处理。

          其他注意事项

          注意百度云SMS的回调请求源IP和端口均不固定,建议业务方不要对回调地址设置IP白名单。

          状态回调请求示例

          POST /your/callback/url HTTP/1.1
          signature: 4eaca69ae63c4b823653c671f1eb5fa5
          requestId: 71bdbef0ac8847378da21ecb142a14e7
          timestamp: 1597320812102
          Content-Type: application/json;charset=utf-8
          
          {
              "requestTime":"2019-12-03T22:53:00Z",
              "deliverTime":"2019-12-03T22:53:05Z",
              "code":"0",
              "requestId":"a6d5f1d9ca2048e5a5454e75da1db563",
              "custom":"example custom",
              "carrierCode":"DELIVRD",
              "mobile":"13800138000",
              "messageId":"c5366f96477b49ca90bcdff2516fe521"
          }

          响应示例

          HTTP/1.1 200 OK
          Content-Length: 50
          Content-Type: aplication/json;charset=UTF-8
          Date: Wed, 04 Dec 2019 06:53:13 GMT

          MD5加密示例

          import org.apache.commons.codec.digest.DigestUtils;
          
          public static void main(String... args) {
              String token = "dfb97fb8170a539acd576b710877c2b0";
              String timestamp = "1597320812102";
              String body = "{\"requestId\":\"6373df1f-3465-454e-a745-0de13154cf67\",\"messageId\":\"6373df1f-3465-454e-a745-0de13154cf67_13060412623\",\"mobile\":\"13800138000\",\"code\":\"0\",\"requestTime\":\"2020-08-13T12:13:14Z\",\"deliverTime\":\"2020-08-13T12:13:32Z\",\"custom\":null,\"carrierCode\":\"DELIVRD\",\"attemptCount\":1,\"segmentCount\":2}";
              String signature = DigestUtils.md5Hex(token + timestamp + body);
              System.out.println(signature);
              // 输出为:34d38bbfef1c471a951a4019561139fb
          }

          上行回调

          描述

          将用户收到短信后所回复的内容通过回调请求告知业务方。

          URL

          由业务方提供。用户可在“开发配置”中设置自己的上行回调地址

          HTTP Method

          POST

          HTTP Header

          参考“状态回调”的HTTP Header部分

          请求参数

          名称 类型 是否必需 描述
          mobile String 手机号
          content String 内容
          sign String 签名
          receiveTime String 接收时间,UTC时间
          userExtId String 通道自定义扩展码,默认不开通,为空。

          响应参数

          响应参数由客户侧提供。百度云SMS会根据回调响应中的HTTP Status来判断是否回调成功,Status为200表示回调成功,非200表示回调失败。

          上行回调请求示例

          {
          	"mobile":"13800138000",
          	"content":"TD",
          	"sign":"百度云",
          	"receiveTime":"2019-12-03T22:53:05Z"
          }

          响应示例

          HTTP/1.1 200 OK
          Content-Length: 50
          Content-Type: aplication/json;charset=UTF-8
          Date: Wed, 04 Dec 2019 06:53:13 GMT

          短信签名

          申请签名

          URL

          /sms/v3/signatureApply?clientToken={clientToken}

          HTTP Method

          POST

          请求Body参数

          参数名称 类型 是否必需 描述 取值示例
          content String 签名内容 百度
          contentType String 签名类型。
          Enterprise:企业
          MobileApp:移动应用名称
          Web:工信部备案的网站名称
          WeChatPublic:微信公众号名称
          Brand:商标名称
          Else:其他
          Enterprise
          description String 对于签名的描述 -
          countryType String 签名适用的国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球均适用
          默认为DOMESTIC
          DOMESTIC
          signatureFileBase64 String 签名的证明文件经过base64编码后的字符串。文件大小不超过2MB。 -
          signatureFileFormat String 签名证明文件的格式,目前支持JPG、PNG、JPEG三种格式 JPG

          请求Query参数

          参数名称 类型 是否必需 描述 取值示例
          clientToken String 幂等性参数 e15d930e-b132-460d-a61b-6086f117df18

          响应参数

          参数名称 类型 描述
          signatureId String 签名ID,唯一标识一个签名
          status String 签名状态

          HTTP请求示例

          POST /sms/v3/signatureApply?clientToken=f744db7f-6609-4b91-9736-dab129434371 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-13T13:27:03Z/1800/host;x-bce-date/7d0555ab7d4c59c755464b191ca7f5021c234bf07fe7ba8a6914a2654f9601be
          Content-Type: application/json
          x-bce-date: 2020-08-13T13:27:03Z
          Content-Length: 184
          
          {
            "content": "Baidu",
            "contentType": "Enterprise",
            "description": "test sdk",
            "countryType": "DOMESTIC",
            "signatureFileBase64": "test-string-base64encoded",
            "signatureFileFormat": "png"
          }

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: d6014140-f067-4b3c-af0f-3e876edfb689
          Cache-Control: no-cache
          Date: Thu, 13 Aug 2020 13:27:04 GMT
          
          {
            "signatureId": "sms-sign-WWejWQ54455",
            "status": "SUBMITTED"
          }

          变更签名

          URL

          /sms/v3/signatureApply/{signatureId}

          HTTP Method

          PUT

          请求Body参数

          参数名称 类型 是否必需 描述 取值示例
          content String 签名内容 百度
          contentType String 签名类型。
          Enterprise:企业
          MobileApp:移动应用名称
          Web:工信部备案的网站名称
          WeChatPublic:微信公众号名称
          Brand:商标名称
          Else:其他
          Enterprise
          countryType String 签名适用的国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球均适用
          DOMESTIC
          description String 签名描述
          signatureFileBase64 String 签名的证明文件经过base64编码后的字符串。文件大小不超过2MB。 -
          signatureFileFormat String 签名证明文件的格式,目前支持JPG、PNG、JPEG三种格式 JPG

          请求Url参数

          参数名称 类型 是否必需 描述 取值示例
          signatureId String 签名ID,唯一标识一个签名 sms-sign-WWejWQ54455

          响应参数

          void

          HTTP请求示例

          PUT /sms/v3/signatureApply/sms-sign-WWejWQ54455 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-13T13:27:03Z/1800/host;x-bce-date/7d0555ab7d4c59c755464b191ca7f5021c234bf07fe7ba8a6914a2654f9601be
          Content-Type: application/json
          x-bce-date: 2020-08-13T13:27:03Z
          Content-Length: 184
          
          {
            "content": "Baidu",
            "contentType": "Enterprise",
            "description": "test sdk",
            "countryType": "DOMESTIC",
            "signatureFileBase64": "test-string-base64encoded",
            "signatureFileFormat": "png"
          }

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: 4a820409-f3ad-4c65-b49e-a984a8bb5cb1
          Cache-Control: no-cache
          Date: Thu, 13 Aug 2020 13:27:04 GMT
          Server: BWS

          查询签名

          URL

          /sms/v3/signatureApply/{signatureId}

          HTTP Method

          GET

          请求url参数

          参数名称 类型 是否必需 描述 取值示例
          signatureId String 签名ID,唯一标识一个签名 sms-sign-WWejWQ54455

          响应参数

          参数名称 类型 描述
          signatureId String 签名ID,唯一标识一个签名
          userId String 签名所属的用户百度云账号
          content String 签名内容
          contentType String 签名类型。
          Enterprise:企业
          MobileApp:移动应用名称
          Web:工信部备案的网站名称
          WeChatPublic:微信公众号名称
          Brand:商标名称
          Else:其他
          status String 审核状态。
          SUBMITTED:申请已提交
          APPROVED:审核通过,但还不用
          REJECTED:审核拒绝
          READY:申请通过,签名可用
          ABORTED:审核取消
          countryType String 签名适用的国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球均适用
          review String 审核意见

          HTTP请求示例

          GET /sms/v3/signatureApply/sms-sign-WWejWQ54455 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T03:11:49Z/1800/host/8c4d6cbf29b74e491be2283e6237b8312f4a7f7c843350f51c0c6a2fffcfc0de
          Date: Fri, 14 Aug 2020 03:11:49 GMT
          Content-Type: application/json; charset=utf-8
          Connection: Keep-Alive

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: 859c245e-8df7-48bd-81e6-6e48e69d28f3
          Content-Type: application/json;charset=UTF-8
          Date: Fri, 14 Aug 2020 03:11:49 GMT
          Server: BWS
          
          {
            "signatureId": "sms-sign-WWejWQ54455",
            "userId": "bbede3f8c42e4113b6971fd09a57f494",
            "content": "Baidu",
            "contentType": "MobileApp",
            "description": "test sdk",
            "review": "",
            "status": "SUBMITTED",
            "countryType": "GLOBAL",
          }

          删除签名

          URL

          /sms/v3/signatureApply/{signatureId}

          HTTP Method

          DELETE

          请求Url参数

          参数名称 类型 是否必需 描述 取值示例
          signatureId String 签名ID,唯一标识一个签名 sms-sign-WWejWQ54455

          响应参数

          void

          HTTP请求示例

          DELETE /sms/v3/signatureApply/sms-sign-WWejWQ54455 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T03:26:59Z/1800/host/5bfc0a708d3894859be4093319ddd48027300c81212332d5f0fa2cbc667f603c
          Date: Fri, 14 Aug 2020 03:26:59 GMT
          Content-Type: application/json; charset=utf-8
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate

          响应成功示例

          HTTP/1.1 200 OK
          
          x-bce-request-id: e15d930e-b132-460d-a61b-6086f117df18
          Cache-Control: no-cache
          Date: Fri, 14 Aug 2020 03:26:59 GMT
          Server: BWS

          短信模板

          创建模板

          URL

          /sms/v3/template?clientToken={clientToken}

          HTTP Method

          POST

          请求Body参数

          参数名称 类型 是否必需 描述 取值示例
          name String 模板名称 假日活动大促营销短信模板
          content String 模板内容 您的验证码是${code},将在${minutes}分钟后失效。
          smsType String 短信类型。见下方短信类型参数说明。 CommonNotice
          countryType String 适用国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球
          DOMESTIC
          description String 模板描述 -

          请求Query参数

          参数名称 类型 是否必需 描述 取值示例
          clientToken String 幂等性参数 7aba2f19-43fb-4bcb-aa9f-912585ffe43d

          响应参数

          参数名称 类型 描述
          templateId String 模板ID,用于唯一标识一个模板
          status String 模板这边黄台

          短信类型参数说明

          smsType 名称
          CommonSale 普通营销
          CommonVcode 普通验证码
          CommonNotice 普通通知
          ExpressVcode 物流验证码
          ExpressNotice 物流通知
          FinanceSale 传统金融营销
          FinanceVcode 传统金融验证码
          FinanceNotice 传统金融通知
          ItfinSale 互联网金融营销
          ItfinVcode 互联网金融验证码
          ItfinNotice 互联网金融通知
          CreditcardSale 信用卡营销
          CreditcardVcode 信用卡验证码
          CreditcardNotice 信用卡通知
          CollectionNotice 催收通知
          GameSale 游戏营销
          GameVcode 游戏验证码
          GameNotice 游戏通知
          GamesSale 小游戏营销
          GamesVcode 小游戏验证码
          GamesNotice 小游戏通知
          EducationSale 教育营销
          EducationVcode 教育验证码
          EducationNotice 教育通知
          EcSale 电商营销
          EcVcode 电商验证码
          EcNotice 电商通知

          HTTP请求示例

          POST /sms/v3/template?clientToken=7aba2f19-43fb-4bcb-aa9f-912585ffe43d HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T03:37:35Z/1800/host;x-bce-date/864b39a36411f975c1a9781ee748f19c17cbba94fb050551a15f9f9971ea9bba
          User-Agent: bce-sdk-java/0.10.108/Mac_OS_X/10.15.2/Java_HotSpot(TM)_64-Bit_Server_VM/25.192-b12/1.8.0_192/zh/
          Date: Fri, 14 Aug 2020 03:37:35 GMT
          Content-Type: application/json
          x-bce-date: 2020-08-14T03:37:35Z
          Content-Length: 129
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate
          
          {
            "name": "My test template",
            "content": "您的验证码是${code}",
            "smsType": "CommonNotice",
            "countryType": "GLOBAL",
            "description": "test sdk create"
          }

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: b5f77216-e9a5-4c2e-a6ab-12127e5e3e5f
          Cache-Control: no-cache
          Content-Type: application/json;charset=UTF-8
          Transfer-Encoding: chunked
          Date: Fri, 14 Aug 2020 03:37:35 GMT
          Server: BWS
          
          {
            "templateId": "sms-tmpl-wHoJXL09355",
            "status": "SUBMITTED",
          }

          变更模板

          URL

          /sms/v3/template/{templateId}

          HTTP Method

          PUT

          请求Body参数

          参数名称 类型 是否必需 描述 取值示例
          name String 模板名称 测试营销模板
          content String 模板内容 您的验证码是${code}
          countryType String 适用的国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球
          DOMESTIC
          smsType String 短信类型 CommonNotice
          description String 描述 -

          请求Url参数

          参数名称 类型 是否必需 描述 取值示例
          templateId String 模板ID,唯一标识一个模板 sms-tmpl-wHoJXL09355

          响应参数

          void

          HTTP请求示例

          PUT /sms/v3/template/sms-tmpl-wHoJXL09355 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T06:58:50Z/1800/host;x-bce-date/7e5962bab8603a7a26b52af4a9e06c07fe92fd122945529e0b6a8eca70aee908
          Date: Fri, 14 Aug 2020 06:58:50 GMT
          Content-Type: application/json
          x-bce-date: 2020-08-14T06:58:50Z
          Content-Length: 166
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate
          
          {
            "templateId": "sms-tmpl-wHoJXL09355",
            "name": "TemplateNameTest",
            "content": "您的验证码是${code}",
            "countryType": "INTERNATIONAL",
            "smsType": "CommonNotice",
            "description": "test modify"
          }

          响应成功示例

          HTTP/1.1 200 OK
          
          x-bce-request-id: 292d3399-a284-462b-85f0-87efef03ee90
          Cache-Control: no-cache
          Content-Length: 0
          Date: Fri, 14 Aug 2020 06:58:51 GMT
          Server: BWS

          注意:已经审核通过的模板不允许变更

          查询模板

          URL

          /sms/v3/template/{templateId}

          HTTP Method

          GET

          请求Url参数

          参数名称 类型 是否必需 描述 取值示例
          templateId String 模板ID,用于唯一标识一个模板 sms-tmpl-wHoJXL09355

          响应参数

          参数名称 类型 描述
          templateId String 模板ID,用于唯一标识一个模板
          userId String 模板所属的百度云账号id
          name String 模板名称
          content String 模板内容
          countryType String 适用的国家类型
          DOMESTIC:国内
          INTERNATIONAL:国际/港澳台
          GLOBAL:全球
          smsType String 短信类型
          status String 审核状态
          SUBMITTED:申请已提交
          APPROVED:审核通过
          REJECTED:审核未通过
          READY:模板可用
          DEPRECATED:模板被废弃
          ABORTED:审核取消
          description String 描述
          review String 审核意见

          HTTP请求示例

          GET /sms/v3/template/sms-tmpl-wHoJXL09355 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T07:15:31Z/1800/host/c44567420de58748ad132faf68f42692d6abfaa3e1502f20821ac16a6bc24da3
          Date: Fri, 14 Aug 2020 07:15:31 GMT
          Content-Type: application/json; charset=utf-8
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate

          响应成功示例

          HTTP/1.1 200 OK
          
          x-bce-request-id: 11278650-d6ab-4f41-a804-3c2e603bbf3a
          Cache-Control: no-cache
          Content-Type: application/json;charset=UTF-8
          Transfer-Encoding: chunked
          Date: Fri, 14 Aug 2020 07:15:31 GMT
          Server: BWS
          
          {
            "templateId": "sms-tmpl-wHoJXL09355",
            "userId": "bbede3f8c42e4113b6971fd09a57f494",
            "name": "TemplateNameTest",
            "content": "${code}",
            "smsType": "CommonNotice",
            "description": "test modify",
            "review": "通过",
            "status": "APPROVED",
            "countryType": "INTERNATIONAL",
          }

          删除模板

          URL

          /sms/v3/template/{templateId}

          HTTP Method

          DELETE

          请求Url参数

          参数名称 类型 是否必需 描述 取值示例
          templateId String 模板ID,用于唯一标识一个模板 sms-tmpl-wHoJXL09355

          响应参数

          void

          HTTP请求示例

          DELETE /sms/v3/template/sms-tmpl-wHoJXL09355 HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T07:19:48Z/1800/host/5357c33eb986516e32fe21ad3013d96057a026afcddaaa7ece2575e1cccfa9b2
          Date: Fri, 14 Aug 2020 07:19:48 GMT
          Content-Type: application/json; charset=utf-8
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: 2513d3aa-294c-4860-971b-07e7a24b07d8
          Cache-Control: no-cache
          Content-Length: 0
          Date: Fri, 14 Aug 2020 07:19:48 GMT
          Server: BWS

          配额及频控

          查询配额及频控

          URL

          /sms/v3/quota?userQuery=

          参数userQuery无需赋值

          HTTP Method

          GET

          请求参数

          响应参数

          参数名称 类型 描述
          quotaPerDay int 日(自然日)发送配额
          quotaPerMonth int 月(自然月)发送配额
          quotaRemainToday int 日剩余配额
          quotaRemainThisMonth int 月剩余配额
          quotaWhiteList bool 是否为配额白名单(白名单用户无配额限制)
          rateLimitPerMobilePerSignByMinute int 单手机号单签名每分钟(60s)发送频率
          rateLimitPerMobilePerSignByHour int 单手机号单签名每小时(60mins)发送频率
          rateLimitPerMobilePerSignByDay int 单手机号单签名每天(24h)发送频率
          rateLimitWhiteList bool 是否为频控白名单(白名单用户无频率限制)

          HTTP请求示例

          GET /sms/v3/quota?userQuery= HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T07:24:36Z/1800/host/562d49c266d3622c3db1d43052ed92b6f9e9aeefa82a0de9772a8025a6404e6e
          Date: Fri, 14 Aug 2020 07:24:36 GMT
          Content-Type: application/json; charset=utf-8
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: 08cc7ca0-bea9-44de-95b7-9d076ee65f61
          Cache-Control: no-cache
          Content-Type: application/json;charset=UTF-8
          Transfer-Encoding: chunked
          Date: Fri, 14 Aug 2020 07:24:36 GMT
          Server: BWS
          
          {
            "quotaPerDay": 100,
            "quotaPerMonth": 1000,
            "quotaRemainToday": 100,
            "quotaRemainThisMonth": 1000,
            "quotaWhiteList": true,
            "rateLimitPerMobilePerSignByMinute": 5,
            "rateLimitPerMobilePerSignByHour": 10,
            "rateLimitPerMobilePerSignByDay": 50,
            "rateLimitWhiteList": true
          }

          变更配额或频控

          URL

          /sms/v3/quota

          HTTP Method

          PUT

          请求参数

          参数名称 类型 是否必需 描述 取值示例
          quotaPerDay int 日(自然日)发送配额 99
          quotaPerMonth int 月(自然月)发送配额 999
          rateLimitPerMobilePerSignByMinute int 单手机号单签名每分钟(60s)发送频率 88
          rateLimitPerMobilePerSignByHour int 单手机号单签名每小时(60mins)发送频率 77
          rateLimitPerMobilePerSignByDay int 单手机号单签名每天(24h)发送频率 66

          响应参数

          void

          HTTP请求示例

          PUT /sms/v3/quota HTTP/1.1
          
          Host: 127.0.0.1:8420
          Authorization: bce-auth-v1/203069ff6d1145548efbccc0aeaf8b5a/2020-08-14T07:36:59Z/1800/host;x-bce-date/aea68a537fc57498afaca438bd21394e3fe61270e96c2aa15e7780fce0d90865
          Date: Fri, 14 Aug 2020 07:36:59 GMT
          Content-Type: application/json
          x-bce-date: 2020-08-14T07:36:59Z
          Content-Length: 150
          Connection: Keep-Alive
          Accept-Encoding: gzip,deflate
          
          {
            "quotaPerMonth": 999,
            "quotaPerDay": 99,
            "rateLimitPerMobilePerSignByDay": 88,
            "rateLimitPerMobilePerSignByHour": 77,
            "rateLimitPerMobilePerSignByMinute": 66
          }

          响应成功示例

          HTTP/1.1 200 OK
          x-bce-request-id: 8c73056d-5bd0-455a-95c1-1453f6fdfd7b
          Cache-Control: no-cache
          Content-Length: 0
          Date: Fri, 14 Aug 2020 07:36:59 GMT
          Server: BWS