Creation of meeting endpoints

1. eventCreator function
2. changesListener function

1. eventCreator function

This Sigma function performs the CRUD operations. The function returns the meeting data in a specified format for the provided input payload.

Input Payload

Create

To create a meeting with the provided input payload.

Copied{
"operationType": "create" 
"meeting": 
    {
        "duration": "1200",
        "host": 
            {
                  "mail": "rebecca@zohocorp.com",
                  "name": "Rebecca"
            },
        "startTime": "2024-01-18T07:01:42.000Z",
        "title": "Meeting Integration Service Implementation",
        "type": "Audio Meeting",
        "participants": [ "lawrence@zohocorp.com", "emilclarin@zohomail.com", "caroline@mailinator.com" //participants mailId in an array 
                           ]
    }
  "ticketInfo": 
    {
           "subject": "Request for Assistance - Meeting Integration Service Setup",
           "contact": 
            {
                       "name": "Rebecca"
                       "emailId":"rebecca@gmail.com"
            },
    "ticketId": 7601000153723001
    }, 
}

Show full

Show less

Update

To update the information on the created meeting with the provided input payload.

Copied{
"operationType" : "update" 
"meeting": 
    {
        "meetingCode": "12345-abcd"
        "duration": "1200",
        "host": 
            {
                  "mail": "rebecca@zohocorp.com",
                  "name": "Rebecca"
            },
        "startTime": "2024-01-18T07:01:42.000Z",
        "title": "Meeting Integration Service Implementation",
        "type": "Audio Meeting",
        "participants": [ "lawrence@zohocorp.com", "emilclarin@zohomail.com", "caroline@mailinator.com" //participants mailId in an array 
                           ]
    }
  "ticketInfo": 
    {
        "subject": "Request for Assistance - Meeting Integration Service Setup",
        "contact": 
            {
            	"name": "Rebecca"
            	"emailId":"rebecca@gmail.com"
            },
    "ticketId": 7601000153723001
    },
}

Show full

Show less

Read

To fetch the meeting information by providing the respective meetingCode in the input payload.

Copied{ 
 "operationType": "get",
 "meeting": 
       { 
        "meetingCode": "12345-abcd"
       } 
}

Delete

To delete a meeting by providing the respective meetingCode in the input payload.

Copied{ 
 "operationType": "delete",
 "meeting": 
       { 
        "meetingCode": "12345-abcd"
       } 
}

Attributes and their description

Attributes	Datatype	Description
operationType	String	The type of CRUD operation. The allowed values are create, update, get, and delete.
meeting	JSON Object	Meeting information
meeting.startTime	String	Start date and start time of the meeting in ISO format Note: ISO format:yyyy-MM-ddThh:mm:ss.SSSZ startTime will be in GMT time zone.
meeting.duration*	String max length: 200	Duration of the event Note: Specify the duration in seconds
meeting.host.name	String	Event owner's name
meeting.host.mail	String valid email	Event owner's email address
meeting.participants	Array of emailIds as string array size: 0-50	List of email addresses of the participants, which includes desk agent mailIds, desk contact mailIds, and also other non Zoho Desk users.
meeting.title*	String max length: 255	Subject of the event
meeting.type	String	Specifies the type of event. The allowed values are Audio Meeting and Video Meeting. Note: The equivalent i18n values are permitted
meeting.description	String max length: 65535	Description of the event
ticketInfo	JSON Object	Ticket info in which the event is associated with
ticketInfo.ticketId	long	TicketId of the Desk ticket
ticketInfo.subject*	String max length: 255	Subject of the ticket
ticketInfo.contact.name*	String max length: 200	Name of the Desk contact
ticketInfo.contact.emailId	String valid email max length: 150	Email address of the Desk contact

* - Mandatory parameters

Output Response

The sigma function is expected to return newly created meeting data in the pre-structured JSON format.

Create, Update, and Read

The output response for create, update, and read operations is given below:

Copied{
  "meeting": 
    {
        "title": "Phone heating issue",
        "agenda": "Technical assistance to resolve customer-reported phone heating issues",
        "meetingCode": "1059305803",
        "duration": 1200,
        "host": 
        {
              "name": "Rebecca",
              "emailId": "rebecca@zohocorp.com",
              "photoUrl": "https://deskstatic.zoho.com/api/v1/agents/7601000027150091/photo?orgId=674476860"
        },
        "joinLink": "https://meet.zoho.com/fhCnzTCo5E",
        "startLink": "https://meeting.zoho.com/meeting/meeting-start?key=1059305803&x-meeting-org=53296550",
        "password": "pwd@123",
        "status": "Scheduled",
        "type": "Audio Conferencing",
        "participants":[
                          {
                              "name": "lawrence@zohomail.com",
                              "emailId": "lawrence@zohomail.com"
                          },
                          {
                              "name": "emilclarin@zohocorp.com",
                             "emailId": "emilclarin@zohocorp.com"
                          },
                          {
                               "name": "caroline@mailinator.com",
                               "emailId": "caroline@mailinator.com"
                               "photoUrl":"https://deskstatic.zoho.com/api/v1/            agents/189902000055358341/photo?orgId=645936564"
                          }
                    ],
        "startTime": "2024-01-18T07:01:00.000Z"
      }
}

