| Name | Description | Type | Additional information |
|---|---|---|---|
| MeetingId |
Unique meeting id. Defaults to an auto-generated unique 6-digit id; returns BadRequest when a supplied value is already in use. |
string |
None. |
| MeetingName |
Meeting name. Defaults to "<operator name> Meeting" on create; left unchanged on update when omitted. |
string |
None. |
| CallRecord |
Record the meeting calls. Default true. |
boolean |
None. |
| NotifyEmail |
Send email notifications for the meeting. Default true. |
boolean |
None. |
| NotifyMessage |
Send SMS/message notifications for the meeting. Default true. |
boolean |
None. |
| Password |
Optional meeting password. |
string |
None. |
| RingDuration |
Ring duration in seconds before fallback. |
integer |
None. |
| FallbackUrl |
URL to redirect to when the call is not answered. |
string |
None. |
| FallbackMessage |
Message shown when the call is not answered. |
string |
None. |
| ConferencePhoneNumber |
Dial-in conference phone number; the passcode is derived from the campaign sequence. |
string |
None. |
| AdditionalNotificationEmail |
Extra email address to notify about the meeting, in addition to the normal participant/host notifications controlled by NotifyEmail. |
string |
None. |
| AdditionalNotificationMobile |
Extra mobile number to notify about the meeting, in addition to the normal participant/host notifications controlled by NotifyMessage. |
string |
None. |
| OperatorEmails |
Comma-separated operator login emails to assign to the meeting (Assign Operators). Each email must belong to an active operator in the caller's company; the creating operator is always included. |
string |
None. |
| AssistantKeysActive |
Comma-separated AssistantKeys enabled for the campaign (AI meeting summary assistants). |
string |
None. |
| AssistantKeysAutoExecute |
Comma-separated AssistantKeys that execute automatically after each meeting. |
string |
None. |
| Summarise |
Enable the AI meeting summary: when true and AssistantKeysActive is not supplied, the default meeting assistant (StpAssistants.IsDefault=1) is enabled on the campaign. The summary can then be generated on demand. |
boolean |
None. |
| AutoSummarise |
Automatically run the AI meeting summary after each meeting: when true and AssistantKeysAutoExecute is not supplied, the default meeting assistant is enabled AND set to auto-execute. Implies Summarise. |
boolean |
None. |
| SendSummaryToHost |
Email the AI summary link to the host after each meeting. Default false. |
boolean |
None. |
| SendSummaryToParticipant |
Email the AI summary link to participants after each meeting. Default false. |
boolean |
None. |
| SummaryRecipientEmail |
Who receives the AI meeting summary link (when SendSummaryToHost is true). Defaults to the operator's login email; on update, defaults to the meeting's current recipient when omitted. |
string |
None. |