Get user settings with incorrect closed_caption value

In the Get user settings response, the in_meeting.closed_caption field appears to no longer be reflecting the user’s closed captioning settings. Was there a change to the endpoint due to groups? What should we use instead to identify if a user is allowing closed captioning in meetings? Thank you!

Hi @alyssa.williams
Welcome to the Zoom Developer Forum!
This is actually the right endpoint to query when trying to identify if a user is allowing closed captioning in meetings!
Can you confirm that this was working previously for you?
Cheers,
Elisa

Hey Elisa!

It was working previously, but stopped working suddenly a few days ago. Was there a breaking API change? I’m also curious about in_meeting.closed_captioning.enable - is this a new field that we need to use instead? It doesn’t appear to reflect the user’s closed caption settings.

To follow up, we’ve done some debugging and the in_meeting.closed_caption field is actually no longer included in the payload at all.

Thanks for the update @alyssa.williams
I was able to replicate this behavior and I can no longer see closed_caption in my response body.
I have reached out to our Engineering team about this issue and I will come back with an update shortly
(ZOOM-373734 internal ticket for reference)

Cheers,
Elisa

Thank you very much! I appreciate the prompt responses.

1 Like

Hi @alyssa.williams
I am still working on this issue, could you confirm with me if you are calling the following endpoint?

And if so, are you able to see the object “closed_captioning” in your “in_meeting” object?

Thanks,
Elisa

Hello! Yes, we are using that endpoint. We do get that object, but its fields do not reflect the user’s settings as the old “closed_caption” field did.

Is there a reason that the old “closed_caption” field disappeared and is there an ETA/timeline of a fix?

Also, for your info, here’s the payload we receive from the user settings endpoint