Show full

Show less

Delete

The output response is "Status: 200"

Attributes and their description

Attributes	Datatype	Description
meeting	JSON Object	Meeting information
title	String max length: 255	Subject of the meeting
agenda	String max length: 65535	Agenda/Description of the meeting
meetingCode	String	Unique meeting code to identify a specific meeting
joinLink*	String max length: 2083	The link to join the meeting. The link is generated when a meeting is created/scheduled.
startLink*	String max length: 2083	The link to start the created/scheduled meeting
password*	String max length: 100	Meeting password to join the meeting
status*	String max length: 100	Status of the meeting The allowed values are scheduled and completed
type	String max length: 250	Specifies the type of meeting The allowed values are Audio Meeting and Video Meeting
startTime	String	Start date and start time of the meeting in ISO format Note: ISO format:yyyy-MM-ddThh:mm:ss.SSSZ startTime will be in GMT time zone
duration*	Integer	Duration of the meeting Note: Specify the duration in seconds
host*	JSON Object
host : name	String	Name of the host
host : emailId*	String	email address of the host
host : photoUrl	String	photoURL of the host
participants	Array of objects array size: 0-50	The list of participants' email addresses
participants: name	String	Name of the participant
participants: emailId	String	email address of the participant
participants: photoURL	String	photoURL of the participant
redirectionUrl*	String URL max length: 2083	The link redirects users to the meeting information page on the corresponding meeting service
meetingRecordings	Array of string	Link to access the recorded meeting
noteLink	String URL max length: 2083	Link to access the notes of the meeting
chatLink	String URL max length: 2083	Link to access the chat

* - Mandatory parameters

2. changesListener function

This Sigma function returns meeting information in the specified format for the provided meeting keys (meetingCodes) in the input payload. It helps to update the ticket comment after a completed meeting, and the completed status of the meeting is updated in the Desk event.

Input payload

Copied{
"meeting":
[
 {
     "eventId": "206706000001078001",
     "meetingCode":"23456hg543"
 },
 {
     "eventId": "206706000001075009",
     "meetingCode":"76543po0"
 }
]}

Note: A maximum of ten meeting keys (meetingCodes) are selected in a single payload.

Attributes and their description

Attributes	Datatype	Description
meeting	JSON Object	Meeting information
eventId*	String	Id of the event
meetingCode*	String	Unique id of the meeting created from the corresponding meeting service

* - Mandatory parameters

Output response

The sigma function returns the meeting information for the meeting codes provided in the input payload in a pre-structured JSON format.

Copied{ 
 meetings : [
      	   {
            "eventId" : "1234",
            "status" : "Completed",
            "startTime" : "13ZT40.0",
            "duration" : 1200,
            "meeting" : {
                    "startTime" : "213Z4T.0",
                    "duration" : 1200,
                    "joinLink" : "",
                    "meetingRecordings" : [],
                    "redirectionUrl": "",
                    "participants" : [],
                    "title" : "345",
                    "password" : "",
                    "meetingCode" :,
                    "status" : "",
                    "chatLink" : "",
                    "noteLink" : ""
                    }         
            }
        ]
}

Attributes and their description

Attributes	Datatype	Description
meetings	Array of objects	Meeting information
eventId*	Integer	Id of the event
status*	String	Status of the meeting
startTime*	String	Start time of the meeting.
duration*	Integer	Duration of the meeting.
joinLink	String	The meeting link.
meetingRecordings	Array of string	Link(s) to the meeting recordings.
redirectionUrl	String URL	The link to redirect users to the meeting information page on the corresponding meeting service.
participants	Array of objects	The list of participants.
participants.name	String	Name of the participant.
participants.emailId	String	email address of the participant.
password	String	Meeting password to join the meeting.
meetingCode	String	Unique meeting code to identify a specific meeting.
status	String	Status of the meeting.
chatLink	String URL	Link to the chat history of the meeting.
noteLink	String URL	Link to the meeting notes.

* - Mandatory parameters

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People