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

集成商创建客户应用

通过API发起客户应用创建服务（仅供集成商使用）

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

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名 类型 必选 示例值 说明
app_name String 是 Whatsapp 应用名称
webhook String 是 https://***/api/webhook/whatsApp webhook地址
dr_sign_algo String 否 sha256 回执加签算法（md5，sha256）

请求示例

body（application/json） 参数：

{
    "app_name": "Whatsapp",
    "webhook": "https://***/api/webhook/whatsApp"
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
message String 请求结果说明
  • data object参数：
参数名 类型 说明
app_id Integer appid
app_name String 应用名称
appkey String appkey

响应示例

成功示例

{
    "code": 0,
    "data": {
        "app_id": 1000,
        "app_name": "Whatsapp",
        "app_key": "KI92cew9"
    },
    "message": "请求成功"
}

失败示例

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

响应码说明

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