科达视讯平台账号API

V6.1.0.4.0.20201230

API_Level:2

组织架构管理

名称 创建部门
URI /api/v1/amc/departments
方法 POST
说明 创建部门
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 认证token
params 请求内容，以json数据形式发送

params示例

params说明

参数名称 数据类型 说明
parent_department_moid* str 父部门moid
department_name* str 部门名称

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
department_moid str 部门id

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 编辑部门
URI /api/v1/amc/departments/{department_moid}
方法 PUT
说明 编辑部门
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token* str 认证token
params 请求内容，以json数据形式发送

params示例

params说明

参数名称 数据类型 说明
department_name* str 部门名称

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 删除部门
URI /api/v1/amc/departments/{department_moid}
方法 DELETE
说明 删除部门
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持DELETE，则使用POST请求，并在请求带上_method参数，值为DELETE
account_token* str 认证token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 查询部门信息
URI /api/v1/amc/departments
方法 GET
说明 查询部门信息
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 认证token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
seqencing int 分组类型
0-其他分组；
1-特殊分组（号码组、来宾用户、未分组用户）；
department_moid str 部门moid
department_name str 部门名称
departments array 部门列表
    seqencing int 分组类型
0-其他分组；
1-特殊分组（号码组、来宾用户、未分组用户）；
    department_moid str 部门moid
    department_name str 部门名称
    departments array 部门列表

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 查询单个部门的用户信息
URI /api/v1/amc/departments/{department_moid}/accounts
方法 GET
说明 查询单个部门的用户信息
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token
start int 获取的用户信息列表的起始行，0标示第一行数据，默认为0
count int 获取的用户信息列表的行数，即包括start在内的后count行数据，0代表获取所有，默认为10

成功回复示例

{
  "success": 1,
  "total": 2,
  "accounts": [
    {
      "account": "aaaaaaaaa",
      "account_jid": "2618a3b0-1e7c-49f9-9ee6-26fcddb6eede@kedacom",
      "account_moid": "2618a3b0-1e7c-49f9-9ee6-26fcddb6eede",
      "binded": 0,
      "date_of_birth": "",
      "department_moid": "2618a3b0-1e7c-49f9-9ee6-26fcddb6eed3",
      "department_name": "4444299",
      "department_position": "C++软件工程师",
      "e164": "",
      "email": "",
      "enable": 1,
      "ext_num": "025-5555522-2189",
      "fax": "",
      "job_num": "",
      "limited": 1,
      "mobile": "",
      "name": "aaaaaaaaa",
      "office_location": "",
      "password": "21218cca77804d2ba1922c33e0151105",
      "sex": 1
    },
    {
      "account": "bbb",
      "account_jid": "2618a3b0-1e7c-49f9-9ee6-26fcddb6eede@kedacom",
      "account_moid": "2618a3b0-1e7c-49f9-9ee6-26fcddb6eede",
      "binded": 0,
      "date_of_birth": "",
      "department_moid": "2618a3b0-1e7d-49f9-9ee6-26fcddb6eede",
      "department_name": "44442ggg",
      "department_position": "C++软件工程师",
      "e164": "",
      "email": "",
      "enable": 1,
      "ext_num": "025-5555522-2189",
      "fax": "",
      "job_num": "",
      "limited": 1,
      "mobile": "",
      "name": "aaaaaaaaa",
      "office_location": "",
      "password": "21218cca77804d2ba1922c33e0151105",
      "sex": 1
    }
  ]
}

成功回复说明

参数名称 数据类型 说明
success int 是否成功
total int 数量
accounts array 账号列表信息
    account str 账号自定义账号，登陆账号
    account_jid str 文字聊天账号jid
    account_moid str 账号moid
    binded int 164号是否绑定自定义账号
0-否；
1-是；
    date_of_birth str 出生日期
    department_moid str 部门序号（UUID格式）
    department_name str 部门名称
    department_position str 职位信息
    e164 str e164号码
    email str 邮箱
    enable int 账号启用停用标识
0-停用；
1-启用；
    ext_num str 电话号分机号如：025-5555522-2189电话：025-5555522；分机：2189
    fax str 传真
    job_num str 账号编号/工号
    limited int 是否为来宾用户
0-否；
1-是；
    mobile str 手机
    name str 账号真实姓名
    office_location str 办公地址
    password str 密码
    sex int 性别
