Zoom

Add Zoom Meeting Registrant

Registers a customer for a Zoom meeting that needs registration.

Unverified

Add this first. This tool needs an access token, so add Get Zoom Access Token to the same bot. The bot calls it first and passes the token in.

What the model is told

Register a customer for an existing Zoom meeting that requires registration. Get a Zoom access token first if you do not have one. Confirm the meeting ID, name and email address with the customer before calling. Tell the customer their personal join_url from the response was also sent by email, and do not read out the registrant_id.

Request

POSThttps://api.zoom.us/v2/meetings/{{meetingId}}/registrants

Headers

  • Content-Typeapplication/json
  • AuthorizationBearer {{accessToken}}

Body

{
  "email": "{{email}}",
  "first_name": "{{firstName}}",
  "last_name": "{{lastName}}"
}

Parameters

  • meetingId stringThe Zoom meeting ID.
  • email stringThe customer's email address.
  • firstName stringThe customer's first name.
  • lastName stringThe customer's last name.
  • accessToken stringThe access_token value returned by the token tool. Reuse it for the rest of the conversation.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "2079c205-d001-432c-9eda-010f96158567",
    "type": "HTTP_REQUEST",
    "label": "Add Zoom Meeting Registrant",
    "name": "add_zoom_meeting_registrant",
    "customName": false,
    "description": "Register a customer for an existing Zoom meeting that requires registration. Get a Zoom access token first if you do not have one. Confirm the meeting ID, name and email address with the customer before calling. Tell the customer their personal join_url from the response was also sent by email, and do not read out the registrant_id.",
    "parameters": [
      {
        "name": "meetingId",
        "type": "string",
        "description": "The Zoom meeting ID."
      },
      {
        "name": "email",
        "type": "string",
        "description": "The customer's email address."
      },
      {
        "name": "firstName",
        "type": "string",
        "description": "The customer's first name."
      },
      {
        "name": "lastName",
        "type": "string",
        "description": "The customer's last name."
      },
      {
        "name": "accessToken",
        "type": "string",
        "description": "The access_token value returned by the token tool. Reuse it for the rest of the conversation."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://api.zoom.us/v2/meetings/{{meetingId}}/registrants"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": "{\n  \"email\": \"{{email}}\",\n  \"first_name\": \"{{firstName}}\",\n  \"last_name\": \"{{lastName}}\"\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.