# 设置机器人对外展示名称(平台号)

[异步回调] 可通过调用该接口设置机器人对外展示的名称是实名姓名或者别名。

请求方式:POST

请求地址:https://$basehost/gateway/qopen/SetRobotNameDisplay

body参数

{
    "robot_id": "机器人id",
    "display_type": 1
}
字段 类型 必填 说明
robot_id string 机器人id
display_type int 对外展示类型:1 实名,2 别名

返回值:

{
    "data": {
        "serial_no": "操作序列号"
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
data json json返回值
   serial_no string 请求序列号
hint string 请求日志ID

处理结果,异步返回值:

{
    "event_type": 100002,
    "serial_no": "操作序列号",
    "err_code": 0,
    "err_msg": "success",
    "robot_id": "机器人id",
    "data": {
        "display_type": 1
    }
}

说明

字段 类型 说明
event_type int 事件类型,100002
serial_no string 操作序列号
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
robot_id string 机器人id
data object 返回数据
data.display_type int 对外展示类型:1 实名,2 别名

完整请求示例:

curl -X POST \
  https://$basehost/gateway/qopen/SetRobotNameDisplay \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
          "robot_id": "机器人id",
          "display_type": 1
}'
最后更新时间: 2023/5/24 10:48:59