Create a session
Description: To create a face-to-face or remote session.
Request URL: /api/v4/<orgId>/sessions.json (How to get my <orgId>?)
Method: POST
OAuth scope: ZohoShowtime.sessionapi.CREATE
Params:
{
"session": {
"name": <sessionName>,
"scheduledTime": 1542113700000,
"scheduledEndTime": 1542117300000,
"deliveryMode": 3,
"sessionSettings":
{
"registrationRequired": true
},
"timezone": <timeZoneSet>,
"description":<sessionDescription>
}
}
Parameters | Description |
"deliveryMode" | '1' refers to a face-to-face session, '3' refers to a remote session |
"name" | Name of the session |
"scheduledTime" | Scheduled time of session |
"registrationRequired" | 'false' means no registration is needed, 'true' means that registration is needed |
"scheduledEndTime" | End time of the schedule as a long value |
CopiedSample Response:
{
"sessionMembers": [
{
"role": "1",
"session": <sessionId>,
"sessionMemberId": <sessionMemberId>,
"name": <userName>,
"createdTime": "1542113496813",
"emailId": <userEmailId>,
"time": "1542113496813",
"id": <sessionMemberId>,
"sessionId": <sessionId>,
"presenterImageUrl": <presenterImageUrl>,
"userId": <userId>,
"orgId": <orgId>
}
],
"session": {
"timezone": <timeZoneSet>,
"attendeeLimit": "200",
"orgId": <orgId>,
"shortenKey": <shortenKey>,
"deliveryMode": "3",
"sessionType": "1",
"createdTime": "1542113496743",
"scheduledBy": <userId>,
"id": <sessionId>,
"joinURL": attend.zoho.com/<shortenKey>,
"deletedTime": "-1",
"registeredCount": "0",
"invitedCount": "0",
"scheduledTime": "1542113700000",
"scheduledEndTime": "1542117300000",
"sessionId": <sessionId>,
"attendedCount": "0",
"paymentsHomePageURL": <paymentsHomePageURL>,
"referrer": "1",
"name": <sessionName>,
"zaid": <zaid>,
"memberRole": "2"
},
"talk": {
"owner": <userId>,
"scheduledTime": "1542113700000",
"deliveryMode": "3",
"session": <sessionId>,
"scheduledEndTime": "1542117300000",
"id": <talkId>,
"sessionId": <sessionId>,
"talkId": <talkId>,
"orgId": <orgId>,
"status": "1"
}