发送单条短信

发送单条短信（SendSms）

描述

给单个手机发送单条短信

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

公共参数列表 详情

名称	类型	必须	长度限制	参数格式	描述	备注
Action	String	是	确定值	[a-zA-Z]+	操作接口名，系统规定参数，取值：SendSms
Version	String	是	确定值		版本号，系统规定参数，取值：2019-05-01
Mobile	String	是		[0-9]+	国际手机号: +国家代号手机号码，例如 +861xxxxxxxxxx ，不支持国内手机号
SignName	String	是		不含特殊符号【】	签名名称	签名需要联系客服提前报备
TplId	String	是		[0-9]+	模板ID
TplParams	Json	是		{ “模板变量key”: “模板变量值” }	例如模板如下：你的验证码{code},有效期为五分钟。其中code是模块变量，则TplParams参数值格式为：{“code”:123456},如果你的模板是营销模板，没有变量，则该参数值为: {}
Content	String	否	最多500个字符	中英文字符，不含特殊符号【】	短信内容	需单独联系客服开通免模板权限，开通后该参数必填(TplId, TplParams不能传值)
SmsType	Int	否			类型值：1验证码, 2 通知 ，3营销类短信	需单独联系客服开通免模板权限，开通后该参数必填(TplId, TplParams不能传值)
ExtId	String	否	最多256个字符		客户自定义流水号
ExtNo	String	否		[0-9]+	自定义扩展号	需单独联系客服开通
SenderId	String	否			国际短信Sender	需要提前报备，指明发往的国家

返回结果

通过指定 Accept:application/json，返回的数据格式为json

名称	类型	描述	备注
Sid	String	短信ID
ExtId	String	客户自定义流水号
RequestId	String	请求唯一标识

示例（调用成功）

请求示例

curl -X POST \
  'http://ksms.ksyun.com/' \
  -H 'accept: application/json' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -H 'host: ksms.ksyun.com' \
  -d 'Mobile=1xxxx&TplId=1xxx&TplParams=%7B%22key%22%3A%22val%22%7D&SignName=xxx&Action=SendSms&Version=2019-05-01&Signature=xxxx&SignatureVersion=1.0&Timestamp=2019-08-13T17:18:36Z&Service=ksms&Accesskey=xxx'

响应成功返回示例

{
    "Sid": "2715044259-4014133240-1-1557249772039",
    "ExtId": "",
    "RequestId": "7de19b5e-0791-4269-872b-c3e05b53c3c8"
}

响应失败返回示例

{
    "RequestId": "ED9B3DF4-75AF-4573-8DD4-7611C57292F2",
    "Error": {
        "Type": "sender",
        "Message": "Invalid sign name",
        "Code": "InvalidSignName"
    }
}

访问API错误码查看更多错误码