WhatsApp API getCode - nxtele/http-api-document GitHub Wiki

集成商获取验证码

通过API发起获取验证码服务(仅供集成商使用)

  • URL:https://api2.nxcloud.com/api/wa/integrator/embedded/register/getCode
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:

鉴权机制

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

请求参数

header参数:

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

body参数:

参数名 类型 必选 示例值 说明
phone_number String 185xxx99 号码
method String sms 枚举值sms voice

请求示例

body(application/json) 参数:

{
    "phone_number": "185xxx99",
    "method": "sms"
}

响应参数

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

响应示例

成功示例

{
    "code": 0,
    "data": {},
    "message": "请求成功"
}

失败示例

{
    "code": -1,
    "message": "请求失败",
    "data": null
}

响应码说明

code message 解决办法
0 请求成功
-1 请求失败 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看API鉴权部分
9000 参数异常 参数遗漏,请检查必须的参数
9001 系统业务错误 请联系技术人员排除问题
9007 非集成商请求 请确认是否集成商