跳转到内容
返回官网

短信发送

根据订单号、手机密文、手机明文号进行批量短信发送,一次请控制在100个订单内。

一、请求参数

请求URL:

POST https://kf.fw199.com/gateway/dd/sms/send

公共参数

参数名称参数类型是否必须示例值参数描述
appidString合作伙伴AppId
timestampString1657525936当前Unix时间戳,秒
seller_nickStringoms38173182抖店的账号,对应蜂巢授权返回doudianseller字段
signString

业务参数

参数名称参数类型是否必须示例值参数描述
request_datastring见示例业务报文
– signstringabc短信签名
– sms_message_listList短信列表
—- biz_typeint1使用订单号或是手机密文(明文号), 0: 手机密文(或是真实手机号), 1: 订单号
—- order_idstring使用biz_type=1 ,要传入订单号1订单号
—- post_telstring使用biz_type=0时,要传入0抖音订单中的手机密文(或真实手机号)
– template_paramstring短信模板中的各参数变量值
– template_idstring短信模板Id
– tagstring忽略,透传字段,回执的时候原样返回给调用方,最大长度512字符
– user_ext_codestring忽略, 用户自定义扩展码,仅当允许自定义扩展码的时候生效

request_data的报文示例

{
"sign": "群荐的铺子",
"sms_message_list": [
{
"biz_type": 1,
"template_param": {
"name": "顺丰",
"number": "sf3813741222"
},
"order_id": "5001789329480019707"
},
{
"biz_type": 0,
"template_param": {
"name": "中通",
"number": "zt381382999"
},
"post_tel": "$DcwmMAKzUZzUj258P0LNEu8bad1eFd7JmRhBXBwT57s=$PzDIsfCO+TTBInVLz+HpMIBCMLhVelkDGhDwGLF3rSagVB8UTp0EC46bGp5PzYFMPneQ4Rn3p9YcaPxkRyivTMJQMaj7v5WvJ689hh/WCv6h+Q==*CgkIARCtHCABKAESPgo874EEcU1IKaIbmqHwtm/yV5qA3KDq84ibA3LfR7ptQc6Cs5x6h1Pwodhx1Nn0Gbsez1EXWjsKEwRQNBHLGgA=$1$$"
}
],
"template_id": "ST_72dd4e2c"
}

二、请求示例代码

Java

@Test
public void DDSmsSendRequest() throws Exception {
Map<String, Object> data = new HashMap<String, Object>();
data.put("appid", Config.AppId);
Long timestamp = System.currentTimeMillis() / 1000;
data.put("timestamp", timestamp.toString());
data.put("seller_nick", Config.DDSellerNick);
String reqData ="{\n" +
" \"sign\": \"群荐的铺子\",\n" +
" \"sms_message_list\": [\n" +
" {\n" +
" \"biz_type\": 1,\n" +
" \"template_param\": \"{\\\"name\\\":\\\"顺丰\\\",\\\"number\\\":\\\"sf3813741333\\\"}\",\n" +
" \"order_id\": \"5001789329480019707\"\n" +
" },\n" +
" {\n" +
" \"biz_type\": 0,\n" +
" \"template_param\": \"{\\\"name\\\":\\\"圆通\\\",\\\"number\\\":\\\"yt3813741888\\\"}\", \n" +
" \"post_tel\": \"$DcwmMAKzUZzUj258P0LNEu8bad1eFd7JmRhBXBwT57s=$PzDIsfCO+TTBInVLz+HpMIBCMLhVelkDGhDwGLF3rSagVB8UTp0EC46bGp5PzYFMPneQ4Rn3p9YcaPxkRyivTMJQMaj7v5WvJ689hh/WCv6h+Q==*CgkIARCtHCABKAESPgo874EEcU1IKaIbmqHwtm/yV5qA3KDq84ibA3LfR7ptQc6Cs5x6h1Pwodhx1Nn0Gbsez1EXWjsKEwRQNBHLGgA=$1$$\"\n" +
" }\n" +
" ],\n" +
" \"template_id\": \"ST_72dd4e2c\" " +
"}";
data.put("request_data", reqData);
data.put("sign", Sign(data,Config.AppSecret));
// 调用服务API
String resp = doHttpRequest(Config.DDSmsSendRequestUrl, data);
System.out.println(resp);
}

三、返回结果

三(一)、成功返回

{
"code": 0,
"message": "ok",
"data": [
{
"code": 0,
"message": "",
"order_id": "",
"message_id": "0a01be41-5403-4731-b6b8-b48d0bb5d986"
},
{
"code": 0,
"message": "",
"order_id": "5001789329480019707",
"message_id": "f2d1acbf-63c9-495b-b18a-91fc15bb4138"
}
]
}

说明: code为0表示成功,非0为失败,message会包含失败原因。业务层面的成功见内层的code,为0表示成功.

四、返回字段说明

参数名称参数类型示例值参数描述
order_idString1234订单号,如果有传入的话原样返回
message_idString23423423消息的唯一标识
codeInt640是否成功 0表示成功
messageString成功说明