In some cases it is necessary to host a conference directly on a website. For example, in telemedicine settings, a patient can communicate with a doctor through a hospital website without installing any third-party software.<\/p>\n
The goal is to create a conference for communicating with a healthcare worker so that a user can join this meeting directly on the website.<\/p>\n
\nTo check how this feature can be implemented, visit our GitHub<\/a>.\n<\/p>\n<\/div>\n In this article, you\u2019ll learn how to use TrueConf Server API v3<\/a> to implement video communication directly in a browser for telemedicine purposes without authentication on TrueConf Server<\/a>. This approach simplifies users\u2019 interaction with a doctor.<\/p>\n In the context of telemedicine, the following implementation options are possible:<\/p>\n Below, we will show how to set up direct guest access<\/a> to a conference. Guests are participants who do not have an account on your video conferencing server. Keep in mind that in this scenario, neither doctors nor patients need an account on the server.<\/p>\n In our example, we will use a guest connection from a browser via WebRTC<\/a>, since this option can be easily integrated into any website. If necessary, you can also use a connection via a client application<\/a>.<\/p>\n First, open the control panel, go to the Dashboard \u2192 Summary, and check if there is the required number of guest connections in your license. In this case, a patient can be logged in as a guest while the doctor will be authenticated as a user registered on the server.<\/p>\n If you are using TrueConf Server Free, you can create public conferences with one guest connection. If you need to increase the number of guest connections, contact our sales team<\/a> to purchase this extension or request a free trial for up to 3 weeks.<\/p>\n<\/li>\n Next, you can use various API methods over OAuth 2.0 protocol. Learn more about how to set up interaction with TrueConf Server over this protocol in our article \u201cHow to get started with TrueConf API<\/a>\u201d.<\/p>\n By using the Create Conference method<\/a>, create a new video conference and set the following required parameters:<\/p>\n As a result, the following Conference object will be passed to the request body:<\/p>\n In response, you\u2019ll get the JSON version of the conference object<\/a> you\u2019ve created. In this case, the conference ID<\/a> will be generated automatically if the user did enter a custom ID, e.g., 0987654321<\/b>.<\/p>\n \nPlease note that if a doctor joins as a guest, you have to use a separate TrueConf Server account with conference owner privileges.\n<\/p>\n<\/div>\n If you need to create a scheduled conference, use the Schedule object<\/a>. It has to include the following parameters:<\/p>\n For example, when scheduling a 30-minute consultation for January 1, 2027, at 12:00 PM Moscow Time (GMT+3), we will get the following Schedule object that will be sent in the request body:<\/p>\n You can now create and provide a patient with a link to automatically join a video consultation. In this case, you can get names, e.g., from the patient\u2019s profile on the website of the medical service provider.<\/p>\n And specify the following parameters:<\/p>\n In our example, the query will look like this:<\/p>\n Alternative connection options:<\/p>\n If the TrueConf client application is installed on a user\u2019s device, it will be launched automatically when the link is clicked, and a user will join the meeting.<\/p>\n \nPlease note that all links generated by this request are temporary<\/b>, and for security reasons, they expire after 1 minute<\/b>. Therefore, you must connect immediately after they are generated; for example, you can generate them directly when you click the \u201cJoin\u201d button that you add to your website.\n<\/p>\n<\/div>\n When you get the As soon as the conference has started, users will be able to join this meeting either via the \n
Preconfiguration of TrueConf Server<\/h2>\n
\n
Step 1: Create a public conference<\/h2>\n
\n
\u201cid\u201d: \u201cConference_ID\u201d<\/code> \u2013 the conference ID which makes it easier to join the meeting;<\/li>\n\u201ctopic\u201d<\/code> \u2013 the conference name;<\/li>\n\u201ctype\u201d: 0<\/code> \u2013 conference mode, in our case, \u201cAll on screen\u201d mode is selected;<\/li>\n\u201cowner\u201d: \u201cuser1@server.name\u201d<\/code> – the owner (if you are adding the doctor as an authenticated user, enter the doctor’s TrueConf ID;<\/a> (username))<\/li>\n\u201cmax_participants\u201d: 2<\/code> – the maximum number of participants \u2013 2;<\/li>\n{\u201ctype\u201d: -1}<\/code> \u2013 conference schedule \u2013 you can select a different value, if necessary. In our case, we will use a virtual room so that the conference can be created on demand at any time;<\/li>\n\u201callow_guests\u201d: true<\/code> \u2013 the parameter which determines whether guests are allowed to join the conference;<\/li>\n\u201callow_only_planned_participants\u201d:false<\/code> \u2013 conference type \u2013 public;<\/li>\n\u201cstate\u201d: \u201crunning\u201d<\/code> \u2013 the conference state at the time of creation; in our case, we are creating a conference that starts running immediately.<\/li>\n<\/ul>\n\u201cid\u201d: \u201cConference_ID\u201d,\r\n \"type\": 0,\r\n \"topic\": \"Conference name\",\r\n \"owner\": \"user1@server.name\",\r\n \"max_podiums\": 2,\r\n \"max_participants\": 2,\r\n \"schedule\": {\"type\": -1},\r\n \"allow_guests\": true,\r\n \"rights\": {\r\n chat_send: true,\r\n chat_rcv: true,\r\n slide_show_send: true,\r\n slide_show_rcv: true,\r\n white_board_send: true,\r\n white_board_rcv: true,\r\n file_transfer_send: true,\r\n file_transfer_rcv: true,\r\n desktop_sharing: true,\r\n recording: true,\r\n audio_send: true,\r\n audio_rcv: true,\r\n video_send: true,\r\n video_rcv: true\r\n },\r\n \"state\": \"running\",\r\n \"recording\": 1,\r\n }\r\n<\/pre>\n\n
\"schedule\":{\r\n \"type\":1,\r\n \"start_time\":1798794000,\r\n \"duration\":1800\r\n }\r\n<\/pre>\nStep 2: Generate links to connect guests automatically<\/h2>\n
\n
\n
call_id: 0987654321<\/code> \u2014 the ID of the created conference<\/a><\/li>\ncase: join_conference_button<\/code> \u2013 the generation of direct links needed for joining the conference from client applications.<\/li>\nuser: 2$Ian Taylor*Ian Taylor<\/code> – The guest’s name displayed during the conference. The $ symbol is required. There are two ways to authenticate a guest when connecting via TrueConf API:<\/li>\n\n
2$Ian Taylor*Ian Taylor<\/code> – the 2$ parameter<\/a> allows you to manually specify the guest\u2019s TrueConf ID. This option is helpful because you don\u2019t need to retrieve the ID from the server after connecting to a conference. However, if there are multiple users named Ian Taylor, you\u2019ll need to ensure the ID is unique, for example by using suffixes or hashes.<\/li>\n$Ian Taylor<\/code> – a parameter for which a unique ID is automatically generated and returned in the response to the request.<\/li>\n<\/ul>\nhttps:\/\/video.company.com\/api\/v3.3\/software\/clients?call_id=0987654321&case=join_conference_button&user=2$Ian Taylor*Ian Taylor<\/pre>\n<\/ul>\n
\u201cname\u201d: \u201cTrueConf Web\u201d<\/code> in the JSON response. Copy the iframe<\/code> tag from it. Before pasting, replace \/\/<\/code> with \/<\/code> in the frame URL. Below is an example of a response with the iframe<\/code> fragment highlighted:<\/li>\n{\r\n \"name\": \"TrueConf Web\",\r\n \"type\": \"web\",\r\n \"platform\": \"webrtc\",\r\n \"download_url\": \"\",\r\n \"download_urls\": null,\r\n \"market_url\": \"\",\r\n \"web_url\": \"https:\/\/video.company.com\/webrtc\/0987654321#login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&token=$29cc834f607b1bffd0d5e68e47b4ead16*1619898725*641aad7d9e1e1a674416e16813939633&lang=auto\",\r\n \"iframe\": \"<iframe src=\\\"https:\/\/video.company.com\/webrtc\/0987654321#login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&token=$29cc834f607b1bffd0d5e68e47b4ead16*1619898725*641aad7d9e1e1a674416e16813939633&lang=auto\\\" allowfullscreen=\\\"allowfullscreen\\\" allow=\\\"microphone; camera; autoplay; display-capture\\\" ><\\\\iframe>\"\r\n}\r\n<\/pre>\n<\/ul>\n\n
\"deeplinks\": {\r\n \"default\": \"trueconf:\\\\c\\\\5016799639@video.company.com%23vcs&h=172.18.246.126,172.17.0.1&force=1&templogin=1&login=*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%A1%D1%82%D0%B5%D0%BF%D0%B0%D0%BD&password=$291bcfe8bfc567822b4ff133c1b668fb7*1671525797*377ee8856b0404911fdeed524854d198&encrypt=0&autoclose=1\",\r\n \"android\": \"intent:\\\\c\\\\5016799639%40video.company.com%23vcs%26h%3d172.18.246.126,172.17.0.1%26force%3d1%26templogin%3d1%26login%3d*guest*%D0%98%D0%B2%D0%B0%D0%BD%20%D0%A1%D1%82%D0%B5%D0%BF%D0%B0%D0%BD%26password%3d$291bcfe8bfc567822b4ff133c1b668fb7*1671525797*377ee8856b0404911fdeed524854d198%26encrypt%3d0%26autoclose%3d1#Intent;scheme=trueconf;package=com.trueconf.videochat;end\"\r\n } <\/pre>\ntrueconf:\\c\\[ConferenceID]@[server_address]%23vcs&h=[server_address]&force=1&templogin=1&login=*guest*[guest_login]&password=$[password]&encrypt=0&autoclose=1<\/pre>\n<\/ul>\n
Step 3: Join a conference call<\/h2>\n
iframe<\/code> element, all that remains is to start the conference and join it. To start the conference, use the Run Conference<\/a> API request and include the conference ID in it.<\/p>\nhttps:\/\/server.name\/api\/v3.11\/{conference_id}\/run<\/code><\/p>\niframe<\/code> link they received or via a direct link.<\/p>\nFeatures for managing scheduled conferences<\/h3>\n