注册送短信

API: SMS/Appextend - Appid可用签名查询


概览


sms/appextend 是 SUBMAIL 的短信签名查询 API。

使用 sms/appextend 可以查询当前appid或目标appid下的签名列表,包括签名、签名扩展码、审核状态。



URL


https://api-v4.mysubmail.com/sms/appextend


支持格式


格式URL
jsonhttps://api-v4.mysubmail.com/sms/appextend .json(默认)
xmlhttps://api-v4.mysubmail.com/sms/appextend .xml
yamlhttps://api-v4.mysubmail.com/sms/appextend .yaml


http 请求方式


  • HTTP GET


是否需要授权


参阅 API 授权和验证机制


sms/template GET 方法(获取模板列表)请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用 ID
signaturestring必需应用密匙或数字签名
参阅 API 授权与验证机制 > 授权和验证方式
target_appid string可选目标 appid
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式

代码示列


使用 CURL GET方法获取模板列表


发送 CURL
curl --location 'https://api-v4.mysubmail.com/sms/appextend?appid=your appid&signature=your appkey'


返回
{
    "status": "success",
    "smsSignature": [
        {
            "appid": "appid",
            "smsSignature": "【签名1】",
            "extend": "扩展码",
            "status": 1   //0=审核中、1=审核已通过、其他=审核不通过
        },
        {
            "appid": "appid",
            "smsSignature": "【签名2】",
            "extend": "扩展码",
            "status": 1
        },
        ...
    ]
}

请求失败
{
    "status": "error",
    "code": 154,
    "msg": "No available SMS signature"
}


错误代码


参阅 API 错误代码