查询指定实体的实体成员列表及详情数据,同时支持关键词筛选(contains),筛选范围:实体值、同义词。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AgentKey | string | 否 | 业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取 | ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
InstanceId | string | 是 | 机器人 ID | chatbot-cn-yjzbyrEvqd |
EntityId | long | 是 | 实体 ID | 123 |
EntityValueId | long | 否 | 实体成员 ID | 234 |
Keyword | string | 否 | 实体成员名称搜索关键词 | 书 |
PageNumber | integer | 否 | 页码 | 1 |
PageSize | integer | 否 | 分页大小 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "n3fg34gbfj8adf2gj923",
"EntityValues": [
{
"EntityId": 34313785463,
"EntityValueId": 3467858234534534700,
"Content": "书类型",
"Synonyms": [
"小说"
],
"CreateTime": "2021-08-12T16:00:01Z",
"ModifyTime": "2021-08-12T16:00:01Z"
}
],
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | BusinessErrorEntityId.NotExists | The business error EntityId is not exists. |
访问错误中心查看更多错误码。