Steps to integrate meeting services
Step 1: Create the extension
To integrate meeting applications into Zoho Desk, you need to create an extension.
Step 2: Add entries in the resource.json file
- Navigate to the project folder on your local drive.
- Open the resource.json file located in the project directory.
- Provide meeting configuration data in a designated JSON format to integrate meeting applications.
A sample JSON structure and its attributes are described below:
Attributes | Datatype | Description |
meeting* | JSON Object | The meeting extension details |
resourceName* | String max length:100 | The resource name for the extension
Note: The name should be unique |
name* | String max length:100 | The name of the meeting service you aim to integrate |
logopath* |
| The logo of the specific meeting service to be displayed in the Desk. This specifies the relative path of the meeting service's logo image.
Logo Specification:
|
meetingEndPoints*
| JSON Object
| Sigma functions that are needed for meeting extension |
meetingEndPoints.eventCreator* | String (URL) | Function for creating a meeting in the meeting service |
meetingEndPoints.changesListener* | String (URL) | Function that returns meeting information for the provided unique meeting code |
preference | JSON Object | The meeting configuration details
|
preference.replyTemplate* | JSON Object | This is the private comment template that will be sent in the ticket when the meeting is scheduled/created. |
preference.replyTemplate.value | String max length: 40000 | The comment template to be sent with supported placeholders in the ticket
Note: supports Rich Text Content supported placeholders:
|
preference.replyTemplate.displayName | String max length: 1000 regex | The name to be displayed on the meeting setup page
Note: The displayName must be in cleartextpattern
|
Sample JSON
Copied{
"meeting":
{
"resourceName": "Meeting",
"name": "Zoho Meeting",
"logopath": "/app/img/meeting.png",
"meetingEndPoints":
{
"eventCreator": "/workspace/invokefunction?sigma_app_uuid=6514e6be-67d7-404b-80b1-d56d6b2bb162&sigma_function_uuid=2a74ad0a-5b5b-4e75-83dc-9861a3dd978e&sigma_function_version=48&sigma_app_version=&integ_scope_id=&app_install_id=&custom_response=true&auth_type=apikey&encapiKey=",
"changesListener": "/workspace/invokefunction?sigma_app_uuid=6514e6be-67d7-404b-80b1-d56d6b2bb162&sigma_function_uuid=8165d91f-d7ea-4de8-876b-1a12c545aa75&sigma_function_version=37&sigma_app_version=&integ_scope_id=&app_install_id=&custom_response=true&auth_type=apikey&encapiKey="
},
"preference":
{
"replyTemplate":
{
"value": "<div>I am having a meeting with <span class='colour' style='color:#0065cc'>${contactName}</span> to address <span class='colour' style='color:#0065cc'>${meetingTitle}</span><br></div><div><br></div>>", //Refer possible values that can be specified in replyTemplate.value//
"displayName": "Agent Response"
}
}
}
}Show full
Show less
Step 3: Create meeting endpoints
Create the meeting end points using Zoho Sigma
- eventCreator: This function is used to perform CRUD operations.
- changesListener: This function returns meeting information for the provided meeting codes.
Step 4: Associate sigma functions with the extension
Associate the created sigma functions with your extension. Once associated, the respective Execution URL will be provided for executing the functions.
Step 5: Use respective URLs in the resource.json file
- Obtain the respective URLs after associating sigma functions with the extension.
- Remove the domain part for each sigma function URL.
An example is shown on the right side:
Obtained execution URL
Copied"https://64745391-670c-4180-830e-a53d4d566603.sigmaexecution.com/workspace/invokefunction?sigmafunctionuuid=de112b74-48cc-458c-98ca-f4c43e434a9b&sigmafunctionversion=26&integscopeid=&appinstallid=&customresponse=true&authtype=apikey&encapiKey=" Modified execution URL after removing the domain
Copied"/workspace/invokefunction?sigmafunctionuuid=de112b74-48cc-458c-98ca-f4c43e434a9b&sigmafunctionversion=26&integscopeid=&appinstallid=&customresponse=true&authtype=apikey&encapiKey="
Step 6: Publish the extension
Publish the extension after updating all the attributes and corresponding values in the resource.json file.