NetSapiens API v2
  1. Meetings
NetSapiens API v2
  • TODO LIST
  • Version
    • Read API Version
      GET
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
      • Read API Keys under your account
      • Read Info on specific APIKey via Key ID
      • Create API Key
      • Update API Key
      • Revoke API Key
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
      • Revoke current JWT
      • Read Current JWT
  • Event Subscriptions
    • Read Event Subscriptions
      GET
    • Read Event Subscription By Id
      GET
    • Create a Event Subscription
      POST
    • Update an Event Subscription
      PUT
    • Delete a subscription
      DELETE
  • Resellers
    • Get Resellers
      GET
    • Create Reseller
      POST
    • Update Reseller
      PUT
    • Delete Reseller
      DELETE
    • Get Specific Reseller
      GET
  • Domains
    • Get Domains
    • Count Domains
    • Get Specific Domain
    • Get Specific Domain With Billing Summary
    • Get My Domain Info
    • Check if Domain Exists
    • Create a Domain
    • Update a Domain
    • Delete a Domain
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Users
    • Get Users in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Create User in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
  • Devices
    • Count Devices for User
    • Get Devices for User
    • Create Device for User
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
  • Phones/Macs
    • Supported Models and Servers
      • Get list of Supported/Provisionable Models
      • Get list of Supported/Provisionable by Vendor
      • Get details of Specific Model
      • Get list of Provisionable Server Profiles
      • Read Provisionable Server Details
    • Read Mac Addresses
    • Read Mac Addresses in Domain
    • Read Specific Mac Address
    • Add MAC address
    • Add MAC address for Domain
    • Update MAC address
    • Update MAC address in Domain
    • Remove MAC address
    • Remove MAC address in Domain
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Create Site in Domain
    • Update Site in Domain
    • Read Specific Site in Domain
  • Call Center
    • Callqueues
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
    • Agents
      • Read Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
  • Answer Rules
    • Read Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Add a Answerrule for a User
    • Delete a Answerrule for a User
    • Update a Answerrule for a User
    • Reorder Answerrules for my User
  • Call Blocking
    • Read blocked numbers for a Domain
    • Read blocked numbers for a User
    • Add blocked numbers for a Domain
    • Add blocked numbers for a User
    • Delete blocked numbers for a Domain
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Create a new MOH for Domain from TTS
        • Update MOH for Domain from TTS
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
        • Delete MOH for Domain
      • User
        • Read MOH for User
        • Create a new MOH for Domain from TTS
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Delete MOH for User
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • CDR (Call History)
    • Read CDRs
    • Read CDRs for Domain
    • Read CDRs for Specific User
    • Search CDRs for Domain
    • Read CDRs for Site in Domain
    • Count CDRs and SUM minutes
    • Count CDRs and SUM minutes for Domain
    • Count CDRs and SUM minutes for Specifc User
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Call Traces & Cradle to Grave
    • Get Call Trace (SIPFlow) For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
  • Calls (live/active calls)
    • Read Active Calls In Domain
    • Count Active Calls In Domain
    • Read Active Calls for User
    • Read Specific Actice Call
    • Make a new Call
    • Disconnect Call
    • Transfer Peer Call
    • Transfer Call
    • Answer Call
    • Hold Active Call
    • Un-Hold Active Call
    • Reject Call
    • Report Active Calls
  • Contacts
    • Shared Contacts
      • Get Domain Contacts
      • Get Specific Domain Contact
      • Create Shared Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get Contacts for User
    • Get Specific Contact for User
    • Count Contacts for User
    • Create Contact
    • Update Contact
    • Delete Contact
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Validate Address
    • Create Address for Domain
    • Update Address for Domain
    • Update Address for User
    • Update Address Endpoint
    • Create Address for User
    • Delete Address For User
    • Delete Address Endpoint
    • Delete Address For Domain
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
    • Get Addresses for User
    • Get Address Using Address ID
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Add a new dial rule into a dial plan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
  • Messages
    • Get Messagesessions for Domain
    • Start a new Message Session
    • Get Messagesessions for User
    • Get Messages for Messagesession
    • Send a message (Chat)
    • Send a message (Group Chat)
    • Send a message (Media Chat)
    • Send a message (SMS)
    • Send a message (Group SMS)
    • Send a message (MMS)
    • Update Messagesession (Participants)
    • Update Messagesession (Session Name)
    • Update Messagesession (Leave)
    • Delete Messagesession
  • SMS Numbers
    • Get All SMS Numbers for System
    • Get SMS Numbers for Domain
    • Create SMS Number
    • Update SMS Number Copy
    • Delete an SMS Number
    • Get SMS Numbers for User
    • Count SMS Numbers for User
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
  • Email
    • Send Email using Template
  • Connections
    • Get All Connections
    • Count All Conections
    • Get All Connections for a Domain
    • Get Specific Connection for a Domain
    • Delete a Specific Connection for a Domain
    • Create a Connection
    • Update a Connection
  • Routes
    • Read Routes
    • Count All Routes
    • Read Route Connections
    • Count All Route Connections
    • Create a Route
    • Create a Route Connection
    • Delete A Specific Route
    • Update A Specific Route
    • Update A Specific Route Connection
  • Meetings
    • Event Logs
      • Create a Meeting Log Event
      • Read Meeting Events
    • Iotum
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • Create a Meeting with Id
      POST
    • Create a Meeting
      POST
    • Read Meeting
      GET
    • Count Domains Meetings
      GET
    • Count Meeting
      GET
    • Register Meeting
      POST
    • Update a Meeting
      PUT
    • Delete a Meeting
      DELETE
    • Request a Meeting ID
      POST
    • Read Meetings for User
      GET
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Read a Specific Configuration Definition
      • Create a Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (Multipart/Mixed Post)
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Update Template from Upload (Multipart/Mixed Post)
    • Update Template from Upload (JSON + Base64 File)
  • Timeframes
    • Domain (Shared)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • Read SSL certificates for CertManager
    • Read SSL certificate by Common Name
    • Create SSL certificate for CertManager
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  1. Meetings

Create a Meeting with Id

POST
/domains/{domain}/users/{user}/meetings/{id}
Last modified:2023-12-21 20:52:24
API v1 create meeting passing in newly requested meeting Id

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
domain
string 
required
Example:
{{domain}}
user
string 
required
Example:
{{user}}
id
string 
required
Meeting Id to create
Example:
779608244
Body Params application/json
description
string 
optional
current_timestamp
enum<string> 
optional
This is the time stamp that the formated via RFC 3339
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
meeting-calendar-invite-id
string 
optional
meeting-ordinal-sequence
integer 
optional
core-server
string 
optional
chat-session-id
string 
optional
meeting-registration-id
string 
optional
meeting-instance-id
string 
optional
meeting-name
string 
required
meeting-type
string 
optional
limits-max-participants
integer 
optional
meeting-status
string 
optional
meeting-schedule-start-datetime
enum<string> 
optional
This is the time stamp that the formated via RFC 3339
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
timezone
enum<string> 
optional
This is the time zone that the user is primarily located in
Allowed values:
US/AlaskaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificAfrica/Addis_AbabaAfrica/AlgiersAfrica/BrazzavilleAfrica/CairoAfrica/CasablancaAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/JohannesburgAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/NairobiAfrica/TimbuktuAfrica/TripoliAfrica/TunisAmerica/AntiguaAmerica/ArubaAmerica/BelizeAmerica/BogotaAmerica/Buenos_AiresAmerica/CancunAmerica/CaracasAmerica/CaymanAmerica/ChihuahuaAmerica/Costa_RicaAmerica/DenverAmerica/DetroitAmerica/EdmontonAmerica/El_SalvadorAmerica/EnsenadaAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/HavanaAmerica/IndianapolisAmerica/JamaicaAmerica/JuneauAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/LouisvilleAmerica/MartiniqueAmerica/MazatlanAmerica/MendozaAmerica/MenomineeAmerica/MeridaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontrealAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/PanamaAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/ReginaAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ThuleAmerica/Thunder_BayAmerica/TijuanaAmerica/TorontoAmerica/VancouverAmerica/WinnipegAmerica/YellowknifeAntarctica/South_PoleArctic/LongyearbyenAsia/AmmanAsia/BaghdadAsia/BahrainAsia/BangkokAsia/BeirutAsia/BruneiAsia/CalcuttaAsia/ColomboAsia/DaccaAsia/DamascusAsia/DhakaAsia/DubaiAsia/GazaAsia/Hong_KongAsia/IstanbulAsia/JakartaAsia/JerusalemAsia/KabulAsia/KatmanduAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/ManilaAsia/MuscatAsia/Phnom_PenhAsia/RangoonAsia/RiyadhAsia/SaigonAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/TaipeiAsia/TehranAsia/Tel_AvivAsia/ThimphuAsia/TokyoAsia/Ulan_BatorAsia/VientianeAsia/VladivostokAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaeroeAtlantic/ReykjavikAustralia/ACTAustralia/AdelaideAustralia/BrisbaneAustralia/CanberraAustralia/DarwinAustralia/LHIAustralia/MelbourneAustralia/NorthAustralia/NSWAustralia/PerthAustralia/QueenslandAustralia/SouthAustralia/SydneyAustralia/TasmaniaAustralia/VictoriaAustralia/WestCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificCanada/SaskatchewanCanada/YukonCubaEtc/GMTEtc/GMT+1Etc/GMT+10Etc/GMT+11Etc/GMT+12Etc/GMT+2Etc/GMT+3Etc/GMT+4Etc/GMT+5Etc/GMT+6Etc/GMT+7Etc/GMT+8Etc/GMT+9Etc/GMT-1Etc/GMT-10Etc/GMT-11Etc/GMT-12Etc/GMT-13Etc/GMT-14Etc/GMT-2Etc/GMT-3Etc/GMT-4Etc/GMT-5Etc/GMT-6Etc/GMT-7Etc/GMT-8Etc/GMT-9Etc/GreenwichEurope/AmsterdamEurope/AthensEurope/BelfastEurope/BelgradeEurope/BerlinEurope/BrusselsEurope/BucharestEurope/BudapestEurope/CopenhagenEurope/DublinEurope/HelsinkiEurope/IstanbulEurope/KievEurope/LisbonEurope/LjubljanaEurope/LondonEurope/MadridEurope/MaltaEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PragueEurope/RomeEurope/SofiaEurope/StockholmEurope/ViennaEurope/WarsawEurope/ZurichGreenwichPacific/AucklandPacific/EasterPacific/FijiPacific/GalapagosPacific/GambierPacific/GuamPacific/HonoluluPacific/MarquesasPacific/MidwayPacific/PalauPacific/RarotongaPacific/Tahiti
meeting-schedule-duration-minutes
integer 
optional
meeting-schedule-recurrence-rule
string 
optional
meeting-video-allowed-from
enum<string> 
optional
Allowed values:
yesno
meeting-audio-allowed-from
enum<string> 
optional
Allowed values:
yesno
meeting-chat-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-chat-history-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-question-answer-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-recording-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-join-require-invite-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-join-require-passcode-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-require-host-to-begin-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-allow-changes-from-hosts-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-hide-attendee-list-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-lock-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-lock-allowed
enum<string> 
optional
Allowed values:
yesno
meeting-room-enabled
enum<string> 
optional
Allowed values:
yesno
meeting-dial-in-number-blob
string 
optional
meeting-passcode
string 
optional
meeting-previous-presenter-attendee-id
string 
optional
meeting-presenter-attendee-id
string 
optional
meeting-video-layout 
integer 
optional
last-modified-datetime
enum<string> 
optional
This is the time stamp that the formated via RFC 3339
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
meeting-instance-actual-start-datetime
enum<string> 
optional
This is the time stamp that the formated via RFC 3339
Allowed value:
YYYY-MM-DDTHH:MM:SS.ssZ
Example
{
  "description": "string",
  "current_timestamp": "YYYY-MM-DDTHH:MM:SS.ssZ",
  "meeting-calendar-invite-id": "string",
  "meeting-ordinal-sequence": 0,
  "core-server": "string",
  "chat-session-id": "string",
  "meeting-registration-id": "string",
  "meeting-instance-id": "string",
  "meeting-name": "string",
  "meeting-type": "string",
  "limits-max-participants": 0,
  "meeting-status": "string",
  "meeting-schedule-start-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ",
  "timezone": "US/Alaska",
  "meeting-schedule-duration-minutes": 0,
  "meeting-schedule-recurrence-rule": "string",
  "meeting-video-allowed-from": "yes",
  "meeting-audio-allowed-from": "yes",
  "meeting-chat-enabled": "yes",
  "meeting-chat-history-enabled": "yes",
  "meeting-question-answer-enabled": "yes",
  "meeting-recording-enabled": "yes",
  "meeting-join-require-invite-enabled": "yes",
  "meeting-join-require-passcode-enabled": "yes",
  "meeting-require-host-to-begin-enabled": "yes",
  "meeting-allow-changes-from-hosts-enabled": "yes",
  "meeting-hide-attendee-list-enabled": "yes",
  "meeting-lock-enabled": "yes",
  "meeting-lock-allowed": "yes",
  "meeting-room-enabled": "yes",
  "meeting-dial-in-number-blob": "string",
  "meeting-passcode": "string",
  "meeting-previous-presenter-attendee-id": "string",
  "meeting-presenter-attendee-id": "string",
  "meeting-video-layout ": 0,
  "last-modified-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ",
  "meeting-instance-actual-start-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/users/{{user}}/meetings/779608244' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "current_timestamp": "YYYY-MM-DDTHH:MM:SS.ssZ",
    "meeting-calendar-invite-id": "string",
    "meeting-ordinal-sequence": 0,
    "core-server": "string",
    "chat-session-id": "string",
    "meeting-registration-id": "string",
    "meeting-instance-id": "string",
    "meeting-name": "string",
    "meeting-type": "string",
    "limits-max-participants": 0,
    "meeting-status": "string",
    "meeting-schedule-start-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ",
    "timezone": "US/Alaska",
    "meeting-schedule-duration-minutes": 0,
    "meeting-schedule-recurrence-rule": "string",
    "meeting-video-allowed-from": "yes",
    "meeting-audio-allowed-from": "yes",
    "meeting-chat-enabled": "yes",
    "meeting-chat-history-enabled": "yes",
    "meeting-question-answer-enabled": "yes",
    "meeting-recording-enabled": "yes",
    "meeting-join-require-invite-enabled": "yes",
    "meeting-join-require-passcode-enabled": "yes",
    "meeting-require-host-to-begin-enabled": "yes",
    "meeting-allow-changes-from-hosts-enabled": "yes",
    "meeting-hide-attendee-list-enabled": "yes",
    "meeting-lock-enabled": "yes",
    "meeting-lock-allowed": "yes",
    "meeting-room-enabled": "yes",
    "meeting-dial-in-number-blob": "string",
    "meeting-passcode": "string",
    "meeting-previous-presenter-attendee-id": "string",
    "meeting-presenter-attendee-id": "string",
    "meeting-video-layout ": 0,
    "last-modified-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ",
    "meeting-instance-actual-start-datetime": "YYYY-MM-DDTHH:MM:SS.ssZ"
}'

