跳至主要內容

客服号管理相关接口

大约 4 分钟

客服号管理相关接口

客服号操作

批量导入客服号

  • 类型

API

  • URI

    /group-dispatch-api/whatsapp/batchInsert

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    批量导入客服号

  • 请求参数说明

字段类型是否必填备注
whatsAppListList客服号列表

data 参数说明

参数名类型是否必填备注
whatsAppStringwhatsapp
avatarString头像
nameString名称
publicKeyString账号公钥
privateKeyString账号私钥
msgPublicKeyString消息公钥
msgPrivateKeyString消息私钥
accountIdString账号 Id
nextKeyIdStringnextKeyId
registrationIdString注册 id
deviceParamsString设备参数
whatsappTypeIntegerwhatsapp 账户类型 1 个人 2 商业,默认个人
  • 请求示例:
{
  "whatsAppList": [
    {
      "whatsApp": "861821726232",
      "whatsappType": 1,
      "name": "lee",
      "avatar": "wwww.baiux.com/1.img",
      "publicKey": "",
      "privateKey": "",
      "msgPublicKey": "",
      "msgPrivateKey": "",
      "accountId": "",
      "nextKeyId": "",
      "registrationId": "",
      "deviceParams": ""
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}

查询客服号信息

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp/queryWhatsAppStatus

  • 请求方式

    GET、Content-Type: application/json

  • 接口说明

    查询所有的客服号信息

  • 请求参数说明

  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataList数据
  • data 响应参数说明
参数名类型是否必填备注
whatsAppStringwhatsApp
statusint状态 0、离线 1、在线 2、封号
onlineStatusint在线状态状态 1、上线中 2、在线 3、下线中 4、离线
  • 响应示例
{
  "data": [
    {
      "whatsApp": "861821371272",
      "status": 1,
      "onlineStatus": 1
    }
  ],
  "code": 200,
  "message": "success"
}

批量上线客服号

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp/batchOnline

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    批量上线客服号

  • 请求参数说明

字段类型是否必填备注
whatsAppListList客服号列表
  • whatsAppList 参数说明
参数名类型是否必填备注
overrideboolean是否覆盖
whatsAppStringwhatsapp
avatarString头像
nameString名称
publicKeyString账号公钥
privateKeyString账号私钥
msgPublicKeyString消息公钥
msgPrivateKeyString消息私钥
nextKeyIdStringnextKeyId
registrationIdString注册 id
accountIdString账号 id
deviceParamsString设备参数
whatsappTypeIntegerwhatsapp 账户类型 1 个人 2 商业,默认个人
  • 请求示例:
{
  "whatsAppList": [
    {
      "whatsApp": "861821726232",
      "whatsappType": 1,
      "override": false,
      "name": "lee",
      "avatar": "wwww.baiux.com/1.img",
      "publicKey": "",
      "privateKey": "",
      "msgPublicKey": "",
      "msgPrivateKey": "",
      "accountId": "",
      "nextKeyId": "",
      "registrationId": "",
      "deviceParams": ""
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}

批量回收客服号

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp/batchRecycle

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    批量回收客服号

  • 请求参数说明

字段类型是否必填备注
whatsAppListList客服号

请求示例:

{
  "whatsAppList": ["861821726232", "861821726231"]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}

同步客服号状态

  • 配置 ID <CHANNEL_SYNC_STATUS>

  • 类型

    WebHook

  • URI

    /callback/gsTask/syncWhatsAppStatus

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    同步客服号状态

  • 请求参数说明

字段类型是否必填备注
whatsAppString客服号
statusint状态 0、离线 1、在线 2、封号
onlineStatusint在线状态状态 1、上线中 2、在线 3、下线中 4、离线
reasonString失败原因
  • 请求示例:
{
  "whatsApp": "8218132718231",
  "status": 1,
  "onlineStatus": 1,
  "reason": ""
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}

客服号注册

客服号注册(提交手机号)

  • 类型

API

  • URI

    /group-dispatch-api/register/submitPhone

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    客服号注册

  • 请求参数说明

字段类型是否必填备注
phoneString客服号(手机号)
verifyTypeint验证码类型 0、短信 1、语音 2、未接来电 3、内部验证码
accountTypeint账号类型 1、个人 2、商业
areaCodeString地区码
countryCodeString国家码
  • 请求示例:
{
  "phone": "182172623211",
  "verifyType": 1,
  "accountType": 2,
  "areaCode": "+86",
  "countryCode": "CN"
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataint任务 id
  • 响应示例

{
  "data": 12,
  "code": 200,
  "message": "success"
}

客服号注册(提交验证码)

  • 类型

API

  • URI

    /group-dispatch-api/register/submitVerifyCode

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    客服号注册(验证码)

  • 请求参数说明

字段类型是否必填备注
phoneString客服号(手机号)
areaCodeString地区码
verifyCodeString验证码
  • 请求示例:
{
  "phone": "1821726232",
  "verifyCode": "123456",
  "areaCode": "+86"
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}

同步客服号注册状态

  • 配置 Id <CHANNEL_REGISTER_STATUS>

  • 类型

WebHook

  • URI

    /group-dispatch-api/register/syncStatus

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    客服号注册状态同步

  • 请求参数说明

字段类型是否必填备注
phoneString客服号(手机号)
statusint1、成功 0、失败
  • 请求示例:
{
  "phone": "861821726232",
  "status": "1"
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • 响应示例

{
  "data": "",
  "code": 200,
  "message": "success"
}
上次编辑于:
贡献者: kubrick,zhuang