REST IM Group API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

The following API calls go over the creation of IM Groups through Zooms REST API calls. Please see our IM Management/a> documentation for pre-requisites for IM Group API access.

List all IM Groups on Zoom.
Endpoint:

https://api.zoom.us/v1/im/group/list

Parameters:
N/A

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/im/group/list

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <total_records>3</total_records>
    <groups>
        <group>
            <group_id>alCRHnIOQnyFQPrJNbeN5A</group_id>
            <name>group1</name>
            <type>Restricted</type>
            <total_members>7</total_members>
            <option_search_by_domain>false</option_search_by_domain>
            <option_search_by_account>true</option_search_by_account>
            <option_search_by_ma_account>false</option_search_by_ma_account>
            <last_modified_time>2016-04-16T07:45:41Z</last_modified_time>
        </group>
        <group>
            <group_id>nPxqDFB2T7-RKk8dUeGBbw</group_id>
            <name>group2</name>
            <type>Restricted</type>
            <total_members>0</total_members>
            <option_search_by_domain>false</option_search_by_domain>
            <option_search_by_account>true</option_search_by_account>
            <option_search_by_ma_account>false</option_search_by_ma_account>
            <last_modified_time>2016-04-16T07:45:13Z</last_modified_time>
        </group>
        <group>
            <group_id>QkOpi5GnR3W2p_HF5sHeXg</group_id>
            <name>group3</name>
            <type>Normal</type>
            <total_members>8</total_members>
            <option_search_by_domain>true</option_search_by_domain>
            <option_search_by_account>true</option_search_by_account>
            <option_search_by_ma_account>false</option_search_by_ma_account>
            <last_modified_time>2016-04-16T05:46:25Z</last_modified_time>
        </group>
    </groups>
</result>

Response JSON:

{
    "total_records": 3,
    "groups": [{
        "group_id": "alCRHnIOQnyFQPrJNbeN5A",
        "name": "group1",
        "type": "Restricted",
        "total_members": 7,
        "option_search_by_domain": false,
        "option_search_by_account": true,
        "option_search_by_ma_account": false,
        "last_modified_time": "2016-04-16T07:45:41Z"
    }, {
        "group_id": "nPxqDFB2T7-RKk8dUeGBbw",
        "name": "group2",
        "type": "Restricted",
        "total_members": 0,
        "option_search_by_domain": false,
        "option_search_by_account": true,
        "option_search_by_ma_account": false,
        "last_modified_time": "2016-04-16T07:45:13Z"
    }, {
        "group_id": "QkOpi5GnR3W2p_HF5sHeXg",
        "name": "group3",
        "type": "Normal",
        "total_members": 8,
        "option_search_by_domain": true,
        "option_search_by_account": true,
        "option_search_by_ma_account": false,
        "last_modified_time": "2016-04-16T05:46:25Z"
    }]
}

Get an IM Group on Zoom via Group ID. Return the Group info.
Endpoint:

https://api.zoom.us/v1/im/group/get

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id' https://api.zoom.us/v1/im/group/get

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>alCRHnIOQnyFQPrJNbeN5A</group_id>
    <name>test group</name>
    <type>Restricted</type>
    <total_members>7</total_members>
    <option_search_by_domain>false</option_search_by_domain>
    <option_search_by_account>true</option_search_by_account>
    <option_search_by_ma_account>false</option_search_by_ma_account>
</group>

Response JSON:

{
    "group_id": "alCRHnIOQnyFQPrJNbeN5A",
    "name": "test group",
    "type": "Restricted",
    "total_members": 7,
    "option_search_by_domain": false,
    "option_search_by_account": true,
    "option_search_by_ma_account": false
}

Create an IM Group on Zoom. Return the new Group info.
Endpoint:

