PlatformInternalAPI

Updated
GET /arrowai.com/
POST /getEventCount
GET /users.php
GET /bots/{id}
GET /api/application.php
arrowai
GET /arrowai.com/

Request body

Responses

200 OK
Body
Object
400 Post
Headers
metacharset
string optional

UTF-8

metaname
array of string optional

viewport

Collection format: csv
event
POST /getEventCount

Request parameters

applicaionid
string optional

“5c57d2c10591b310008b4567”

sessionid
string optional

“NWM1NDA0OTUwNTkxYjMxMTAwOGI0NTY3KzE1NTEyNTkxNjg=”

Request headers

eventtype
array of string optional

“NWM1NDA0OTUwNTkxYjMxMTAwOGI0NTY3KzE1NTEyNTkxNjg=”

Collection format: csv
count
string optional

50

event type
string optional

10406

Request body

User
GET /users.php

Request parameters

Action
array of string optional

“authenticateapp”

Collection format: csv
appid
string optional

“5c57d2c10591b310008b4567”

email
array of string optional
Collection format: csv
key
array of string optional

“NWM1NDA0OTUwNTkxYjMxMTAwOGI0NTY3KzE1NTEyNTkxNjg=”

Collection format: csv
sessionid
array of string optional

“NWM1NDA0OTUwNTkxYjMxMTAwOGI0NTY3KzE1NTEyNTkxNjg=”

Collection format: csv

Responses

400 data

{“headerKey”:“Basic NWM1N2QyYzEwNTkxYjMxMDAwOGI0NTY3OjEyMzQ1Njc=”}}

Headers
code
string optional

0

status
array of array optional

success

Collection format: csv
data
string optional

{“headerKey”:“Basic NWM1N2QyYzEwNTkxYjMxMDAwOGI0NTY3OjEyMzQ1Njc=”}}

Bots
GET /bots/{id}

Path variables

id
string required

This is the Id of the App

Request body

Object
sessionid
string required
key
string required

Responses

200 OK
Body
Object
status
string

could be success or fail

data
Array
Object
name
string
users
Array
Object
user_id
string
created_at
string
Application
GET /api/application.php

Request headers

type
string optional
Example:
application/json

Responses

200 OK
Body
Object
code
string

0

status
Array

success

Array of string
Account Management
Authentication API
POST /api/users.php
POST /api/users.php
POST /users/authenticateUser
Sign Up
POST /api/users.php

Sign UP API

Request parameters

action
string required

“adduser” - This action is same for all new users

Example:
"adduser"
name
string optional

this is username

Example:
xyz
email
string required
Example:
shweta@gmail.com
phone
integer optional
Example:
1234567890
password
string required
Example:
password
Sign out
POST /api/users.php

This url is used for sign out.

Request body

Object
action
string

“logout” - this action name is same.

Example:
logout
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNDk3NTE=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNDk3NTE=
appId
string
Example:
5d7a31a4b81d602c00000003
Sign In
POST /users/authenticateUser

This api is used for “Login”

Request body

Object
action
string

“authenticate” - this action name is same for all users

Example:
"authenticate"
email
string
Example:
xyz@gmail.com
password
string
App Management API

This is the User that is inside the application. This should not be confused with Accounts API (which are various login accounts)

POST /application
POST /api/application.php
POST /api/application.php
POST /api/disableApplication
Get Application List
POST /application

This API is used to get the Application list. baseURL:-“https://apiserver.arrowai.in

Request body

Object
action
string

“list” -default action name

Example:
"list"
Create New Application
POST /api/application.php

Authentication

Open

This API is used when user add new application.

Request body

Object
action
string

“addnew” - this action name is same for all new application

Example:
addnew
name
string

Application name as per the user choice

Example:
new
addedIntegration
Array of unknown
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=

Responses

200 OK
Body
Object
code
integer
status
string
Example:
success
data
Object
_id
string
Example:
5d7a31a4b81d602c00000003
name
string
Example:
new
users
Array
Object
user_id
Object
$id
string
Example:
578666b63a488b4d008b4567
created_at
integer
Example:
1568289188
role
string
Example:
owner
username
string
Example:
ArrowAI app
menus
Array of unknown
bots
Array of unknown
public
integer
repository
string
Example:
owner
default_module
Object
bot_id
Object
$id
string
Example:
5d7a31a4b81d602c00000000
features
Object
get_contact_detail
Object
$id
string
Example:
5d7a31a4b81d602c00000001
Update Application
POST /api/application.php

This API is used to update the Application details.

Request body

Object
action
string
Example:
updatedetail
name
string
Example:
xyz
description
string
Example:
this is updated application
public
integer
category
string
imageUrl
string
botPrimaryColor
string
userMessageColor
string
botMessageColor
string
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=
appId
string
Example:
5d7a3239b81d602e00000003

Responses

200 OK
Body
Object
code
integer
status
string
Example:
success
data
Object
success
boolean
Example:
true
Delete Application
POST /api/disableApplication

This API is used for delete Application. baseURL : https://arrowdotnetcustomfunctions.azurewebsites.net/api/disableApplication

Request body

Object
appid
string

appId is defferent for all application

Example:
5d7a3239b81d602e00000003
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgyODcwOTU=
appId
string
Example:
5d7a3239b81d602e00000003

Responses

500 Internal Server Error
Body
Object
id
string
Example:
daca83d7-b9b3-4eda-bf29-2516d0f5572b
requestId
string
Example:
4a0a7bd3-2794-4e9c-9e62-592f2445e31b
statusCode
integer
Example:
500
errorCode
integer
message
string
Example:
An error has occurred. For more information, please check the logs for error ID daca83d7-b9b3-4eda-bf29-2516d0f5572b
Module Management API
POST /api/application.php
Add New Module
POST /api/application.php

This API is used For Add new module http://dev.arrowai.com/api/application.php

Responses

201 Created
Body
application/json
Object
action
string
Example:
addintegration
appId
string
Example:
57ab1ccfdd814f4d008b4567
state
string

module Id

Example:
"9"
status
string
Example:
true
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAwNzc0MDU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAwNzc0MDU=

Examples

List of available module

[  
   {  
      _id:"1",
      name:"Dashboard",
      state:"application.id.dashboard.home",
      icon:"font-icon-home",
      color:"color:#6a501e;"
   },
   {  
      _id:"2",
      name:"Interaction Engine",
      icon:"glyphicon glyphicon-send",
      color:"orange-red",
      external:      $window.location.origin+ "/external/listening/#/app/:appId/messages/livechat"
   },
   {  
      _id:"3",
      name:"Workflow Engine",
      state:"application.id.workflow.process",
      icon:"font-icon font-icon-cogwheel",
      color:"orange-red",
      subMenu:[  
         {  
            name:"Flows",
            state:"workflow.process",
            icon:"glyphicon glyphicon-random",
            subMenuStatus:"display:none",

         },
         {  
            name:"Event Sources",
            state:"workflow.eventslist",
            icon:"fa fa-bell",
            subMenuStatus:"display:none",

         },
         {  
            name:"Triggers",
            state:"workflow.triggerlist",
            icon:"font-icon font-icon-user",
            subMenuStatus:"display:none"
         },
         {  
            _id:"4",
            name:"ChatBot Engine",
            state:"application.id.chatbot.chatflow",
            icon:"font-icon fa fa-comments",
            color:"orange-red",

         },
         {  
            _id:"5",
            name:"Intelligence Engine",
            state:"application.id.intelligence.recommendation",
            icon:"fa fa-bolt",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Customer Recommendation",
                  state:"intelligence.recommendation",
                  icon:"fa fa-hand-peace-o",

               }
            ]
         },
         {  
            _id:"6",
            name:"Analytics Engine",
            state:"application.id.analytics.dashboard",
            icon:"fa fa-bar-chart",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Dashboard",
                  state:"analytics.dashboard",
                  icon:"fa fa-tachometer",

               },
               {  
                  name:"Customer Reports",
                  state:"analytics.reports",
                  icon:"fa fa-list-alt",

               },
               {  
                  name:"Data Source connection",
                  state:"analytics.datasource",
                  icon:"fa fa-database",

               }
            ]
         },
         {  
            _id:"7",
            name:"Content Engine",
            state:"application.id.contents.page",
            icon:"fa fa-newspaper-o",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Pages",
                  state:"contents.page",
                  icon:"fa fa-file-powerpoint-o",
                  //icon:<i class="fa fa-file-powerpoint-o" aria-hidden="true"></i>,

               },
               {  
                  name:"News",
                  state:"contents.news",
                  icon:"font-icon font-icon-zigzag",

               },
               {  
                  name:"Images",
                  state:"contents.images",
                  icon:"fa fa-picture-o",

               },
               {  
                  name:"Videos",
                  state:"contents.videos",
                  icon:"fa fa-video-camera",

               },
               {  
                  name:"Blogs",
                  state:"contents.blogs",
                  icon:"fa fa-rss"
               }
            ]
         },
         {  
            _id:"9",
            name:"Cricket",
            state:"application.id.cricket.commentary",
            icon:"fa fa-futbol-o",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Live Commentary",
                  state:"cricket.commentary",
                  icon:"font-icon fa fa-bullhorn"
               },
               {  
                  name:"Send Live Score",
                  state:"cricket.scorecard",
                  icon:"font-icon glyphicon glyphicon-bullhorn"
               },
               {  
                  name:"Match Schedule",
                  state:"cricket.schedule",
                  icon:"fa fa-calendar"
               },
               {  
                  name:"Stadium",
                  state:"cricket.stadium",
                  icon:"fa fa-opera"
               },
               {  
                  name:"Team",
                  state:"cricket.team",
                  icon:"fa fa-user-plus"
               },
               {  
                  name:"Seat Info",
                  state:"cricket.seatinfo",
                  icon:"fa fa-wheelchair"
               },
               {  
                  name:"Series",
                  state:"cricket.series",
                  icon:"fa fa-trophy",
                  subMenu:[  
                     //                     {  
                        //     name:"Series Type",
                        //     state:"cricket.seriestype"                        // 
//
                     },
                     {  
                        name:"Series",
                        state:"cricket.series",
                        icon:"fa fa-trophy"
                     },
                     {  
                        name:"Series Season",
                        state:"cricket.seriesSeason",
                        icon:"fa fa-calendar"
                     }
                  ]
               }
            ]
         },
         {  
            _id:"10",
            name:"Storage",
            state:"application.id.storage.bucket",
            icon:"fa fa-database",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Storage Bucket",
                  state:"storage.bucket",
                  icon:"fa fa-bitbucket"
               }
            ]
         },
         {  
            _id:"11",
            name:"Ticketing Engine",
            state:"application.id.ticket.home",
            icon:"fa fa-ticket",
            color:"orange-red",

         },
         {  
            _id:"12",
            name:"BM Assist",
            external:"http://bankai.azurewebsites.net/index.html#/?key="            + escape($cookies.get('key')) + "",
            icon:"fa fa-university",
            color:"orange-red",

         },
         {  
            _id:"13",
            name:"Customer",
            state:"application.id.customer.list",
            icon:"font-icon font-icon-user",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Customer List",
                  state:"customer.list",
                  icon:"fa fa-user",
                  color:"orange-red",

               },
               {  
                  name:"Customer Cohorts",
                  state:"customer.cohorts",
                  icon:"fa fa-users",
                  color:"blue",

               },

            ]
         },
         {  
            _id:"14",
            name:"Contest",
            state:"application.id.contest.quiz",
            icon:"fa fa-trophy",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Quiz",
                  state:"contest.quiz",
                  icon:"fa fa-mars",
                  subMenu:[  
                     {  
                        name:"Quiz Type",
                        state:"contest.quizgroup",
                        icon:"fa fa-puzzle-piece"
                     },
                     {  
                        name:"Quiz",
                        state:"contest.quiz",
                        icon:"fa fa-sticky-note"
                     }
                  ]
               },
               {  
                  name:"Polls",
                  icon:"fa fa-bomb",
                  subMenu:[  
                     {  
                        name:"Poll Type",
                        state:"contest.pollgroup",
                        icon:"fa fa-pie-chart"
                     },
                     {  
                        name:"Polls",
                        state:"contest.polls",
                        icon:"fa fa-bar-chart"
                     }
                  ]
               }
            ]
         },
         {  
            _id:"15",
            name:"Prediction",
            state:"application.id.predication.group",
            icon:"fa fa-empire",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"Prediction Group",
                  state:"predication.group",
                  icon:"fa fa-renren"
               },
               {  
                  name:"Add Prediction",
                  state:"predication.list",
                  icon:"fa fa-pinterest-p"
               }
            ]
         },
         {  
            _id:"16",
            name:"Advertisement",
            state:"application.id.advertisement.list",
            icon:"glyphicon glyphicon-text-background",
            color:"orange-red",
            subMenu:[  
               {  
                  name:"List Of My Adds",
                  state:"advertisement.list",
                  icon:"fa fa-bars",

               },
               {  
                  name:"Dashboard",
                  state:"advertisement.dashboard",
                  icon:"fa fa-tachometer",

               }
            ]
         }
      ]      ;



Integration API
POST /api/application.php
POST /api/application.php
POST /api/application.php
Save FaceBook Configuration
POST /api/application.php

This API is used for save configuration

Request parameters

action
string optional

‘configurefacebook’

appId
string optional

appId

accessToken
string optional

accessToken

validationToken
string optional

validationToken

save Integration Configure
POST /api/application.php

This API is used for save integration configuration.

Request parameters

action
string optional

‘configureIntegration’

appId
string optional

appId

integrationId
string optional

accessToken

integrationConfig
string optional

validationToken

save Twitter Configuration
POST /api/application.php

This API is used for Save twitter Configuration.

Interaction Engine API
Message API
GET /messages/incoming
Incoming Message
GET /messages/incoming

This API is used for Incoming Messages.

Request body

Object
success
boolean
Example:
true
Configuration API
GET /bot/enable
Bot Enable / Disable
GET /bot/enable
Customer
Dashboard
GET /events/getEventCount
POST /users/getUsers
Get Event Count
GET /events/getEventCount

This api is used for dashboard. base URL :-https://interaction.arrowai.in

Request body

Object
applicationId
string
Example:
58906f07faad6f52008b456a
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
app_id
string
Example:
58906f07faad6f52008b456a

Responses

200 OK
Body
Object
eventType
string

Event types are fixed - user_message_to_bot, newUser,bot_message_to_use

COUNT(eventType)
integer
Example:
2
Get User
POST /users/getUsers

This api is used to get user list

Request body

Object
limit
integer
Example:
1000000
page
integer
Example:
1
filters
Array of unknown
fields
Object
_id
integer
Example:
1
data
integer
Example:
1
sortBy
Object
data.name
integer
Example:
1
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
app_id
string
Example:
58906f07faad6f52008b456a
Content Engine

This Group contains API’s of Content Engine.

News API
PUT /_table/tbl_news/1
GET /_proc/getallnews
Update News
PUT /_table/tbl_news/1

This API is for updation of Specific News. URL: http://dream.arrowai.com/api/v2/ecommercedb/_table/tbl_news/1 //with new id

Request parameters

app_id
string optional

application_id

news_id
string optional

news_id

news_name
string optional

news_name

news
string optional

news

url
string optional

news_url

weightage
string optional

weightage

image
string optional

filename

createdate
string optional

createdate

attchment_id
string optional

attchment_id

category
string optional

category_name

Request body

Object
app_id
string
Example:
57ab1ccfdd814f4d008b4567
id
integer
Example:
20695826
url
string
Example:
fsdfsdf
weightage
string
Example:
1
image
string
Example:
https://s3.ap-southeast-1.amazonaws.com/arrowai-dreamfactory-new/7c7eecd0-220d-9202-7dc0-3e29173fa344fifa image.jpg
createdate
string
Example:
2018-06-28 05:49:08
news_id
unknown nullable
category
string
Example:
Business
attchment_id
unknown nullable
news
string
Example:
45454
news_name
string
Example:
TEst

Examples

Request Format of Update News

{"resource":[{ app_id: app_id, 
news_id:news_id,
news_name:news_name,
news:news,
url:url,
weightage:weightage,
image:filename,
createdate:createdate,
attchment_id:attachment_id,
category:category
}]}
Get News List
GET /_proc/getallnews

This API is for List of News. URL: http://dream.arrowai.com/api/v2/ecommercedb/_proc/getallnews(<applicationId>)

Request body

Object
app_id
string

application_id

Example:
57ab1ccfdd814f4d008b4567
id
integer

id

Example:
20695826
url
string

url

Example:
fsdfsdf
weightage
string

wrightage

Example:
1
image
string

filename

Example:
https://s3.ap-southeast-1.amazonaws.com/arrowai-dreamfactory-new/7c7eecd0-220d-9202-7dc0-3e29173fa344fifa image.jpg
createdate
string

create date

Example:
2018-06-28 05:49:08
news_id
string

news_id

category
string

category

Example:
Business
attchment_id
string

attachment_id

news
string

news

Example:
45454
news_name
string

news_name

Example:
TEst
Video API
GET /api/v2/ecommercedb
PATCH /api/v2/ecommercedb
POST /api/v2/ecommercedb
Update Video
PATCH /api/v2/ecommercedb

Request parameters

resource
string optional

In this resource id, app_id etc parameters are included.

id
string optional
app_id
string optional

finalObject.app_id

title
string optional

finalObject.title

VideoUrl
string optional

finalObject.VideoUrl

thumbnail
string optional

finalObject.filename

summary
string optional

finalObject.summary

url
string optional

finalObject.url

Save Video
POST /api/v2/ecommercedb

URL: http://dream.arrowai.com/api/v2/ecommercedb+’/_table/tbl_media_video

Request parameters

resource
string required

In this resource app_id,title etc… are included.

app_id
string optional

finalObject.app_id

title
string optional

finalObject.title

VideoUrl
string optional

finalObject.VideoUrl

thumbnail
string optional

finalObject.filename

summary
string optional

finalObject.summary

url
string optional

finalObject.url

attachment_id
string optional

finalObject.attachment_id

create_date
string optional

finalObject.create_date

Image API
GET /api/v2/ecommercedb
POST /api/v2/images
POST /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
GET /api/v2/ecommercedb
Get Tag Images
GET /api/v2/ecommercedb
upload File To Url
POST /api/v2/images

API URL:http://dream.arrowai.com/api/v2/images +’/images/’+ filename

Request headers

Content-Type
string optional

undefined

Save Multiple Image
POST /api/v2/ecommercedb

This URL is used to save multiple images. URL:http://dream.arrowai.com/api/v2/ecommercedb+’/_table/tbl_media_gif

Delete Image
DELETE /api/v2/ecommercedb
User Engine
Event API
POST /events/add
GET /events/getEvents
GET /event/details
Add Event
POST /events/add

API format for Add Events. API URL:https://firedev.arrowai.com/events/add

Request parameters

groupId
string optional
Example:
-gdgdfgdsgfdsgsgsgfdsgd
applicationId
string optional
Example:
59d385763800f371008b456b
integration
string optional
Example:
web
eventCategory
string optional
Example:
XYZ
eventAction
string optional
Example:
click
eventType
string optional
Example:
clickevent
eventId
string optional
Example:
web_user_activity
data
string optional
Example:
{ "test" : "hi" }
List Events
GET /events/getEvents

List of Events. API URL:Request URL: https://firedev.arrowai.com/events/getEvents

Request parameters

limit
string optional
Example:
20
page
string optional
Example:
1
filters
string optional
Example:
[ { "sort": { "timestamp": -1 } } ]
fields
string optional
Example:
{ "_id": 1, "data": 1 }
sortBy
string optional
sessionid
string optional
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAwOTYwNjY=
app_id
string optional
Example:
5b0256a8b845af78008b456a
Event Details
GET /event/details
Segmentation API
GET /api/v2/chat_developer/_table/cohortCondition?filter=app_id%3D5af4184361f06578008b456a
POST /users/getUsers
GET /api/v2/chat_developer
GET /segment/properties
GET /segment/add
GET /api/v2/chat_developer/_table/cohortCondition
GET /api/v2/chat_developer
GET /api/v2/chat_developer
Segment User List
GET /api/v2/chat_developer/_table/cohortCondition?filter=app_id%3D5af4184361f06578008b456a

Request parameters

resource
string optional
Example:
[ { "_id": "5af56535bd65eb56eb0b36a2", "app_id": "5af4184361f06578008b456a", "cohortName": "testcohort", "name": "6ac7bce7-2333-8bec-a23c-622ee110f792", "filters": { "userWhoDidConditionList": { "conditionType": "and", "conditions": [ { "eventId": "interaction_engine", "eventType": "newUser", "timeFilter": { "name": "inPast", "duration": 11, "durationType": "days" }, "where": { "key": "count", "conditions": { "operator": "=" }, "value": 1 }, "filters": [] } ] }, "userWhoDidNotConditionList": { "conditionType": "and", "conditions": [] }, "userPropertiesConditionList": { "conditionType": "and", "conditions": [] } } } ]
Get Cohert User
POST /users/getUsers

URL:https://firedev.arrowai.com+ ‘/users/getUsers’

Request parameters

limit
string optional

self.userList.current.limit

page
string optional

self.userList.current.page

filters
string optional

filters || []

fields
string optional
Example:
{ _id: 1, "data": 1 }
sortBy
string optional
Example:
{"data.name": 1}
Get Cohort List
GET /api/v2/chat_developer

Cohort List URL.http://dream.arrowai.com/api/v2/chat_developer+ ‘/_table/cohortCondition?filter=app_id%3D’ + appId

View Segment Properties
GET /segment/properties
Add Segment
GET /segment/add
Segment Create
GET /api/v2/chat_developer/_table/cohortCondition

Request parameters

