Webex · Schema
SurveyLinkRequestObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| hostEmail | string | Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. An admin can specify the email of the meeting host who is |
| meetingStartTimeFrom | string | Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested and conforms with the `timezone` in the request heade |
| meetingStartTimeTo | string | End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested and conforms with the `timezone` in the request header |
| emails | array | Participants' email list. The maximum size of `emails` is 100. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SurveyLinkRequestObject",
"title": "SurveyLinkRequestObject",
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "[email protected]",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. An admin can specify the email of the meeting host who is in a site he manages and the API returns post survey links on behalf of the meeting host."
},
"meetingStartTimeFrom": {
"type": "string",
"example": "2019-03-18T09:30:00Z",
"description": "Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested and conforms with the `timezone` in the request header if specified. `meetingStartTimeFrom` cannot be after `meetingStartTimeTo`. Only applies when `meetingId` is not an instance ID. The API generates survey links for the last instance of `meetingId` in the time range specified by `meetingStartTimeFrom` and `meetingStartTimeTo`. If not specified, `meetingStartTimeFrom` equals `meetingStartTimeTo` minus `1` month; if `meetingStartTimeTo` is also not specified, the default value for `meetingStartTimeFrom` is `1` month before the current date and time."
},
"meetingStartTimeTo": {
"type": "string",
"example": "2019-03-25T09:30:00Z",
"description": "End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested and conforms with the `timezone` in the request header if specified. `meetingStartTimeTo` cannot be prior to `meetingStartTimeFrom`. Only applies when `meetingId` is not an instance ID. The API generates survey links for the last instance of `meetingId` in the time range specified by `meetingStartTimeFrom` and `meetingStartTimeTo`. If not specified, `meetingStartTimeTo` equals `meetingStartTimeFrom` plus `1` month; if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is the current date and time."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Participants' email list. The maximum size of `emails` is 100."
}
}
}