接口列表

约 1856 字大约 5 分钟

会员办理接口

2025-08-13

请按照接入准备中的信息，配置正确的接口域名和鉴权参数，并参考签名示例对内容正确签名。

前置校验可选

接口地址: /wy-cel-open/api/member/handle/verify

2025年5月15日之前对接的产品，使用该接口：/cel-open/api/member/handle/verify

请求方式: POST

请求数据类型: application/json

接口描述: 在发验证码或办理之前，先校验用户能不能办理，如：号码是否正确，号码是否已办理等。

请求参数:

参数名称	参数说明	是否必须	数据类型	说明
appId	系统标识	true	string
sign	签名	true	string
data	会员办理校验入参	true	object	VerifyReq
phone	号码	true	string
productId	产品编码	true	string	分配的推广编码
ext	扩展参数	false	string

响应参数:

参数名称	参数说明	类型	说明
code	状态码	integer
message	描述	string
data		object	VerifyResp
success	状态	boolean
msg	失败原因	string
appId	应用ID（四川移动-新）	string
serialNumber	流水号（四川移动-新）	string

请求示例:

{
  "appId": "",
  "sign": "",
  "data": {
    "phone": "",
    "productId": ""
  }
}

响应示例:

// 接口调用异常
{
  "code": 500,
  "message": "签名失败"
}
// 校验失败
{
  "code": 0,
  "message": "",
  "data": {
    "success": false,
    "msg": "标签检查结果-被限制"
  }
}
// 校验通过
{
  "code": 0,
  "message": "",
  "data": {
    "success": true
  }
}

发验证码

接口地址: /wy-cel-open/api/member/handle/send-sms

2025年5月15日之前对接的产品，使用该接口：/cel-open/api/member/handle/send-sms

请求方式: POST

请求数据类型: application/json

接口描述: 发送办理短信

请求参数:

参数名称	参数说明	是否必须	数据类型	说明
appId	系统标识	true	string
sign	签名	true	string
data	会员办理发短信入参	true	object	SendSmsReq
phone	号码	true	string
productId	产品编码	true	string	分配的推广编码
adPlatform	投放引擎名称	true	string	如：广点通
appName	办理App名称	true	string	如：快手极速版
appPackage	办理App包名不为空且为英文字符串	true	string	如：com.kuaishou.nebula
sourceUrl	办理页面链接	true	string
ext	扩展参数	false	string	不为空时必须是JSON字符串，比如 "{"a": "12"}"

响应参数:

参数名称	参数说明	类型	说明
code	状态码	integer
message	描述	string
data		object	SmsResp
smsKey	短信key 有返回则提交时必须带上	string
success	状态	boolean
msg	失败原因	string

请求示例:

{
  "appId": "",
  "sign": "",
  "data": {
    "phone": "",
    "productId": ""
  }
}

响应示例:

// 接口调用异常
{
  "code": 500,
  "message": "签名失败"
}
// 短信发送失败
{
  "code": 0,
  "message": "",
  "data": {
    "smsKey": "",
    "success": false,
    "msg": "用户无权限办理"
  }
}
// 短信发送成功
{
  "code": 0,
  "message": "",
  "data": {
    "smsKey": "",
    "success": true
  }
}

提交办理

接口地址: /wy-cel-open/api/member/handle/submit

2025年5月15日之前对接的产品，使用该接口：/cel-open/api/member/handle/submit

请求方式: POST

请求数据类型: application/json

接口描述: 调用办理接口进行业务订购。云盘阅读的页面、插码和录屏见云盘阅读，办理仍走本接口。

请求参数:

参数名称	参数说明	是否必须	数据类型	说明
appId	系统标识	true	string
sign	签名	true	string
data	会员办理办理入参	true	object	HandleReq
phone	号码	true	string
productId	产品编码	true	string	分配的推广编码
smsKey	短信key 发短信时有返回则必须带上，没有则为空	false	string
smsCode	短信验证码	true	string
channelTxId	渠道订单号	false	string
notifyUrl	回调通知地址	false	string
adPlatform	投放引擎名称	true	string	如：广点通
appName	办理App名称	true	string	如：快手极速版
appPackage	办理App包名不为空且为英文字符串	true	string	如：com.kuaishou.nebula
sourceUrl	办理页面链接	true	string
snapshotUrl	办理页面快照链接	false	string
imageUrls	办理页面快照图片链接	false	string
ext	扩展参数	false	string	不为空时必须是JSON字符串，比如 "{"a": "12"}"。云盘阅读必传，字段见云盘阅读

响应参数:

参数名称	参数说明	类型	说明
code	状态码	integer
message	描述	string
data		object	HandleResp
orderId	会员办理订单号	string
status	状态 PROCESSING：处理中 SUCCESS：成功 CANCEL：取消 FAIL：失败	string
msg	失败、处理中的原因	string
redirectUrl	跳转地址三方支付、云盘阅读返回后按对应文档跳转	string

请求示例:

{
  "appId": "", 
  "sign": "",
  "data": {
    "phone": "",
    "productId": "",
    "smsKey": "",
    "smsCode": "",
    "channelTxId": "",
    "notifyUrl": "",
    "adPlatform": "",
    "appName": "",
    "appPackage": "",
    "sourceUrl": "",
    "snapshotUrl": "",
    "imageUrls": "",
    "ext": ""
  }
}

响应示例:

// 接口调用异常
{
  "code": 500,
  "message": "签名失败"
}
// 办理失败
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "FAIL",
    "msg": "用户无权限办理"
  }
}
// 办理中
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "PROCESSING",
    "msg": "待用户回复确认中",
    "redirectUrl": null
  }
}
// 办理成功
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "SUCCESS"
  }
}

查询状态

接口地址: /wy-cel-open/api/member/handle/query/status

2025年5月15日之前对接的产品，使用该接口：/cel-open/api/member/handle/query/status

请求方式: POST

请求数据类型: application/json

接口描述: 用提交办理返回的 orderId 查询订单状态。订单仍是 PROCESSING 时，会向运营商查询最新结果再返回。渠道可以在支付回跳后主动查询。异步产品仍建议同时传入 notifyUrl，接收状态通知。

请求参数:

参数名称	参数说明	是否必须	数据类型	说明
appId	系统标识	true	string
sign	签名	true	string
data	查询入参	true	object	QueryStatusReq
orderId	会员办理订单号	true	string	提交办理返回的订单号

响应参数:

参数名称	参数说明	类型	说明
code	状态码	integer
message	描述	string
data		object	HandleResp
orderId	会员办理订单号	string
status	状态 PROCESSING：处理中 SUCCESS：成功 CANCEL：取消 FAIL：失败	string
msg	失败、处理中的原因	string

请求示例:

{
  "appId": "",
  "sign": "",
  "data": {
    "orderId": "12345678"
  }
}

响应示例:

// 接口调用异常
{
  "code": 500,
  "message": "签名失败"
}
// 订单不存在
{
  "code": 617,
  "message": "订单不存在"
}
// 处理中
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "PROCESSING",
    "msg": ""
  }
}
// 办理成功
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "SUCCESS"
  }
}
// 办理失败
{
  "code": 0,
  "message": "",
  "data": {
    "orderId": "12345678",
    "status": "FAIL",
    "msg": "用户无权限办理"
  }
}

SUCCESS、FAIL、CANCEL 为终态，停止查询。PROCESSING 建议间隔 2 秒以上再查。

状态通知

渠道方提供通知接口地址，觉观触发接口调用

接口地址:

取办理提交接口参数notifyUrl的值

请求方式: POST

请求数据类型: application/json

接口描述: 渠道方在调办理时传入 notifyUrl，在办理成功后会按照如下参数格式，回调此接口进行状态通知。

请求参数:

参数名称	参数说明	是否必须	数据类型
orderId	会员办理订单号	true	string
status	状态，可用值： PROCESSING SUCCESS CANCEL FAIL	false	string
msg	原因	false	string

请求示例:

// 成功
{
  "orderId": "123456",
  "status": "SUCCESS"
}
// 办理中
{
  "orderId": "123456",
  "status": "PROCESSING",
  "msg": ""
}
// 失败
{
  "orderId": "123456",
  "status": "FAIL",
  "msg": "开通异常"
}
// 取消
{
  "orderId": "123456",
  "status": "CANCEL",
  "msg": "退订/退费"
}

响应示例:

ok

接口列表

前置校验 可选

发验证码

提交办理

查询状态

状态通知

前置校验可选