0-女；
1-男；

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 创建账号
URI /api/v1/amc/accounts
方法 POST
说明 创建账号
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 软件权限token
params 请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称 数据类型 说明
account* str 账号自定义账号，登陆账号
1.字符限制：
  a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ <> | ` " $
  b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @
（除首尾字符可以输入）
2.最大字符长度：64个字节
enable int 账号启用停用标识
0-停用；
1-启用；
name* str 账号真实姓名
email str 邮箱
1.字符限制：仅支持 英文字母（大小写）、数字、“_”、“@”、“.”、“-”
mobile str 手机
1.字符限制：仅支持 数字、“.”、“_”、“-”、“*”、“#”、空格
password* str 密码
1.字符限制：仅支持 英文字母(大小写)、数字、“_”、“.”
binded int 默认为自动分配
0-不绑定号码；
1-手动分配；
2-自动分配；
e164 str e164号码（只有binded值为1时，才需要填值，其他情况不用填）
sex int 性别 默认为1
0-女；
1-男；
date_of_birth str 出生日期 格式为ISO8601:20:00标准
ext_num str 电话号分机号如：025-5555522-2189电话：025-5555522；分机：2189
1.字符限制：数字、（、）、，、-、；、*、+、#、空格、.
fax str 传真
1.字符限制：数字、“-”
office_location str 办公地址
departments array 部门信息列表
    department_moid* str 部门序号（UUID格式）
    department_name str 部门名称
    department_position str 职位信息
job_num str 账号编号/工号
1.字符限制：数字、字母
limited int 是否为来宾用户,默认为0
0-否；
1-是；

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
account_moid str 账号moid

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 编辑账号
URI /api/v1/amc/accounts/{account_moid}
方法 PUT
说明 编辑账号，params非必填，如果不需要修改某个字段属性，则在params中不要加入该字段；启用停用账号，请修改账号启停字段
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 软件权限token
params 请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称 数据类型 说明
enable int 账号启用停用标识
0-停用；
1-启用；
name str 账号真实姓名
email str 邮箱
1.字符限制：仅支持 英文字母（大小写）、数字、“_”、“@”、“.”、“-”
mobile str 手机
1.字符限制：仅支持 数字、“.”、“_”、“-”、“*”、“#”、空格
password str 密码
1.字符限制：仅支持 英文字母(大小写)、数字、“_”、“.”
binded int 默认为自动分配
0-不绑定号码；
1-手动分配；
2-自动分配；
e164 str e164号码（只有binded值为1时，才需要填值，其他情况不用填）
sex int 性别 默认为1
0-女；
1-男；
date_of_birth str 出生日期 格式为ISO8601:20:00标准
ext_num str 电话号分机号如：025-5555522-2189电话：025-5555522；分机：2189
1.字符限制：数字、（、）、，、-、；、*、+、#、空格、.
fax str 传真
1.字符限制：数字、“-”
office_location str 办公地址
departments array 部门信息列表
    department_moid* str 部门序号（UUID格式）
    department_name str 部门名称
    department_position str 职位信息
job_num str 账号编号/工号
1.字符限制：数字、字母
limited int 是否为来宾用户,默认为0
0-否；
1-是；

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 删除账号
URI /api/v1/amc/accounts/{account_moid}
方法 DELETE
说明 删除账号，自动停用账号并解绑E164号、删除账号
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持DELETE，则使用POST请求，并在请求带上_method参数，值为DELETE
account_token* str 认证token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 查询账号信息
URI /api/v1/amc/accounts/{account_moid}
方法 GET
说明 通过moid获取账号信息
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 认证token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
account str 账号自定义账号，登陆账号
binded int 164号是否绑定自定义账号
0-否；
1-是；
date_of_birth str 出生日期
e164 int e164号码
email str 邮箱
enable int 账号启用停用标识 0-停用；1-启用；
0-停用；
1-启用；
ext_num str 电话号分机号如：025-5555522-2189电话：025-5555522；分机：2189
fax str 传真
job_num str 账号编号/工号
limited int 是否为来宾用户
0-否；
1-是；
mobile str 手机
account_moid str 账号moid
account_jid str 文字聊天账号jid
name str 账号真实姓名
office_location str 办公地址
password str 密码
sex int 性别
0-女；
1-男；
departments array 部门信息列表
    department_moid str 部门序号（UUID格式）
    department_name str 部门名称
    department_position str 职位信息

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 查询所有账号信息
URI /api/v1/amc/accounts
方法 GET
说明 查询所有账号信息
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token
start int 获取的用户信息列表的起始行，0标示第一行数据，默认为0
count int 获取的用户信息列表的行数，即包括start在内的后count行数据，0代表获取所有，默认为10
account str 可选，用户账号名，携带此参数可以根据账号名查询账号

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
total int 数量
accounts array 账号列表信息
    account str 账号自定义账号，登陆账号
    binded int 164号是否绑定自定义账号
0-否；
1-是；
    date_of_birth str 出生日期
    e164 str e164号码
    email str 邮箱
    enable int 账号启用停用标识
0-停用；
1-启用；
    ext_num str 电话号分机号如：025-5555522-2189电话：025-5555522；分机：2189
    fax str 传真
    job_num str 账号编号/工号
    limited int 是否为来宾用户
0-否；
1-是；
    mobile str 手机
    account_moid str 账号moid
    account_jid str 文字聊天账号jid
    name str 账号真实姓名
    office_location str 办公地址
    password str 密码
    sex int 性别
0-女；
1-男；
    departments array 部门信息列表
        department_moid str 部门moid（UUID格式）
        department_name str 部门名称
        department_position str 职位信息

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 停用账号
URI /api/v1/amc/accounts/{account_moid}/disable
方法 PUT
说明 停用账号
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token* str 认证token
params 请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称 数据类型 说明
e164* str e164号码，如果账号没有绑定E164号，则不填写

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 重置密码
URI /api/v1/amc/accounts/{account_moid}/password
方法 PUT
说明 重置密码
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token* str 认证token
params 请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称 数据类型 说明
value* str 密码
1.字符限制：仅支持 英文字母(大小写)、数字、“_”、“.”

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 查询会议审批信息
URI /api/v1/amc/approval_infos
方法 GET
说明 查询会议审批信息
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token
user_domain_moid* str 查询审批信息的用户域moid,默认为本级用户域

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
real_approval int 实体会议审批开启或者关闭
0-关闭；
1-开启；
video_approval int 视频会议审批开启或者关闭
0-关闭；
1-开启；

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 启用停用会议审批功能
URI /api/v1/amc/approval_infos
方法 PUT
说明 启用停用会议审批功能
最低支持版本 1

参数说明

参数名称 数据类型 说明
_method 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token* str 认证token
params 请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称 数据类型 说明
real_approval* int 实体会议审批开启或者关闭
0-关闭；
1-开启；
video_approval* int 视频会议审批开启或者关闭
0-关闭；
1-开启；

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号
describe str 错误说明

名称 获取集团顶级公共群组列表
URI /api/v1/amc/public_groups
方法 GET
说明 获取集团顶级公共群组列表
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
public_groups array 公共群组数组，返回空是代表用户无权查看公共群组或不在公共群组中
    public_group_moid str 公用群组moid
    name str 公共群组名称
    version str 版本号

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 获取指定公共群组组织架构信息
URI /api/v1/amc/public_groups/{public_group_moid}
方法 GET
说明 获取指定公共群组组织架构信息,{public_group_moid}为公共群组moid
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
public_group_moid str 请求所查询的公共组群moid
groups array 群组数组，不返回根节点，且返回空代表无群组
    moid str 群组moid
    name str 群组名称
    parent_moid str 父群组moid

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 获取指定集团公共群组所有人员信息
URI /api/v1/amc/public_groups/{public_group_moid}/users
方法 GET
说明 获取指定集团公共群组所有人员信息，{public_group_moid}为公共群组moid
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
public_group_moid str 请求所查询的公共组群moid
users array 组织内账号数组，返回空代表没有成员
    moid str 账号moid
    jid str xmpp账号
    account str 自定义账号
    email str 邮箱
    e164 str xmpp账号
    mobile str 联系电话
    name str 姓名
    group_moid str 群组moid
    ext_num str 分机
    seat str 座位号
    brief str 简介
    portrait40 str 用户头像（40像素）地址
    portrait64 str 用户头像（64像素）地址
    portrait128 str 用户头像（128像素）地址

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 获取账号API版本信息
URI /api/amc/version
方法 GET
说明 获取账号API版本信息
最低支持版本 1

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
version str 版本信息
api_level int 账号API版本标识，请与账号API说明文档中的各个接口的最低支持版本号作对比，若小于最低支持版本号，则该接口不支持当前版本的API调用

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号