Responses

🟢200OK
application/json
Body
id
integer 
read-onlyrequired
The meeting id
domain
string 
required
This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).
<= 64 characters
Examples:
example.commyDomaintest.12123
Match pattern:
^[A-Za-z0-9._-]+|\*
user
string 
required
This is the main user extension for the user account.
Examples:
1000200
description
string 
optional
The description about the meeting
current_timestamp
string <date-time>
required
The current timestamp value of the meeting
meeting-calendar-invite-id
string 
read-onlyoptional
The read only value for the meeting to use with calendar integration
meeting-ordinal-sequence
integer 
read-onlyoptional
The read only value for the meeting with manage the calendar integrations
core-server
string 
read-onlyoptional
The core server which the meeting was created on and events are driven from
chat-session-id
string 
read-onlyoptional
The read only value identifying the meeting chat room session
meeting-registration-id
string 
optional
The token value for guest to use to register for a webinar
meeting-instance-id
string 
optional
The instance value of a meeting with used to associate with a recording or differentiating recurring meetings
meeting-name
string 
optional
The descriptive name of the meeting
meeting-type
enum<string> 
optional
The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'
Allowed values:
presentationconference
Default:
conference
limits-max-participants
integer 
optional
The maximum number of participants allows in the meeting
meeting-status
required
The current status of the meeting
Any of
Allowed values:
startedactiveendedcompletedeleted
meeting-schedule-start-datetime
string <date-time>
required
The scheduled start time for the meeting
timezone
enum<string> 
required
The timezone which the meeting was created with
Allowed values:
US/AlaskaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificAfrica/Addis_AbabaAfrica/AlgiersAfrica/BrazzavilleAfrica/CairoAfrica/CasablancaAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/JohannesburgAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/NairobiAfrica/TimbuktuAfrica/TripoliAfrica/TunisAmerica/AntiguaAmerica/ArubaAmerica/BelizeAmerica/BogotaAmerica/Buenos_AiresAmerica/CancunAmerica/CaracasAmerica/CaymanAmerica/ChihuahuaAmerica/Costa_RicaAmerica/DenverAmerica/DetroitAmerica/EdmontonAmerica/El_SalvadorAmerica/EnsenadaAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/HavanaAmerica/IndianapolisAmerica/JamaicaAmerica/JuneauAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/LouisvilleAmerica/MartiniqueAmerica/MazatlanAmerica/MendozaAmerica/MenomineeAmerica/MeridaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontrealAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/PanamaAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/ReginaAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ThuleAmerica/Thunder_BayAmerica/TijuanaAmerica/TorontoAmerica/VancouverAmerica/WinnipegAmerica/YellowknifeAntarctica/South_PoleArctic/LongyearbyenAsia/AmmanAsia/BaghdadAsia/BahrainAsia/BangkokAsia/BeirutAsia/BruneiAsia/CalcuttaAsia/ColomboAsia/DaccaAsia/DamascusAsia/DhakaAsia/DubaiAsia/GazaAsia/Hong_KongAsia/IstanbulAsia/JakartaAsia/JerusalemAsia/KabulAsia/KatmanduAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/ManilaAsia/MuscatAsia/Phnom_PenhAsia/RangoonAsia/RiyadhAsia/SaigonAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/TaipeiAsia/TehranAsia/Tel_AvivAsia/ThimphuAsia/TokyoAsia/Ulan_BatorAsia/VientianeAsia/VladivostokAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaeroeAtlantic/ReykjavikAustralia/ACTAustralia/AdelaideAustralia/BrisbaneAustralia/CanberraAustralia/DarwinAustralia/LHIAustralia/MelbourneAustralia/NorthAustralia/NSWAustralia/PerthAustralia/QueenslandAustralia/SouthAustralia/SydneyAustralia/TasmaniaAustralia/VictoriaAustralia/WestCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificCanada/SaskatchewanCanada/YukonCubaEtc/GMTEtc/GMT+1Etc/GMT+10Etc/GMT+11Etc/GMT+12Etc/GMT+2Etc/GMT+3Etc/GMT+4Etc/GMT+5Etc/GMT+6Etc/GMT+7Etc/GMT+8Etc/GMT+9Etc/GMT-1Etc/GMT-10Etc/GMT-11Etc/GMT-12Etc/GMT-13Etc/GMT-14Etc/GMT-2Etc/GMT-3Etc/GMT-4Etc/GMT-5Etc/GMT-6Etc/GMT-7Etc/GMT-8Etc/GMT-9Etc/GreenwichEurope/AmsterdamEurope/AthensEurope/BelfastEurope/BelgradeEurope/BerlinEurope/BrusselsEurope/BucharestEurope/BudapestEurope/CopenhagenEurope/DublinEurope/HelsinkiEurope/IstanbulEurope/KievEurope/LisbonEurope/LjubljanaEurope/LondonEurope/MadridEurope/MaltaEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PragueEurope/RomeEurope/SofiaEurope/StockholmEurope/ViennaEurope/WarsawEurope/ZurichGreenwichPacific/AucklandPacific/EasterPacific/FijiPacific/GalapagosPacific/GambierPacific/GuamPacific/HonoluluPacific/MarquesasPacific/MidwayPacific/PalauPacific/RarotongaPacific/Tahiti
meeting-schedule-duration-minutes
integer 
optional
The scheduled length of the meeting
meeting-schedule-recurrence-rule
string 
read-onlyoptional
The read only value describing the recuring nature of the meeting using RFC 5545
meeting-video-allowed-from
enum<string> 
optional
The value indicating which attendee types can share video
Allowed values:
everyonehostpresenters
meeting-audio-allowed-from
enum<string> 
optional
The value indicating which attendee types can share audio
Allowed values:
everyonehostpresenters
meeting-chat-enabled
integer 
optional
The value indicating if chat is enabled for this meeting
Default:
1
Examples:
01
meeting-chat-history-enabled
integer 
optional
The value indicating if previous meetings chat history is shown
Default:
1
Examples:
01
meeting-question-answer-enabled
integer 
optional
The value indicating if question and answer feature is enabled
Default:
0
Examples:
01
meeting-recording-enabled
integer 
optional
The value indicating if the meeting is being recorded
Default:
0
Examples:
01
meeting-join-require-invite-enabled
integer 
optional
The value indicating if participants must be invited into the meeting by host or owner
Default:
0
Examples:
01
meeting-join-require-passcode-enabled
integer 
optional
The value indicating if a passcode is required to join the meeting
Default:
0
Examples:
01
meeting-require-host-to-begin-enabled
integer 
optional
The value indicating if the meeting will be started by the host
Default:
0
Examples:
01
meeting-allow-changes-from-hosts-enabled
integer 
optional
The value indicating if the host can change meeting
Default:
1
Examples:
01
meeting-hide-attendee-list-enabled
integer 
optional
The value indicating if the attendee lis is hidden from other attendees
Default:
0
Examples:
01
meeting-lock-enabled
integer 
optional
The value indicating if the meeting is locked to changes
Default:
0
Examples:
01
meeting-lock-allowed
string 
optional
The value indicating if the meeting is allowed to be locked
meeting-room-enabled
integer 
required
The value indicating if the meeting is a room
Default:
0
Examples:
01
meeting-dial-in-number-blob
optional
The number for audio-only users to dial in to the meeting
Any of
meeting-passcode
string 
optional
The passcode used to enter meeting if it is required
meeting-previous-presenter-attendee-id
string 
read-onlyoptional
The value of the previous attendee that prsented their screen
meeting-presenter-attendee-id
string 
optional
The value of the current attendee that is sharing their screen
meeting-video-layout 
enum<string> 
optional
The current meeting layout default for entire meeting
Allowed values:
spotlightconversationgrid
last-modified-datetime
string <date-time>
optional
The timestamp of the last time the meeting was modified
meeting-instance-actual-start-datetime
string <date-time>
optional
The timestamp the current meeting instance was started
Example
{
  "id": 0,
  "domain": "example.com",
  "user": "1000",
  "description": "string",
  "current_timestamp": "2019-08-24T14:15:22Z",
  "meeting-calendar-invite-id": "string",
  "meeting-ordinal-sequence": 0,
  "core-server": "string",
  "chat-session-id": "string",
  "meeting-registration-id": "string",
  "meeting-instance-id": "string",
  "meeting-name": "string",
  "meeting-type": "conference",
  "limits-max-participants": 0,
  "meeting-status": "started",
  "meeting-schedule-start-datetime": "2019-08-24T14:15:22Z",
  "timezone": "US/Alaska",
  "meeting-schedule-duration-minutes": 0,
  "meeting-schedule-recurrence-rule": "string",
  "meeting-video-allowed-from": "everyone",
  "meeting-audio-allowed-from": "everyone",
  "meeting-chat-enabled": 1,
  "meeting-chat-history-enabled": 1,
  "meeting-question-answer-enabled": 0,
  "meeting-recording-enabled": 0,
  "meeting-join-require-invite-enabled": 0,
  "meeting-join-require-passcode-enabled": 0,
  "meeting-require-host-to-begin-enabled": 0,
  "meeting-allow-changes-from-hosts-enabled": 1,
  "meeting-hide-attendee-list-enabled": 0,
  "meeting-lock-enabled": 0,
  "meeting-lock-allowed": "string",
  "meeting-room-enabled": 0,
  "meeting-dial-in-number-blob": "string",
  "meeting-passcode": "string",
  "meeting-previous-presenter-attendee-id": "string",
  "meeting-presenter-attendee-id": "string",
  "meeting-video-layout ": "spotlight",
  "last-modified-datetime": "2019-08-24T14:15:22Z",
  "meeting-instance-actual-start-datetime": "2019-08-24T14:15:22Z"
}
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:24
Previous
Delete a Video Company
Next
Create a Meeting
Built with