Mit der API können Sie Online-Besprechungen von Ihrer eigenen Anwendung aus starten, Daten / Dokumente in die Besprechung schreiben und in Ihrer Anwendung zurücklesen.

Diese Seite beschreibt die Idiligo-API mit GET- und POST-Anforderungen. Die angezeigten Platzhalter müssen durch die tatsächlichen Werte ersetzt werden.


1. Melden Sie sich an und erhalten Sie ein Sicherheitstoken


Um sich anzumelden, benötigen Sie ein Idiligo-Konto mit einem Benutzernamen, einem Passwort und einem API-Schlüssel. Diesen API-Schlüssel erhalten Sie in Ihrer Kontoeinstellung. Diese Anforderung gibt ein Sicherheitstoken (token) zurück, das 24 Stunden lang gültig bleibt.


HTTP GET
GET /InsideService20.asmx/Login?apikey=string&username=string&password=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">string</string>

HTTP POST
POST /InsideService20.asmx/Login HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

apikey=string&username=string&password=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">string</string>


2. Erstellen Sie einen Teilnehmer für Ihr Online-Meeting


Optional können Sie den Teilnehmer für Ihr Online-Meeting erstellen. Sie benötigen das Sicherheitstoken (token) und die E-Mail-Adresse (email) des Teilnehmers. Diese Anfrage gibt die Teilnehmer-ID (contactId) zurück.


HTTP GET
GET /InsideService20.asmx/CreateContact?token=string&email=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">long</long>

HTTP POST
POST /InsideService20.asmx/CreateContact HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&email=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">long</long>


3. Erstellen Sie ein Online-Meeting


Um eine Online-Besprechung zu starten, benötigen Sie das Sicherheitstoken (token) und den Code des Skripts (trajectCode), das Sie in der Online-Besprechung verwenden möchten. Diese Anforderung gibt die nicht öffentliche Besprechungs-ID (callId) zurück.


HTTP GET
GET /InsideService20.asmx/CreateCall?token=string&trajectCode=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">long</long>

HTTP POST
POST /InsideService20.asmx/CreateCall HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&trajectCode=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">long</long>


4. Verbinden Sie den Teilnehmer mit dem Online-Meeting


Um den Teilnehmer mit dem Online-Meeting zu verbinden, benötigen Sie das Sicherheitstoken (token), die nicht öffentliche Online-Meeting-ID (callId) und die Teilnehmer-ID (contactId).


HTTP GET
GET /InsideService20.asmx/SetContact?token=string&callId=string&contactId=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
HTTP POST
POST /InsideService20.asmx/SetContact HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&callId=string&contactId=string
HTTP/1.1 200 OK 


5. Generieren Sie die URL für den Organisator des Meetings


Damit der Veranstalter zur Besprechung gehen kann, sollte eine URL erstellt werden. Sie benötigen das Sicherheitstoken (token) und die nicht öffentliche Anruf-ID (callId). Bitte beachten Sie, dass für den Teilnehmer eine andere URL gilt (siehe Punkt 6).


HTTP GET
GET /InsideService20.asmx/NavigateToAgentUrl?token=string&callId=string&returnUrl=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
HTTP POST
POST /InsideService20.asmx/GetPublicCallId HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&callId=string&returnUrl=string
HTTP/1.1 200 OK 


6. Generieren Sie die URL für den Teilnehmer des Meetings (öffentliche ID)


Damit der Teilnehmer an der Besprechung teilnehmen kann, sollte eine URL erstellt werden. Sie können die URL mithilfe der öffentlichen ID erstellen. Die URL für die Teilnahme an dem Online-Meetung lautet: https://app.idiligo.com/client?id=[publicId]. Diese Anforderung generiert die öffentliche ID (publicId). Sie benötigen das Sicherheitstoken (token) und die nicht öffentliche Anruf-ID (callId). Bitte beachten Sie, dass für den Veranstalter des Meetings eine andere URL gilt (siehe Punkt 5).


HTTP GET
GET /InsideService20.asmx/GetPublicCallId?token=string&callId=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">string</string>

HTTP POST
POST /InsideService20.asmx/GetPublicCallId HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&callId=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<string xmlns="http://www.idiligo.com/">string</string>


7. Optional: Füllen Sie Ihr Online-Meeting mit Werten aus Ihrer Anwendung aus


Optional können Sie das Online-Meeting mit Daten aus Ihrer Anwendung ausfüllen. Sie benötigen das Sicherheitstoken (token), die öffentliche ID (publicId) und die Namen der in den Skripten verwendeten Felder (names) sowie die entsprechenden Werte (values) aus Ihrer Anwendung.


HTTP GET
GET /InsideService20.asmx/SetValues?token=string&PublicId=string&names=string&names=string&values=string&values=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
HTTP POST
POST /InsideService20.asmx/SetValues HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&PublicId=string&names=string&names=string&values=string&values=string
HTTP/1.1 200 OK 


8. Optional: Fügen Sie Ihrem Online-Meeting ein Dokument hinzu


Sie können Ihren Online-Besprechungen Dokumente hinzufügen. Dies geht in 2 Schritten.

Schritt 1: Hochladen des Dokuments nach Idiligo

Für diesen Schritt benötigen Sie das Token (token), den Speicherort des Dokuments (URL), den Namen des Dokuments (filename) und den Namen des Dokuments im Skript (externalId). Im Skript benötigen Sie das Node "Upload", mit der entsprechenden externalId. Als Ergebnis erhalten Sie die ID des Dokuments (documentId).


HTTP GET
GET /InsideService20.asmx/AddDocumentFromUrl?token=string&apm;url=string&filename=string&externalId=string HTTP/1.1 HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<long xmlns="http://www.idiligo.com/">long</long>

HTTP POST
POST /InsideService20.asmx/AddDocumentFromUrl HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&url=string&filename=string&externalId=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<long xmlns="http://www.idiligo.com/">long</long>



Schritt 2: Hinzufügen des hochgeladenen Dokuments zu einer Online-Besprechung

Um das hochgeladene Dokument mit dem Online Meeting zu verbinden, benötigen Sie das Token (token), die nicht öffentliche Meeting-ID (callId), die ID des Dokuments (documentId) und die Node-ID im Skript (nodeCode). Diese Node-ID gehört zu dem Node vom Typ "Upload" und sollte die identische externalID enthalten, wie in Schritt 1.


HTTP GET
GET /InsideService20.asmx/AddDocumentToCall?token=string&callId=string&documentId=string&nodeCode=string HTTP/1.1 
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<long xmlns="http://www.idiligo.com/">long</long>

HTTP POST
POST /InsideService20.asmx/AddDocumentToCall HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&callId=string&documentId=string&nodeCode=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<long xmlns=""http://www.idiligo.com/">long</long>


9. Rufen Sie die Dokumente aus dem Online Meeting ab

Sie können die in dem Online Meeting hochgeladenen / generierten / unterschriebenen Dokumente abrufen.
Sie benötigen hierzu das Token und die nicht öffentliche ID (callId).


HTTP GET
GET /InsideService20.asmx/GetAttachments?token=string&apm;callId=string HTTP/1.1  
Host: app.idiligo.com
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 

<ArrayOfAttachmentDTO xmlns="http://www.idiligo.com/">
 <AttachmentDTO>
  <Id>long</Id>
  <Description>string</Description>
  <Url>string</Url>
  <Preview>string</Preview>
  <Attach>boolean</Attach>
  <Size>string</Size>
  <Date>string</Date>
  <SignUrl>string</SignUrl>
  <SignStatus>int</SignStatus>
 </AttachmentDTO>
 <AttachmentDTO>
  <Id>long</Id>
  <Description>string</Description>
  <Url>string</Url>
  <Preview>string</Preview>
  <Attach>boolean</Attach>
  <Size>string</Size>
  <Date>string</Date>
  <SignUrl>string</SignUrl>
  <SignStatus>int</SignStatus>
 </AttachmentDTO>
 </ArrayOfAttachmentDTO>
HTTP POST
POST /InsideService20.asmx/GetAttachments HTTP/1.1 
Host: app.idiligo.com 
Content-Type: application/x-www-form-urlencoded 
Content-Length: length 

token=string&callId=string
HTTP/1.1 200 OK 
Content-Type: text/xml; charset=utf-8 
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?> 
<ArrayOfAttachmentDTO xmlns="http://www.idiligo.com/">
 <AttachmentDTO>
  <Id>long</Id>
  <Description>string</Description>
  <Url>string</Url>
  <Preview>string</Preview>
  <Attach>boolean</Attach>
  <Size>string</Size>
  <Date>string</Date>
  <SignUrl>string</SignUrl>
  <SignStatus>int</SignStatus>
 </AttachmentDTO>
 <AttachmentDTO>
  <Id>long</Id>
  <Description>string</Description>
  <Url>string</Url>
  <Preview>string</Preview>
  <Attach>boolean</Attach>
  <Size>string</Size>
  <Date>string</Date>
  <SignUrl>string</SignUrl>
  <SignStatus>int</SignStatus>
 </AttachmentDTO>
 </ArrayOfAttachmentDTO>


Für einen vollständigen Überblick über alle Arten von Anfragen:
http://app.idiligo.com/insideservice20.asmx