Operations (sample payloads)

Main operations

Add meeting registrants

Register a participant for a meeting. Sample Input Sample Output

Create meeting

Create a meeting for a user. Sample Input Sample Output

{
    "settings": {
        "host_video": true,
        "participant_video": true,
        "cn_meeting": false,
        "in_meeting": false,
        "join_before_host": false,
        "mute_upon_entry": true,
        "watermark": false,
        "use_pmi": false,
        "approval_type": 2,
        "audio": "both",
        "auto_recording": "cloud",
        "enforce_login": false,
        "waiting_room": true,
        "registrants_confirmation_email": true,
        "global_dial_in_countries": [
            "US",
            "CA",
            "GB"
        ],
        "global_dial_in_numbers": [
            \{
                "country_name": "United States",
                "city": "New York",
                "number": "+1 1234567890",
                "type": "toll",
                "country": "US"
            \}
        ]
    },
    "start_time": "2023-06-15T14:00:00Z",
    "created_at": "2023-06-10T09:30:15Z",
    "topic": "Weekly Team Meeting",
    "start_url": "https://zoom.us/s/1234567890?zak=eyJ6bV9za20iOiJ6bV9vMm0iLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "join_url": "https://zoom.us/j/1234567890",
    "host_id": "AbCdEfGhIjK",
    "status": "waiting",
    "duration": 60,
    "timezone": "America/New_York",
    "type": 2,
    "id": 1234567890,
    "uuid": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456"
}

Create users

Add a new user to your account Sample Input Sample Output

Create webinar

Create a webinar for a user. Sample Input

{
    "user_id": "abc123",
    "topic": "Introduction to Cloud Computing",
    "webinar_type": 5,
    "start_time": "2023-06-15T14:00:00Z",
    "duration": 60,
    "password": "cloud123",
    "agenda": "In this webinar, we will cover the basics of cloud computing, its benefits, and popular cloud service providers.",
    "tracking_fields": [
        \{
            "field": "Department",
            "value": "IT"
        \}
    ],
    "settings": \{
        "host_video": true,
        "panelist_video": true,
        "practice_session": true,
        "hd_video": true,
        "approval_type": "0",
        "audio": "both",
        "auto_recording": "cloud",
        "alternative_hosts": [
            "johndoe@example.com"
        ],
        "close_registration": false,
        "show_share_button": true,
        "allow_multiple_devices": true,
        "on_demand": false,
        "contact_name": "Jane Smith",
        "contact_email": "janesmith@example.com",
        "registrants_email_notification": true,
        "meeting_authentication": true
    \}
}

Sample Output

{
    "uuid": "abcdef123456",
    "id": 987654321,
    "host_id": "xyz789",
    "host_email": "host@example.com",
    "topic": "Introduction to Cloud Computing",
    "type": 5,
    "start_time": "2023-06-15T14:00:00Z",
    "duration": 60,
    "timezone": "America/New_York",
    "agenda": "In this webinar, we will cover the basics of cloud computing, its benefits, and popular cloud service providers.",
    "created_at": "2023-05-20T10:30:00Z",
    "start_url": "https://zoom.us/s/987654321?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6Il9fQ0hBVE9QRVJBVE9SX18iLCJpc3MiOiJ3ZWIiLCJzdHkiOjEwMCwid2NkIjoiYXcxIiwiY2x0IjowLCJtbnVtIjoiOTg3NjU0MzIxIiwic3RrIjoiQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVowMTIzNDU2Nzg5IiwiZXhwIjoxNjIzNzYwODAwLCJpYXQiOjE2MjM3NTM2MDAsImFpZCI6Il9fQ0hBVE9QRVJBVE9SX18iLCJjaWQiOiIifQ.qxrFrg6ZmZxGc3Tr8qKxrI3_ydCn4q6jWKIHbaSIVME",
    "join_url": "https://zoom.us/j/987654321",
    "registration_url": "https://zoom.us/webinar/register/WN_abcdefghijklmnop",
    "password": "cloud123",
    "settings": {
        "host_video": true,
        "panelists_video": true,
        "approval_type": 0,
        "audio": "both",
        "auto_recording": "cloud",
        "enforce_login": false,
        "enforce_login_domains": "",
        "alternative_hosts": "johndoe@example.com",
        "close_registration": false,
        "show_share_button": true,
        "allow_multiple_devices": true,
        "practice_session": true,
        "hd_video": true,
        "question_answer": true,
        "registrants_confirmation_email": true,
        "on_demand": false,
        "request_permission_to_unmute_participants": false,
        "global_dial_in_countries": [
            "US",
            "CA",
            "GB"
        ],
        "global_dial_in_numbers": [
            \{
                "country_name": "United States",
                "number": "+1 6465588656",
                "type": "toll",
                "country": "US"
            \}
        ],
        "contact_name": "Jane Smith",
        "contact_email": "janesmith@example.com",
        "registrants_restrict_number": 1000,
        "registrants_email_notification": true,
        "post_webinar_survey": false,
        "survey_url": "",
        "meeting_authentication": true,
        "authentication_option": "zoom_authentication",
        "authentication_name": "",
        "authentication_domains": ""
    }
}

Create webinar registrant

Register a participant for a webinar. Sample Input

{
    "user_id": "john.doe@example.com",
    "webinar_id": "123456789",
    "email": "jane.smith@example.com",
    "first_name": "Jane",
    "last_name": "Smith",
    "occurrence_ids": [
        "987654321",
        "876543210"
    ],
    "address": "123 Main St",
    "city": "New York",
    "country": "United States",
    "zip": "10001",
    "state": "NY",
    "phone": "+1-555-123-4567",
    "industry": "Technology",
    "org": "Tech Solutions Inc.",
    "job_title": "Software Engineer",
    "purchasing_time_frame": "1-3 months",
    "role_in_purchase_process": "Evaluator/Recommender",
    "no_of_employees": "101-500",
    "comments": "Interested in learning more about your product features.",
    "custom_questions": [
        \{
            "title": "How did you hear about us?",
            "value": "Through a colleague"
        \},
        \{
            "title": "What's your primary interest in our webinar?",
            "value": "Product demonstration"
        \}
    ]
}

Sample Output

Delete user

Delete a user from your account. Sample Input Sample Output

{
    "success": true
}

Get account call logs

Retrieve an account's call logs. Sample Input Sample Output

{
    "page_count": 3,
    "page_number": 1,
    "page_size": 30,
    "total_records": 75,
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "call_logs": [
        {
            "id": "123456789",
            "call_type": "voice",
            "caller_number": "+14155551234",
            "caller_number_type": "internal",
            "caller_name": "John Doe",
            "callee_number": "+14155555678",
            "callee_number_type": "external",
            "callee_name": "Jane Smith",
            "direction": "outbound",
            "duration": 300,
            "result": "completed",
            "date_time": "2023-05-15T14:30:00Z",
            "owner": \{
                "type": "user",
                "id": "user123",
                "name": "John Doe",
                "extension_number": 1001
            \}
        }
    ]
}

Get cloud recording report

Retrieves cloud recording usage report for a specified period. Sample Input

\{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z"
\}

Sample Output

Get daily usage report

Retrieves daily report to access the account-wide usage of Zoom services for each day in a given month. Sample Input

\{
    "year": 2023,
    "month": 5
\}

Sample Output

Get meeting poll report

Retrieve a report of results for a past meeting. Sample Input Sample Output

{
    "id": 123456789,
    "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
    "start_time": "2023-05-15T14:30:00Z",
    "questions": [
        {
            "name": "Poll 1",
            "question_details": [
                \{
                    "question": "What is your favorite color?",
                    "answer": "Blue"
                \},
                \{
                    "question": "How satisfied are you with the meeting?",
                    "answer": "Very satisfied"
                \}
            ]
        },
        {
            "name": "Poll 2",
            "question_details": [
                \{
                    "question": "Do you prefer in-person or virtual meetings?",
                    "answer": "Virtual"
                \}
            ]
        }
    ]
}

Get meeting recordings

Get all the recordings from a meeting. Sample Input Sample Output

Get meeting report

Get a detailed report for a past meeting. Sample Input Sample Output

Get users call logs

Retrieve a user's call logs. Sample Input Sample Output

