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

批量增加

场景描述

调用该接口批量增加uap用户。

单次最多可增加100条数据。

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

uapId

number

False

uap标识id,CTI Pool模式下为必选。

日志中的方法名

batchAddUapAgent

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    startPhoneNum

    string

    True

    起始用户号码。

    最大长度为32个字符。

    2

    endPhoneNum

    string

    True

    结束用户号码。

    最大长度为32个字符。

    说明:

    结束用户号码减去起始号码必须小于等于100。

    3

    ipType

    number

    True

    IP地址类型。

    0代表IPV4。

    1代表IPV6。

    4

    ipAddress

    string

    True

    信令IP地址。

    5

    pass

    string

    True

    用户认证密码。

    长度为8-16位。

    说明:

    密码必须包含如下至少两种字符的组合:

    • 至少一个小写字母
    • 至少一个大写字母
    • 至少一个数字
    • 至少一个特殊字符:

      ~@^*_+.?

    6

    authFlag

    string

    False

    0:UAP鉴权

    1:业务鉴权

    默认为0

    7

    uapAlgorithmType

    string

    False

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

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

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

    8

    uapLocalAlgorithmType

    string

    False

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

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

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

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

返回结果。该对象参数说明请参见表5

表5 result对象

序号

名称

参数类型

说明

3.1

existedNumber

string

重复的用户号码范围。

3.2

addNumber

number

增加的用户号码个数

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "startPhoneNum": "88880100",
        "endPhoneNum": "88880200",
        "ipType": 0,
        "ipAddress": "10.10.10.10",
        "pass": "********"
    }
  • 响应参数
    {
        "result": {
            "existedNumber": "88880101-88880109",
            "addNumber": 92
        },
        "message": "success",
        "retcode": "0"
    }

相关文档