{
    "schedule_meeting": {
        "host_video": false,
        "participants_video": false,
        "audio_type": "both",
        "join_before_host": false,
        "personal_meeting": true,
        "use_pmi_for_scheduled_meetings": false,
        "use_pmi_for_instant_meetings": false,
        "force_pmi_jbh_password": true,
        "require_password_for_scheduling_new_meetings": true,
        "require_password_for_instant_meetings": true,
        "require_password_for_pmi_meetings": "all",
        "pmi_password": "<removed-value>",
        "pstn_password_protected": true,
        "mute_upon_entry": false,
        "embed_password_in_join_link": true,
        "meeting_password_requirement": {
            "length": 0,
            "have_letter": false,
            "have_number": false,
            "have_special_character": false,
            "have_upper_and_lower_characters": false,
            "only_allow_numeric": false,
            "consecutive_characters_length": 0,
            "weak_enhance_detection": false
        }
    },
    "in_meeting": {
        "e2e_encryption": false,
        "chat": true,
        "private_chat": true,
        "auto_saving_chat": false,
        "entry_exit_chime": "all",
        "record_play_voice": false,
        "file_transfer": true,
        "feedback": true,
        "co_host": false,
        "polling": false,
        "attendee_on_hold": false,
        "show_meeting_control_toolbar": false,
        "allow_show_zoom_windows": false,
        "annotation": true,
        "remote_control": true,
        "non_verbal_feedback": false,
        "breakout_room": false,
        "remote_support": false,
        "far_end_camera_control": false,
        "group_hd": false,
        "virtual_background": true,
        "virtual_background_settings": {
            "enable": true,
            "allow_videos": true,
            "allow_upload_custom": true,
            "files": [
                {
                    "name": "San Francisco",
                    "type": "image",
                    "is_default": true
                },
                {
                    "name": "Grass",
                    "type": "image",
                    "is_default": true
                },
                {
                    "name": "Earth",
                    "type": "image",
                    "is_default": true
                },
                {
                    "name": "Beach",
                    "type": "video",
                    "is_default": true
                },
                {
                    "name": "Northern Lights",
                    "type": "video",
                    "is_default": true
                }
            ]
        },
        "auto_answer": false,
        "custom_data_center_regions": false,
        "screen_sharing": true,
        "attention_mode_focus_mode": false,
        "who_can_share_screen": "host",
        "who_can_share_screen_when_someone_is_sharing": "host",
        "waiting_room": false,
        "allow_live_streaming": true,
        "workplace_by_facebook": true,
        "custom_live_streaming_service": true,
        "custom_service_instructions": "",
        "request_permission_to_unmute_participants": false,
        "meeting_reactions": true,
        "show_a_join_from_your_browser_link": false,
        "allow_participants_to_rename": true,
        "allow_participants_chat_with": 4,
        "allow_users_save_chats": 3,
        "meeting_polling": {
            "enable": false
        },
        "closed_captioning": {
            "enable": false,
            "save_caption": false
        },
        "manual_captioning": {
            "manual_captions": true,
            "allow_to_type": true,
            "third_party_captioning_service": true,
            "auto_generated_captions": true,
            "full_transcript": false,
            "save_captions": false
        },
        "live_streaming_facebook": true,
        "live_streaming_youtube": true,
        "webinar_live_streaming": {},
        "webinar_chat": {},
        "slide_control": false,
        "meeting_survey": false,
        "webinar_polling": {
            "enable": false
        },
        "disable_screen_sharing_for_host_meetings": false,
        "disable_screen_sharing_for_in_meeting_guests": false
    },
    "email_notification": {
        "cloud_recording_available_reminder": true,
        "jbh_reminder": true,
        "cancel_meeting_reminder": true,
        "alternative_host_reminder": true,
        "schedule_for_reminder": true,
        "recording_available_reminder_schedulers": false,
        "recording_available_reminder_alternative_hosts": false
    },
    "recording": {
        "local_recording": true,
        "cloud_recording": true,
        "record_speaker_view": true,
        "record_gallery_view": false,
        "record_audio_file": true,
        "record_audio_file_each_participant": false,
        "save_chat_text": true,
        "show_timestamp": false,
        "auto_recording": "none",
        "ip_address_access_control": {
            "enable": false
        },
        "host_delete_cloud_recording": true,
        "recording_disclaimer": false,
        "auto_delete_cmr": false,
        "required_password_for_shared_cloud_recordings": true,
        "recording_password_requirement": {
            "length": 8,
            "have_letter": true,
            "have_number": true,
            "have_special_character": true,
            "only_allow_numeric": false
        },
        "record_files_separately": {
            "active_speaker": false,
            "gallery_view": false,
            "shared_screen": false
        },
        "display_participant_name": true,
        "recording_thumbnails": true,
        "optimize_recording_for_3rd_party_video_editor": false,
        "save_panelist_chat": false,
        "save_close_caption": true
    },
    "telephony": {
        "third_party_audio": false,
        "audio_conference_info": "",
        "show_international_numbers_link": true,
        "telephony_regions": {
            "allowed_values": [
                "CATB",
                "EUTB_FR",
                "EUTB_AM",
                "USTB",
                "AUTB",
                "ASTB",
                "EUTB"
            ],
            "selection_value": "USTB"
        }
    },
    "tsp": {},
    "feature": {
        "meeting_capacity": 100,
        "large_meeting": false,
        "webinar": false,
        "zoom_events": false,
        "cn_meeting": false,
        "in_meeting": false,
        "zoom_phone": false,
        "concurrent_meeting": "None",
        "zoom_iq_for_sales": false
    },
    "integration": {
        "linkedin_sales_navigator": false
    },
    "profile": {
        "recording_storage_location": {
            "allowed_values": [
                "US",
                "AU",
                "CA",
                "DE",
                "SG",
                "BR",
                "JP"
            ],
            "value": "US"
        }
    },
    "audio_conferencing": {
        "toll_free_and_fee_based_toll_call": {
            "enable": false
        }
    }
}

Thank you @alyssa.williams

I am engaging with our Team to learn more about this change and to be able to provide you the best answer.
I will update you shortly

Cheers,
Elisa

Hi Elisa! Are there any updates?

Hi @alyssa.williams
Thank you for your patience while I work on this issue.
Could you please open up a ticket with support here:
https://devsupport.zoom.us/hc/en-us

Add the link to this post and could you please mention my name so I can take it from there!
Thanks a lot
Elisa

Hi, thanks for the best platform. I am using it from today and finding it best. Hopefully, it will be best for onwards. Thanks again

1 Like