{
    "page_count": 2,
    "page_number": 1,
    "page_size": 30,
    "total_records": 45,
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "call_logs": [
        \{
            "id": "call123",
            "call_type": "inbound",
            "caller_number": "+14155551234",
            "caller_number_type": "external",
            "caller_name": "John Doe",
            "callee_number": "+14155555678",
            "callee_number_type": "internal",
            "callee_name": "Jane Smith",
            "direction": "inbound",
            "duration": 300,
            "result": "answered",
            "date_time": "2023-05-15T14:30:00Z"
        \},
        \{
            "id": "call124",
            "call_type": "outbound",
            "caller_number": "+14155555678",
            "caller_number_type": "internal",
            "caller_name": "Jane Smith",
            "callee_number": "+14155559876",
            "callee_number_type": "external",
            "callee_name": "Bob Johnson",
            "direction": "outbound",
            "duration": 180,
            "result": "completed",
            "date_time": "2023-05-16T10:15:00Z"
        \}
    ]
}

Get users profile

Retrieve a user's Zoom phone profile information. Sample Input Sample Output

Get users report

Retrieves an active or inactive users report for a specified period of time. Sample Input

\{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "user_status": "active",
    "page_size": 50,
    "page_number": 1
\}

Sample Output

Get webinar

Retrieves a specific webinar. Sample Input

{
    "webinar_id": "123456789"
}

Sample Output

Get webinar polls report

Retrieves a report on past webinar polls. Sample Input

{
    "webinar_id": "123456789"
}

Sample Output

Get webinar Q&A report

Retrieves a report on question and answers from past webinars. Sample Input

{
    "webinar_id": "123456789"
}

Sample Output

{
    "id": 123456789,
    "uuid": "abcdef123456ghijkl789012",
    "start_time": "2023-05-15T14:00:00Z",
    "questions": [
        {
            "name": "John Doe",
            "email": "johndoe@example.com",
            "question_details": [
                \{
                    "question": "What are the key features of your product?",
                    "answer": "Our product's key features include real-time collaboration, advanced analytics, and seamless integration with other tools."
                \},
                \{
                    "question": "Is there a free trial available?",
                    "answer": "Yes, we offer a 14-day free trial for all new users."
                \}
            ]
        },
        {
            "name": "Jane Smith",
            "email": "janesmith@example.com",
            "question_details": [
                \{
                    "question": "How does your pricing model work?",
                    "answer": "We offer tiered pricing based on the number of users and features required. Please visit our website for detailed pricing information."
                \}
            ]
        }
    ]
}

Get webinar report

Retrieves a specific webinar details report. Sample Input

{
    "webinar_id": "123456789"
}

Sample Output

List activity logs report

Retrieves a list of sign in / sign out activity logs report of users under a Zoom account. Sample Input

\{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "page_size": 50,
    "next_page_token": ""
\}

Sample Output

List all recordings

List all cloud recordings of a user. Sample Input Sample Output

{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "page_count": 1,
    "page_size": 30,
    "total_records": 2,
    "next_page_token": "",
    "meetings": [
        {
            "uuid": "abcdefgh-1234-5678-9012-ijklmnopqrst",
            "id": 123456789,
            "account_id": "ABCD1234efgh5678",
            "host_id": "XYZ9876wvut5432",
            "topic": "Team Meeting",
            "type": 2,
            "start_time": "2023-05-15T14:00:00Z",
            "timezone": "America/New_York",
            "duration": 60,
            "total_size": 102400000,
            "recording_count": 1,
            "share_url": "https://zoom.us/rec/share/abcdefghijklmnop",
            "recording_files": [
                \{
                    "id": "1234abcd-5678-efgh-ijkl-9012mnopqrst",
                    "meeting_id": "abcdefgh-1234-5678-9012-ijklmnopqrst",
                    "recording_start": "2023-05-15T14:00:00Z",
                    "recording_end": "2023-05-15T15:00:00Z",
                    "file_type": "MP4",
                    "file_size": 102400000,
                    "play_url": "https://zoom.us/rec/play/abcdefghijklmnop",
                    "download_url": "https://zoom.us/rec/download/abcdefghijklmnop",
                    "status": "completed",
                    "recording_type": "shared_screen_with_speaker_view"
                \}
            ]
        },
        {
            "uuid": "uvwxyz12-3456-7890-abcd-efghijklmnop",
            "id": 987654321,
            "account_id": "EFGH5678ijkl9012",
            "host_id": "LMN4321qrst8765",
            "topic": "Project Review",
            "type": 2,
            "start_time": "2023-05-20T10:00:00Z",
            "timezone": "Europe/London",
            "duration": 45,
            "total_size": 76800000,
            "recording_count": 1,
            "share_url": "https://zoom.us/rec/share/uvwxyz123456789",
            "recording_files": [
                \{
                    "id": "5678efgh-9012-ijkl-mnop-3456qrstuvwx",
                    "meeting_id": "uvwxyz12-3456-7890-abcd-efghijklmnop",
                    "recording_start": "2023-05-20T10:00:00Z",
                    "recording_end": "2023-05-20T10:45:00Z",
                    "file_type": "MP4",
                    "file_size": 76800000,
                    "play_url": "https://zoom.us/rec/play/uvwxyz123456789",
                    "download_url": "https://zoom.us/rec/download/uvwxyz123456789",
                    "status": "completed",
                    "recording_type": "shared_screen_with_speaker_view"
                \}
            ]
        }
    ]
}

