欢迎语管理

更新时间：2025-05-30 01:56:03下载pdf

通过本接口，可以实现对项目下绑定音箱的欢迎语的设置管理。

当前只支持一个门店创建条欢迎语，项目下所有绑定的音箱共用一条欢迎语。
当前 PaaS 接口未开放欢迎语与入住状态的关联，具体参数使用时请参照参数说明。

API 列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/voice/welcome-speeches	创建欢迎语
PUT	/v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}	修改欢迎语
DELETE	/v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}	删除欢迎语
GET	/v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}	查询欢迎语
GET	/v1.0/osaas/projects/{project_id}/voice/welcome-speeches	分页查询欢迎语

创建欢迎语

接口描述

创建欢迎语

接口地址

POST /v1.0/osaas/projects/{project_id}/voice/welcome-speeches

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	Yes
appellation_conf	Integer	BODY	自定义欢迎语状态 1：带称谓（格式：【住客名称（默认某先生/女士）】） 2：不带称谓。(当前无入住状态支持，本参数无实际效果，可默认传 2)	Yes
content	String	BODY	欢迎语内容，最长 200 字符	Yes
speech_strategy_list	Array	BODY	播放策略(1:门锁触发, 2:门磁触发, 3:插卡取电开关触发)	Yes
speech_interval_type	Integer	BODY	播放间隔类型，0:只在第一次触发播报，1:每次触发都会播报，2:间隔时间触发播报。 (当前无入住状态支持，暂不支持传 0)	Yes
speech_interval	String	BODY	播放间隔时间（单位：分钟）当播放间隔类型为间隔时间触发播报(2)时，才需要配置	No

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	返回欢迎语唯一标识

请求示例

POST {url}/v1.0/osaas/projects/123382396******/voice/welcome-speeches

请求示例

{
    "appellation_conf":1,
    "content":"XXXXX",
    "speech_interval": 30,
    "speech_interval_type":2,
    "speech_strategy_list":[
        "1",
        "2",
        "3"
    ]
}

响应成功示例

{
    "result": "15420303806xxxxx",
    "success": true,
    "t": 1656483666915
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改欢迎语

接口描述

修改欢迎语

接口地址

PUT /v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	Yes
voice_welcome_id	String	URI	欢迎语唯一标识	Yes
appellation_conf	Integer	BODY	自定义欢迎语状态 1：带称谓（格式：【住客名称（默认某先生/女士）】） 2：不带称谓	No
content	String	BODY	欢迎语内容，最长 200 字符	No
speech_strategy_list	Array	BODY	播放策略(1:门锁触发, 2:门磁触发, 3:插卡取电开关触发)	No
speech_interval_type	Integer	BODY	播放间隔类型，0:只在第一次触发播报，1:每次触发都会播报，2:间隔时间触发播报	No
speech_interval	String	BODY	播放间隔时间（单位：分钟）当播放间隔类型为间隔时间触发播报时，才需要配置	No

特殊说明请参考创建接口参数

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果：true：成功，false：失败

请求示例

PUT {url}/v1.0/osaas/projects/1233823******/voice/welcome-speeches/15420303806xxxxx

请求示例

{
    "appellation_conf":2,
    "content":"xxxxxx",
    "speech_interval": 60,
    "speech_interval_type":2,
    "speech_strategy_list":[
        "1",
        "3"
    ]
}

响应成功示例

{
    "result": true,
    "success": true,
    "t": 1656402446442
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除欢迎语

接口描述

删除欢迎语

接口地址

DELETE /v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	Yes
voice_welcome_id	String	URI	欢迎语唯一标识	Yes

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果：true：成功，false：失败

请求示例

DELETE {url}/v1.0/osaas/projects/1233823******/voice/welcome-speeches/15420303806xxxxx

响应成功示例

{
    "result": true,
    "success": true,
    "t": 1656483664975
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

查询欢迎语

接口描述

查询欢迎语

接口地址

GET /v1.0/osaas/projects/{project_id}/voice/welcome-speeches/{voice_welcome_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	Yes
voice_welcome_id	String	URI	欢迎语唯一标识	Yes

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	欢迎语结果

result参数说明

参数名	类型	说明
project_id	String	项目id
appellation_conf	Integer	自定义欢迎语状态 1：带称谓（格式：【住客名称（默认某先生/女士）】） 2：不带称谓
content	String	欢迎语内容
speech_strategy_list	Array	播放策略(1:门锁触发, 2:门磁触发, 3:插卡取电开关触发)
speech_interval_type	Integer	播放间隔类型，0:只在第一次触发播报，1:每次触发都会播报，2:间隔时间触发播报
speech_interval	Integer	播放间隔时间（单位：分钟）
voice_welcome_id	String	欢迎语惟一标识符
gmt_create	Long	创建时间
gmt_modified	Long	修改时间

请求示例

GET {url}/v1.0/osaas/projects/1233823******/voice/welcome-speeches/15420303806xxxxx

响应成功示例

{
    "result": {
        "appellation_conf": 2,
        "content": "XXXXXX",
        "gmt_create": 1656402434166,
        "gmt_modified": 1656402446420,
        "project_id": "13948325765xxxxx",
        "speech_interval": 60,
        "speech_interval_type": 2,
        "speech_strategy_list": [
            "1",
            "3"
        ],
        "voice_welcome_id": "15420303806xxxxx"
    },
    "success": true,
    "t": 1656402457444
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询欢迎语

接口描述

分页查询欢迎语

接口地址

GET /v1.0/osaas/projects/{project_id}/voice/welcome-speeches

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	Yes
page_no	Integer	URL	页码(page_no>0)，默认1	No
page_size	Integer	URL	页条数(0<page_size<100)，默认10	No

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
welcome_speech_list	Array	欢迎语列表

welcome_speech_list参数说明

参数名	类型	说明
project_id	String	项目id
appellation_conf	Integer	自定义欢迎语状态 1：带称谓（格式：【住客名称（默认某先生/女士）】） 2：不带称谓
content	String	欢迎语内容
speech_strategy_list	Array	播放策略(1:门锁触发, 2:门磁触发, 3:插卡取电开关触发)
speech_interval_type	Integer	播放间隔类型，0:只在第一次触发播报，1:每次触发都会播报，2:间隔时间触发播报
speech_interval	Integer	播放间隔时间（单位：分钟）
voice_welcome_id	String	欢迎语惟一标识符
gmt_create	Long	创建时间
gmt_modified	Long	修改时间

请求示例

GET {url}/v1.0/osaas/projects/1233823******/voice/welcome-speeches/15420303806xxxxx

响应成功示例

{
    "result": {
        "appellation_conf": 2,
        "content": "XXXXXX",
        "gmt_create": 1656402434166,
        "gmt_modified": 1656402446420,
        "project_id": "13948325765xxxxx",
        "speech_interval": 60,
        "speech_interval_type": 2,
        "speech_strategy_list": [
            "1",
            "3"
        ],
        "voice_welcome_id": "15420303806xxxxx"
    },
    "success": true,
    "t": 1656402457444
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

上一篇房屋三方语音设备关系管理

下一篇酒店门锁