文档中心 > API类目 > 阿里通信API

qimen.taobao.vtplan.contract.get (获取可办理合约)

调用运营商接口获取可办理合约信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
contractType String 可选 LegacyCardContract LegacyCardContract-老卡合约
itemId Number 必须 815808970079 当前合约办理关联实物商品,天猫侧商品ID
userMobile String 必须 13677777777 待办理合约的手机号
itemSkuId Number 可选 5849908825726 当前合约办理关联实物商品,天猫侧商品SKU ID
itemPrice Number 必须 599900 当前合约办理关联实物商品,此刻计算的券后价,单位:分 预估金额,仅做参考(优惠具备实效性,不保证最终一致性,以及用户资产等场景)

响应参数

名称 类型 示例值 描述
result Boolean true 接口调用是否成功,即是否存在内部异常
isPass Boolean true 合约查询是否通过
resultCode String 0000 合约查询结果编码 isPass = true 时,resultCode = 0000 isPass = false 时,resultCode = 错误原因
resultMsg String 可办理 合约查询结果描述 isPass = false 时,描述查询失败原因
data Contract [] 可办理合约列表
  • └ planDesc
  • String
  • 合约的描述
  • 合约的描述
  • └ ext
  • String
  • {}
  • 扩展字段,json字符串
  • └ outProductCode
  • String
  • 121312
  • 合约的运营商OfferID,仅支持1个
  • └ retFeeTotal
  • Number
  • 100000
  • 合约的套餐总返费用,单位:分
  • └ monthFee
  • Number
  • 12900
  • 合约的月低消/月租,单位:分
  • └ planPeriod
  • Number
  • 12
  • 合约的周期,单位:月
  • └ planName
  • String
  • 129元5G
  • 合约的优惠展示名

请求示例

{"itemId":0,"contractType":"LegacyCardContract","userMobile":"13677777777","itemSkuId":0,"itemPrice":599900}

响应示例

{
    "result":true,
    "isPass":true,
    "resultCode":"0000",
    "resultMsg":"可办理",
    "data":[
        {
                "planDesc":"合约的描述",
                "ext":"{}",
                "outProductCode":"121312",
                "retFeeTotal":100000,
                "monthFee":12900,
                "planPeriod":12,
                "planName":"129元5G"
        }
    ]
}

验签示例

{"result":"true","resultCode":"sign-check-failure","resultMsg":"Illegal request"}

错误码解释

错误码 错误描述 解决方案

API工具

FAQ

返回
顶部