开发文档

1 Number_check（mix） 国际空号检测

1.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.tig253.com/open/credit/sgunn/numberCheckMix

1.2 请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://innopaas.com/ 登录后获取
appKey	String	是	请在https://innopaas.com/ 登录后获取
mobile	String	是	号码，示例：+2347015501869

1.3 相应内容

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录响应 code 码
message	String	响应 code 码解释
reqId	String	请求 id
chargeStatus	int	是否收费，枚举值：1 ：收费； 0：不收费
chargeCount	int	计费条数
data	Object
number	String	电话号码，以国家代码开头的标准格式电话号码
status	String	是否为实号， 0：查询失败 1：实号 2：空号 3：未知 4：其他
chargeStatus	String	是否计费，1：计费；0：不计费
originalOperator	Object	原始运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的 GSM-R 网络的代码
is_hlr	String	是否支持运营商库查询
ocn	String	运营商标记（仅北美）

{
    "code": "200000",
    "message": "success",
    "reqId": "180705520776506917",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "number": "+8617380939999",
        "status": "3",
        "chargeStatus": "1",
        "originalOperator": {
            "mnc": "11",
            "is_hlr": "0",
            "ocn": null,
            "mcc": "460",
            "region": "CN",
            "type": "mobile",
            "operator": "China Telecom"
        }
    }
}

2 Number_portability 国际携号转网检测

2.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.tig253.com/open/credit/sgsftp/all_mnp

2.2 请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://innopaas.com/ 登录后获取
appKey	String	是	请在https://innopaas.com/ 登录后获取
mobile	String	是	号码，示例：+2347015501869

2.3 响应内容

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录响应 code 码
message	String	响应 code 码解释
reqId	String	请求 id
chargeStatus	int	是否收费，枚举值：1 ：收费； 0：不收费
chargeCount	int	计费条数
data	Object
number	String	电话号码，以国家代码开头的标准格式电话号码
chargeStatus	String	是否计费，1：计费；0：不计费
originalOperator	Object	原始运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的 GSM-R 网络的代码
ocn	String	ocn运营商标记（仅北美）
currentOperator	Object	当前运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的GSM-R网络的代码

{
    "code": "200000",
    "message": "success",
    "reqId": "171698307359457058",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "number": "+525517271436",
        "chargeStatus": "1",
        "originalOperator": {
            "mnc": "050",
            "ocn": null,
            "mcc": "334",
            "region": "MX",
            "type": "mobile",
            "operator": "AT&T COMERCIALIZACION MOVIL"
        },
        "currentOperator": {
            "mnc": "020",
            "type": "Mobile",
            "mcc": "334",
            "region": "MX",
            "operator": "ALTCEL S.A.P.I. DE C.V."
        }
    }
}

3 Number_check（live） 国际状态检测live

3.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.tig253.com/open/credit/sgunn/all_empty
备注	使用本接口请联系创蓝商务开一个用于登陆 https://innopaas.com/ 后台的账号，开好后客户自行前往后台激活产品获取appid

3.2 请求参数

参数名	类型	是否必填	说明
appId	String	是	请在 https://innopaas.com/ 登录后获取。
appKey	String	是	请在 https://innopaas.com/ 登录后获取。
mobile	String	是	号码，示例：+2347015501869

3.3 响应内容

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录响应 code 码
message	String	响应 code 码解释
reqId	String	请求 id
chargeStatus	int	是否收费，枚举值：1 ：收费； 0：不收费
chargeCount	int	计费条数
data	Object
number	String	电话号码，以国家代码开头的标准格式电话号码
status	String	是否为实号， 0：查询失败 1：实号 2：空号 3：未知 4：其他
chargeStatus	String	是否计费，1：计费；0：不计费
originalOperator	Object	原始运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的 GSM-R 网络的代码
is_hlr	String	是否支持运营商库查询 1:支持 0:不支持
ocn	String	运营商标记（仅北美）

{
    "code": "200000",
    "message": "success",
    "reqId": "171698307359457048",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "number": "+525517271431",
        "status": "1",
        "chargeStatus": "1",
        "originalOperator": {
            "mnc": "050",
            "is_hlr": "1",
            "ocn": null,
            "mcc": "334",
            "region": "MX",
            "type": "mobile",
            "operator": "AT&T COMERCIALIZACION MOVIL"
        }
    }
}

4 Number_check（live） 国际状态检测live 批量检测接口

4.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.tig253.com/customized/numberCheck/batchLive

4.2 请求参数

参数名	类型	是否必填	说明
appId	String	是	请在 https://innopaas.com/ 登录后获取。
appKey	String	是	请在 https://innopaas.com/ 登录后获取。
mobile	String	是	号码，多个号码以英文逗号隔开，最多支持50个号码。示例：+2347015501869,+2347015501861

4.3 响应内容

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录响应 code 码
message	String	响应 code 码解释
reqId	String	请求 id
chargeStatus	int	是否收费，枚举值：1 ：收费； 0：不收费
chargeCount	int	计费条数
data	List
code	String	响应code码。200000：成功，其他失败。见附录响应code码
number	String	电话号码，以国家代码开头的标准格式电话号码
message	String	响应 code 码解释
reqId	String	请求 id
data	Object
number	String	电话号码，以国家代码开头的标准格式电话号码
status	String	是否为实号， 0：查询失败 1：实号 2：空号 3：未知 4：其他
chargeStatus	String	是否计费，1：计费；0：不计费
originalOperator	Object	原始运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的 GSM-R 网络的代码
is_hlr	String	是否支持运营商库查询 1:支持 0:不支持
ocn	String	运营商标记（仅北美）

{{
    "code": "200000",
    "message": "success",
    "reqId": "KJVJ1008375009370046464",
    "chargeStatus": 1,
    "chargeCount": "3",
    "data": [
        {
            "code": "200000",
            "number": "+8617380939991",
            "message": "success",
            "reqId": "216751714584503877",
            "data": {
                "number": "+8617380939991",
                "originalOperator": {
                    "mnc": "11",
                    "is_hlr": "0",
                    "ocn": null,
                    "mcc": "460",
                    "region": "CN",
                    "type": "mobile",
                    "operator": "China Telecom"
                },
                "chargeStatus": "1",
                "status": "3"
            }
        },
        {
            "code": "200000",
            "number": "+525517271436",
            "message": "success",
            "reqId": "207744515162621519",
            "data": {
                "number": "+525517271436",
                "originalOperator": {
                    "mnc": "050",
                    "is_hlr": "1",
                    "ocn": null,
                    "mcc": "334",
                    "region": "MX",
                    "type": "mobile",
                    "operator": "AT&T COMERCIALIZACION MOVIL"
                },
                "chargeStatus": "1",
                "status": "1"
            }
        },
        {
            "code": "200000",
            "number": "+8617380939999",
            "message": "success",
            "reqId": "207744515162621520",
            "data": {
                "number": "+8617380939999",
                "originalOperator": {
                    "mnc": "11",
                    "is_hlr": "0",
                    "ocn": null,
                    "mcc": "460",
                    "region": "CN",
                    "type": "mobile",
                    "operator": "China Telecom"
                },
                "chargeStatus": "1",
                "status": "3"
            }
        }
    ]
}

5 Number_activity 活跃号检测（待上线）

5.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://wsapi.tig253.com/open/credit/sgunn/all_active
备注	使用本接口请联系创蓝商务开一个用于登陆 https://innopaas.com/ 后台的账号，开好后客户自行前往后台激活产品获取appid

5.2 请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://innopaas.com/ 登录后获取
appKey	String	是	请在 https://innopaas.com/ 登录后获取
mobile	String	是	号码，示例：+2347015501869

5.3 响应内容

字段名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。见附录响应 code 码
message	String	响应 code 码解释
reqId	String	请求 id
chargeStatus	int	是否收费，枚举值：1 ：收费； 0：不收费
chargeCount	int	计费条数
data	Object
number	String	电话号码，以国家代码开头的标准格式电话号码
actionStatus	String	是否为活跃号 0：高活跃 1：低活跃 2：未知
chargeStatus	String	是否计费，1：计费；0：不计费
originalOperator	Object	原始运营商信息
region	String	国家地区
type	String	号码类型 FIXED_LINE：固定电话 MOBILE：移动电话 FIXED_LINE_OR_MOBILE：固定电话或移动电话 TOLL_FREE：免费电话 PREMIUM_RATE：高费率电话 SHARED_COST：共享成本电话 VOIP：网络电话, PERSONAL_NUMBER：个人号码 PAGER：传呼机 UAN：万能访问号码 VOICEMAIL：语音信箱 UNKNOWN：未知
operator	String	移动运营商名称，号码所属的移动运营商名称
mcc	String	移动国家代码，移动用户进行注册的国家代码
mnc	String	移动网络代码，所在国家的 GSM-R 网络的代码
ocn	String	ocn运营商标记（仅北美）

{
    "code": "200000",
    "message": "success",
    "reqId": "180705520776506914",
    "chargeStatus": 1,
    "chargeCount": "1",
    "data": {
        "number": "+525517271436",
        "actionStatus": "0",
        "chargeStatus": "1",
        "originalOperator": {
            "mnc": "050",
            "ocn": null,
            "mcc": "334",
            "region": "MX",
            "type": "mobile",
            "operator": "AT&T COMERCIALIZACION MOVIL"
        }
    }
}

附录：响应 code 码

code 码	说明
200000	请求成功
400001	参数校验异常
403000	用户校验失败
415000	请求数据转换异常
500000	系统异常
500002	数据处理异常
500003	业务操作失败
500004	远程调用失败
500005	账户余额异常
500006	请求外部系统失败
504000	系统超时
500007	请求 IP 不合法
500008	请求速率超限
500013	当前产品未开通
400101	在下游系统中的商户信息不存在
403101	账户被下游系统禁用
403102	账户在下游系统中没有被激活
510101	在下游系统中的用户产品可用数量不足
400102	商户 IP 地址在下游系统中不合法
400200	黑名单列表
400201	手机号码不能为空
400203	最大上传图片为 3 张
400901	账户信息不存在
400902	应用类型信息不存在
500901	邮箱未设置
500902	账户信息已存在
500903	账户相关能力已激活
500904	日消耗统计文件已存在
500905	文件生成失败
500906	更新文件状态失败
500907	删除文件失败
500908	url 与文件只能选择一个进行上传