- Accounts
- List sub accountsGET
- Create a sub accountPOST
- Disassociate a sub accountDELETE
- Get sub account detailsGET
- Get locked settingsGET
- Update locked settingsPATCH
- Get managed domainsGET
- Update optionsPATCH
- Update the account ownerPUT
- Get settingsGET
- Update settingsPATCH
- Delete virtual background filesDELETE
- Upload virtual background filesPOST
- Get trusted domainsGET
- Billing
- Get billing informationGET
- Update billing informationPATCH
- List billing invoicesGET
- Get invoice detailsGET
- Get plan InformationGET
- Subscribe plansPOST
- Subscribe additional planPOST
- Update an additional planPUT
- Cancel additional plansPATCH
- Update a base planPUT
- Cancel a base planPATCH
- Get plan usageGET
- Download an invoice fileGET
- Phone
- Update BYOC settings
- Set up a Zoom Phone account
- Assign SIP trunks
- Update SIP trunk details
- Add BYOC phone numbers
- Get account's call logs
- List calling plans
- Change main company number
- List phone numbers
- Get phone number details
- Update phone number details
- Get call recordings
- List setting templates
- Add a setting template
- Get setting template details
- Update a setting template
- List BYOC SIP trunks
- List phone users
- Get user's profile
- Update user's profile
- Get user's call logs
- Delete a user's call log
- Assign calling plan to a user
- Unassign user's calling plan
- Assign phone number to user
- Unassign phone number
- Get user's recordings
- Get user's settings
- Remove shared access
- Update shared access
- Set up shared access
- Get user's voicemails
- Delete a voicemail
- Cloud Recording
- List recordings of an account
- List archived files
- Delete meeting recordings
- Get meeting recordings
- List recording registrants
- Create a recording registrant
- Get registration questions
- Update registration questions
- Update registrant's status
- Get meeting recording settings
- Update meeting recording settings
- Recover meeting recordings
- Delete a meeting recording file
- Recover a single recording
- List all recordings
- SIP Connected Audio
- Users
- Switch a user's account
- List users
- Create users
- Check a user email
- Get user's ZAK
- Check a user's PM room
- Delete a user
- Get a user
- Update a user
- Delete user assistants
- List user assistants
- Add assistants
- Delete a user assistant
- Update a user's email
- Update a user's password
- Get user permissions
- Upload a user's profile picture
- Update a user's presence status
- Delete user schedulers
- List user schedulers
- Delete a scheduler
- Get user settings
- Update user settings
- Delete virtual background files
- Upload virtual background files
- Update user status
- Revoke a user's SSO token
- Get a user token
- Chat Channels
- Contacts
- Chat Channels (Account-level)
- Chat Messages
- Groups
- Devices
- Chatbot Messages
- IM Chat
- IM Groups
- Meetings
- Use in-Meeting recording controls
- Delete a meeting
- Get a meeting
- Update a meeting
- Perform batch poll creation
- Get meeting invitation
- Get live stream details
- Update a live stream
- Update Live Stream Status
- List meeting polls
- Create a meeting poll
- Delete a meeting poll
- Get a meeting poll
- Update a meeting poll
- List meeting registrants
- Add meeting registrant
- List registration questions
- Update registration questions
- Update registrant's status
- Delete a meeting registrant
- Update meeting status
- List ended meeting instances
- List past meeting's poll results
- Get past meeting details
- Get past meeting participants
- List meeting templates
- List meetings
- Create a meeting
- Dashboards
- List Zoom meetings client feedback
- Get zoom meetings client feedback
- List client meeting satisfaction
- Get CRC port usage
- Get IM metrics
- Get top 25 Zoom Rooms with issues
- Get issues of Zoom Rooms
- List meetings
- Get meeting details
- List meeting participants
- List meeting participants QoS
- Get post meeting feedback
- Get sharing/recording details
- Get meeting participant QoS
- List webinars
- Get webinar details
- Get webinar participants
- List webinar participant QoS
- Get post webinar feedback
- Get sharing/recording details
- Get webinar participant QoS
- List Zoom Rooms
- Get top 25 issues of Zoom Rooms
- Get Zoom Rooms details
- List call logs
- Get call QoS
- Get call details from call log
- Deprecated API Endpoints
- Webinars
- Get webinar absentees
- List past webinar instances
- List webinar participants
- List past webinar poll results
- List Q&A of past webinar
- List webinar templates
- List webinars
- Create a webinar
- Delete a webinar
- Get a webinar
- Update a webinar
- Perform batch registration
- Remove panelists
- List panelists
- Add panelists
- Remove a panelist
- List a webinar's polls
- Create a webinar's poll
- Delete a webinar poll
- Get a webinar poll
- Update a webinar poll
- List webinar registrants
- Add a webinar registrant
- List registration questions
- Update registration questions
- Update registrant's status
- Delete a webinar registrant
- Get a webinar registrant
- Update webinar status
- Get webinar tracking sources
- Phone Auto Receptionists
- Phone Blocked List
- Phone Call Queues
- Common Area Phones
- Phone Devices
- Phone Reports
- Phone Shared Line Groups
- Phone Site
- Reports
- Get sign In / sign out activity report
- Get cloud recording usage report
- Get daily usage report
- Get meeting detail reports
- Get meeting participant reports
- Get meeting poll reports
- Get operation logs report
- Get telephone reports
- Get active/inactive host reports
- Get meeting reports
- Get webinar detail reports
- Get webinar participant reports
- Get webinar poll reports
- Get webinar Q&A report
- Roles
- Rooms
- Rooms Account
- Rooms Location
- Rooms Devices
- SIP Phone
- TrackingField
- TSP
- PAC
- Data Compliance
- Webhooks
- master account APIs
Retrieve an IM directory group
GET
/im/groups/{groupId}
Scopes:
imgroup:read:adminLight请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://api.zoom.us/v2/im/groups/'响应示例响应示例
200 - response
{
"id": "string",
"name": "string",
"search_by_account": "boolean",
"search_by_domain": "boolean",
"search_by_ma_account": "boolean",
"total_members": "integer",
"type": "string"
}请求参数
Path 参数
groupId
string
必需
Can be retrieved by calling GET /groups.
返回响应
🟢200**HTTP Status Code:** `200` <br>
IM group object returned.<br>
**Error Code:** `200` <br>
Only available for paid account:{accountId}.
application/json
Body
IM group object.
id
string
Group ID.
name
string
可选
total_members
integer
可选
search_by_account
boolean
可选
search_by_domain
boolean
可选
search_by_ma_account
boolean
可选
type
enum<string>
可选
normal - Only members can see the other members in the group. Other people can search for members in the group.shared - Everyone in the account can see the group and members. restricted - No one except group members can see the group or search for other group members.枚举值:
normalsharedrestricted
默认值:
normal
🔵300**Error Code:** `300` <br>
Missing field: name.
🟠404**HTTP Status Code:** <br>
IM Group not found.<br>
**Error Code:** `4130` <br>
Group does not exist:{groupId}.
【Zoom】API开发者 微信交流群
用微信扫右侧 二维码，加入【Zoom】API开发者 交流群，互助沟通
扫码加入交流群修改于 2024-04-24 09:06:48