resource
string optional
Example:
[ { "app_id": "5af4184361f06578008b456a", "cohortName": "testcohort", "name": "6ac7bce7-2333-8bec-a23c-622ee110f792", "filters": { "userWhoDidConditionList": { "conditionType": "and", "conditions": [ { "eventId": "interaction_engine", "eventType": "newUser", "timeFilter": { "name": "inPast", "duration": 11, "durationType": "days" }, "where": { "key": "count", "conditions": { "operator": "=" }, "value": 1 }, "filters": [] } ] }, "userWhoDidNotConditionList": { "conditionType": "and", "conditions": [] }, "userPropertiesConditionList": { "conditionType": "and", "conditions": [] } } } ]
Get Cohort Configuration
GET /api/v2/chat_developer

URL:http://dream.arrowai.com/api/v2/chat_developer + ‘/_table/cohortConfiguration’

Delete Cohorts
GET /api/v2/chat_developer

URL.http://dream.arrowai.com/api/v2/chat_developer + ‘/_table/cohortCondition/’ + _id

Examples

          getWhoDid: function () {
                return this.userWhoDidConditionList;
            },
            getWhoDidNot: function () {
                return this.userWhoDidNotConditionList;
            },
            getUserProperties: function () {
                return this.userPropertiesConditionList;
            },
User API
GET /users/getUsers
POST /users/getUsers
GET /user/profile
GET /users/getUsers
GET /users/getUsers
POST /users/new
POST /api/v2/ecommercedb
Get user list
GET /users/getUsers

Request body

application/json
Object
app_id
string

Application ID

Example:
5a7bfc8ebde31989008b456a
key
string

Interaction Engine Key (either of key or sessionId should only be given)

Example:
68aba74c-f126-4c57-b9a0-d20b9bed4d7d
sessionid
string

ArrowAI UI Session ID (either of key or sessionId should only be given)

Example:
ArrowAI UI Session ID (either of key or sessionId should only be given)
filters
Array

This is the list of filters that can be given. Each object is a pipeline for aggregate operation but $match changes to match, ie remove $ for the type of stage

Examples:
{
    "match": {
        "data.integration.android": true
    }
}
{
    "project": {
        "_id": 1 
    }
}
{
    "group": {
        _id: "$groupId", events: { $push: "$$ROOT" }
    }
}
Object
match
Object
data.integration.android
string
Example:
true
fields
Object

The list of data that is required to be shown, all the properties set to 1 will be sent back from the api call

events
integer
data
integer
Example:
1
_id
integer
Example:
1
variable
string
Example:
1
lastMessageChannel
number
Example:
1
lastMessage
integer
Example:
1
unread
integer
Example:
-1
page
integer

Page Number

limit
integer

Limit of the number of results. To get all the list of users, type limit as 0

Default:
20
Example:
1
sortBy
string

Field to sort the data

allFields
boolean

if set to true, then it overwrites all the column of fields and gives you the total list of all attributes

Default:
false
Examples:
truefalse
Examples

With Interaction Key

{
    "app_id": "5a7bfc8ebde31989008b456a",
    "key": "68aba74c-f126-4c57-b9a0-d20b9bed4d7d",
    "filters": [
        {
            "match": {
                "data.integration.android": true
            }
        }
    ],
    "fields": {
        "events": 1,
        "data": 1,
        "_id": 1,
        "variable": 1,
        "lastMessageChannel": 1,
        "lastMessage": 1,
        "unread": -1
    },
    "page": 1,
    "limit": 2
}

With Session Id

{
    "app_id": "5a7bfc8ebde31989008b456a",
    "sessionid": "NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MTk3MTI1MTE=",
    "filters": [
        {
            "match": {
                "data.integration.android": true
            }
        }
    ],
    "fields": {
        "events": 1,
        "data": 1,
        "_id": 1,
        "variable": 1,
        "lastMessageChannel": 1,
        "lastMessage": 1,
        "unread": -1
    },
    "page": 1,
    "limit": 2
}

Get Event number with data

{
    "app_id": "5a7bfc8ebde31989008b456a",
    "key": "68aba74c-f126-4c57-b9a0-d20b9bed4d7d",
    "filters": [
        {
        	"project": {
        		"data": 1,
		        "_id": 1,
	            "numberOfEvents": { "$size": "$events" }
	         }
        }
    ],
    "fields": {
    	"data": 1,
		"numberOfEvents": 1,
        "_id": 1
    },
    "page": 1,
    "limit": 100,
    "sortBy": "numberOfEvents"
}

All web but not android


{
    "app_id": "5a7bfc8ebde31989008b456a",
    "key": "68aba74c-f126-4c57-b9a0-d20b9bed4d7d",
    "filters": [
        {
            "match": {
                "data.integration.web": true
            }
        },
        {
        	"match": {
        		"data.integration.android": {"$exists": false} 
        	}
        },
        {
        	"project": {
	           "data": 1,
		        "_id": 1,
		        "variable": 1,
		        "lastMessageChannel": 1,
		        "lastMessage": 1,
		        "unread": 1,
	            "numberOfEvents": { "$size": "$events" }
	         }
        }
    ],
    "fields": {
		"numberOfEvents": 1,
        "data": 1,
        "_id": 1,
        "unread": 1
    },
    "page": 1,
    "limit": 20
}

Responses

200 OK
Body
application/json
Object
code
integer
Enumeration:
0

No error

1

Has Error

users
Object

Contains data for users

data
Array

Array of users data

Object
_id
string
Example:
-L4yS0fS7YqpFbZSkhFR
data
string
phone
string
name
string
Example:
Shweta
integration
Object
webIds
string
-L5CUzbAYpibBNpStv2Z
boolean
Example:
true
web
boolean
Example:
true
androidUniqId
string
Example:
wSk3pYZwV1Ym1VEdZKhMe1KYaH73
androidIds
Object
-L5o-mHMFR_i-RmnJJYz
boolean
Example:
true
-L5DW9p6asn0xFsKSu64
boolean
Example:
true
-L5DW9AMyFhquRBGlmzC
boolean
Example:
true
-L5Cou0bocOekkHzb3pN
boolean
Example:
true
-L5CotLQKTuvhcBnIi4-
boolean
Example:
true
-L4yS0bGG7WdI69C3rDu
boolean
Example:
true
android
boolean
Example:
true
email
string
Example:
shweta@arrowai.com
authKey
string
Example:
wSk3pYZwV1Ym1VEdZKhMe1KYaH73
events
Array
Object
_id
string
Example:
5a8c4a88ecefe7003806a232
data
Object
source
Array of string
Examples:
["android"]
android
appId
string
Example:
5a7bfc8ebde31989008b456a
name
string
Example:
shweta
email
string
Example:
shweta@arrowai.com
phone
string
Example:
1234567890
deviceInfo
Object
IP
string
Example:
0.0.0.0
ANDROID_ID
string
Example:
312c9f3925c9cade
BOARD
string
Example:
msm8953
BOOTLOADER
string
Example:
MSM8953_TISSOT1.0_20171219100348
BRAND
string
Example:
xiaomi
CPU_ABI
string
Example:
arm64-v8a
CPU_ABI2
string
DISPLAY
string
Example:
N2G47H.7.12.19
FINGERPRINT
string
Example:
xiaomi/tissot/tissot_sprout:7.1.2/N2G47H/7.12.19:user/release-keys
HARDWARE
string
Example:
qcom
HOST
string
Example:
mi-server
ID
string
Example:
N2G47H
MANUFACTURER
string
Example:
Xiaomi
MODEL
string
Example:
Mi A1
PRODUCT
string
Example:
tissot
SERIAL
string
Example:
fdd6d38f0504
TAGS
string
Example:
release-keys
TIME
string
Example:
1513652529000
TYPE
string
Example:
user
UNKNOWN
string
Example:
unknown
USER
string
Example:
builder
channel
string
Example:
android
FCM_Token
string
Example:
dsdPrF-xiao:APA91bH-2sWTzHMGbNGXyx-qGfs4Q1gjoLft2486VQLz-J8d31qH8EDjyXKUI9mkmui3NZ2Ez0rVa5BoncQAIQqN6ESKm8EtSJpciYuMXmQ2Sn4lHbdnMZZdTB6ryL_LI-UJ3evsr8dY
groupId
string
Example:
-L4yS0fS7YqpFbZSkhFR
applicationId
string
Example:
5a7bfc8ebde31989008b456a
eventType
string
Example:
newUser
__v
string
pageCount
string

