文档首页/ 全球SIM联接 GSL/ API参考/ API列表/ 自定义属性/ 用户新增自定义属性接口
更新时间:2023-09-18 GMT+08:00
分享

用户新增自定义属性接口

功能介绍

用户新增自定义属性接口

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/attributes

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

cust_attr_name

String

自定义属性名称

最大长度:32

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

id

Long

自定义属性标识

状态码: 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度:64

error_msg

String

错误描述

最大长度:512

状态码: 500

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度:64

error_msg

String

错误描述

最大长度:512

请求示例

新增自定义属性,自定义属性为“新建自定义属性名”。

POST https://{endpoint}/v1/attributes

{
  "cust_attr_name" : "新建自定义属性名"
}

响应示例

状态码: 200

OK

{
  "id" : 1000001
}

状态码: 400

Bad Request

  • 示例 1

    {
      "error_code" : "GSL.00020004",
      "error_msg" : "参数异常"
    }
  • 示例 2

    {
      "error_code" : "GSL.00027001",
      "error_msg" : "自定义属性名称不合法,请检查!"
    }
  • 示例 3

    {
      "error_code" : "GSL.00027002",
      "error_msg" : "自定义属性名称已存在,请重新输入!"
    }
  • 示例 4

    {
      "error_code" : "GSL.00027003",
      "error_msg" : "自定义属性名称和SIM卡管理列字段重复,请重新输入!"
    }
  • 示例 5

    {
      "error_code" : "GSL.00027004",
      "error_msg" : "登录用户最多可以创建6个自定义属性。"
    }

状态码: 500

Internal Server Error

{
  "error_code" : "GSL.00020003",
  "error_msg" : "系统繁忙,请稍后重试。"
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档