List call logs

Retrieve a list of monthly call log metrics. Sample Input

{
    "date_range": \{
        "from": "2023-05-01T00:00:00Z",
        "to": "2023-05-31T23:59:59Z"
    \},
    "site_id": "abc123xyz",
    "quality_type": "all",
    "page_size": 30,
    "next_page_token": ""
}

Sample Output

{
    "next_page_token": "NXT_PG_TKN_123456",
    "page_size": 30,
    "total_records": 150,
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "call_logs": [
        {
            "call_id": "CALL_123456",
            "duration": 300,
            "direction": "inbound",
            "date_time": "2023-05-15T14:30:00Z",
            "mos": "4.2",
            "caller": {
                "phone_number": "+14155551234"
            },
            "callee": {
                "extension_number": "1001"
            }
        },
        {
            "call_id": "CALL_789012",
            "duration": 180,
            "direction": "outbound",
            "date_time": "2023-05-16T09:45:00Z",
            "mos": "4.5",
            "caller": {
                "phone_number": "+14155555678"
            },
            "callee": {
                "extension_number": "1002"
            }
        }
    ]
}

List call recordings

Return an account's call recordings. Sample Input Sample Output

List channel members

Retrieve a list of members of a channel. Sample Input

\{
    "user_id": "abc123",
    "channel_id": "ch456def",
    "page_size": 50,
    "page_number": 1
\}

Sample Output

List meeting participants report

Get participant report for a past meeting. Sample Input Sample Output

List meeting registrants

Retrieves a list of registrants for a specific meeting. Sample Input Sample Output

List meetings

List all the meetings that were scheduled for a user (meeting host). Sample Input

{
    "user_id": "john.doe@example.com",
    "meeting_type": "upcoming",
    "date_range": \{
        "from": "2023-05-01T00:00:00Z",
        "to": "2023-05-31T23:59:59Z"
    \},
    "page_size": 30,
    "page_number": 1
}

Sample Output

{
    "page_count": 2,
    "page_number": 1,
    "page_size": 30,
    "total_records": 45,
    "meetings": [
        \{
            "uuid": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
            "id": 123456789,
            "host_id": "XYZ987654",
            "topic": "Weekly Team Meeting",
            "type": 2,
            "start_time": "2023-05-15T14:00:00Z",
            "duration": 60,
            "timezone": "America/New_York",
            "created_at": "2023-05-01T10:30:00Z",
            "join_url": "https://zoom.us/j/123456789"
        \},
        \{
            "uuid": "zyxwvuts-rqpo-nmlk-jihg-fedcba654321",
            "id": 987654321,
            "host_id": "XYZ987654",
            "topic": "Project Review",
            "type": 2,
            "start_time": "2023-05-20T10:00:00Z",
            "duration": 90,
            "timezone": "America/New_York",
            "created_at": "2023-05-02T15:45:00Z",
            "join_url": "https://zoom.us/j/987654321"
        \}
    ]
}

List meetings report

Retrieves a list of past meetings for a specified period of time, for a given user. Sample Input Sample Output