Total Pages

Example:
8
totalCount
string

Total Count

Example:
16
currentPage
string

current Page Number

Example:
1
currentLimit
string

Current limit set

Example:
1
Examples
{
    "code": "1",
    "users": {
        "data": [
            {
                "_id": "-L4yS0fS7YqpFbZSkhFR",
                "data": "",
                "phone": "",
                "name": "Shweta",
                "integration": {
                    "webIds": "",
                    "-L5CUzbAYpibBNpStv2Z": "true"
                },
                "web": "true",
                "androidUniqId": "wSk3pYZwV1Ym1VEdZKhMe1KYaH73",
                "androidIds": {
                    "-L5o-mHMFR_i-RmnJJYz": "true",
                    "-L5DW9p6asn0xFsKSu64": "true",
                    "-L5DW9AMyFhquRBGlmzC": "true",
                    "-L5Cou0bocOekkHzb3pN": "true",
                    "-L5CotLQKTuvhcBnIi4-": "true",
                    "-L4yS0bGG7WdI69C3rDu": "true"
                },
                "android": "true"
            }
        ],
        "email": "shweta@arrowai.com",
        "authKey": "wSk3pYZwV1Ym1VEdZKhMe1KYaH73"
    },
    "events": [
        {
            "_id": "5a8c4a88ecefe7003806a232",
            "data": {
                "source": [
                    ""
                ],
                "appId": "5a7bfc8ebde31989008b456a",
                "name": "shweta",
                "email": "shweta@arrowai.com",
                "phone": "1234567890"
            },
            "deviceInfo": {
                "IP": "0.0.0.0",
                "ANDROID_ID": "312c9f3925c9cade",
                "BOARD": "msm8953",
                "BOOTLOADER": "MSM8953_TISSOT1.0_20171219100348",
                "BRAND": "xiaomi",
                "CPU_ABI": "arm64-v8a",
                "CPU_ABI2": "",
                "DISPLAY": "N2G47H.7.12.19",
                "FINGERPRINT": "xiaomi/tissot/tissot_sprout:7.1.2/N2G47H/7.12.19:user/release-keys",
                "HARDWARE": "qcom",
                "HOST": "mi-server",
                "ID": "N2G47H",
                "MANUFACTURER": "Xiaomi",
                "MODEL": "Mi A1",
                "PRODUCT": "tissot",
                "SERIAL": "fdd6d38f0504",
                "TAGS": "release-keys",
                "TIME": "1513652529000",
                "TYPE": "user",
                "UNKNOWN": "unknown",
                "USER": "builder",
                "channel": "android",
                "FCM_Token": "dsdPrF-xiao:APA91bH-2sWTzHMGbNGXyx-qGfs4Q1gjoLft2486VQLz-J8d31qH8EDjyXKUI9mkmui3NZ2Ez0rVa5BoncQAIQqN6ESKm8EtSJpciYuMXmQ2Sn4lHbdnMZZdTB6ryL_LI-UJ3evsr8dY"
            },
            "groupId": "-L4yS0fS7YqpFbZSkhFR",
            "applicationId": "5a7bfc8ebde31989008b456a",
            "eventType": "newUser",
            "__v": ""
        }
    ],
    "pageCount": "8",
    "totalCount": "16",
    "currentPage": "1",
    "currentLimit": "1"
}
User List
POST /users/getUsers

This is the API to get the list of users.You can also define multiple filters and get the list based on that. API Url:https://firedev.arrowai.com/users/getUsers

Responses

201 Created
Body
application/json
Object
app_id
string
Example:
"59d385763800f371008b456b"
fields
string
Example:
{_id: 1, data: 1}
filters
string
Example:
"59d385763800f371008b456b"
limit
string
Example:
20
page
string
Example:
1
sessionid
string
Example:
"NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzA1Mjc5MTk="
sortBy
string
Example:
{data.name: 1}

Examples

{limit: 20, page: 1, filters: "59d385763800f371008b456b", fields: {_id: 1, data: 1},}
{"code":0,"users":{"data":[{"_id":"-KvXFyj5yvAHT5uyUQTj"},{"_id":"-LExoQb6H6cbBhrJyddg","data":{"name":"Guest105","integration":{"web":true,"webIds":{"-LExoQaz-0sccLhsQ1ge":true}}}},{"_id":"-LG4BAv3MDxL948tezi1","data":{"name":"Guest130","integration":{"web":true,"webIds":{"-LG4BAuyB_F-h6feLLiu":true}}}},{"_id":"-LD0y4Dz38fhlLWlqgEh","data":{"integration":{"webIds":{"-LD0y4DxurulFR0Jhz_b":true},"web":true},"name":"Guest186"}},{"_id":"-LCvP_Op3CHqW0UQZOwz","data":{"integration":{"webIds":{"-LCvP_Oi3IWlqKyxyGRo":true},"web":true},"name":"Guest270"}},{"_id":"-LF7Bsd73Ya0fVtYjBuI","data":{"name":"Guest290","integration":{"web":true,"webIds":{"-LF7Bsd40T0tJygtL8yz":true}}}},{"_id":"-LF1V467d8dWxopP5b6f","data":{"name":"Guest436","integration":{"web":true,"webIds":{"-LF1V45z6rbQwSSMRxnJ":true}}}},{"_id":"-KvXHjuHOoIsfUYxZDLH","data":{"name":"Guest618","integration":{"webIds":{"-KvXHjcIOxxCYz_9t50H":true},"web":true}}},{"_id":"-LEJ1A9RAs_rr6toeQSr","data":{"name":"Guest63","integration":{"web":true,"webIds":{"-LEJ1A9NVAF-fDfXgav4":true}}}},{"_id":"-LDkRuOn-4GUTEBlvyCY","data":{"integration":{"webIds":{"-LDkRuOjnN96XdpFdjVh":true},"web":true},"name":"Guest649"}},{"_id":"-LEJKmjTLsZvyyFhXGmu","data":{"name":"Guest658","integration":{"web":true,"webIds":{"-LEJKmjRKUefaSm0OVIN":true}}}},{"_id":"-LF7XHoQlYIirid6qNCq","data":{"name":"Guest692","integration":{"web":true,"webIds":{"-LF7XHoNn5IXWJpN7JXN":true}}}},{"_id":"-LCY7nZ5v5GqDg8CKeAb","data":{"integration":{"webIds":{"-LCY7nZ2m6uoGVXhz7FN":true},"web":true},"name":"Guest746"}},{"_id":"-LDMFGaIWF-e3pBiVLeA","data":{"integration":{"webIds":{"-LDMFGaBSxEc53k60bWu":true},"web":true},"name":"Guest845"}},{"_id":"-LCbhWjfISW90Zxt2RK7","data":{"integration":{"webIds":{"-LCbhWjZi0e8r4i4IvtK":true},"web":true},"name":"Guest846"}},{"_id":"-LDGZkOE_3C9JdQwJ--w","data":{"integration":{"webIds":{"-LDGZkO9YPaYp150k5Yn":true},"web":true},"name":"Guest872"}},{"_id":"-LF2Md-c4mV_gZIQB_z2","data":{"name":"Guest889","integration":{"web":true,"webIds":{"-LF2Md-ZExola4s6KSFY":true}}}},{"_id":"-LEibz3hkTkM0wKZlQJV","data":{"name":"Guest908","integration":{"web":true,"webIds":{"-LEibz3es6uqTFxgjoVG":true}}}},{"_id":"-LF7D92ECW00vzKPY9a2","data":{"name":"Guest919","integration":{"web":true,"webIds":{"-LF7D928L4nxWgcdsypG":true}}}},{"_id":"-LChPH_MLBG0tuAD5xks","data":{"integration":{"webIds":{"-LChPH_KA9_SvNKdYyhr":true},"web":true},"name":"Guest980"}}],"pageCount":2,"totalCount":22,"currentPage":1,"currentLimit":20}}
Get User Profile
GET /user/profile

Responses

200 OK
Body
application/json
Object
userId
string
Example:
"578666b63a488b4d008b4567"
key
string
Example:
"NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAzMzU4ODM="
name
string
Example:
"ArrowAI app"
email
string
Example:
"contact@arrowai.com"
phone
string
Example:
"1231231231"
User Detail - Events
GET /users/getUsers

User Detail - Messages:coming from firebase outGoingMessage API Url: https://firedev.arrowai.com/users/getUsers

Request parameters

limit
integer optional
Example:
1
page
integer optional
filters
string optional
Example:
[ { "match": { "_id": "userId" } } ]
fields
string optional
Example:
{ "_id": 1, "data": 1, "variable": 1, "deviceInfo": 1 }
allFields
string optional

allFields

sessionid
string optional
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MjYwMjUwNjI=
app_id
string optional
Example:
59d385763800f371008b456b

Responses

200 OK
Body
application/json
Object
code
string

0

users
string
Example:
{ "data": [ { "_id": "-KvXHjuHOoIsfUYxZDLH", "app_id": "59d385763800f371008b456b", "__v": 0, "data": { "name": "Guest618", "integration": { "webIds": { "-KvXHjcIOxxCYz_9t50H": true }, "web": true } }, "variable": { "global_env": {}, "global_system_last_message": { "text": "hi" }, "global_user_logged_in_status": false, "global_system_application_id": "59d385763800f371008b456b", "global_system_bot_id": "59d3861c3800f370008b4569", "global_system_user_id": "-KvXHjcIOxxCYz_9t50H", "global_system_user_channel": "web", "global_system_group_user_id": "-KvXHjuHOoIsfUYxZDLH" } } ], "pageCount": 1, "totalCount": 1, "currentPage": 1, "currentLimit": 1 }
User Detail - Custom Values
GET /users/getUsers

Request parameters

limit
integer optional

1

page
integer optional

1

filters
string optional
Example:
[ { "match": { "_id": "userId" } } ]
fields
string optional
Example:
{ "_id": 1, "data": 1, "variable": 1, "deviceInfo": 1 }
allFields
string optional

true

sessionid
string optional
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MjYwMjUwNjI=
app_id
string optional
Example:
59d385763800f371008b456b

Responses

200 OK
Body
Object
code
string

0

users
string
Example:
{ "data": [ { "_id": "-KvXHjuHOoIsfUYxZDLH", "app_id": "59d385763800f371008b456b", "__v": 0, "data": { "name": "Guest618", "integration": { "webIds": { "-KvXHjcIOxxCYz_9t50H": true }, "web": true } }, "variable": { "global_env": {}, "global_system_last_message": { "text": "hi" }, "global_user_logged_in_status": false, "global_system_application_id": "59d385763800f371008b456b", "global_system_bot_id": "59d3861c3800f370008b4569", "global_system_user_id": "-KvXHjcIOxxCYz_9t50H", "global_system_user_channel": "web", "global_system_group_user_id": "-KvXHjuHOoIsfUYxZDLH" } } ], "pageCount": 1, "totalCount": 1, "currentPage": 1, "currentLimit": 1 }
Create New User
POST /users/new

To Create the new user in the system. If Channel Id is already given it will automatically create the new Channel user in firebase with the same ID. If no channel user id is given it will automatically create a new channel user id.

Request body

application/json
Object
data
string required

These are the fields that are accessible like name, email, …

name
string
Example:
Guest499
source
Array of string
Examples:
["web"]
web
email
string
phone
string
Examples

Example for add new user

{
    "data": "",
    "name": "Guest499",
    "source": [
        ""
    ],
    "email": "",
    "phone": ""
}

Responses

201 Created
Body
application/json
Object
data
string
appId
string
Example:
5a0fdd56c3a53a6e008b456a
source
Array of string
Examples:
["web"]
web
deviceInfo
string required
color
integer
Example:
16777216
fonts
string
Example:
No
navigator
string
Example:
Netscape
channel
string
Example:
web
webUserGuest
string
version
string
Example:
5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36
colordepth
string
Example:
24
width
string
Example:
1920
height
string
Example:
1865
maxwidth
string
Example:
1059
codename
string
Example:
Mozilla
platform
string
Example:
Linux x86_64
groupId
string
Example:
-KzxMmbp5bcdfN2qlqUv
id
string
Example:
-KzxMmbo8IDSkF4i45Ld
Save(Add)User
POST /api/v2/ecommercedb

This URL is used to save the user URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_user’

Request parameters

resource
string optional

In this resource app_id,user_id etc… parameters re included.

app_id
string optional

finalObject.app_id

user_id
string optional

finalObject.user_id

user_name
string optional

finalObject.user_name

email
string optional

finalObject.email

mobile
string optional

finalObject.mobile_no

image
string optional

finalObject.filename

createdate
string optional

finalObject.createdate

ChatBot Engine
POST /creatorApi/index.php
Story List Module
POST /creatorApi/index.php
POST /creatorApi/index.php
POST /creatorApi/index.php
Get Story List In Module
POST /creatorApi/index.php

This API i used to get story list in module.

Request parameters

action
string optional
Example:
'storylist'
bot
string optional

botId

Get Story List In Module For Tag
POST /creatorApi/index.php

This API i used to get story list in module for tag.

Request parameters

action
string optional
Example:
'storylist'
'bot'
string optional

botId

'tag'
string optional

tag

Delete Story From Bot
POST /creatorApi/index.php

This API is used to delete story from bot

Request parameters

action
string optional
Example:
'deletestory'
storyId
string optional

storyId

bot
string optional

botId

Add Question Answer In Module
POST /creatorApi/index.php

This API is used to add questions and answer.

Request parameters

action
string optional
Example:
'addquestionanswerstory'
bot
string optional

botId

question
string optional

question

answer
string optional

answer

tag
string optional

tag

Message Setting
POST /api/application.php
Update Application Message Setting
POST /api/application.php

This url is used to update Application message setting.

Request parameters

action
string optional
Example:
'updatemessagedetail'
id
string optional

id

sorrySentence
string optional

sorrySentence

userEmails
string optional
unclearMaxCount
string optional
timeout
string optional
enableModes
string optional
defaultBot
string optional
Question
GET /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
POST /api/v2/ecommercedb
Delete Question
DELETE /api/v2/ecommercedb
Save Question
POST /api/v2/ecommercedb

Request parameters

resource
string optional

In this resource app_id,question etc… parameters are included.

app_id
string optional

finalObject.app_id

question
string optional

finalObject.question

conversation_id
string optional

finalObject.conversation_id

tbl_question_tag_by_question_id
string optional

finalObject.tbl_question_tag_by_question_id

Configuration
POST /api/v2/ecommercedb
PATCH /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
Save Config
POST /api/v2/ecommercedb

Request parameters

resource
string optional

in this resource appId ,botId etc…parameters are included

appId
string optional

finalObject.app_id

botId
string optional

finalObject.botId

conversationId
string optional

finalObject.conversation_id

type
string optional

finalObject.type

conversationName
string optional

finalObject.conversationName

Update Config
PATCH /api/v2/ecommercedb

Request parameters

resource
string required

in this resource id, appId etc… parameters are included.

id
string optional
appId
string optional

finalObject.app_id

botId
string optional

finalObject.botId

conversationId
string optional

finalObject.conversation_id

type
string optional

finalObject.type

conversationName
string optional

finalObject.conversationName

Delete Conversation Config
DELETE /api/v2/ecommercedb
conversation
GET /api/v2/ecommercedb
Resolution
GET /api/v2/ecommercedb
Module crud
POST /api/application.php
POST /api/application.php
GET /bots
Delete Module
POST /api/application.php

This api is used to delete module

Request body

Object
action
string

“removemodulefromapp” - this action name is same for all modules

Example:
removemodulefromapp
bot
string
Example:
5d7b286ed9e0336b00000000
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
appId
string
Example:
5d7a31a4b81d602c00000003
Add Module
POST /api/application.php

This api is used to create new module

Request body

Object
action
string
Example:
addmodule
name
string
Example:
new module
description
string
Example:
this is new module
language
string
Example:
en
public
integer
Example:
1
category
string
Example:
other
tags[0][text]
string
Example:
testing
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
appId
string
Example:
5d7a31a4b81d602c00000003
Get List
GET /bots

This api is used to get module list. base URL:-https://apiserver.arrowai.in

Request body

Object
action
string
Example:
listbots
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
appId
string
Example:
5d7a31a4b81d602c00000003

Responses

200 OK
Body
Object
code
integer
status
string
Example:
success
data
Array
Object
_id
string
Example:
5d7b2a0ad9e0336e00000000
name
string
Example:
new module
description
string
Example:
this is new module
image_url
string
users
Array
Object
user_id
string
Example:
578666b63a488b4d008b4567
created_at
integer
Example:
1568352778
role
string
Example:
owner
username
string
menus
Array of unknown
suggestions
Array of unknown
initialGreetings
string
public
integer
Example:
1
tags
Array
Object
text
string
Example:
testing
category
string
Example:
other
language
string
Example:
en
repository
string
Example:
owner
Generic Bot
GET /api/bots.php
Get generic List
GET /api/bots.php

This api is used to get generic list.

Request body

Object
action
string

“featuredpublicbotsrepo” - this action name is same to get generic bot list

Example:
featuredpublicbotsrepo
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1NjgzNTExMDU=
appId
string
Example:
5d7a31a4b81d602c00000003

Responses

200 OK
Body
Object
code
integer
status
string
Example:
success
data
Array
Object
_id
string
Example:
574c4e563447c94e0c8b4568
name
string
Example:
Accounts and Deposits
description
string
Example:
Module to manage bank account of user
image_url
string
Example:
https://cdn1.iconfinder.com/data/icons/freeline/32/account_friend_human_man_member_person_profile_user_users-512.png
users
Array
Object
user_id
string
Example:
57e12ed95db18d51008b4567
created_at
integer
Example:
1464618583
role
string
Example:
owner
username
string
featured
boolean
Example:
true
menus
Array of unknown
suggestions
Array
Example:
["Account Balance","Transaction Between Dates","Last Five Transaction","Add Money","Open Account"]
string
Example:
Account Balance
initialGreetings
string
public
integer
Example:
1
tags
Array
Object
text
string
Example:
account-management
category
string
Example:
banking
repository
string
Example:
owner
initialGreeting
string
Example:
I am here to help you manage your bank account
Workflow Engine
Trigger API
DELETE /api/triggerAction?appId=
GET /api/triggerAction?appid=
POST /api/trigger.php
Delete Trigger
DELETE /api/triggerAction?appId=

API URL: https://arrowinteraction.azurewebsites.net+’/api/triggerAction?appId=’+app_Id+’&env=’+URL.ENV_URL+’&_id=’+id+’’

Responses

204 No Content
application/json
Get Trigger List
GET /api/triggerAction?appid=

This API is used to get trigger. API URL: RABIT_MQ:“https://arrowinteraction.azurewebsites.net/api/triggerAction?appid=appId

Responses

200 OK
Body
application/json
Object
actionId
string
Example:
59d385763800f371008b456b59d3
actionName
string
Example:
time based
appId
string
Example:
59d385763800f371008b456b
env
string
Example:
local
key
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAyNDc4MDU=
sessionid
string
Example:
NTc4NjY2YjYzYTQ4OGI0ZDAwOGI0NTY3KzE1MzAyNDc4MDU=
triggerName
string
Example:
dfgdfg
triggerType
string
Example:
action based
_id
string
Example:
5b35de2861c9350a24cb01b6
Save Trigger
POST /api/trigger.php

This API is used to save or add new Trigger.

Request parameters

action
string required

Add new trigger

Example:
addTrigger
name
string optional
type
string optional

app.type

repeatationRule
string optional

app.repeatationRule

dateTime
string optional

app.dateTime

repeatInterval
string optional

app.repeatInterval

dateOfNextOccerance
string optional

app.dateOfNextOccerance

userType
string optional

app.userType

user
string optional

app.user

module
string optional

app.module

conversation
string optional

app.conversation

Trigger Event API
GET /api/v2/arrowmongo_db
GET /api/v2/arrowmongo_db
GET /api/saveTriggersEvents
PATCH /api/v2/arrowmongo_db
GET /api/saveTriggersEvents
GET /api/saveTriggersEvents?appid=
get Event Feature
GET /api/v2/arrowmongo_db

This API URL is used to get Event Feature API URL:DREAMFACTORY_ARROWMONGOURL:“http://dream.arrowai.com/api/v2/arrowmongo_db

get Event Sub Type
GET /api/v2/arrowmongo_db

This API URL is used for get sub event type DREAMFACTORY_ARROWMONGOURL:“http://dream.arrowai.com/api/v2/arrowmongo_db

Save Trigger Event
GET /api/saveTriggersEvents

This URL is used to save te trigger events API URL https://arrowinteraction.azurewebsites.net+’/api/saveTriggersEvents’

Update Trigger Event
PATCH /api/v2/arrowmongo_db

This API is used to Update Trigger Event. API URL: http://dream.arrowai.com/api/v2/arrowmongo_db+’/_table/tblEvent’

Delete Trigger Event
GET /api/saveTriggersEvents

This API is used to delete Trigger Event. API URL: https://arrowinteraction.azurewebsites.net+’/api/saveTriggersEvents’,{_id:id}

get Trigger Event
GET /api/saveTriggersEvents?appid=

This trigger event is used to get trigger event. API URL: https://arrowinteraction.azurewebsites.net+’/api/saveTriggersEvents?appid=’+appId+’’

Flow Management
PATCH /rest/bip/
DELETE /rest/bip/
GET /rest/bip?filter=app_id:
Update Flow
PATCH /rest/bip/

This URL is used to update the flow. URL:http://arrowflow.in+’/rest/bip/’ + flow.id, flow

Delete Flow
DELETE /rest/bip/

This URL is used to Delete the flow. URL:http://arrowflow.in+’/rest/bip/’ + processId

Examples

{method: "DELETE", transformRequest: Array(1), transformResponse: Array(1), paramSerializer: ƒ, url: "http://arrowflow.in/rest/bip/f87b75bf-f72e-48db-988c-193bda8f3cfb",}
Get Flow List
GET /rest/bip?filter=app_id:

This URL is used to get the flow list URL:http://arrowflow.in+"/rest/bip?filter=app_id:" + appId

Responses

200 OK
Body
application/json
Object
app_id
string
Example:
"59d385763800f371008b456b"
binder
string
Example:
[]
config
string
Example:
{auth: "none"}
coordinates
string
Example:
{b570d114-d7f3-42c2-b64c-1342bccab06f: {…}, source: {…}}
created
string
Example:
1529471605000
domain_id
string
Example:
"e17b4646-fbfe-43df-85a5-5ecc86b8301a"
end_life
string
Example:
{action: "pause", time: 0, imp: 0}
hub
string
Example:
{source: {…}}
icon
string
Example:
""
id
string
Example:
"4426d697-a387-4237-93af-0e1994213af8"
name
string
Example:
"sendMessaTest"
note
string
Example:
"via localhost"
paused
string
Example:
false
Cricket Module
Series
POST /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
POST /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
SaveSeries
POST /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_series’

Request parameters

resource
string optional

In this resource appid,createdate etc… parameters are included

appid
string optional

seriesObject.appid

createdate
string optional

seriesObject.createdate

seriesname
string optional

seriesObject.seriesname

seriestypeid
string optional

seriesObject.seriestypeid

tagid
string optional

seriesObject.tagid

Delete Series
DELETE /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_series/’ + _id

Save Series Season
POST /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_seriers_season’

Request parameters

resource
string required

In this resource appid,createdate etc… parameters are included.

appid
string optional

seriesSeasonObject.appid

createdate
string optional

seriesSeasonObject.createdate

tagid
string optional

seriesSeasonObject.tagid

seriesId
string optional

seriesSeasonObject.seriesId

seriesseasonname
string optional

seriesSeasonObject.seriesseasonname

startdate
string optional

seriesSeasonObject.startdate

enddate
string optional

seriesSeasonObject.enddate

season
string optional

seriesSeasonObject.season

Delete Series Season
DELETE /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_seriers_season/’ + _id

Match Schedule
GET /api/v2/ecommercedb
GET /api/v2/ecommercedb
GET /api/v2/ecommercedb
Schedule Match List
GET /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_liveupdate?filter=app_id%3D’ + appId

Get Schedule Match For Live
GET /api/v2/ecommercedb

Get The Shedule for Live Match URL: http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/matchschedule?filter=(app_id%20%3D%20’ + appId + ‘)%20and%20(date%20%3D%20’ + date + ‘)’

Team API
GET /api/v2/ecommercedb
Team List
GET /api/v2/ecommercedb

Team List URL:http://dream.arrowai.com/api/v2/ecommercedb+ ‘/_proc/getCurrentTeam(’ + appId + ‘)’

Stadium
GET /api/v2/ecommercedb
POST /api/v2/ecommercedb
POST /api/v2/ecommercedb
PATCH /api/v2/ecommercedb
PATCH /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
Save Stadium
POST /api/v2/ecommercedb

Request parameters

resource
string required

In this resource app_id ,location etc… parameters are included.

app_id
string optional

finalObject.app_id

location
string optional

finalObject.location

stadium_id
string optional

finalObject.stadium_id

stadium_name
string optional

finalObject.stadium_name

image
string optional

finalObject.filename

stadum_short_name
string optional

finalObject.stadum_short_name

Save Stadium Feature
POST /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb+’/_table/tbl_stadium_feature

Request parameters

resource
string required

In tis resource app_id,stadium_id etc… parameters are included.

app_id
string optional

finalObject.app_id

stadium_id
string optional

finalObject.stadium_id

feature
string optional

finalObject.stadium_feature

description
string optional

finalObject.description

image
string optional

finalObject.filename

create_date
string optional

finalObject.create_date

Update Stadium Feature
PATCH /api/v2/ecommercedb

Request parameters

resource
string required

In tis resouce id, app_id etc… parameters are included.

id
string optional
app_id
string optional

finalObject.app_id

stadium_id
string optional

finalObject.stadium_id

feature
string optional

finalObject.stadium_feature

description
string optional

finalObject.description

image
string optional

finalObject.filename

create_date
string optional

finalObject.create_date

Update Stadium
PATCH /api/v2/ecommercedb

Request parameters

resource
string optional

In this resource id,app_id etc… prameters are included

id
string optional
app_id
string optional

finalObject.app_id

location
string optional

finalObject.location

stadium_id
string optional

finalObject.stadium_id

stadium_name
string optional

finalObject.stadium_name

image
string optional

finalObject.filename

stadum_short_name
string optional

finalObject.stadum_short_name

Delete Stadium Feature
Seats Information
POST /api/v2/ecommercedb
GET /api/v2/ecommercedb
DELETE /api/v2/ecommercedb
PATCH /api/v2/ecommercedb
Save Seat Info
POST /api/v2/ecommercedb

Request parameters

resource
string required

In tis resource app_id, seat_prize etc parameters are included.

app_id
string optional

finalObject.app_id

seat_prize
string optional

finalObject.seat_prize

seatcategory
string optional

finalObject.seatcategory

stadiumname
string optional

finalObject.stadiumname

terrace
string optional

finalObject.terrace

total_seat
string optional

finalObject.total_seat

zone
string optional

finalObject.zone

Delete Seat Info
DELETE /api/v2/ecommercedb
Update seat info
Match Score
GET /api.datasportsgroup.com/clients/expc/cricket/get_ball_by_ball?type=match&id=777115&client=expc&authkey=hgifwhoewjfpfjhwief823r8723782hgfbwif
GET /api/v2/ecommercedb
Get Match Score
GET /api.datasportsgroup.com/clients/expc/cricket/get_ball_by_ball?type=match&id=777115&client=expc&authkey=hgifwhoewjfpfjhwief823r8723782hgfbwif
Get data from ball by ball
GET /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/tbl_ball_by_ball?filter=(match_id%3D%22’ + matchid + ‘%22)&limit=20&order=id%20desc’

RCB
GET /api/get-schedule2017.json
GET /api/get-rcb-team.json
GET /api/get-rcb-management.json
POST /api/v2/ecommercedb
POST /api/v2/ecommercedb
Match List from RCB
GET /api/get-schedule2017.json
Get RCB team
Get RCB Management
Save Rcb Match
POST /api/v2/ecommercedb

URL:http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/matchschedule’, data

Save Rcb Team Member
POST /api/v2/ecommercedb

URL.http://dream.arrowai.com/api/v2/ecommercedb + ‘/_table/table_member’, data

Contest Engine
Quiz API
POST /api/v2/ecommercedb
save Quiz
POST /api/v2/ecommercedb

Request parameters

resource
string required

In this resource app_id,questions etc… are included

app_id
string optional

finalObject.app_id

question
string optional

finalObject.question

quiz_id
string optional

finalObject.quiz_id

tbl_quiz_ans_by_quizid
string optional

finalObject.tbl_quiz_ans_by_quizid