OAID发送短信

基于OAID的短信发送接口,OAID来自淘宝订单,蜂巢返回的订单中都包含OAID字段.

一、请求参数

请求URL:

POST https://kf.fw199.com/gateway/taobao/jst/sms/oaid/send

参数名	类型	必须	示例值	说明
appid	String	true	uwkahf@jfs92	合作伙伴AppId
timestamp	String	true	1633618722	当前时间戳
tb_seller_nick	String	true	kingdo	淘宝卖家店铺登录账号，非店铺名称
sign	String	true	999de41d862efaa6f1084ead3b3ba480	如何计算生成见示例代码
request_data	json	true	报文

报文request_data的参数说明

名称	类型	必须	示例值	描述
extend_name	String	false	12345	拓展Name
order_id	String	true	1590159531380428537	订单号
extend_code	String	false	12345	拓展Code
sms_free_sign_name	String	true	聚石塔测试签名	短信签名
template_code	String	true	SMS_12345	短信模板
params		false	{“content”:”您好! “}	短信占位符，替换短信模板里的占位符
extend	String	false	123	拓展信息
oaid	String	true	3mwdUE03cfGGuH4A4DrWWjcL8lxkl3bH29SM1RHqDNo5RgXYTdCQj1ZMN8wbv7qnLeiX6Dr	OAID
additional_info	Boolean	false	true	是否需要返回附加信息

request_data请求的json示例, 一次发送短信数量控制在100内.

[
    {
        "extend_name": "extname-100",  //拓展Name
        "extend": "extend200", // 拓展信息
        "additional_info": true, // 是否需要返回附加信息
        "sms_free_sign_name": "迈步鞋城淘宝店",
        "params": {
            "mima": "p282",
            "cardno": "38138124"
        },
        "order_id": "3006925020239565830",
        "extend_code": "888",
        "oaid": "16RESBQZwM4lw1TgrXXqkh1erCoqpXflDjx1uukJHWpsuaxZRoDphrpJic88GUQ1f2lVxtA",
        "template_code": "SMS_251071470"
    },
    {
        "extend_name": "extname-200",
        "extend": "extend200",
        "additional_info": true,
        "sms_free_sign_name": "迈步鞋城淘宝店",
        "params": {
            "code": "38138125"
        },
        "order_id": "3011187783529034024",
        "extend_code": "888",
        "oaid": "13La3Dk472eDhscaPVTWrnicw9qkTSqljEqzt5yToSCx1bcwF20eZIHrqiadCwYMcgzDSiaaA",
        "template_code": "SMS_257051849"
    }
]

二、请求示例代码

Java

@Test
    public void  JstSmsOAIDSendRequest() throws Exception {
        Map<String, String> data = new HashMap<String, String>();
        data.put("appid",  Config.AppId);
        Long timestamp = System.currentTimeMillis() / 1000;
        data.put("timestamp", timestamp.toString());
        data.put("tb_seller_nick", Config.TBSellerNick);
        JSONArray list = new JSONArray();
        // 第1条短信
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("extend_name", "extname-100");
        jsonObject.put("order_id", "3006925020239565830");
        jsonObject.put("extend_code", "888");
        jsonObject.put("sms_free_sign_name", "迈步鞋城淘宝店");
        jsonObject.put("template_code",  "SMS_251071470");
        JSONObject params = new JSONObject();
        params.put("cardno", "38138124");
        params.put("mima", "p282");
        jsonObject.put("params",  params);
        jsonObject.put("extend", "extend200");
        jsonObject.put("oaid", "16RESBQZwM4lw1TgrXXqkh1erCoqpXflDjx1uukJHWpsuaxZRoDphrpJic88GUQ1f2lVxtA");
        jsonObject.put("additional_info", true);
        list.add(jsonObject);

        // 第2条短信
        jsonObject = new JSONObject();
        jsonObject.put("extend_name", "extname-200");
        jsonObject.put("order_id", "3011187783529034024");
        jsonObject.put("extend_code", "888");
        jsonObject.put("sms_free_sign_name", "迈步鞋城淘宝店");
        jsonObject.put("template_code",  "SMS_257051849");
        params = new JSONObject();
        params.put("code", "38138125");
        jsonObject.put("params",  params);
        jsonObject.put("extend", "extend200");
        jsonObject.put("oaid", "13La3Dk472eDhscaPVTWrnicw9qkTSqljEqzt5yToSCx1bcwF20eZIHrqiadCwYMcgzDSiaaA");
        jsonObject.put("additional_info", true);
        list.add(jsonObject);
        data.put("request_data", list.toJSONString());
        data.put("sign", Utils.Sign(data,Config.AppSecret));
        doHttpRequest(Config.JstSmsOAIDSendRequestUrl ,data);

    }

三、返回结果

返回情况

{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "order_id": "3006925020239565830",// 订单号,入参原样返回
            "code": 0,
            "message": "success",
            "request_id": "15s99ai9wbln1",
            "module": {
                "code": "341623067818673604^0", // 短信拓展码
                "nameLen": 3
            }
        },
        {
            "order_id": "3011187783529034024", // 订单号,入参原样返回
            "code": 1,
            "message": "Remote service error,请求失败，当前号码的短信发送次数超过当天限制。",
            "request_id": "",
            "module": {
                "code": "",
                "nameLen": 0
            }
        }
    ],
    "trace_id": ""
}

说明： code为0表示成功，非0为失败，message会包含失败原因。发送成功见内层的code是否为0,0表示成功,失败的话,内层的message会有失败原因.

四、常见问题

四（一）、营销类短信发送时间

答：早八点到晚22点之间可以发送营销短信。