REST Archived Chat Messages 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 Chat Reports through Zooms REST API calls.

Get chat history list for a specified time period.
Note: The access token can be gathered at the REST API Credential page by authorized admins.
Endpoint:

https://api.zoom.us/v1/chat/list

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&access_token=your_access_token&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/chat/list

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2016-01-16</from>
    <to>2016-01-22</to>
    <page_size>30</page_size>
    <page_count>2</page_count>
    <next_page_token></next_page_token>
    <chat_list>
        <chat>  
<session_id>94de5d617f88340103fef1ad18fccf145149c3aad33a136f82c6f88f956   b3873</session_id>
            <type>Group</type>
            <participants></participants>
            <group_name>zoom test1</group_name>
            <last_message_send_time>2016-01-18T06:40:56Z</last_message_send_time>
        </chat>
        <chat>
<session_id>c5de5d617f88340103fef1ad18fccf145149c3aad33a136f82c6f88f956   b3873</session_id>
            <type>Group</type>
            <participants></participants>
            <group_name>zoom test2</group_name>
            <last_message_send_time>2016-01-18T06:42:56Z</last_message_send_time>
        </chat>  
    </chat_list>
</result>

Response JSON:

{
    "from": "2016-01-16",
    "to": "2016-01-22",
    "page_size": 30,
    "page_count": 2,
    "next_page_token": "",
    "chat_list": [{
        "session_id": "94de5d617f88340103fef1ad18fccf145149c3aad33a136f82c6f88f956b3873",
        "type": "Group",
        "participants": "",
        "group_name": "zoom test1",
        "last_message_send_time": "2016-01-18T06:40:56Z"
    }, {
        "session_id": "c5e6b53712436a4ab5eb8c8007a64cc61bf1b53753772830693bcf7c678b2ade",
        "type": "Group",
        "participants": "",
        "group_name": "zoom test2",
        "last_message_send_time": "2016-01-18T06:42:56Z"
    }]
}

Get chat messages for a specified period.
Note: The access token can be gathered at the REST API Credential page by authorized admins.
Endpoint:

https://api.zoom.us/v1/chat/get

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&access_token=your_access_token&session_id=chat_session_id&from=2016-06-05&to=2016-06-06' https://api.zoom.us/v1/chat/get

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
	<session_id>
94de5d617f88340103fef1ad18fccf145149c3aad33a136f82c6f88f956b3873</session_id>
<group_name>zoom</group_name>
    <from>2016-01-16</from>
    <to>2016-01-22</to>
    <page_size>30</page_size>
    <page_count>2</page_count>
    <next_page_token></next_page_token>
    <chat_messages>
        <message_detail>
            <message>test1</message>
<sender></sender>
            <date_time>2016-01-18T06:40:56Z</date>
        </message_detail>
        <message_detail>
            <message>test2</message>
<sender></sender>
            <date_time>2016-01-18T06:42:56Z</date>
        </message_detail>
    </chat_messages>
</result>

Response JSON:

{
"session_id": "94de5d617f88340103fef1ad18fccf145149c3aad33a136f82c6f88f956b3873",
"group_name": "zoom",
    "from": "2016-01-16",
    "to": "2016-01-22",
    "page_size": 30,
    "page_count": 2,
    "next_page_token": "",
    "chat_messages": [{
        "message": "test1",
        "sender": "",
        "date_time": "2016-01-18T06:40:56Z",
    }, {
        "message": "test2",
        "sender": "",
        "date_time": "2016-01-18T06:42:56Z",
    }]
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk