星云税融API

API 文档
Base URL: https://shuiwu.xingyunv2.cn
接口文档
文档 / 办税小号

办税小号

小号申请、绑定、短信管理

申请小号订单

申请办税小号

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/apply

请求参数

参数名 类型 必填 说明
uniCode String 是 客户传入订单的唯一标识
bsxhNum String 是 购买办税小号的数量
useType String 否 使用类型：0=测试，1=正式使用，默认为1

请求示例

JSON 
{
    "uniCode": "a123456789",
    "bsxhNum": 10
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data.id Integer 订单ID
data.uniCode String 客户系统的订单唯一标识
data.appKey Integer 客户的appkey
data.bsxhNum Integer 购买办税小号数量
data.createTime String 订单创建成功时间

响应示例

JSON 
{
    "req_id": "41fbefcd894d4a21a83730bf013382e4",
    "code": "SUCCESS",
    "data": {
        "createTime": "2023-05-13 21:13:07",
        "uniCode": "a123456789",
        "appKey": 10001000,
        "id": 465623822463680,
        "bsxhNum": 10
    },
    "success": true,
    "message": ""
}

查询小号订单详情

查询小号订单

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/order/query

请求参数

参数名 类型 必填 说明
uniCode String 是 客户传入订单的唯一标识

请求示例

JSON 
{
    "uniCode": "a123456789"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data.id Integer 订单ID
data.uniCode String 客户系统的订单唯一标识
data.appKey Integer 客户的appkey
data.bsxhNum String 订单小号数量
data.effectiveBsxhList Array 办税小号明细列表
data.createTime String 订单创建成功时间

响应示例

JSON 
{
    "reqId": "2fc*******464e9639906",
    "code": "SUCCESS",
    "success": true,
    "message": "",
    "data": {
        "appKey": 10001000,
        "bsxhNum": 1,
        "createTime": "2024-02-02 16:05:16",
        "effectiveBsxhList": [
            "170xxxxxxxx"
        ],
        "id": 512300045792,
        "uniCode": "a123456789"
    }
}

绑定实名手机号

绑定实名手机号与办税小号

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/bind

请求参数

参数名 类型 必填 说明
phoneNoA String 是 实名手机号（可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不加连字符）
phoneNoX String 是 办税小号

请求示例

JSON 
{
    "phoneNoA": "157xxxxxxxx",
    "phoneNoX": "170xxxxxxxx"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data String 绑定成功返回的绑定关系Id

响应示例

JSON 
{
    "reqId": "915c51ddb1674f2caf982e30db8815a6",
    "code": "SUCCESS",
    "success": true,
    "message": "",
    "data": "1000050000736099"
}

更换绑定手机号

更换绑定的实名手机号

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/rebind

请求参数

参数名 类型 必填 说明
oldNoA String 是 旧的实名手机号
phoneNoA String 是 要换绑为的实名手机号（可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不加连字符）
phoneNoX String 是 办税小号

请求示例

JSON 
{
    "oldNoA": "1573xxxxxxx",
    "phoneNoA": "1574xxxxxxx",
    "phoneNoX": "170xxxxxxx"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data Boolean 更换结果，true=成功，false=失败

响应示例

JSON 
{
    "reqId": "55a0b9c64e3c4792a9b026b306dd53a1",
    "code": "SUCCESS",
    "success": true,
    "message": "",
    "data": true
}

解除绑定

解除实名手机号绑定

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/unbind

请求参数

参数名 类型 必填 说明
phoneNoA String 是 要解除绑定的实名手机号（可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不加连字符）
phoneNoX String 是 办税小号

请求示例

JSON 
{
    "phoneNoA": "157xxxxxxxx",
    "phoneNoX": "170xxxxxxxx"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data Boolean 解除绑定结果，true=成功，false=失败

响应示例

JSON 
{
    "reqId": "55a0b9c64e3c4792a9b026b306dd53a1",
    "code": "SUCCESS",
    "success": true,
    "message": "",
    "data": true
}

通话清单查询

办税小号通话清单查询

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/call/list

请求参数

参数名 类型 必填 说明
secret_no String 是 办税小号（X号码）
phone_no String 否 实名手机号（A号码）
peer_no String 否 验证码短信内容
call_type String 否 呼叫类型：0=主叫，1=被叫，4=呼叫拦截
starttime String 否 查询通话开始时间，格式yyyy-MM-dd HH:mm:ss，默认当天0点
endtime String 否 查询通话结束时间，格式yyyy-MM-dd HH:mm:ss，默认当天23:59:59
page.currentPage Integer 否 当前页码，默认1
page.pageSize Integer 否 每页大小，默认100

请求示例

JSON 
{
    "secret_no": "170xxxxxxxx",
    "starttime": "2023-03-20 00:00:00",
    "endtime": "2023-03-29 23:59:59",
    "page": {
        "currentPage": 1,
        "pageSize": 100
    }
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data.page.totalPage Integer 总页数
data.page.pageSize Integer 每页大小
data.page.currentPage Integer 当前页码
data.page.totalCount Integer 总记录数
data.list[].id Integer 记录ID
data.list[].phone_no String 实名手机号
data.list[].secret_no String 办税小号
data.list[].peer_no String 对端号码
data.list[].call_type Integer 呼叫类型：0=主叫，1=被叫
data.list[].call_time String 通话时间
data.list[].start_time String 开始时间
data.list[].release_time String 释放时间
data.list[].talktime Integer 通话时长（秒）
data.list[].release_dir Integer 释放方向
data.list[].unconnected_cause Integer 未接通原因

响应示例

JSON 
{
    "req_id": "f180a18300d048b190876e20a03a2ac8",
    "success": true,
    "data": {
        "page": {
            "totalPage": 1,
            "pageSize": 100,
            "currentPage": 1,
            "totalCount": 1
        },
        "list": [
            {
                "phone_no": "18xxxxxxxxx",
                "unconnected_cause": 0,
                "call_time": "2023-03-29 09:08:58",
                "peer_no": "106xxxxxxx9999999",
                "release_dir": 0,
                "start_time": "2023-03-29 09:08:58",
                "talktime": 0,
                "id": 1038886104699,
                "secret_no": "170xxxxxxxx",
                "call_type": 1,
                "release_time": "2023-03-29 09:08:58"
            }
        ]
    }
}

查询短信验证码

查询小号收到的短信验证码

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/sms/query

请求参数

参数名 类型 必填 说明
receiver String 是 办税小号手机号
dq String 否 地区代码，见附录地区代码

请求示例

JSON 
{
    "receiver": "170xxxxxxxx"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data[].sender String 发送人号码
data[].receiver String 接收人手机号码
data[].smsContent String 短信内容
data[].createtime String 短信创建时间

响应示例

JSON 
{
    "reqId": "55a0b9c64e3c4792a9b026b306dd53a1",
    "code": "SUCCESS",
    "success": true,
    "message": "",
    "data": [
        {
            "sender": "106xxxxxxxx",
            "receiver": "170xxxxxxxx",
            "smsContent": "您的验证码为123456",
            "createtime": "2024-01-01 10:00:00"
        }
    ]
}

配置小号订单开通通知地址

配置小号订单开通通知地址

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/notify/config

请求参数

参数名 类型 必填 说明
callbackUrl String 否 短信接受地址

请求示例

JSON 
{
    "callbackUrl": "https:\/\/xxx.com\/"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data Boolean 保存结果，true=成功，false=失败

响应示例

JSON 
{
    "req_id": "f180a18300d048b190876e20a03a2ac8",
    "success": true,
    "data": true
}

小号订单开通通知回调

小号订单开通通知回调

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/notify/callback

请求参数

参数名 类型 必填 说明
id Integer 是 企享云系统的订单id
uniCode String 是 客户系统的订单唯一标识
appKey Integer 是 客户的appkey
bsxhNum Integer 是 订单购买的小号总数
effectiveNum String 是 所有有效的小号数量
effectiveBsxhList Array 是 所有有效的小号列表
pushTime String 是 订单最新的推送时间

请求示例

JSON 
{
    "id": 465623822463680,
    "uniCode": "a123456789",
    "appKey": 10001000,
    "effectiveNum": 8,
    "bsxhNum": 10,
    "pushTime": "2023-05-13 14:03:25",
    "effectiveBsxhList": [
        "170xxxxxxxx",
        "170xxxxxxxx"
    ]
}

响应参数

参数名 类型 说明
code String 返回2000表示成功
message String SUCCESS

响应示例

JSON 
{
    "code": "2000",
    "message": "SUCCESS"
}

配置小号短信通知地址

配置小号短信通知地址

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/sms/notify/config

请求参数

参数名 类型 必填 说明
callbackUrl String 是 短信接受地址
hqnr String 否 获取内容：1=验证码信息，2=全量短信信息，默认为1

请求示例

JSON 
{
    "callbackUrl": "https:\/\/xxx.com\/"
}

响应参数

参数名 类型 说明
reqId String 请求id，由服务器端生成的唯一标识
code String 错误码
success Boolean 是否成功标记
message String 错误信息
data Boolean 配置结果，true=成功，false=失败

响应示例

JSON 
{
    "req_id": "5b0694c6f3af4771b88f76f31bf954fb",
    "success": true,
    "code": "SUCCESS",
    "data": true
}

小号短信通知回调

小号短信通知回调

登录查看报价
POST https://shuiwu.xingyunv2.cn/api/v1/proxy/virtual-number/sms/notify/callback

请求参数

参数名 类型 必填 说明
callId String 是 短信唯一标识
sender String 是 短信的发送人，一般指当地税局的号码
receiver String 是 短信的接收人，即办税小号
smsContent String 是 短信内容
receiveTime String 是 短信收到的时间，格式yyyy-MM-dd HH:mm:ss
pushTime String 是 短信推送给客户的时间，格式yyyy-MM-dd HH:mm:ss

请求示例

JSON 
{
    "callId": "a1234xxxxxxxx",
    "pushTime": "2023-04-25 15:53:30",
    "receiveTime": "2023-04-25 15:53:26",
    "receiver": "170XXXXXXXX",
    "sender": "10690510000000562537",
    "smsContent": "【山东税务】验证码为xxxxxx，请您输入短信验证码完成操作。"
}

响应参数

参数名 类型 说明
code String 返回2000表示成功
message String 成功

响应示例

JSON 
{
    "code": "2000",
    "message": "成功"
}

© 2026 星云税融API. All rights reserved.

如需接入支持，请联系技术团队 | 注册账号