短信发送

接口说明

接口地址：https://smssh.253.com/sms/v2/batch-send 通用接口说明详见 API 调用说明

请求体参数

名称	类型	必填	描述	示例
productType	String	是	产品类型：`notify`-通知短信；`market`-营销短信；`verify`-验证码短信；`2ec`-CS 短信（二类电商）；`finance`-DK 短信（金融）；`game`-BK 短信（游戏）；`acquisition`-HK 短信（拉新）。	`market`
phoneNumbers	String	是	手机号：11 位号码，多个号码用英文逗号分隔（详见请求示例），上限 1000 个。	-
templateCode	String	是	模板 ID：可前往模板管理中心查看。	-
templateParam	String	条件	模板变量值：模板含变量时必填。JSON 数组字符串，按手机号顺序为每个手机号提供一组变量值；模板中的第 1、2、3……个变量依次使用 `param1`、`param2`、`param3`……传值。详见请求示例。	-
report	String	否	是否需要状态回执：`true`-需要；`false`-不需要。默认值为 `false`。	`true`
callbackUrl	String	否	状态回执推送地址：需以 `http` 或 `https` 开头，请勿传入空格；不传时使用 API Key 配置的回调地址。	-
outId	String	否	自定义参数：在状态回执中以 `uid` 字段原样回传，最大支持 256 个字符。	-
smsUpExtendCode	String	否	上行扩展码：在上行报告中以 `extend` 字段原样回传，限 5 位以内数字。	-

请求示例


{
  "productType": "market",
  "phoneNumbers": "15800000000,15300000000",
  "templateCode": "1111111",
  "templateParam": "[{\"param1\":\"张三\",\"param2\":\"13\"},{\"param1\":\"李四\",\"param2\":\"88\"}]",
  "report": "true",
  "callbackUrl": "https://example.com/callback",
  "outId": "321abc",
  "smsUpExtendCode": "555"
}

响应体参数

名称	类型	描述	示例
msg	String	提示信息：成功时返回 `success`。	-
code	String	请求状态码：`000000` 表示成功；其他值表示失败，详见接口响应状态码说明。	`000000`
data	Object	短信提交结果数据：仅请求成功时返回，字段见 data 参数。	-
requestId	String	请求 ID：随机生成的 UUID。	-

data 参数

名称	类型	描述	示例
failNum	String	提交失败的短信条数	-
successNum	String	提交成功的短信条数	-
msgId	String	消息 ID：32 位纯数字组成的唯一标识。	-

响应示例


{
  "msg": "success",
  "code": "000000",
  "data": {
    "failNum": "0",
    "successNum": "2",
    "msgId": "26073016585700902202000045962837"
  },
  "requestId": "2CBBEDF76FB64E3EB924DA3958B7D6BB"
}

产品中心

热门搜索

中国站

国际站

接口说明

请求体参数

请求示例

响应体参数

data 参数

响应示例