文档中心
一、快递100短信发送接口 二、快递100短信回调请求 API调试工具

快递100短信发送接口文档

一、快递100短信发送接口

1.1 请求地址

https://apisms.kuaidi100.com/sms/send.do

1.2 请求类型

POST

1.3 请求参数

请求参数(header)

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(body)

名称类型是否必填示例值参数描述
signString4BBDE07660E5EFF9 0873642CFAE9A8DD加密签名信息:MD5(key + userid);加密后字符串转32位大写
useridString9974ef2c377a4dbt9 c8g1b64dd6311ea我方分配给贵司的的公司编号,请申请企业版获取
sellerString快递100短信签名,请在企业管理后台设置后使用,该字段信息会在短信标签处显示。不要超过5个字符
phoneString13568688888接收短信手机号
tidlong11短信模板ID,请在企业管理后台设置后使用
contentString{"接收人姓名":"王帅", "公司名":"快递100", "快递单号":"154893238584", "url":https: //api.kuaidi100.com/home"}短信模板替换内容。其中,链接不要使用全变量,需为固定链接或域名+{变量},如kuaidi100.com/{变量}
outorderString143255893外部订单号:当该短信发送模板有回调地址时,外部订单号会返回给调用者,方便用户更新数据
callbackStringhttp:// xxx/callback回调地址:如果客户在发送短信时填写该参数,将按照这个参数回调短信发送状态;如果为空,将按照模板配置的地址回调短信发送状态;如果两个参数都不填写,将不会回调通知状态

1.4 请求参数示例

    sign= "4BBDE07660E5EFF90873642CFAE9A8DD"
    userid= "9974ef2c377a4dbc9c8c1b64dd6311ea"
    seller= "快递100"
    phone= "13566688888"
    tid= 11
    content = {
        "接收人姓名": "王帅",
        "公司名": "快递100",
        "快递单号": "154893238584",
        "url": "http://www.kuaidi100.com"
    }
    outorder = "143255893"  

1.5 返回结果

参数名称数据类型示例值参数描述
statusinteger1状态值:0-表示失败;1-表示成功
dataobject 返回数据信息
msgString 信息内容:返回具体的信息体描述
extraobject 附加信息
totalinteger 该值表示所数据的总条数

1.6 返回数据示例

{
    "status": 1,
    "data": "",
    "msg": "短信发送中……",
    "extra": "",
    "total": 0
}    

1.7 错误返回代码含义

返回代码信息内容描述原因及建议处理方式
200提交成功
400参数校验失败-[phone:手机号格式错误]传入正确的手机号码
401短信接口权限暂未开启、签名校验失败、未获取到用户信息联系商务开启短信接口权限,签名计算正确,传入正确的userid等
500发送短信失败,请联系管理员系统原因,重试

二、快递100短信回调请求

2.1 回调信息

参数名称数据类型示例值参数描述
statusinteger1状态值:0-表示失败;1-表示成功
Θdataobject 返回数据信息:短信发送状态
└ outorderString143255893传入的外部订单号
└ messageStringOK附加信息
└ statusString接收成功短信发送状态:接收成功、接收失败
└ signString 返回校验信息:MD5(id + phone + outorder);校验方式是MD5加密的:模板ID+手机号+外部订单号。用户可根据加密签名判断是否进行处理请求
msgString 信息内容:返回具体的信息体描述
extraobject 附加信息
totalinteger 该值表示所数据的总条数

2.2 返回数据示例

{
    "status": 1,
    "data": {
        "outorder": "143255893",
        "message": "",
        "status": "接收成功"
    },
    "msg": "短信发送结果信息",
    "extra": "",
    "total": 0
}       

2.3 请求报文响应示例

当我方调用贵方的回调接口(callbackurl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:

{
    "status": true
}

注意:当回调地址response没有正确响应时,会最多再推送5次,时间间隔分别是2min,5min,8min,15min,2h