Instant Connect
By using a Custom Integration node to link to Instant Connect you will be able to create and invite both internal and external users to a video call.
Please follow the below guide to first setup instant connect:
https://developer.webex.com/docs/instant-connect-meeting-links
Please ensure you are familiar with the Webex Connect Custom Integration node framework:
https://help.imiconnect.io/docs/custom-nodes
Node Creation
Navigate to the integrations section within your Webex Connect Tenant.
You should end up on the Integrations page with a list of Inbound/Outbound integrations and any other integrations allocated/created on your tenant.
Select Add Integration and choose Custom Node as the option to create.
Download and use the below Instant Connect SVG Logo as your Logo
The Create new Node Options should be populated as follows.
| Field | Description |
|---|---|
| Upload Icon (SVG) | Downloaded SVG as detailed above |
| Node Name | Instant Connect |
| Rest API | Selected |
| Description | Instant Connect Video Links |
| Node Category | Select Custom Category then populate with <Instant Connect> |
| Creation Type | Create Blank Integration |
Once the above steps are complete you should have a blank integration node and be on the add Methods Screen.
Methods
| Method | Description |
|---|---|
| Generate Basic Link | Custom Integration node Method to create an Instant Connect meeting with 1 guest and 1 host and minimal options. |
| Add Guest | Customer Integration node Method to add a guest user to an existing Instant Connect meeting. |
Generate Basic Link
The first method to create is the method to generate a basic link, please follow the below guidance to create this method.
Node Request Details
Please select the Add Method link to add a new Method and populate the Custom Integration nodes as per the below image and guidance.
| Field | Content | Description |
|---|---|---|
| Request Name | Generate Basic Link |
This will set the Request name to Generate Basic Link |
| Request Timeout (Ms) | 10000 |
This will set the Request Timeout to 10 seconds (10,000 milliseconds) |
| Connection Timeout (Ms) | 10000 |
This will set the Request Timeout to 10 seconds (10,000 milliseconds) |
| Type | Post |
The is the HTTP method type to use when making the request to Instant Connect |
| Resource URL | https://mtg-broker-a.wbx2.com/api/v2/joseencrypt |
This is the end point as defined in https://developer.webex.com/docs/instant-connect-meeting-links |
| Authorization | No auth |
No in built auth type is needed for Webex Instant Connect urls. Authorization is provided by the authorization Header. |
| All Settings prior to Headers | ensure are disabled as per image |
No throttle or limits are needed by Webex Instant Connect |
Node Headers
The below headers should be set within the configuration as per the image.
| Parameter | Parameter Value Type | Parameter Value | Description |
|---|---|---|---|
| Authorization | Static |
Bearer <Your Authorization Token> |
The bearer token to be used is as per the developer portal authorization (12 hours) or from the Bot token (100 years) |
| Content-Type | Static |
application/json |
The content type of the content being passed, this is : application/json |
Node Body
Th ebelow Node body should be passed, once this has been entered in the Body text box, the PArse button should be clicked and the values entered in the parsable content as per the below table.
{
"jwt": {
"sub": "$(uniquechatId)"
},
"loginUrlForHost": true,
"aud": "a4d886b0-979f-4e2c-a958-3e8c14605e51",
"numHost": 1,
"numGuest": 1,
"provideShortUrls": true,
"verticalType": "gen"
}
| Parameter | Parameter Value Type | Parameter Value | Description |
|---|---|---|---|
| uniquechatId | Dynamic |
uniquechatId |
This is the ID of the chat to be created, if Id's are re-used the original space in webex will be used for the video chat so this should be unique to invite or at least only re-used with the same users. This same value can be used in the "Add User" method to invite further guests to the chat. |
Node Response
Please ensure the response type of JSON (Applicaiton/Json) is selected as per the below image.
Then click the Import from sample button and paste the following JSON into the payload.
{
"host": [
{
"cipher": ".bQG86Qrp-ELZRIU1pskDc2Jxt5tegkFK1U4hgLFTGkk9xD3n3IckEQ..VDIxoyQC3dUTXI1CJ2hKFsBeRizszt33Y1c_He1pAv7MkCHmquRQeDpM8hfuV0-BAxdBx_X4CuEJUrmjjOMweGTv_8OaUyBILadHQo_ZUo2-eJ819zxbdOjLX5zWeE20KQjfYuHOLPPDS2UaeRZOIDMm-pNFExpaJLWOuvCfIX8wVLqmaUxLSb8aqGDVv1E1L5iFtokKtmO08Bkh17xsrHiFkzywOoiU-WOpDzLhQZzxcZEHmRMmCIzO-8JpwSJXHP_7VDz-dveGbfsXlI3P1IC6z2y-TVMsMRxT1w7Mur5SZJVvXooIYqZfQ74tKA6Ln53KJSkGCXiZuhZA1LqtQu1C1EP4wlFqmZh5LIkHj0YlwR2GTaxgFXTHY2gF_ZdzfJQZWDxW0WfquzZddL2BNdR0hGR62YhLCJTUNJkOksKC9z6_7dAPNiPb-ZB6mpbMlJ7hOliBtpGLW0ij1iRQMKO-V9vXLmtwWg04Es4EkRsiC0S_j7UCgc94VhiEg0TqCT5uUIHi6A.qCgpQYMkRyyoqyZFaxWPpA",
"short": "Vu86Mnw"
}
],
"guest": [
{
"cipher": "eyJwMnMiOiJLbUZ5bmNfbFA5N2dib2EzSE1vekZ0UHlnQVFPIiwicDJjIjoxMzYwMiwiYXVkIjoiYTRkODg2YjAtOTc5Zi00ZTJjLWE5NTgtM2U4YzE0NjA1ZTUxIiwiaXNzIjoiMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmIiwiY3R5IjoiSldUIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlBCRVMyLUhTNTEyK0EyNTZLVyJ9.OYDzzwcBNHfhnYZsZVlCMAWhsDMJH4ITpdkMvYgv77-hmG-I_eccFQ.V_DvK3t1yFgS_mHX.--7PE3IV0UzqHdpdHeG28rN_PjrobnnYn0pfNbji8cCdGum2VOV_hM9IYAhDrBgTN7nVdIiR97akmJ4_VJBldrhpKHSaCsh3Ijh2yAaSQbz9jmorlqvGoEeAdFboJXTGFgd0NnbWzVyRysO5H8ubrdi12H-1FNxInzunBqd4C2SweRO3wv64YnevqjZi9uYPk5pWJPrkm0PW-1m3WPrWyhCsVBlJL6MzIyJ9O721HsjIZkPuj1j5x0wZlYWUFea0bCKjqIGVD_W1ILO2JA1d3PZ0JrzQPT78awA2-xPxKg7wAQa_sZRCdcw2T-unFopnE3uvQb1Y-UZRYEkEyChuCXOVKvfcJtydTyrIZnUE73sbTNTlNe-5hGzGiqtHKhJaXUGrnX85v770UT1xnOgxnrojdm6P1QHkwebRXtxvbEIuvL1BCIjjdApKV61c3SZNiNwPU.8W8yzKVr0Si64VoIaMJjmw",
"short": "Ep4L5OK"
}
],
"baseUrl": "https://instant.webex.com/visit/"
}
The below values should be parsed out from the response and imported to be used on the Response object.
Where not populated correctly, please populate the below Response parameters.
| Node Event | Body | Response Path | Condition | Value | Node Edge | Description |
|---|---|---|---|---|---|---|
| Success | HTTP Status |
equals |
200 |
Success ``` | ||
| Failure | HTTP Status |
not equals |
200 |
Error ``` |
| Parameter Name | Body | Response Path | Description |
|---|---|---|---|
| baseUrl | Body |
$.baseUrl |
This is the base URL to be used when building the links to send to the host and end user and will be returned by the node as a node exit parameter |
| hostcipher | Body |
$.host[0].cipher |
This is the cipher to be used when building the links to send to the host and will be returned by the node as a node exit parameter |
| hostshortkey | Body |
$.host[0].short |
This is the short key to be used when building the links to send to the host and will be returned by the node as a node exit parameter |
| guestcipher | Body |
$.guest[0].cipher |
This is the cipher to be used when building the links to send to the end user and will be returned by the node as a node exit parameter |
| guestshortkey | Body |
$.guest[0].short |
This is the short key to be used when building the links to send to the end user and will be returned by the node as a node exit parameter |
Test the node, if all values have been entered correctly the below screen should be shown with a response of 200.
Add Guest
The second method to create is the method to generate a basic link, please follow the below guidance to create this method.
Node Request Details
Please select the Add Method link to add a new Method and populate the Custom Integration nodes as per the below image and guidance.
| Field | Content | Description |
|---|---|---|
| Request Name | Generate Basic Link |
This will set the Request name to Generate Basic Link |
| Request Timeout (Ms) | 10000 |
This will set the Request Timeout to 10 seconds (10,000 milliseconds) |
| Connection Timeout (Ms) | 10000 |
This will set the Request Timeout to 10 seconds (10,000 milliseconds) |
| Type | Post |
The is the HTTP method type to use when making the request to Instant Connect |
| Resource URL | https://mtg-broker-a.wbx2.com/api/v2/joseencrypt |
This is the end point as defined in https://developer.webex.com/docs/instant-connect-meeting-links |
| Authorization | No auth |
No in built auth type is needed for Webex Instant Connect urls. Authorization is provided by the authorization Header. |
| All Settings prior to Headers | ensure are disabled as per image |
No throttle or limits are needed by Webex Instant Connect |
Node Headers
The below headers should be set within the configuration as per the image.
| Parameter | Parameter Value Type | Parameter Value | Description |
|---|---|---|---|
| Authorization | Static |
Bearer <Your Authorization Token> |
The bearer token to be used is as per the developer portal authorization (12 hours) or from the Bot token (100 years) |
| Content-Type | Static |
application/json |
The content type of the content being passed, this is : application/json |
Node Body
Th ebelow Node body should be passed, once this has been entered in the Body text box, the PArse button should be clicked and the values entered in the parsable content as per the below table.
{
"jwt": {
"sub": "$(uniquechatId)"
},
"loginUrlForHost": true,
"aud": "a4d886b0-979f-4e2c-a958-3e8c14605e51",
"numHost": 1,
"numGuest": 1,
"provideShortUrls": true,
"verticalType": "gen"
}
| Parameter | Parameter Value Type | Parameter Value | Description |
|---|---|---|---|
| uniquechatId | Dynamic |
uniquechatId |
This is the ID of the chat to be created, if Id's are re-used the original space in webex will be used for the video chat so this should be unique to invite or at least only re-used with the same users. This same value can be used in the "Add User" method to invite further guests to the chat. |
Node Response
Please ensure the response type of JSON (Applicaiton/Json) is selected as per the below image.
Then click the Import from sample button and paste the following JSON into the payload.
{
"host": [
{
"cipher": ".bQG86Qrp-ELZRIU1pskDc2Jxt5tegkFK1U4hgLFTGkk9xD3n3IckEQ..VDIxoyQC3dUTXI1CJ2hKFsBeRizszt33Y1c_He1pAv7MkCHmquRQeDpM8hfuV0-BAxdBx_X4CuEJUrmjjOMweGTv_8OaUyBILadHQo_ZUo2-eJ819zxbdOjLX5zWeE20KQjfYuHOLPPDS2UaeRZOIDMm-pNFExpaJLWOuvCfIX8wVLqmaUxLSb8aqGDVv1E1L5iFtokKtmO08Bkh17xsrHiFkzywOoiU-WOpDzLhQZzxcZEHmRMmCIzO-8JpwSJXHP_7VDz-dveGbfsXlI3P1IC6z2y-TVMsMRxT1w7Mur5SZJVvXooIYqZfQ74tKA6Ln53KJSkGCXiZuhZA1LqtQu1C1EP4wlFqmZh5LIkHj0YlwR2GTaxgFXTHY2gF_ZdzfJQZWDxW0WfquzZddL2BNdR0hGR62YhLCJTUNJkOksKC9z6_7dAPNiPb-ZB6mpbMlJ7hOliBtpGLW0ij1iRQMKO-V9vXLmtwWg04Es4EkRsiC0S_j7UCgc94VhiEg0TqCT5uUIHi6A.qCgpQYMkRyyoqyZFaxWPpA",
"short": "Vu86Mnw"
}
],
"guest": [
{
"cipher": "eyJwMnMiOiJLbUZ5bmNfbFA5N2dib2EzSE1vekZ0UHlnQVFPIiwicDJjIjoxMzYwMiwiYXVkIjoiYTRkODg2YjAtOTc5Zi00ZTJjLWE5NTgtM2U4YzE0NjA1ZTUxIiwiaXNzIjoiMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmIiwiY3R5IjoiSldUIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlBCRVMyLUhTNTEyK0EyNTZLVyJ9.OYDzzwcBNHfhnYZsZVlCMAWhsDMJH4ITpdkMvYgv77-hmG-I_eccFQ.V_DvK3t1yFgS_mHX.--7PE3IV0UzqHdpdHeG28rN_PjrobnnYn0pfNbji8cCdGum2VOV_hM9IYAhDrBgTN7nVdIiR97akmJ4_VJBldrhpKHSaCsh3Ijh2yAaSQbz9jmorlqvGoEeAdFboJXTGFgd0NnbWzVyRysO5H8ubrdi12H-1FNxInzunBqd4C2SweRO3wv64YnevqjZi9uYPk5pWJPrkm0PW-1m3WPrWyhCsVBlJL6MzIyJ9O721HsjIZkPuj1j5x0wZlYWUFea0bCKjqIGVD_W1ILO2JA1d3PZ0JrzQPT78awA2-xPxKg7wAQa_sZRCdcw2T-unFopnE3uvQb1Y-UZRYEkEyChuCXOVKvfcJtydTyrIZnUE73sbTNTlNe-5hGzGiqtHKhJaXUGrnX85v770UT1xnOgxnrojdm6P1QHkwebRXtxvbEIuvL1BCIjjdApKV61c3SZNiNwPU.8W8yzKVr0Si64VoIaMJjmw",
"short": "Ep4L5OK"
}
],
"baseUrl": "https://instant.webex.com/visit/"
}
The below values should be parsed out from the response and imported to be used on the Response object.
Where not populated correctly, please populate the below Response parameters.
| Node Event | Body | Response Path | Condition | Value | Node Edge | Description |
|---|---|---|---|---|---|---|
| Success | HTTP Status |
equals |
200 |
Success ``` | ||
| Failure | HTTP Status |
not equals |
200 |
Error ``` |
| Parameter Name | Body | Response Path | Description |
|---|---|---|---|
| baseUrl | Body |
$.baseUrl |
This is the base URL to be used when building the links to send to the host and end user and will be returned by the node as a node exit parameter |
| guestcipher | Body |
$.guest[0].cipher |
This is the cipher to be used when building the links to send to the end user and will be returned by the node as a node exit parameter |
| guestshortkey | Body |
$.guest[0].short |
This is the short key to be used when building the links to send to the end user and will be returned by the node as a node exit parameter |
Test the node, if all values have been entered correctly the below screen should be shown with a response of 200.
Saving the Node
After Clicking the Save button
Additional Resources
Webex Connect Help documentation - https://help.imiconnect.io/ Webex Connect Developers API docs - https://developers.imiconnect.io/ Custom Node creation Guide - https://help.imiconnect.io/docs/custom-nodes Instant Conenct - https://instant.webex.com/ Instant Connect API - https://developer.webex.com/docs/instant-connect-meeting-links Webex Bot - https://developer.webex.com/my-apps/new/bot