https://api.zoom.us/v1/im/group/create

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&name=im_group_name' https://api.zoom.us/v1/group/create

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>FVuxiBenQEiFGw4wbFQwVg</group_id>
    <name>test group</name>
    <type>Normal</type>
    <total_members>0</total_members>
    <option_search_by_domain>false</option_search_by_domain>
    <option_search_by_account>false</option_search_by_account>
    <option_search_by_ma_account>false</option_search_by_ma_account>
</group>

Response JSON:

{
    "group_id": "f1UihJq7QC6_iPyg0iR1Jw",
    "name": "test group",
    "type": "Normal",
    "total_members": 0,
    "option_search_by_domain": false,
    "option_search_by_account": false,
    "option_search_by_ma_account": false
}

Edit an IM Group on Zoom. Return the edited group info.
Endpoint:

https://api.zoom.us/v1/im/group/edit

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id' https://api.zoom.us/v1/im/group/edit

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>f1UihJq7QC6_iPyg0iR1Jw</group_id>
    <name>test group</name>
    <type>Normal</type>
    <total_members>0</total_members>
    <option_search_by_domain>false</option_search_by_domain>
    <option_search_by_account>false</option_search_by_account>
    <option_search_by_ma_account>false</option_search_by_ma_account>
</group>

Response JSON:

{
    "group_id": "f1UihJq7QC6_iPyg0iR1Jw",
    "name": "test group",
    "type": "Normal",
    "total_members": 0,
    "option_search_by_domain": false,
    "option_search_by_account": false,
    "option_search_by_ma_account": false
}

Delete an IM Group on Zoom.
Endpoint:

https://api.zoom.us/v1/im/group/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id' https://api.zoom.us/v1/im/group/id

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>iEAohxv8RoaozPT310dW7g</id>
    <deleted_at>2016-04-20T08:41:37Z</deleted_at>
    <deleted_count>1</deleted_count>
</result> 

Response JSON:

{
    "id": "R2DbDoFMQHWoqF0mJ3ozEw",
    "deleted_at": "2016-04-20T08:41:58Z",
    "deleted_count": 1
}

List the members in the IM Group on Zoom
Endpoint:

https://api.zoom.us/v1/im/group/member/list

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id' https://api.zoom.us/v1/im/group/member/list

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>1</total_records>
    <members>
        <memeber>
            <id>6EoubcvJR7eF2grNXJkrHA</id>
            <email>test.us@zoom.us </email>
            <first_name>Test</first_name>
            <last_name>Us</last_name>
         <pic_url>https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569</pic_url>
        </memeber>
    </members>
</result>

Response JSON:

{
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 1,
    "members": [{
        "id": "6EoubcvJR7eF2grNXJkrHA",
        "email": "test.us@zoom.us",
        "first_name": "Text",
        "last_name": "Us",
        "pic_url": "https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569"
    }]
}

Add members to the IM Group on Zoom.
Endpoint:

https://api.zoom.us/v1/im/group/member/add

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id&member_ids=user_ids' https://api.zoom.us/v1/im/group/member/add

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>W8r1m-FSQiiTJsAICWvnzA</id>
    <add_at>2015-08-20T08:54:49Z</add_at>
    <add_count>1</add_count>
</result> 

Response JSON:

{
    "id": "W8r1m-FSQiiTJsAICWvnzA",
    "add_at": "2015-08-20T08:55:03Z",
    "add_count": 1
}

Delete some members to the IM Group on Zoom.
Endpoint:

https://api.zoom.us/v1/im/group/member/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=im_group_id&member_ids=user_ids' https://api.zoom.us/v1/im/group/member/delete

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>W8r1m-FSQiiTJsAICWvnzA</id>
    <deleted_at>2015-08-20T08:57:50Z</deleted_at>
    <deleted_count>2</deleted_count>
</result>

Response JSON:

{
    "id": "W8r1m-FSQiiTJsAICWvnzA",
    "deleted_at": "2015-08-20T08:57:38Z",
    "deleted_count": 2
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk