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

1、接口描述

该接口用于实名手机号与办税小号绑定，呼叫办税小号时呼叫转移至实名手机号

2、接口地址

POST /v1/ZHBD/bindAxn  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

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

示例参数

{
    "phoneNoA":"15732681211",
    "phoneNoX":"17092273354"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"915c51ddb1674f2caf982e30db8815a6",
        "success":false,
        "time":201,
        "timestamp":1636186696660
    },
    "value":{
        "code":"SUCCESS",
        "success":true,
        "message":"",
        "data":"1000050000736099"
    }
}
失败返回结果示例
{
    "result":{
        "req_id":"915c51ddb1674f2caf982e30db8815a6",
        "success":false,
        "time":201,
        "timestamp":1636186696660
    },
    "value":{
        "code":"PARAMETER_ERROR",
        "success":false,
        "message":"传入参数不能为空！"
    }
}
  • 字段说明
字段名 说明
data 绑定成功返回的绑定关系Id

5、错误码

错误代码 错误消息 状态码
PARAMETER_ERROR 无效的手机号或固定电话（固定电话需要加区号，区号和号码中间不需要加连字符） phoneNoA，请检查手机号或固定电话格式是否正确 无
PARAMETER_ERROR 无效的办税小号 phoneNoX ，请检查办税小号格式是否正确！ 无
PARAMETER_ERROR 实名手机号 phoneNoA与号码池key为poolKey 的办税小号 phoneNoX 绑定失败！ 无

更换绑定的实名手机号

1、接口描述

该接口用于更换与办税小号绑定的实名手机号，呼叫办税小号时呼叫转移至实名手机号

2、接口地址

POST /v1/ZHBD/updateNoA  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
oldNoA String 是 旧的实名手机号
phoneNoA String 是 要换绑为的实名手机号（可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。）
phoneNoX String 是 办税小号
  • 示例参数
{
    "oldNoA":"15732681211",
    "phoneNoA":"15732681212",
    "phoneNoX":"17092273354"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"55a0b9c64e3c4792a9b026b306dd53a1",
        "success":true,
        "time":234,
        "timestamp":1636031393579
    },
     "value":{
        "code":"SUCCESS",
        "success":true,
        "message":"",
        "data":true
    }
}
返回失败示例
{
    "result":{
        "req_id":"9292b64c0b034134bd89de8d0753b06d",
        "success":false,
        "time":192,
        "timestamp":1636361875139
    },
    "value":{
        "code":"PARAMETER_ERROR",
        "success":false,
        "message":"传入的参数-原来的实体手机号phoneNoA不能为空！"
    }
}
  • 字段说明
字段名 说明
data 实名手机号更换结果，true成功，false失败

5、错误码

错误代码 错误消息 状态码
PARAMETER_ERROR 无效的办税小号phoneNoX ，请检查办税小号格式是否正确！ 无
PARAMETER_ERROR 无效的手机号或固定电话（固定电话需要加区号，区号和号码中间不需要加连字符）phoneNoA，请检查手机号或固定电话格式是否正确 无
PARAMETER_ERROR 号码池key为 poolKey 的办税小号 phoneNoX 绑定关系已更新，更新后的实名手机号为phoneNoA，绑定id为subsId 无
PARAMETER_ERROR 号码池key为poolKey 的办税小号phoneNoX 更新绑定的实名手机号phoneNoA失败！ 无

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

1、接口描述

该接口用于解除实名手机号与办税小号的绑定关系，呼叫办税小号时不再呼叫转移至实名手机号

2、接口地址

POST /v1/ZHBD/unbind  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
phoneNoA String 是 要解除绑定的实名手机号（可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。）
phoneNoX String 是 办税小号
  • 示例参数
{
    "phoneNoA":"15732681211",
    "phoneNoX":"17092273354"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"55a0b9c64e3c4792a9b026b306dd53a1",
        "success":true,
        "time":234,
        "timestamp":1636031393579
    },
   "value":{
        "code":"SUCCESS",
        "success":true,
        "message":"",
        "data":true
    }
}
返回失败示例
{
    "result":{
        "req_id":"8fc4454f42354ec2956517c3f4a5bde9",
        "success":false,
        "time":185,
        "timestamp":1636360481439
    },
   "value":{
        "code":"PARAMETER_ERROR",
        "success":false,
        "message":"传入参数不能为空！"
    }
}
  • 字段说明
