淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	更多限制	描述
sender	Sender	可选			发送者信息
└ app_type Number 可选 6 应用类型 0： ipad排队预定 1： ipad正餐自助 2：iPad快餐租住 3： android打印服务 4： iPad快餐收银 5： android堂食外卖 6： android快餐收银 7： iOS手机助手 8：安卓手机助手 12： onmobile os android 1001：微信 1002：百度直达号 1003：商户官网 1004：找位 1005：百度地图排队 1006：百度糯米预定 1007：百度糯米排队 1008：百度外卖 1009：呼叫中心 2001：商户后台 b.kry 3001： ERP 4001： SCM;5002:零售烘培;5003:云参谋;6002:随行付 └ shop_identity Number 可选 247900001 商户id，商户自身业务时必填 └ trade_type Number 可选 4002 业务类型，第一位为业务类型，后面三位表示trade_id存储表。 1001:预定_booking 2001:排队_queue 3001:堂食_orderall 3002:堂食/快餐_trade 4001:外卖_takeaway 4002:外卖_trade 5001:营销 5002:烘培预定; 6001:其他;6006:随行付 └ terminal_identity String 可选 app 消息发送终端标识，如终端mac地址，admin 后台登录账户，该字段主要记录该条消息是由哪些终端发出去的 └ sign_type Number 可选 2 短信签名固定值 2 └ shop_type Number 可选 1 商户来源：1-客如云，2-口碑。默认为客如云
packages	Packages []	可选		最大列表长度：999999	消息体信息,最多50个消息体
└ callback_url String 可选 http://callback.com/testing 异步发送时，发送成功后通知 receiver Receiver 可选接受者信息 └ country_code String 可选 86 国家编码，默认86 └ phones String [] 可选电话号码，只支持标准营销(1013)，个性化营销(1014)，优惠券(1015)类的短信群发，最多支持100个号码 └ memo String 可选 memo 备注 └ message_type Number 可选 1011 短信类型 1011:通知类短信 1013:标准营销短信(可指定通道) 1014:个性化营销短信(可指定通道) 1015:优惠券短信(可指定通道) 2005:IVR通知 └ channel_code Number 可选 4 发送通道，只有标准营销短信(1013),个性化营销短信（1014）和优惠券短信（1015）才需要指定通道 ,其他情况指定无效 └ message_uuid String 可选 a81cc7e838f34019bcc66b5egfge4i1b 消息UUID，32字符 └ content String 可选尊敬的女士您好送您1张满减券短信内容 (可为string或者json对象)，最大长度2048
sync	Number	可选	1		同步发送（1：同步发送，0：异步发送），默认值为： 1
ak	String	必须	1111		短信二次验签appkey

名称	类型	示例值	描述
codeInfo	Number	0	错误码 [0：成功] [1000：请求参数错误] [1001：sign签名错误] [2000：业务异常] [2001：合作表示错误] [3000：系统异常] [3001：内部接口异常] [-1：未知异常]
data	Data []		业务对象
└ failure_cause String demo 失败原因 └ message_uuid String a81cc7e838fgg019bgg66b5egfge4i1b 消息UUID └ phone_nos String [] 电话 └ transport_status Number 3 短信发送状态 1：传输中 2：失败 3：成功 4：无对应通道 5：余额不足 6：其他原因，具体看failure_cause字段描述
success	Boolean	true	是否成功
messageInfo	String	成功[OK]	错误说明

{"sender":{"app_type":6,"shop_identity":247900001,"shop_type":1,"trade_type":4002,"terminal_identity":"app","sign_type":2},"ak":"1111","packages":[{"callback_url":"http://callback.com/testing","receiver":{"country_code":"86","phones":[""]},"memo":"memo","message_type":1011,"channel_code":4,"message_uuid":"a81cc7e838f34019bcc66b5egfge4i1b","content":"尊敬的女士您好送您1张满减券"}],"sync":1}

{
    "codeInfo":0,
    "data":[
        {
                "failure_cause":"demo",
                "message_uuid":"a81cc7e838fgg019bgg66b5egfge4i1b",
                "transport_status":3
        }
    ],
    "success":true,
    "messageInfo":"成功[OK]"
}

{"codeInfo":"sign-check-failure","messageInfo":"Illegal request"}

错误码	错误描述	解决方案

错误码查询工具 SDK下载

开放平台

本地生活API

qimen.alibaba.alsc.message.send (短信发送)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