Recall.ai

Parámetros de entrada

• zoomobject

  Settings for the bot to join Zoom meetings. { "join_token_url": "some_url", "zak_url": "some_url", "user_email": "some@email" }

• join_atstring

  The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call. Once a bot has joined a call, it's join_at will be cleared.

• variantobject

  The variant of the bot. For example { "zoom": "web", "google_meet": "web_4_core", "microsoft_teams": "web_4_core" }

• bot_namestring

  A description of the bot.

• google_meetobject

  Settings for the bot to join Google Meet meetings. For example { "login_required": true, "google_login_group_id": "some_group_id" }

• meeting_urlstringObligatorio

  The url of the meeting. For example, https://zoom.us/j/123?pwd=456. This field will be cleared a few days after the bot has joined a call.

• output_mediaobject

  Settings for the bot output media. For example { "camera": { "kind": "webpage", "config": { "url": "some_uri" } }, "screenshare": { "kind": "webpage", "config": { "url": "some_uri" } } }

• recording_modestringenum

  Setting for the recording mode.

  speaker_viewgallery_viewgallery_view_v2audio_only
• automatic_leaveobject

  Settings for the bot to automatically leave the call. For example { "waiting_room_timeout": 30, "noone_joined_timeout": 30, "everyone_left_timeout": 2, "in_call_not_recording_timeout": 2, "in_call_recording_timeout": 1, "recording_permission_denied_timeout": 1 }

• real_time_mediaobject

  The settings for real-time media output. For example { "webhook_call_events_destination_url": "some_webhook_url", "webhook_chat_messages_destination_url": "some_webhook_url", "websocket_speaker_timeline_exclude_null_speaker": true, "websocket_speaker_timeline_destination_url": "some_url", "websocket_audio_destination_url": "some_url", "websocket_video_destination_url": "some_url", "rtmp_destination_url": "some_url" }

• slack_authenticatorobject

  Settings for the bot to authenticate with Slack. For example { "slack_team_integration_id": "some_id", "team_domain": "some_domain", "login_email": "some@email", "profile_photo_base64_jpg": "some_string_url" }

• slack_huddle_observerobject

  Settings for the bot to observe Slack huddles. For example { "slack_team_integration_id": "someid", "team_domain": "some_domain", "login_email": "some@email", "auto_join_public_huddles": true, "ask_to_join_private_huddles": true, "ask_to_join_message": "some_message", "profile_photo_base64_jpg": "some_url", "huddle_bot_api_token": "some_token", "huddle_bot_config": "some_config_string" }

• automatic_video_outputobject

  Settings for the bot to output video. Image should be 16:9. Recommended resolution is 640x360. For example { "in_call_recording": { "kind": "jpeg", "b64_data": "some_base64_string" }, "in_call_not_recording": { "kind": "jpeg", "b64_data": "some_base64_string" } }

• recording_mode_optionsobject

  Additional options for recording mode. For example { "participant_video_when_screenshare": "beside", "start_recording_on": "participant_speak" }

• real_time_transcriptionobject

  The settings for real-time transcription. { "destination_url": "some_url", "partial_results": false, "enhanced_diarization": true }

• include_bot_in_recordingobject

  Additional options for recording mode. For example { "audio": true }

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  A UUID string identifying this bot.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bot_idstringObligatorio

  The ID of the bot for which to retrieve the chat messages.

• cursorstring

  The pagination cursor value.

• orderingstring

  Which field to use when ordering the results.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  A UUID string identifying this bot.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bot_idstringObligatorio

  The ID of the bot to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the bot to start recording.

• recording_modestringenum

  Setting for the recording mode.

  speaker_viewgallery_viewgallery_view_v2audio_only
• real_time_mediaobject

  The settings for real-time media output. For example { "webhook_call_events_destination_url": "some_webhook_url", "webhook_chat_messages_destination_url": "some_webhook_url", "websocket_speaker_timeline_exclude_null_speaker": true, "websocket_speaker_timeline_destination_url": "some_url", "websocket_audio_destination_url": "some_url", "websocket_video_destination_url": "some_url", "rtmp_destination_url": "some_url" }

• recording_mode_optionsobject

  Additional options for recording mode. For example { "participant_video_when_screenshare": "beside", "start_recording_on": "participant_speak" }

• real_time_transcriptionobject

  The settings for real-time transcription. { "destination_url": "some_url", "partial_results": false, "enhanced_diarization": true }

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  A UUID string identifying this bot.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not