Skip to content

OTA API verify

momi00 edited this page Sep 5, 2023 · 7 revisions

身份验证结果

通过API获取身份验证的结果

  • URL:https://api2.nxcloud.com/api/ota/verify
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:

鉴权机制

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

请求参数

header参数:

参数名 类型 必选 示例值 说明
accessKey String fme2na3kdi3ki 用户身份标识
ts String 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒
bizType String 6 OTA业务类型,取固定值“6”
action String verify OTA业务操作,取固定值“verify”
sign String 6e9506557d1f289501d333ee2c365826 API入参参数签名,签名算法

body参数:

参数名 类型 必选 示例值 说明
appkey String pem28kje 应用appkey
requestId String 989d535f78338411f7de07c028ddee4b 一键登录请求接口返回的requestId

请求示例

body(application/json) 参数:

{
    "appkey": "pem28kje",
    "requestId": "989d535f78338411f7de07c028ddee4b"
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
msg String 请求结果说明

请求成功

  • data 参数:
参数名 类型 说明
requestId String 请求ID
status String 身份验证结果(SUCCESS:成功,PENDING:等待,MISMATCH:不匹配,FAILURE:失败,UNKNOWN:未知)

响应示例

成功示例

{
    "code": 0,
    "msg": "请求成功",
    "data": {
        "requestId": "989d535f78338411f7de07c028ddee4b",
        "status": "SUCCESS"
    }
}

失败示例

{
    "code": 88,
    "msg": "请求失败",
    "data": null
}

响应码说明

code message 解决办法
0 Request successful
99 System error 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看API鉴权部分
9901 Parameter error or empty 参数遗漏,请检查必须的参数
9906 App does not exist or is unavailable 核查下应用是否创建/禁用问题
2204 Request failed 请联系技术人员排除问题
2206 Exceeded rate limit 请求过于频繁,请稍后再试

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally