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

修改

场景描述

调用该接口修改uap多媒体用户。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/vdn/uap/user?uapId=0

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

uapId

number

False

uap标识id

在日志中的方法名

modifyUapAgent

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    phoneNum

    string

    True

    用户号码。

    最大长度为32个字符。

    2

    password

    string

    False

    用户认证密码。

    长度为8-16位。

    说明:
    • 为兼容uap设置,此处密码可修改为空密码,但此项操作存在安全风险。
    • 密码必须包含如下至少两种字符的组合:
      • 至少一个小写字母
      • 至少一个大写字母
      • 至少一个数字
      • 至少一个特殊字符:

        ~@^*_+.?

    3

    confirmPass

    string

    False

    确认密码。

    长度为8-16位。

    说明:
    • 为兼容uap设置,此处密码可修改为空密码,但此项操作存在安全风险
    • 密码必须包含如下至少两种字符的组合:
      • 至少一个小写字母
      • 至少一个大写字母
      • 至少一个数字
      • 至少一个特殊字符:

        ~@^*_+.?

    4

    unregisteredAuth

    Boolean

    False

    true :注销时鉴权

    false: 注销时不鉴权

    5

    authFlag

    string

    False

    0:UAP鉴权

    1:业务鉴权

    6

    uapAlgorithmType

    string

    False

    UAP加密算法类型。取值范围:

    • 0:SHA256
    • 1:MD5
    • 2:SHA256&MD5
      说明:

      MD5、SHA256&MD5为不安全加密算法,有安全风险。

    7

    uapLocalAlgorithmType

    string

    False

    UAP本地认证加密算法类型。

    • 0:SHA256
    • 1:MD5
    • 2:SHA256&MD5
      说明:

      MD5、SHA256&MD5为不安全加密算法,有安全风险。

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

返回结果

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "phoneNum": "88881000",
        "password": "********",
        "confirmPass": "********"
    }
  • 响应参数
    {
        "result": {},
        "message": "success",
        "retcode": "0"
    }

相关文档