新增子账号

新增子账号
修改子账号
删除子账号
- 请求URL
- 响应参数列表
  - 示例
子账号查询
子账号详情
设置子账号配额
子账号配额类型

1.子账号是壹耘平台提供给会员管理其客户的账号，会员可以使用子账号的各个功能，轻松地管理每一个独立的客户。
2.子账号与指定的应用关联，请勿跨应用使用。
3.您可以使用主账号和子账号调用API,但是子账号不能访问主账号或者其他子账号的资源。

请求URL

POST ${BASE_URL}/management/subaccount

请求参数列表

参数	有效值范围	说明
`callbackUrl`	http url	用于子账号接收平台事件的url,如果为空，事件回调会发给应用的回调url
`remark`	字符串	备注，例如：备注您的客户的名称
`quotas`	Array	配额数组,默认为空不限制配额
`quotas.type`	字符串	配额类型,默认不限制配额
`quotas.value`	整数	默认-1代表无限制

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	JSON 对象	返回数据对象，参见data对象属性列表

参数详解

data对象属性列表

属性	有效值范围	说明
`id`	UUID	子账号id
`certId`	字符串	鉴权子账号
`secretKey`	字符串	鉴权密钥
`appId`	UUID	关联的应用Id
`parentId`	UUID	主账号Id
`callbackUrl`	http url	子账号回调地址,如果为空，事件回调会发给应用的回调url
`enabled`	int	是否启用，默认启用,1启用，0禁用
`remark`	字符串	备注

示例

请求:

POST ${BASE_URL}/management/subaccount HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx
{
   "callbackUrl":"http://api.yoururl.com/callback",
   "remark":"客户1",
   "quotas":[
       {"type":"CallQuota",value:1000}
      ]
}

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": {
    "id":"rhreherherhgwgweg1304561",
    "certId":"erhehejtrtj",
    "secretKey":"gwer4h56e4h1eh",
    "appId":"gwegwegwehwherherh",
    "parentId":"41586tytymtyrth",
    "callbackUrl":"http://api.yoururl.com/callback",
    "enabled":1,
    "remark":"客户1"
  }
}

修改子账号

请求URL

PUT ${BASE_URL}/management/subaccount/{id}

请求参数列表

参数	有效值范围	说明
`callbackUrl`	http url	用于子账号接收平台事件的url,如果为空，事件回调会发给应用的回调url
`enabled`	int	是否启用，默认1,1启用，0禁用,必填
`remark`	字符串	备注，例如：备注您的客户的名称

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	JSON 对象	返回数据对象，参见data对象属性列表

参数详解

data对象属性列表

属性	有效值范围	说明
`id`	UUID	子账号id
`certId`	字符串	鉴权子账号
`secretKey`	字符串	鉴权密钥
`appId`	UUID	关联的应用Id
`parentId`	UUID	主账号Id
`callbackUrl`	http url	子账号回调地址,如果为空，事件回调会发给应用的回调url
`enabled`	int	是否启用，默认启用,1启用，0禁用
`remark`	字符串	备注

示例

请求:

PUT ${BASE_URL}/management/subaccount/rhreherherhgwgweg1304561 HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx
{
   "callbackUrl":"http://api.yoururl.com/callback",
   "remark":"客户1"
}

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": {
    "id":"rhreherherhgwgweg1304561",
    "certId":"erhehejtrtj",
    "secretKey":"gwer4h56e4h1eh",
    "appId":"gwegwegwehwherherh",
    "parentId":"41586tytymtyrth",
    "callbackUrl":"http://api.yoururl.com/callback",
    "enabled":1,
    "remark":"客户1"
  }
}

删除子账号

请求URL

DELETE ${BASE_URL}/management/subaccount/{id}

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	boolean	成功true,失败false

示例

请求:

DELETE ${BASE_URL}/management/subaccount/rhreherherhgwgweg1304561 HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": true
}

子账号查询

分页查询应用的子账号列表。

请求URL

GET ${BASE_URL}/management/subaccount

请求参数列表

