GetAgent - 获取Agent详情-伶鹊(Cloud Contact Center)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sca:GetAgent

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BaseMeAgentId	integer	否	baseMeAgentId	12345
JsonStr	string	否	完整 JSON 字符串信息，具体内容参见以下详细信息。	xxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	6987D326-83D9-4A42-B9A5-0B27F9B40539
Code	string	结果代码，200 表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。	200
Message	string	错误的时候，返回错误信息	successful
Success	boolean	是否调用成功：true：调用成功。 false：调用失败。	true
Data	AgentInfo	返回结果

示例

正常返回示例

JSON格式

{
  "RequestId": "6987D326-83D9-4A42-B9A5-0B27F9B40539",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Data": {
    "Id": 0,
    "AgentName": "",
    "AgentDescription": "",
    "ModelType": "",
    "InputType": "",
    "InstructionType": "",
    "InstructionTypeParam": {
      "FieldsParam": {
        "NameDescPairList": [
          {
            "Name": "",
            "Desc": "",
            "Value": ""
          }
        ]
      },
      "ServiceInspectionParam": {
        "SceneName": "",
        "SceneDescription": "",
        "Dimensions": [
          {
            "Dimension": "",
            "Desc": ""
          }
        ]
      },
      "TagCategoryParam": {
        "NameDescPairList": [
          {
            "Name": "",
            "Desc": "",
            "ValueList": [
              ""
            ]
          }
        ]
      },
      "CustomPromptParam": {
        "CustomPrompt": "",
        "NameDescPairList": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "TagTreeLevelParam": {
        "TagIds": [
          0
        ],
        "TagTreeLevels": [
          {
            "TagTreeIds": [
              0
            ],
            "Prompt": ""
          }
        ]
      }
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。