注册送短信

API: sms/traffic - 引流信息报备 API


概览


sms/traffic 是 SUBMAIL 引流信息报备的查询、创建和删除 API。

使用 sms/traffic GET方式 可以查询当前账户下的引流信息报备信息。
使用 sms/traffic POST方式 可以创建引流信息并提交审核。
使用 sms/traffic DELETE方式 可以删除引流信息。



URL


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


支持格式


接口返回格式URL
jsonhttps://api-v4.mysubmail.com/sms/traffic(默认)


是否需要授权


参阅 API 授权和验证机制


sms/traffic GET 方法请求参数


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

成功返回
{
    "status": "success",
    "traffic":{
        "sms_signature": "【SUBMAIL】",
        "sms_type": 1,
        "is_loan_related": 0,
        "business_categories": "00",
        "business_breakdown": "02",
        "message_title": "验证码通知",
        "message": "【SUBMAIL】您的验证码是var(code),15分钟有效",
        "message_param_flg": 1,
        "message_param_type": "2",
        "message_param_length": "6",
        "mobile1": "15201893074",
        "mobile1_name": "张三",
        "mobile1_cert_id": "310001198911220034",
        "mobile1_type": 1,
        "mobile1_desc": "客服回访电话1",
        "mobile1_test": "1",
        "mobile1_test_date": "2025-12-11",
        "mobile1_test_desc": "0",
        "mobile2": "15221876708",
        "mobile2_name": "李四",
        "mobile2_cert_id": "342521199005261234",
        "mobile2_type": 1,
        "mobile2_desc": "客服回访电话2",
        "mobile2_test": "1",
        "mobile2_test_date": "2025-12-12",
        "mobile2_test_desc": "0",
        "url": "https://www.mysubmail.com/console/sms/overview",
        "target_url": "",
        "url_type": 2,
        "url_desc": "官网链接",
        "domain_icp": "ICP1234",
        "domain_company": "上海赛邮云计算有限公司",
        "domain_company_code": "1234",
        "status": 1,
        "create_at": "2025-12-12T13:54:34+08:00",
        "reject": ""
    }
}

注:1. status表示当前引流信息的报备状态,0=提交中、1=已报备到运营商、2=已通过生效、3=被驳回。
2. reject,status=3时有数据,表示驳回原因。


失败返回
{
    "status": "error",
    "code": 168,
    "msg": "record not found"
}


sms/traffic POST 方法请求参数

请求方式
http post
content-type: form-data


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用 ID
signaturestring必需应用密匙或数字签名
参阅 API 授权与验证机制 > 授权和验证方式
sms_signature string必需短信签名,“【”和“】”符号可省略,参数处理过程中会移除这两个符号。
sms_type int可选0短信用途,0-行业通知短信、1-营销推广短信。
is_loan_related int可选0是否涉及金融借贷,0-不涉及,1-涉及。
business_categories string必需业务类别,可选项: 00-业务管理和服务类、01-商业性、02-公益性。
business_breakdown string必需业务细分,可选项: 00-其他用途、01-通知服务、02-验证码、03-业务提醒(非金融类)、04-业务提醒(金融类)、05-还款通知。
message_title string必需模板名称:与业务细类对应的中文
message string必需短信模板
message_param_flg int可选0短信模板内容是否包含变量参数,0-不包含、1-包含
message_param_type string可选模板内容变量参数类型,(如模板含变量参数 此项必填) 1.字符型、2.整数型、3.小数型、4.字符数据混合型、5.URL(链接)、6.联系方式。多个参数类型用“,”分隔
message_param_length string可选模板内容变量参数长度,可多选(如模板含变量参数 此项必填),填写要求:对应参数类型的参数长度,用“,”分隔
mobile1 string可选引流号码1
mobile1_name string可选引流号码1机主姓名
mobile1_cert_id string可选引流号码1机主证件号码
mobile1_type int可选引流号码1号码类型 1-手机号 2-固号 3-400电话 4-800电话 5-95号码 6-96号码 7-1开头号码(非手机号) 8-其他号码
mobile1_desc string可选引流号码1号码用途说明
mobile1_test string可选引流号码1号码是否已拨测
mobile1_test_desc string可选引流号码1号码拨测是否有问题,默认无
mobile1_test_date string可选引流号码1拨测日期,示例:2025-12-12
mobile2 string可选引流号码2
mobile2_name string可选引流号码2机主姓名
mobile2_cert_id string可选引流号码2机主证件号码
mobile2_type int可选引流号码2号码类型 1-手机号 2-固号 3-400电话 4-800电话 5-95号码 6-96号码 7-1开头号码(非手机号) 8-其他号码
mobile2_desc string可选引流号码2号码用途说明
mobile2_test string可选引流号码2号码是否已拨测
mobile2_test_desc string可选引流号码2号码拨测是否有问题,默认无
mobile2_test_date string可选引流号码2拨测日期,示例:2025-12-12
url string可选短信内链接
target_url string可选跳转链接,如果引流链接是短网址,则此选项必填
url_type int可选2链接类型 1-IP类型链接 2-域名类型链接
url_desc string可选链接用途说明
domain_company string可选域名备案公司名
domain_company_code string可选签名备案公司企业代码
domain_icp string可选ICP备案号
attachments file可选证明材料
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式

注:1. 一次报备最多可同时报备一个引流链接和两个引流号码。
2. 在提交引流号码或引流链接时,需同时提交相关的其他信息和证明材料。


成功返回示例
{
    "id",1980,
    "status": "success",
}

失败返回示例
{
    "status": "error",
    "code": 160,
    "msg": "message_title parameter error"
}


sms/traffic DELETE 方法请求参数


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

成功返回
{
    "status": "success",
}

失败返回
{
    "status": "error",
    "code": 168,
    "msg": "record not found"
}


错误代码


参阅 API 错误代码