参数	有效值范围	说明
`pageNo`	正整数	页数，默认1
`pageSize`	1-1000	每页数据条数，默认10

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	JSON 对象	返回数据对象，参见data对象属性列表

参数详解

data对象属性列表

属性	有效值范围	说明
`pageSize`	整数	每页条数
`startIndex`	整数	当前页第一条数据的索引
`totalCount`	整数	总条数
`totalPageCount`	整数	总页数
`currentPageNo`	整数	当前页
`result`	Array	列表数据
`result.id`	UUID	子账号id
`result.certId`	字符串	鉴权子账号
`result.secretKey`	字符串	鉴权密钥
`result.appId`	UUID	关联的应用Id
`result.parentId`	UUID	主账号Id
`result.callbackUrl`	http url	子账号回调地址
`result.enabled`	int	是否启用，默认启用,1启用，0禁用
`result.remark`	字符串	备注

示例

请求:

GET {BASE_URL}/management/subaccount?pageNo=1&pageSize=10 HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": {
        "pageSize": 10,
        "startIndex": 1,
        "totalCount": 1,
        "totalPageCount": 1,
        "currentPageNo": 1,
        "result": [
          {
              "id":"rhreherherhgwgweg1304561",
              "certId":"erhehejtrtj",
              "secretKey":"gwer4h56e4h1eh",
              "appId":"gwegwegwehwherherh",
              "parentId":"41586tytymtyrth",
              "callbackUrl":"http://api.yoururl.com/callback",
              "enabled":1,
              "remark":"客户1"
            }
        ]
      }
    }
}

子账号详情

查询子账号详情，包括子账号配额。

请求URL

GET ${BASE_URL}/management/subaccount/{id}

请求参数列表

参数	有效值范围	说明
`id`	UUID	必填

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	JSON 对象	返回数据对象，参见data对象属性列表

参数详解

data对象属性列表

属性	有效值范围	说明
`id`	UUID	子账号id
`certId`	字符串	鉴权子账号
`secretKey`	字符串	鉴权密钥
`appId`	UUID	关联的应用Id
`parentId`	UUID	主账号Id
`callbackUrl`	http url	子账号回调地址
`enabled`	int	是否启用，默认启用,1启用，0禁用
`remark`	字符串	备注
`quotas`	Array	配额数组,默认为空不限制配额
`quotas.type`	字符串	配额类型,默认不限制配额
`quotas.value`	整数	默认-1代表无限制

示例

请求:

GET {BASE_URL}/management/subaccount/egwgwegweg11123 HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": {
          "id":"rhreherherhgwgweg1304561",
          "certId":"erhehejtrtj",
          "secretKey":"gwer4h56e4h1eh",
          "appId":"gwegwegwehwherherh",
          "parentId":"41586tytymtyrth",
          "callbackUrl":"http://api.yoururl.com/callback",
          "enabled":1,
          "remark":"客户1",
          "quotas":[
            {
                "type":"CallQuota",
                "value":1111
            }
          ]
      }
    }
}

设置子账号配额

`配额是会员提供给其客户使用服务的额度`

请求URL

PUT ${BASE_URL}/management/subaccount/{id}/quotas

请求参数列表

参数	有效值范围	说明
`quotas`	Array	配额数组,必填
`quotas.type`	字符串	配额类型,必填
`quotas.value`	整数	默认-1代表无限制

示例

{
   "quotas":[
    {"type":"AgentQuota",value:1000}
   ]
}

响应参数列表

参数	有效值范围	说明
`code`	数字文本	状态码，全0表示正确
`msg`	文本	返回情况说明
`data`	boolean	成功true,失败false

示例

请求:

PUT ${BASE_URL}/management/subaccount/rhreherherhgwgweg1304561/quotas HTTP/1.1
Host: api.yunhuni.com
Content-Type: application/json
Accept-Type: application/json
Content-Length: xxx
{
   "quotas":[
    {"type":"AgentQuota",value:1000}
   ]
}

响应:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "code": "000000",
  "msg": "请求成功",
  "data": true
}

子账号配额类型

名称	说明
`CallQuota`	通话时长配额，单位：分钟
`AgentQuota`	呼叫中心坐席配额，单位：个