{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "page_count": 2,
    "page_size": 30,
    "total_records": 45,
    "next_page_token": "abcdefghijklmnop",
    "meetings": [
        \{
            "uuid": "1234abcd-5678-efgh-ijkl-mnopqrstuvwx",
            "id": 987654321,
            "host_id": "host123",
            "type": 2,
            "topic": "Team Weekly Standup",
            "user_name": "John Doe",
            "user_email": "john.doe@example.com",
            "start_time": "2023-05-03T09:00:00Z",
            "end_time": "2023-05-03T10:00:00Z",
            "duration": 60,
            "total_minutes": 60,
            "participants_count": 8
        \},
        \{
            "uuid": "2345bcde-6789-fghi-jklm-nopqrstuvwxy",
            "id": 987654322,
            "host_id": "host123",
            "type": 2,
            "topic": "Project Review Meeting",
            "user_name": "John Doe",
            "user_email": "john.doe@example.com",
            "start_time": "2023-05-10T14:00:00Z",
            "end_time": "2023-05-10T15:30:00Z",
            "duration": 90,
            "total_minutes": 90,
            "participants_count": 5
        \}
    ]
}

List operation logs report

Retrieves operation logs report for a specified period of time. Sample Input

\{
    "from": "2023-05-01T00:00:00Z",
    "to": "2023-05-31T23:59:59Z",
    "page_size": 50,
    "next_page_token": "abcdefghijklmnopqrstuvwxyz123456"
\}

Sample Output

List phone users

Return all of an account's users who are assigned to a Zoom phone license. Sample Input Sample Output

List role members

Return all members that are assigned to a specific role. Sample Input

\{
    "role_id": "ABCD1234",
    "page_count": "1",
    "page_size": 30,
    "next_page_token": "qwertyuiop1234567890"
\}

Sample Output

{
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 2,
    "members": [
        \{
            "id": "user123",
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe",
            "type": 1,
            "department": "Sales"
        \},
        \{
            "id": "user456",
            "email": "jane.smith@example.com",
            "first_name": "Jane",
            "last_name": "Smith",
            "type": 2,
            "department": "Marketing"
        \}
    ]
}

List roles

Return all roles listed on your account. Sample Input Sample Output

{
    "total_records": 3,
    "roles": [
        \{
            "id": "1234567890",
            "name": "Admin",
            "description": "Full administrative access to all Zoom features",
            "total_members": 5
        \},
        \{
            "id": "2345678901",
            "name": "Manager",
            "description": "Manage users and rooms, but cannot change account settings",
            "total_members": 10
        \},
        \{
            "id": "3456789012",
            "name": "Member",
            "description": "Basic access to join meetings and use chat",
            "total_members": 50
        \}
    ]
}

List telephone report

Gets telephone report for a specified period of time. Sample Input Sample Output

List user channels

Retrieve a list of channels related to a user. Sample Input Sample Output

List user chat messages

Retrieve a list of a user's chat messages. Sample Input

\{
    "user_id": "abc123",
    "to_channel": "channel456",
    "page_size": 50,
    "page_number": 1
\}

Sample Output

List users

List users on your account. Sample Input Sample Output

{
    "page_count": 2,
    "page_number": 1,
    "page_size": 30,
    "total_records": 45,
    "users": [
        \{
            "id": "abc123",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "type": 2,
            "pmi": 1234567890,
            "timezone": "America/New_York",
            "verified": 1,
            "dept": "Sales",
            "created_at": "2023-01-15T10:30:00Z",
            "last_login_time": "2023-05-20T14:45:00Z",
            "last_client_version": "5.13.5",
            "status": "active"
        \},
        \{
            "id": "def456",
            "first_name": "Jane",
            "last_name": "Smith",
            "email": "jane.smith@example.com",
            "type": 2,
            "pmi": 9876543210,
            "timezone": "Europe/London",
            "verified": 1,
            "dept": "Marketing",
            "created_at": "2023-02-01T09:15:00Z",
            "last_login_time": "2023-05-19T16:30:00Z",
            "last_client_version": "5.13.5",
            "status": "active"
        \}
    ]
}

List webinar participants report

Get detailed report on each attendee of a webinar. Sample Input

\{
    "webinar_id": "123456789",
    "page_size": 50,
    "page_number": 1
\}

