MyLINK Connect Official Docs
  • Welcome!
  • Product Overview
    • Definitions
    • Chatbot & Flow builder
    • Integrations
    • Mobile App
    • Artificial Intelligence
    • Statistics & Reporting
    • Professional Services & Support
    • Privacy & Security
    • GDPR
  • Basic Concepts
    • Your Account
      • The Trial plan
      • Upgrading your trial
      • Additional Packages
      • Canceling your current plan
      • Deleting your account
      • Messages Count
      • Multiple Owners
    • Designing your Chatbot
      • My Bots
      • Introduction
      • Flow Design
      • Behaviors
      • Interactions
      • Actions and Operations
    • Chatbot Details
      • Chatbot Settings
        • General Settings
        • Localization Settings
        • Conversation Settings
        • Integration Settings
        • Payment Integration Settings
        • Developers Setting
      • Teams
        • Team Permissions
        • Team Message Templates
        • Team Member Access
      • Backup & Restore
      • Clone and Reference Clone
    • Publishing
      • Live & Draft Chatbots
      • Publish Your Bot
      • Channels
        • Web
          • Web Variables
          • WordPress
          • Widget Customization
            • Initialization
            • Scripting
        • WhatsApp
          • WhatsApp Variables
          • First Message Processing
        • RCS
          • RCS Variables
          • Configuring Providers
            • LINK Mobility
        • Google Business Messages (Deprecated)
          • Google Business Messages Variables
        • SMS
          • SMS Variables
          • Configuring Providers
            • LINK Mobility
        • Facebook
          • Facebook Ads Integration
          • Feed Integration
          • Messenger Referral
          • Facebook Variables
          • Moving users from an existing bot to MyLINK Connect
        • Instagram
          • Instagram Variables
        • Telegram
          • Telegram Deep Linking
          • Telegram Variables
        • Slack
          • Configuring Slack
          • Slack Variables
        • Microsoft Teams
          • Microsoft Teams Variables
        • Discord
          • Discord Variables
        • Alexa
          • Troubleshooting
          • Alexa Variables
        • Phone
          • Phone Variables
          • Configuring Providers
            • Voximplant
        • Genesys
          • Genesys Variables
        • Viber
          • Viber Variables
        • Custom
          • REST Reference Guide
          • API Variables
  • Artificial Intelligence
    • NLP
      • Intents
      • Expressions
      • Entities
        • Creating Manually
        • Entity Types
        • Synonims
      • Training & Testing your Model
        • Using the NLP Parse Logs
        • Importing Intents From File
      • NLP Master
    • Large Language Models
      • Settings
      • Guidelines
      • Resources
      • Functions
      • Train & Test
  • Database
    • MyLINK Connect Database
    • Collections
      • Import And Export Collections Data
    • Database API Interface
      • Url Filtering Syntax
      • Read Record
      • Save To Collection
      • Delete From Collection
      • Query Collection
        • Open Query
        • Read Records
      • CSV Direct Data
  • Broadcasts
    • Broadcasts
      • Settings
        • On Demand
          • HubSpot
        • On Date And Time
        • On Time
        • On Trigger
        • On Interval
        • On Conversation State Changed
    • Broadcast Widget Page
    • Campaigns
    • Distribution Lists
    • Audiences
    • Distribution Logs
  • Conversations
    • Conversations
    • My Conversations
    • Contacts
    • Chat Commands
    • Contact Details
    • Data Retention
  • Analytics
    • Dashboards
    • Goals
  • Actions And Operations
    • Execution
      • Execution Diagram
    • Actions Availability
    • Variables and Tags
    • Dynamic Parsing And Content
    • Content
      • Text Action
      • Random Text Action
      • Quick Reply Action
      • Database Quick Reply Buttons Action
      • Quick Reply Array Action
      • Chat Delay Action
      • Phone Quick Reply Action
      • Email Quick Reply Action
      • Location Quick Reply Action
      • Display Location
      • Image Action
      • QR Code Action
      • Video Action
      • Audio Action
      • File Action
      • Url Action
      • NLP Topics Summary Action
      • Highly Structured Message
      • Custom Class
    • Input
      • Voice Recognition Action
      • Global Detection
        • Text Parse Action
        • NLP Processing Action
        • Dialogflow Detection Action
        • IBM Watson Assistant Intent Detection Action
        • OpenAI Assistant Detection
        • AI Detection
      • Generic Input Action
      • NLP Input Action
      • Number Input Action
      • Email Input Action
      • Phone Number Action
      • Media Attachment Action
      • Voice Input Action
      • Global Detection Action
      • OpenAI
        • OpenAI Assistant Input
        • OpenAI Assistant Detection
      • Dialogflow
        • Dialogflow Input Action
        • Dialogflow Detection Action
      • IBM Watson Assistant
        • IBM Watson Assistant Input Action
        • IBM Watson Assistant Detection Action
      • Large Language Models
        • AI Detection
        • AI Input
    • Flow
      • Go To Action
      • Include Interaction Action
      • Random Split Action
      • Flow Control Action
      • Set Chat Operator State Action
      • Schedule Behaviour Action
      • Variable Switch Action
      • Tag Switch Action
      • Set Context Action
      • Conversation Bookmark Action
      • Create Conversation URL Action
      • Reset Conversation Action
      • Goal
      • Log Message
      • Control Conversation Transfer Action
        • Forward Variable Value Action
    • Forms
      • Form Container
      • Fields
        • Text Box
        • Password
        • Text Area
        • Dropdown
        • Checkbox
        • Number
        • Date Picker
        • Time Picker
        • Calendar
        • File Upload
      • Layout
        • Image
        • Literal
        • Divider
        • Html Content
        • Custom CSS
    • Database
      • Load Single Record
      • Delete Records
      • Save Record
      • Save Raw Model
      • Query Collection Data
      • Move To Next Record
      • Set Field Filter Value
      • Order By Field
      • Set Field Value
      • Database Function
    • Cards
      • Carousel Template Action
      • List Card Template Action
      • Buttons Card Template Action
      • Card Container Action
      • Interactive Message Action
      • One-Time Notification Request Action
      • Database Carousel Action
      • Dynamic Carousel Action
      • Card And Menu Buttons
        • Postback Button Action
        • URL Button Action
        • Call Phone Button
        • Share Button Action
        • Nested Button Action
        • Interactive Button
    • Profile
      • Set Variable Action
      • Delete Variable Action
      • Set Tag Action
      • Delete Tag Action
      • Set Campaign Subscription Action
    • Privacy
      • Forget User
      • Privacy Opt-In
      • Privacy Flag Condition
    • IoT
      • Control Device State
      • Device State Switch
    • Integration
      • Call API Service Action
      • Execute Cloud Script Action
        • Base Conversation object methods
        • Firebase Connection methods
        • MyLINK Connect Database Collection Methods
      • Execute Client Script Action
      • Send SMS Message
      • LINK Mobility Payment API Action
      • Dynamic Content Action
      • Post To Facebook Action
      • Firebase Database Action
      • ActiveCampaign Action
      • Zapier Webhook Action
      • Microsoft Teams Webhook Action
      • MailChimp Contact Action
      • Marketing Platform Action
      • Wordpress Search Action
      • RSS & Podcast Feed Action
      • SendGrid Mail Action
      • Send Mail Action
      • Send Custom Mail Action
  • Connect API
    • Choosing your API
    • Global Platform API
      • Authorization
      • Platform SSO
      • Bots
        • List
        • Publish
        • Clone
        • Reference Clone
        • Teams
          • List
          • Add Or Update
          • Delete
        • Variables
      • Conversations
        • Audiences
        • Audience Contacts
        • Entries
        • Share Url
      • NLP Query
      • Large Language Models
        • Settings
        • Guidelines
        • Add Resource
        • Delete Resource
        • Add Function
        • Delete Function
        • Train
        • Train State Check
        • Test
      • Statistics
        • Account Statistics Data
        • Bot Statistics Data
        • Report Files
        • Download Report File
      • Broadcasts
        • Broadcasts List
        • Broadcast State
  • Changelog
Powered by GitBook
On this page
  • Settings
  • Remarks
  • Trigger
  • Variables
  • Availability
  1. Actions And Operations
  2. Integration

Call API Service Action

PreviousIntegrationNextExecute Cloud Script Action

Last updated 15 days ago

This operation can be used to call any external HTTP or HTTPS Web API services using different methods. The full result or a single hierarchical value can be assigned to a variable to be later used in the conversation flow.

Settings

The action uses the following settings:

Setting

Description

Method

Choose the HTTP request method required to invoke the API Service

Service URL

The URL of the service to be invoked

Username

The username to be used to invoke the service, if required

Password

The password to be used to invoke the service, if required

Challenge Authentication Mode

If enabled, the service will called by using Username and Password as standard Network Credentials

Ignore SSL Certificate

If enabled, allow bypassing SSL verification when required by the server

Headers

Headers to be sent with the request. One header on each line in a name=value format

Execute Asynchronously

If enabled, will execute the API call asynchronously. The bot flow will not wait for the call completion to move forward.

Payload

The payload to be sent with the request. It can be anything acceptable by your target service.

UTF-8 Payload Format

Adds or removes UTF-8 charset request from content type header

Payload Mode

The type of payload that is going to be sent to the service.

Response Format

Choose if the service is replying with a JSON or XML or BINARY content

