Get webinar details using a key - Zoho Webinar

Note: This task is applicable to all services except Zoho Creator.

Overview:

This task is used to get the webinar details using a webinar key in Zoho Webinar.

This task is based on Zoho Webinar API: Get webinar details using a key

Syntax:

response =zoho.webinar.getWebinarById(<portal_id>,<webinar_key>,<instance_id>,<connection>);

where:

ParamsData typeDescription
<variable>KEY_VALUESpecifies the variable that will hold the response returned by Zoho Webinar.
<portal_Id>NUMBER

Specifies the unique portal identifier where the webinar details will be fetched from.

Note: Portal_Id can be fetched in the following ways.

  • From the URL of the application while accessing it. The URL is in the format webinar.zoho.com/webinar/portal_Id/department_Id/home
  • Get portal ID from Zoho Webinar API, where ZSOID represents the portal ID.
<webinar_key>KEY-VALUESpecifies the unique key identifier of the webinar details to be fetched from.
<instance_id>NUMBERSpecifies the identifier for recurring webinar.
<connection>TEXT

Specifies the link name of the Zoho Webinar connection.

Required scope for this connection ZohoWebinar.webinar.READ

Example:

The following script gets a webinar ID with the specified webinar details into Zoho Webinar.

response = zoho.webinar.getWebinarById(99031443,1080779662,640967000000110006,"webinar");

where:

response
Is the KEY-VALUE returned by Zoho Webinar. It represents the webinar details.
99031443
Is the NUMBER that specifies the unique portal identifier where the webinar details will be fetched from.
1080779662
Is the NUMBER that specifies the unique key identifier of the webinar details to be fetched from.
640967000000110006
Is the NUMBER that specifies the identifier for recurring webinar.
"webinar"
Is the TEXT that represents the name of the connection.

Sample response

The success response returned is in the following format.

Success response

{
  "session": {
    "regEmbedURL": "https://webinar.zoho.com/meeting/register/embed?sessionId=1080779662",
    "registrationRequired": true,
    "timezone": "Asia/Kolkata",
    "displayName": "sri",
    "creatorZuid": "67517985",
    "departmentId": "640967000000025011",
    "isDepartmentAdmin": false,
    "endTimeMillisec": 1763663400000,
    "endtimeFormat": "Fri, Nov 21, 2025 12:00 AM",
    "duration": 3600000,
    "instanceId": "640967000000110006",
    "registrationCount": 0,
    "digest": "",
    "startTime": "Nov 20, 2025 11:00 PM IST",
    "departmentName": "My Department",
    "presenter": "67517985",
    "offset": "19800000",
    "contactEmail": "admin.nm@zoho.com",
    "startLink": "https://webinar.zoho.com/meeting/webinar-start?key=1080779662&x-meeting-org=99031443",
    "isSessionStarted": false,
    "agenda": "",
    "presenterEmail": "admin.nm@zoho.com",
    "attendeesCount": 0,
    "registrationLink": "https://live.zoho.com/aqkw-kni-zoq",
    "startTimeMillisec": 1763659800000,
    "recordings": [
      {
        "embedUrl": "https://webinar.zoho.com/meeting/videoprv/embed?recordingId=36fd547b8c01aaa1ad4b1bbceeea3c58631b0ca5a42c245874be73dc74b7dec2",
        "duration": "21014",
        "downdloadUrl": "https://files.zohopublic.com/public?event-id=36fd547b8c01aaa1ad4b1bbceeea3c58631b0ca5a42c245874be73dc74b7dec2&x-service=webinar&x-cli-msg=",
        "name": "1080779662_640967000000111009_1763616110272.mp4",
        "playUrl": "https://webinar.zoho.com/meeting/public/videoprv?recordingId=36fd547b8c01aaa1ad4b1bbceeea3c58631b0ca5a42c245874be73dc74b7dec2&x-meeting-org=99031443",
        "status": "UPLOADED"
      },
      {
        "embedUrl": "https://webinar.zoho.com/meeting/videoprv/embed?recordingId=36fd547b8c01aaa1ad4b1bbceeea3c58a97ac08fe083e0031bb2c92043cc4baf",
        "duration": "53127",
        "downdloadUrl": "https://files.zohopublic.com/public?event-id=36fd547b8c01aaa1ad4b1bbceeea3c58a97ac08fe083e0031bb2c92043cc4baf&x-service=webinar&x-cli-msg=",
        "name": "1080779662_640967000000111003_1763616053784.mp4",
        "playUrl": "https://webinar.zoho.com/meeting/public/videoprv?recordingId=36fd547b8c01aaa1ad4b1bbceeea3c58a97ac08fe083e0031bb2c92043cc4baf&x-meeting-org=99031443",
        "status": "UPLOADED"
      }
    ],
    "service": 2,
    "timeFormat": "Thu, Nov 20, 2025 11:00 PM",
    "topic": "swdefrgth",
    "endTime": "Nov 21, 2025 12:00 AM IST",
    "webinarType": 1,
    "meetingKey": "1080779662",
    "isPastSession": true
  }
}
 

Failure response

{
  "error": {
    "errorCode": 4000,
    "message": "The meeting key is invalid.",
    "key": "INVALID_MEETING_KEY"
  }
}