字段名 说明
data 解除绑定结果，true成功，false失败

5、错误码

错误代码 错误消息 状态码
PARAMETER_ERROR 无效的办税小号phoneNoX ，请检查办税小号格式是否正确！ 无
PARAMETER_ERROR 号码池key为poolKey的办税小号phoneNoX尚未绑定！ 无
PARAMETER_ERROR 号码池key为 poolKey绑定关系id为 subsId的办税小号phoneNoX解除绑定关系失败！ 无

查询短信验证码

1、接口描述

该接口用于根据手机号码查询企业短信验证码信息（接口只会返回最新的10条短信验证码信息）

2、接口地址

POST /v1/YZM/queryNote  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
receiver String 是 办税小号手机号
  • 示例参数
{
    "receiver":办税小号手机号,
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果：
{
    "result": {
        "req_id": "15494e9b445a48adbf3fff190451aa53",
        "success": true,
        "time": 1782,
        "timestamp": 1584940352021
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "",
        "data":[
            {
            "sender":"发送人号码",
            "receiver":"接收人手机号码",
            "smsContent":"短信内容",
            "createtime":"短信创建时间"
            }
         ]
    }
}
错误返回报文：
{
    "result":{
        "req_id":"00fc190f84c7490890f87215bc94c793",
        "success":true,
        "time":80,
        "timestamp":1636019234079
    },
    "value":{
        "code":"PARAMETER_ERROR",
        "success":false,
        "message":"接收人手机号码不能为空"
    }
}
查询无结果：
{
    "result":{
        "req_id":"00fc190f84c7490890f87215bc94c793",
        "success":true,
        "time":80,
        "timestamp":1636019234079
    },
    "value":{
        "code":"NO_RESULT",
        "success":false,
        "message":"未查到结果！"
    }
}
  • 字段说明
字段名 数据类型 说明
success Boolean 成功标志，true成功、false失败
code String 错误码
message String 错误信息
data Array 数据
  • data数据说明
字段名 说明
sender 发送人号码
receiver 接收人手机号码
smsContent 短信内容
createtime 短信创建时间

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 接收人手机号码不能为空！ 200
NO_RESULT 未查到结果！！ 200

上报短信验证码

1、接口描述

该接口用于接口对接客户调用上报短信验证码的场景

2、接口地址

POST /v1/YZM/reportCaptchaSmsForIc  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
receiver String 是 接收人手机号码
nsrsbh String 是 验证码对应纳税人识别号
content String 是 验证码短信内容
  • 示例参数
{
    "receiver":接收人手机号码,
    "nsrsbh":验证码对应纳税人识别号,
    "content":验证码短信内容
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果：
{
    "result": {
        "req_id": "15494e9b445a48adbf3fff190451aa53",
        "success": true,
        "time": 1782,
        "timestamp": 1584940352021
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "",
        "data":true
    }
}
错误返回报文：
{
    "result":{
        "req_id":"00fc190f84c7490890f87215bc94c793",
        "success":true,
        "time":80,
        "timestamp":1636019234079
    },
    "value":{
        "code":"PARAMETER_ERROR",
        "success":false,
        "message":"接收人手机号码（receiver）不能为空！"
    }
}
  • 字段说明
字段名 数据类型 说明
success Boolean 业务成功标志，true成功、false失败
code String 错误码
message String 错误信息
data Boolean 验证码上报成功
  • 5、错误码
错误代码 错误信息
PARAMETER_ERROR 接收人手机号码（receiver）不能为空！
纳税人识别号（nsrsbh）不为空！
验证码内容（content）不为空！

办税小号通话清单查询

1、接口描述

此接口用于用户通过办税小号查询通话清单。

2、接口地址

POST /v1/ZHBD/querySecretReportPageList  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
phone_no String 否 实名手机号,即A号码
secret_no String 是 办税小号,即X号码
peer_no String 否 AXB中的B号码或者N号码
call_type Interger 否 呼叫类型。取值：0：主叫，即phone_no打给peer_no。1：被叫，即peer_no打给phone_no。4：呼叫拦截。
starttime String 否 查询通话的开始时间,格式为：yyyy-MM-dd HH:mm:ss,默认当天0点0分0秒
endtime String 否 查询通话的结束时间,格式为：yyyy-MM-dd HH:mm:ss，默认当天23点59分59秒
page Object 否 分页信息，可选，不传默认返回第 1 页，分页大小 100

page参数

参数名称 参数类型 是否必填 说明
pageSize int 否 分页大小，默认100
currentPage int 否 当前页，默认1
  • 示例参数
{
    "secret_no":"18xxxxxxxxx",
    "starttime":"2023-03-20 00:00:00",
    "endtime":"2023-03-29 23:59:59",
    "page":{
        "currentPage":1,
        "pageSize":100
    }
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果：
{
    "result":{
        "req_id":"f180a18300d048b190876e20a03a2ac8",
        "success":true,
        "time":66,
        "timestamp":1680070945436
    },
    "value":{
        "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":"1xxxxxxxxxx",
                "call_type":1,
                "release_time":"2023-03-29 09:08:58"
            }
        ]
    }
}

错误返回报文：
{
    "result":{
        "req_id":"859aa47f22a4482f96e17a3968d7ecbb",
        "success":false,
        "time":23,
        "timestamp":1680071012996
    },
    "error":{
        "code":"600001",
        "message":"参数secret_no不能为空！"
    }
}
  • 字段说明
参数名称 参数类型 是否返回 说明
id Long 是 唯一id
phone_no String 是 实名手机号,即A号码
secret_no String 是 办税小号,即X号码
peer_no String 是 AXB中的B号码或者N号码
call_type Interger 是 呼叫类型。取值：0：主叫，即phone_no打给peer_no。1：被叫，即peer_no打给phone_no。4：呼叫拦截。
call_time String 是 主叫拨打时间，格式为：yyyy-MM-dd HH:mm:ss
start_time String 是 查询通话的开始时间,格式为：yyyy-MM-dd HH:mm:ss
release_time String 否 查询通话的结束时间,格式为：yyyy-MM-dd HH:mm:ss
talktime Long 是 通话时间，单位毫秒
unconnected_cause Integer 否 未接通通话的原因归类。取值：0：正常通话。1：黑名单拦截。2：无绑定关系。3：呼叫限制。4：其他。
release_dir Interger 是 通话释放方向。 取值：0：平台释放。1：主叫挂断。2：被叫挂断
  • 5、错误码
错误代码 错误信息
PARAMETER_ERROR 参数secret_no不能为空

短信通知接口

前提条件

1、客户添加应用时需设置短信通知接收地址，并确保提供的地址能够正常处理平台发送的通知消息。如果需要开启短信通知功能，请通过配置短信通知地址配置短信接受地址。

1、接口描述

此接口向客户推送办税小号的短信通知。 客户收到通知后返回HTTP状态码为200的空消息即可。

2、接口地址

POST 客户提供的短信通知地址  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

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

示例参数

{
    "callId":"a1234xxxxxxxx",
    "pushTime":"2023-04-25 15:53:30",
    "receiveTime":"2023-04-25 15:53:26",
    "receiver":"170XXXXXXXX",
    "sender":"131XXXXXXXX",
    "smsContent":"【山东税务】务平台功能，验证码为xxxxxx，请您输入短信验证码完成操作。（温馨提示：请勿泄露短信验证码）"
}

4、返回结果

客户服务器接收到短信事件通知后，返回无消息体的200响应

响应示例：
HTTP/1.1 200 OK

配置短信通知地址

1、接口描述

此接口用于客户配置短信接受地址

2、接口地址

POST /v1/AGG/sms/editPushSmsConfig  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
callbackUrl String 是 短信接受地址
  • 示例参数
{
"callbackUrl":"https://xxx.com/"
}

4、返回结果

示例返回结果：

{
    "result":{
        "req_id":"5b0694c6f3af4771b88f76f31bf954fb",
        "success":true,
        "time":2679,
        "timestamp":1682490150446
    },
    "value":{
        "code":"SUCCESS",
        "data":true,
        "success":true,
        "message":""
    }
}

创建小号订单

1、接口描述

此接口用于用户购买小号，创建订单使用。

2、接口地址

POST /v1/ZHBD/createBsxhOrder  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
uniCode String 是 客户传入订单的唯一标识
bsxhNum Integer 是 购买办税小号的数量
  • 示例参数
{
  "uniCode":"a123456789",
  "bsxhNum":10
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果：
{
    "result":{
        "req_id":"41fbefcd894d4a21a83730bf013382e4",
        "success":true,
        "time":90,
        "timestamp":1684069987389
    },
    "value":{
        "code":"SUCCESS",
        "data":{
            "createTime":"2023-05-13 21:13:07",
            "uniCode":"a123456789",
            "appKey":10xxxxx,
            "id":465623822463680,
            "bsxhNum":10
        },
        "success":true,
        "message":""
    }
}

错误返回报文：
{
    "result":{
        "req_id":"d0cbb450aa6e478d9c9a7a881b3a3979",
        "success":true,
        "time":146,
        "timestamp":1684069847432
    },
    "value":{
        "code":"INTERFACE_ERROR",
        "success":false,
        "message":"uniCode=a123456789的订单已存在"
    }
}
  • 字段说明
参数名称 参数类型 是否返回 说明
id Long 是 企享云平台的订单唯一id
uniCode String 是 客户系统的订单唯一标识
appKey Long 是 客户的appkey
  • 5、错误码
错误代码 错误信息
PARAMETER_ERROR 参数uniCode不能为空

查询小号订单详情

1、接口描述

此接口用于查询小号订单详情

2、接口地址

POST /v1/ZHBD/queryBsxhOrder  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
uniCode String 是 客户传入订单的唯一标识
  • 示例参数
{
  "uniCode":"a123456789"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果：
{
    "id":465623822463680,
    "uniCode":"a123456789",
    "appKey":1xxxxxx,
    "effectiveNum":8,
    "pushTime":"2023-05-13 14:03:25",
    "bsxhNum":10,
    "effectiveBsxhList":["170xxxxxxxx","170xxxxxxxx","170xxxxxxxx","170xxxxxxxx","170xxxxxxxx","170xxxxxxxx","170xxxxxxxx","170xxxxxxxx"]
}

错误返回报文：
{
    "result":{
        "req_id":"d0cbb450aa6e478d9c9a7a881b3a3979",
        "success":true,
        "time":146,
        "timestamp":1684069847432
    },
    "value":{
        "code":"INTERFACE_ERROR",
        "success":false,
        "message":"uniCode=a123456789的订单不存在"
    }
}
  • 字段说明
参数名称 参数类型 是否返回 说明
id Long 是 企享云平台的订单唯一id
uniCode String 是 客户系统的订单唯一标识
appKey Long 是 客户的appkey
pushTime String 是 订单最新的推送时间
  • 5、错误码
错误代码 错误信息
PARAMETER_ERROR 参数uniCode不能为空

小号开通通知接口

前提条件

1、客户添加应用时需设置小号开通接收地址，并确保提供的地址能够正常处理平台发送的通知消息。如果需要开小号开通成功通知功能，请通过配置小号开通通知地址配置开通的小号接受地址。

1、接口描述

此接口向客户推送开通小号的通知。 客户收到通知后返回HTTP状态码为200的空消息即可。

2、接口地址

POST 客户提供的通知地址  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

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

示例参数

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

4、返回结果

客户服务器接收到事件通知后，返回无消息体的200响应

响应示例：
HTTP/1.1 200 OK

配置小号开通通知地址

1、接口描述

此接口用于客户配置小号开通接受地址

2、接口地址

POST /v1/ZHBD/editBsxhOrderPushUrlConfig  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为 JSON 格式。

参数名称 参数类型 是否必填 说明
callbackUrl String 是 短信接受地址
  • 示例参数
{
"callbackUrl":"https://xxx.com/"
}

4、返回结果

示例返回结果：

{
    "result":{
        "req_id":"5b0694c6f3af4771b88f76f31bf954fb",
        "success":true,
        "time":2679,
        "timestamp":1682490150446
    },
    "value":{
        "code":"SUCCESS",
        "data":true,
        "success":true,
        "message":""
    }
}

results matching ""

    No results matching ""