短信调用服务 FunctionCode | SER-B004

为用户提供的一种通信服务的能力，分为国内短信服务和国际/港澳台短信服务。通过API/SDK、控制台调用短信发送能力，将指定信息发送至国内手机号码。

简介

短信服务（Short Message Service）是为广大企业用户或个人用户提供的通信服务。通过API/SDK、控制台调用短信发送能力，将指定信息发送至国内手机号码。您可以在不同场景发送不同类型的短信，例如验证码、通知短信、推广短信以及多媒体短信等，给您带来安全可靠的服务体验。

提示

一条短信由短信签名和短信模板组成，因此在发送短信前，您需要先完成短信资质以及签名、模板的申请工作，并等待审核通过。通过模板变量自定义，您可以实现短信内容的定制化。

接口说明

• 请求方式 POST
• Headers serviceCode: SER-B004
• Headers Content-Type: application/json
• Headers Authorization: Bearer ${app_token}

正式环境	测试环境
https://api.linkingopen.com/service/openapicore/open	https://api.linkingopen.com/test/service/openapicore/open

请求参数

名称	描述	类型	必填
mobile	发送短信的手机号。	string	是
templateID	短信模板ID。	boolean | string	是
template_parameter	短信模板参数。示例：{name:"123456",time:"5"}	string	是

该 template_parameter 中的参数为模板中变量名和变量值对。在模板中，变量值会替换模板中的占位符。

返回参数

名称	描述	类型	必填
code	请求唯一 ID。	string	是
msg	返回数据。	string	是

接口示例

参数示例

以下是JSON：

请求参数

{
    "mobile" : "15152*****",
    "templateID" : "SMS_18*****",
    "template_parameter" : "{\"name\":\"联空\",\"service\":\"图文咨询\"}"
}

返回参数

  {
     "code": "1",
     "msg": "success"
  }

SDK示例

Java

public class SDKExample {
    public static void main(String[] args) {
        // Java示例：初始化SDK并调用一个方法
        SDK sdk = new SDK();
        sdk.initialize();
        sdk.processImage("image.jpg");
    }
}

.NET

using System;

public class SDKExample {
    public static void Main() {
        // .NET 示例：初始化SDK并调用方法
        SDK sdk = new SDK();
        sdk.Initialize();
        sdk.ProcessImage("image.jpg");
    }
}

Node

async function runExample() {
    // Node.js 示例：初始化SDK并调用异步方法
    const sdk = new SDK();
    await sdk.initialize();
    await sdk.processImage('image.jpg');
}

常见业务状态码

错误码	描述	解决方案
SYSTEM_ERROR	系统繁忙	服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
INVALID_PARAMETER	参数有误	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试
APP_NOT_ONLINE	小程序未处于上架状态	小程序上架状态再操作