Sample Output

List webinar registrants

Retrieves a list of registrants for a specific webinar. Sample Input

\{
    "user_id": "john.doe@example.com",
    "webinar_id": "123456789",
    "page_size": 30,
    "page_number": 1,
    "status": "approved",
    "occurrence_id": "1234567890"
\}

Sample Output

List webinars

List all the webinars that are scheduled by or on-behalf a user (Webinar host). Sample Input Sample Output

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input Sample Output

Search company contacts

Search for a contact using the 'Search key' field by providing the user's first name, last name or email address. Sample Input

\{
    "search_key": "john.doe@example.com",
    "query_presence_status": true,
    "page_size": 2,
    "next_page_token": ""
\}

Sample Output

Update meeting registrants status

Retrieves a list of registrants for a specific meeting. Sample Input Sample Output

{
    "updated": true
}

Update user status

Deactivate an active user or reactivate a deactivated user. Sample Input Sample Output

{
    "updated": true
}

Update webinar registrant status

Update a webinar registrant’s status. Sample Input

{
    "webinar_id": "123456789",
    "action": "approve",
    "registrants": [
        {
            "email": "john.doe@example.com"
        },
        {
            "email": "jane.smith@example.com"
        }
    ]
}

Sample Output

{
    "updated": true
}

DDL operations

List authentication options (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input

{}

Sample Output

List meetings (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

{
    "meetings": [
        \{
            "id": 123456789,
            "topic": "Weekly Team Meeting",
            "start_time": "2023-05-15T14:00:00Z",
            "duration": 60,
            "timezone": "America/New_York",
            "join_url": "https://zoom.us/j/123456789",
            "host_id": "abc123def456",
            "status": "waiting"
        \},
        \{
            "id": 987654321,
            "topic": "Client Presentation",
            "start_time": "2023-05-16T10:30:00Z",
            "duration": 45,
            "timezone": "Europe/London",
            "join_url": "https://zoom.us/j/987654321",
            "host_id": "xyz789uvw456",
            "status": "started"
        \}
    ]
}

List phone users (DDL)

Sample Input

{}

Sample Output

[
    {
        "id": "user123",
        "email": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "+1234567890",
        "extension_number": "1001",
        "status": "active",
        "site": \{
            "id": "site456",
            "name": "Main Office"
        \},
        "department": "Sales",
        "cost_center": "CC001",
        "calling_plans": [
            \{
                "type": "Zoom Phone Pro",
                "name": "United States and Canada Unlimited"
            \}
        ]
    },
    {
        "id": "user456",
        "email": "jane.smith@example.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "phone_number": "+1987654321",
        "extension_number": "1002",
        "status": "active",
        "site": \{
            "id": "site789",
            "name": "Branch Office"
        \},
        "department": "Marketing",
        "cost_center": "CC002",
        "calling_plans": [
            \{
                "type": "Zoom Phone Pro",
                "name": "Global Select"
            \}
        ]
    }
]

List roles (DDL)

Sample Input

{}

Sample Output

{
    "roles": [
        \{
            "id": "y3KSZRx7QpmkVhOKkWdHYg",
            "name": "Owner",
            "description": "This role grants the user full administrative access.",
            "total_members": 2
        \},
        \{
            "id": "Z9KSZRx7QpmkVhOKkWdHYg",
            "name": "Admin",
            "description": "This role allows the user to manage most aspects of the account.",
            "total_members": 5
        \},
        \{
            "id": "A7KSZRx7QpmkVhOKkWdHYg",
            "name": "Member",
            "description": "This role allows the user to join meetings and manage their own settings.",
            "total_members": 50
        \}
    ],
    "total_records": 3,
    "page_size": 30,
    "next_page_token": ""
}

List user channels (DDL)

Sample Input

{}

Sample Output

{
    "channels": [
        \{
            "id": "abcdef123456",
            "name": "General",
            "type": 1
        \},
        \{
            "id": "ghijkl789012",
            "name": "Marketing",
            "type": 2
        \},
        \{
            "id": "mnopqr345678",
            "name": "Engineering",
            "type": 2
        \}
    ]
}

List users (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

List webinars (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping


Sample Input Sample Output

Was this page helpful?