全部产品

可视语音对讲API

更新时间:2020-11-30 16:36:16

一、流程

可视语音流程图

二、API

1. 精灵端(或其他可视对讲设备端)

1.1 获取绑定二维码

path

版本

是否需要登录

/solution/community/intercom/device/qrcode/get

1.0.0

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

ts

Long

请求时间戳(服务端校验±1小时)

sign

String

签名

str = {appKey}-{ts}-{deviceId}{deviceType}

sign = md5(str)

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-qrCode

String

绑定ID(可生成二维码透出给小程序端扫描)

-expireTime

String

绑定失效时间yyyy-MM-dd HH:mm:ss

-qrCodeUrl

String

二维码图片地址(将来可能要提供不同分辨率)

1.2 查询设备绑定状态

path

版本

是否需要登录

/solution/community/intercom/device/status/get

1.0.1

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-bindId

String

绑定ID,bindStatus为true时有值

-bindStatus

Boolean

绑定状态,true已绑定,false未绑定

-houseName

String

绑定房号,bindStatus为true时有值

-communityId

Long

小区ID

-bindType

Integer

0 业主 1 物业

1.3 设备端解绑室内对讲设备

path

版本

是否需要登录

/solution/community/intercom/device/end/unbind

1.0.0

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

1.4 设备端开门

path

版本

是否需要登录

/solution/community/intercom/unitdoor/open

1.0.1

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

iotId

String

目标门禁设备的设备ID

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

1.5 查询对讲会话信息

path

版本

是否需要登录

/solution/community/intercom/device/channel/get

1.0.0

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-communityId

Long

小区

-houseName

String

房号

-unitSpaceId

String

单元空间ID

-houseSpaceId

String

房屋空间ID

-sipGroupId

String

SIP服务组名(对应房屋)

-sipNumber

String

SIP服务ID(对应语音设备)

-sipPassword

String

SIP服务密码

-sipHost

String

SIP服务地址

-sipPort

String

SIP服务端口

1.6 查询可用的门禁设备列表

path

版本

是否需要登录

/solution/community/intercom/entrance/device/list

1.0.0

入参

入参名称

数据类型

是否必须

入参描述

deviceId

String

对讲设备标识,如天猫精灵设备ID

deviceType

String

对讲设备类型,默认TMALL_GENIE

pageSize

Integer

页面大小

pageSize

Integer

页号

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-pageSize

Integer

页面大小

-pageSize

Integer

页号

-total

Integer

门禁设备总数

-data

JSONArray

房屋空间ID

--communityId

Long

小区ID

--iotId

String

设备ID

--deviceName

String

设备名称

--nickName

String

设备昵称

--productKey

String

设备PK

--productName

String

产品名称

--thingType

String

设备类型。可以是"VIRTUAL", "WEB", "APP","DEVICE"

--status

Integer

设备状态。0-初始化;1-在线;3-离线;8-禁用

--nodeType

Integer

产品类型,0 DEVICE 1 GATEWAY

--netType

String

产品入网方式

--categoryId

Long

品类ID

--categoryName

String

品类名称

2. 小程序端

关于paasIdentityId的使用方法,下面二选一

  • 一方SaaS应用时,可以不填写,使用登录态获取用户信息

  • 三方PaaS应用时,必填代表用户的identityId

2.1 绑定室内对讲设备

path

版本

是否需要登录

/solution/community/intercom/device/bind

1.0.0

可选

需要cloudToken

入参 ChannelAuthDTO

入参名称

数据类型

是否必须

入参描述

paasIdentityId

String

paas调用时的用户ID

qrCode

String

绑定二维码,见1.1

houseSpaceId

String

房屋的空间ID

deviceNickName

String

设备别名

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-bindId

String

绑定ID

2.2 更新室内对讲设备别名

path

版本

是否需要登录

/solution/community/intercom/device/rename

1.0.0

可选

需要cloudToken

入参 ChannelAuthDTO

入参名称

数据类型

是否必须

入参描述

paasIdentityId

String

paas调用时的用户ID

bindId

String

绑定ID

deviceNickName

String

设备别名,长度最大64,中文、字母、数字、横线、下划线、点组成

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

2.3 全量查询室内对讲设备列表

path

版本

是否需要登录

/solution/community/intercom/device/list

1.0.0

可选

需要cloudToken

入参 ChannelAuthDTO

入参名称

数据类型

是否必须

入参描述

paasIdentityId

String

paas调用时的用户ID

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

JSONObject

-bindId

String

绑定ID

-intercomDeviceId

String

脱敏的对讲设备ID

-intercomDeviceType

String

对讲设备类型

-houseSpaceId

String

房屋的空间ID

-houseName

String

房间号

2.4 小程序端解绑室内对讲设备

path

版本

是否需要登录

/solution/community/intercom/device/unbind

1.0.0

可选

需要cloudToken

入参 ChannelAuthDTO

入参名称

数据类型

是否必须

入参描述

paasIdentityId

String

paas调用时的用户ID

bindId

String

绑定ID

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息