The API enables you to start online meetings from your own application, write data / documents to the meeting, and read it back in your application.

This page describes the Idiligo API with GET and POST requests. The placeholders shown need to be replaced by the actual values.


1. Log in and obtain a security token

To log in, you need an Idiligo account with a username, password, and API key. This API key can be obtained in your account settings.
This request returns a security token (token), which remains valid for 24 hours.


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. Create a participant for your online meeting

Optionally, you can create the participant for your online meeting. You need the security token (token) and the email address (email) of the participant. This request returns the participant ID (contactId).


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. Create an online meeting

To start an online meeting, you need the security token (token) and the code of the script (trajectCode) you want to use in the online meeting. This request returns the non-public meeting ID (callId).


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. Connect the participant to the online meeting


To connect the participant to the online meeting you need the security token (token), the non-public online meeting ID (call Id), and the participant 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. Generate the URL for the organizer of the meeting


In order for the organizer to go to the meeting, an URL should be created. You need the security token (token) and the non-public call ID (callId).
Please note that for the participant a different URL applies (see point 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. Generate the URL for the participant of the meeting (public ID)


In order for the participant to join the meeting, an URL should be created. You can construct the URL using the Public ID (publicId). The URL for joining the online meeting is: https://app.idiligo.com/client?id=[publicId]. This request generates the Public ID (publicId). You need the security token (token) and the non public call ID (callId).
Please note that for the organizer of the meeting a different URL applies (see point 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: prefill your online meeting with values from your application

Optionally, you can prefill the online meeting with data from your application. You need the security token (token), Public ID (publicId), and the names of the fields (names) used in the scripts and the corresponding values (values) from your application.


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: add a document to your online meeting

You can add documents to your online meetings in 2 steps.

Step 1: uploading the document to Idiligo

For this step you need to token (token), location of the document (url), name of the document (filename) and the name of the document in the script (externalId). In the script you need to have a node of the type "Upload", with a corresponding externalId. As a result you get the ID of the document (documentId).


HTTP GET
GET /InsideService20.asmx/AddDocumentFromUrl?token=string&apm;url=string&filename=string&externalId=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/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>



Step 2: adding the uploaded document to an online meeting

To connect the uploaded document to the online meeting you need the token (token), non public call ID (callId), the ID of the document (documentId) and the node ID in the script (nodeCode). This node ID belongs to the node with the type "Upload" and should contain the identical externalId as mentions in step 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. Retrieve the document(s) from the online meeting

You can retrieve the documents (uploaded/generated/signed) in the online meeting.
You need the token (token) and the non Public ID (callId). As a result you get the information about the document. Use the url to download the document in your system. This url will vary in time and Idiligo will only store the document temporary.


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>



For a complete overview of all types of requests:
http://app.idiligo.com/insideservice20.asmx