文档帮助平台
首页服务端API参考 企业管理 添加企业
添加企业
更新时间：2025-05-21 08:26:12

添加企业

请求方法

POST

请求地址

/platform/enterprises

请求参数:

请求参数 参数类型 数据类型 是否必须 参数说明
name Body String 是 企业名称，长度范围1-128
country Body String 否 国家，默认：CN，长度范围1-2
area Body String 否 地区
partyNumber Body String 是 企业号，纯数字
extension Body String 是 管理员4位分机账号，纯数字
email Body String 否 邮箱，长度范围1-128
mobile Body String 否 手机号
managerName Body String 是 管理员名称，长度范围1-128
numberResourceEnable Body Boolean 否 号码资源自定义，默认false
accountConfig Body AccountConfig 否 账号配置
conferenceConfig Body ConferenceConfig 否 会议配置
dataAccessConfig Body DataAccessConfig 否 数据访问权限配置

accountConfig：

请求参数 参数类型 数据类型 是否必须 参数说明
maxGroupAmount Body Integer 否 企业组织架构可构建分组数量上限，默认200，范围200-7000
maxVmrAmount Body Integer 否 企业组织架构可构建虚拟会议室数量上限，默认100，范围1-100000
maxStaffAmount Body Integer 否 用户账号数量上限，默认5000，范围100-20000
maxDeviceAmount Body Integer 否 设备账号数量上限，默认5000，范围100-20000
maxThirdPartyDeviceAmount Body Integer 否 第三方设备账号数量上限，默认5000 ，范围100-20000
phoneBookCacheShardLevel Body Integer 否 地址簿缓存分片等级，默认0，范围0-3
phoneBookPushBulkLevel Body Integer 否 地址簿推送等级，默认0，范围0-3

conferenceConfig

请求参数 参数类型 数据类型 是否必须 参数说明
maxScheduledConfDuration Body Integer 否 会议单次预约时长上限，默认12，范围12-48小时
maxRecurrenceConfAmount Body Integer 否 周期会议可预约数量上限，默认100，范围100-1000
maxRecurrenceConfEndTime Body Integer 否 周期会议最长有效期限，默认1年，范围1-3年
maxRecurrenceConfParticipantAmount Body Integer 否 会议参会成员数量上限，默认500，范围100-2000
enableOpenApi Body Boolean 否 是否开启openapi，默认false
enableLdap Body Boolean 否 是否开启Ldap，默认false

dataAccessConfig：

请求参数 参数类型 数据类型 是否必须 参数说明
maxPersonalCdrViewableDuration Body Integer 否 企业中的个人通话(历史会议)记录显示时间上限，默认12个月，范围1-36个月
maxPersonalCdrViewableAmount Body Integer 否 企业中的个人通话(历史会议)记录显示数量上限，默认2000条，范围2000-5000
maxConfCtrlViewableDuration Body Integer 否 会议控制-查看已预约会议的显示时间上限，默认365天，范围7-365天
maxConfCtrlViewableAmount Body Integer 否 会议控制-查看已预约会议的显示数量上限，默认10000条，范围1000-50000
confScheduleViewableRangeStart Body Integer 否 企业个人会议日程-参与会议显示范围，默认1个月，范围（1-3）个月
confScheduleViewableRangeEnd Body Integer 否 企业个人会议日程-参与会议显示范围，默认1个月，范围（1-3）个月

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
id String 企业id

请求消息示例

POST /open/api/v2/platform/enterprises HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
    "name": "openapi企业",
    "country": "CN",
    "partyNumber": "222222",
    "managerName": "openapi管理员",
    "extension": "9999"
}

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
    "id": "36d08aba64614ed78fddb8ce7c1cdaef"
}

CURL命令示例

curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -d '{"name": "openapi企业","country": "CN", "partyNumber": "222222","managerName": "openapi管理员","extension": "9999"}' 'https://api.yealink.com/open/api/v2/platform/enterprises'
本页目录