Skip to content

Number Check API query

GiuFLim edited this page Aug 2, 2023 · 16 revisions

概要

  • 号码检测查询接口

请求URL

http://api2.nxcloud.com/api/number/query

请求方式

  • Method: POST
  • Content-Type: application/json

鉴权机制

鉴权规则请参考地址:API接口调用约定

image

请求Header

参数名称 参数类型 是否必填 示例值 参数描述
accessKey String fme2na3kdi3ki 用户身份标识
ts String 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒
bizType String 1 [业务类型] 固定值 用来标识号码检测
action String numbercheck 固定值 用来标识号码检测
sign String 6e9506557d1f289501d333ee2c365826 API入参参数签名,签名算法

请求Body

参数名 必选 类型 说明
messageId string 查询检测结果的messageId,业务id, 客户回执中推送

请求示例

{
    "messageId": "311950bba96d49b29eb89c9c3cdcd2c1-267371"
}

成功返回 字段含义 请参照回执接口 ** https://github.com/nxtele/http-api-document/wiki/Number-Check-API-callback **

{
    "messageId": "311950bba96d49b29eb89c9c3cdcd2c1-267371",
    "code": 0,
    "msg": "success",
    "batchNo": "801811903570",
    "phone": "84522291021",
    "data": {
        "basic": {
            "preCheck": "YES",
            "regionCode": "VN",
            "countryCode": "84",
            "nationalNumber": "522291021",
            "standNumber": "84522291021",
            "numberType": 2,
            "carrier": "Vietnamobile"
        },
        "live": {
            "validity": "UNKNOWN",
            "reachable": "UNKNOWN",
            "roaming": "UNKNOWN"
        }
    },
    "cost": {
        "price": 0.0100,
        "currency": "USD"
    }
}

失败返回

{
    "msg": "messageId不合法",
    "code": 319,
    "data": {}
}

错误代码

code msg
0 成功
88 请求失败
319 messageId不合法
320 messageId不属于当前客户

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally