OkayAPI Docs


API Path: /api/App/Sms/AliyunSendSms

API Description: 通过阿里云的SendSms发送短信,使用前请进入小白开放平台-阿里云短信配置

5
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
PhoneNumbersStringRequired接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。
SignNameStringRequired短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如:阿里云
TemplateCodeStringRequired短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如:SMS_153055065
TemplateParamArrayJSON FormatOptaion短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"}

API Debug

KEYREQUIREDVALUE
app_key *Required
PhoneNumbers *Required
SignName *Required
TemplateCode *Required
TemplateParam Option

API Response

KEYTypeDescription
操作码,0成功,1失败err_code
BizIdString发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。
CodeString请求状态码。返回OK代表请求成功。其他错误码详见错误码列表
MessageString状态码的描述。
RequestIdString请求ID。

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400表示客户端参数错误
Http Status = 404表示接口服务不存在
Http Status = 500表示服务端内部错误