更新时间:2025-12-01 GMT+08:00
分享

查询

场景描述

调用该接口查询OBS URL

  • 组网为全容器化时,由于容器化CTI不支持,所以容器化CC-Gateway也不支持。

接口方法

该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/config/sys/obsURL?ids=5,4

其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。

URI中携带的参数说明如6.10.1-表 URI中携带的参数说明所示。

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

ids

string

False

  1. 需要查询的一组OBS URL编号。
  2. 编号为空时,表示查询所有OBS URL数据。
  3. 取值类型为整数,根据实际编号填写。每个id用英文“,”隔开,一次最多不超过100个。

日志中的方法名

queryObsURL

请求消息

  • 消息头
    表2 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

    2

    Guid

    string

    True

    Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息。

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

array

返回结果。该对象参数说明请参见6.10.1-表 result数组对象参数

表4 result数组对象参数

序号

名称

参数类型

说明

4.1

id

string

OBS URL ID。

4.2

purpose

string

用途说明。

4.3

obsUrl

string

url地址。

4.4

userName

string

用户名称。

最大长度49字节。

4.5

loginUri

string

登录接口。

4.6

interfaceUri

string

获取接口信息接口。

4.7

timeout

number

超时时长,范围[1,30],默认3s。

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

  • 响应参数
    {
        "result": [
            {
                "id": 7,
                "purpose": "",
                "obsUrl": "https://127.0.0.1:8080",
                "userName": "dbuser",
                "loginUri": "/rest/isales/v1/openapi/obs/auth/login",
                "interfaceUri": "/rest/isales/v1/openapi/obs/business/interface",
                "timeout": 3
            }
        ],
        "message": "success",
        "retcode": "0"
    }

相关文档