获取机器人变量元数据

服务描述

本接口,可用于获取机器人变量元数据

开发须知

调用本接口前,请先获取appId

服务地址

POST https://{您的专属域名}/outbound/openapi/v1/robot/queryMetadataByRobot

请求参数

参数 位置 类型 是否必填 说明
appId header String Y 应用ID
timestamp header String Y 时间戳,毫秒
sign header String Y 签名
encrypted header String N 是否需要加密,需要加密传值(加密方式):AES/REQBODY/RESP,不需要加密不用传该字段
Content-Type header String Y application/json
robotId url地址栏 String Y 机器人id
Body数据示例:

robotId 不需要加密

POST https://{您的专属域名}/outbound/openapi/v1/robot/queryMetadataByRobot?robotId=52f014b2c46a4c4fb728560d57b5614a

返回结果加密

加密方式header中的encrypted传值,表示需要对返回结果进行加密,拿到加密后的返回结果, 使用私钥加解密工具进行解密

返回结果### post请求

    >`robotId` 不需要加密
    ```
    POST https://{您的专属域名}/outbound/openapi/v1/robot/queryMetadataByRobot?robotId=52f014b2c46a4c4fb728560d57b5614a
    ```
  • 需要加密,以下是返回结果加密前的json
  • 不需要加密则直接直接返回不加密的结果
参数 类型 说明
code String 结果码
message String 结果描述
data Response 元数据和变量信息
Response
参数 类型 说明
name String 变量名
code String 变量标识一键外呼扩展字段中key字段使用该值
type String 变量类型,name 姓名;text 文本;number 金额;id_number 数字,请自己根据类型校验下数据类型
description String 描述
返回结果示例:
{
    "code": "10000",
    "message": "请求成功",
    "data": [
        {
            "name": "姓名",
            "code": "姓名",
            "type": "name",
            "description": "客户姓名"
        }
    ]
}
结果码说明
结果码 说明
10000 请求成功
20001 请求失败
21002 认证失败,请重新登录

FAQ:

results matching ""

    No results matching ""