JSON Token Path

The full property path of the value to extract from the JSON response

XML XPath Query

The query to be applied to extract the required value from the XML response

Target Variable

The name of the variable that will hold the response received from the server or the value extracted by Token Path or XPath Query

Save Response Headers

If enabled, will store all of the request response headers in a variable

Remarks

Connect will invoke the URL using standard HTTP format: any service available online can be invoked and interacted using this action.

API actions, like all other actions, are executed during flow execution by default. A slow API call can slow down your bot response times and performance. If your API is just receiving data but you're not using the results on the flow please consider using asynchronous mode.

The JSON service reply format setting will also enable standard RAW replies: Connect will accept and store in the target variable whatever the server will reply. If you specify a JSON Token Path on a non-JSON result the action will raise an error.

The XML service reply format will automatically parse both standard XML replies and SOAP envelope replies. Typical WSDL based services are perfectly invokable using this action.

Use Payload Mode to set the type of payload you're sending to your service and to change how Xenioo will format the request.

Payload Mode

Result

RAW

No formatting or additional headers are used by Connect. The request is sent as-is.

JSON

Connect will automatically add a content-type:application/json header to the request

FORM-ENCODED

Connect will automatically try to split the payload in one or more variable=value strings and send the data as application/x-www-form-urlencoded.

By default, Connect will add a charset=utf-8 string to the content-type header. Some older web servers might not accept this additional information. If so, remove it by disabling the "UTF-8 Payload Format" flag.

If you specify both Username and Password but do not enable Challenge Authentication Mode, Xenioo will automatically transform both into a base64 string and call the service using an additional Authorization/Basic header like the one below:

Authorization=Basic dGVzdDp0ZXN0

Connect will never add any header or default call value to the request. Any header or value that is required by your call will need to be fully added so that you have total control over each and every aspect of your API integration.

Connect variables can hold without content loss only string based content. If you choose to access a service that replies in binary content (like a service that replies with a pdf file or an image) choose BINARY format as result. Connect will automatically create a file with the result contents inside your account storage and return the full filename url inside the target variable. If the binary service is correctly exposing a content-type for the reply, Connect will automatically append to the downloaded file the correct extension.

Response Headers

Response Headers can be saved by this action by activating the Save Response Headers flag. When the action is executed, every headers sent by the server inside the response will be added to a JSON object into a variable named last_api_response_headers.

A sample headers variable is available below:

{
    "transfer-encoding":"chunked",
    "connection":"keep-alive",
    "access-control-allow-origin":"*",
    "content-type":"application/json",
    "date":"Wed, 10 Nov 2021 14:25:44 GMT"
}

Call Timeout

Trigger

Call Completed. This action will trigger any child operation as soon as the service call is completed. The event will trigger whatever the call is successful or has failed.

Variables

This action produces the following variables:

Variable

Description

last_api_message

The last HTTP message returned by the call. If successful, the variable will be set to 200 OK, otherwise it will contain the remote URL error message.

last_api_response_headers

The response headers of the last call.

Availability

Channel specific availability follows the table below:

Channel

Availability

Facebook

Fully Available.

WhatsApp

Fully Available.

Telegram

Fully Available.

Web

Fully Available.

Alexa

Fully Available.

Google Assistant

Fully Available.

Slack

Fully Available.

API

Fully Available.

Each field of the response headers can be accessed using . For consistency among different systems and calls, all header key names are automatically translated to lowercase. Your dynamic parsing should take this into account when referring to specific fields.

By default, Connect enforces a 10 seconds timeout on every API call executed by your chatbot. If your remote service needs more time to execute its operations please contact to discuss your backend requirements.

When timeout is increased for an account an additional is counted for any API call taking more than 30 seconds to complete.

This action can be used only inside interactions and not as child of other actions. This action requires a to be used on a live chatbot.

Dynamic Parsing
team@xenioo.com
Premium Account
⛔
✅
✅
✅
⛔
⛔
✅
⛔
✅
⛔
⛔
⛔
✅
✅
✅
⛔
Parsed
action message