Microsoft Kaizala (Preview)

Microsoft Kaizala (Preview)

Microsoft Kaizala is a mobile app that helps you connect with your entire mobile workforce and supply chain, organize and allocate tasks more efficiently with built-in and custom Actions, and get actionable information and insights to accelerate decision-making.

Actions

Add an existing group as subgroup

This operation allows you to add an existing group as subgroup to another group.

Required Parameters

Group
string
Select a Group on which action will be performed.

Optional Parameters

Sub-group
string
Subgroup.

Add user to group

This operation allows you to add a user to a group.

Required Parameters

Group
string
Select a Group on which action will be performed.
Members
string
List of mobile numbers (for e.g. +911234567890,+912345678901 which needs to be added.)

Create a group

This operation allows you to create a Kaizala group.

Required Parameters

Group Name
string
Name of the group to be created.
Welcome Message
string
Enter a welcome message for the members of a group.

Optional Parameters

Members
string
Add members (for e.g. +911234567890,+916810870005) to the created group.
Group Type
string
Select the type of group.
Short Description
string
Enter a short description for the group.
Long Description
string
Enter a long description for the group.

Returns

Create a subgroup

This operation allows creation of a subgroup within a group.

Required Parameters

Group
string
Select a Group on which action will be performed.
Group Name
string
Name of the group to be created.
Welcome Message
string
Enter a welcome message for the members of a group.

Optional Parameters

Members
string
Add members (for e.g. +911234567890,+916810870005) to the created group.
Group Type
string
Select the type of group.
Short Description
string
Enter a short description for the group.
Long Description
string
Enter a long description for the group.

Remove a subgroup from group

This operation allows you to remove a subgroup as member of another group.

Required Parameters

Group
string
Select a Group on which action will be performed.
Sub-group Identifier
string
Enter an identifier for the sub-group.

Remove user from a group

This operation allows you to remove a user from a group.

Required Parameters

Group
string
Select a Group on which action will be performed.
Select a member
string

Send action on a group

This operation allows you to send an Action to a specific Kaizala group that you’re a member of.

Required Parameters

Group
string
Select a Group on which action will be performed.
request
dynamic
Send Action Request.

Optional Parameters

Action
string
Select Action type.
Action Package
string
Select an action package.

Returns

Send text message to a group

This operation allows you to send a text message to a specific Kaizala group that you’re a member of.

Required Parameters

Group
string
Select a Group on which action will be performed.
Message
string
Enter a text message.

Optional Parameters

Subscribers
string
Enter Mobile numbers with country code (for e.g. +911234567890,+916810870005)

Returns

Upload a media file

This operation allows you to upload a media file and generates MediaResource which can be used in other APIs to send data.

Required Parameters

File Content
file
The media should be in multipart form.

Returns

Upload media from url

This operation allows you to upload the given media from URL and generates MediaResource which can be used in other APIs to send data.

Required Parameters

Media url
string
Url of the media file.

Returns

Triggers

When a custom action is sent in a group

This operation is triggered when someone creates a custom action on a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a group is added as a member to a group

This operation is triggered when someone adds a subgroup to a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a group is removed as a member to a group

This operation is triggered when someone removes a subgroup from a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a member is added to a group

This operation is triggered when someone adds a member to a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a member is removed from a group

This operation is triggered when someone removes a member from a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a survey is sent in a group

This operation is triggered when a survey is created on a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When a text message is sent on a group

This operation is triggered when someone sends a text message on a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

When someone responds to a custom action

This operation is triggered when someone responds to a custom action posted on a group.

Required Parameters

Group
string
Select a group.
Action Package
string
Select an action package.
Action
string
Select a custom action.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

The outputs of this operation are dynamic.

When someone responds to a survey

This operation is triggered when someone responds to an existing survey posted on a group.

Required Parameters

Group
string
Select a group.
Survey
string
Select a survey.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

The outputs of this operation are dynamic.

When there is an announcement sent in a group

This operation is triggered when someone sends an announcement action to a group.

Required Parameters

Group
string
Select a group.

Optional Parameters

Callback Token
string
Callback Context
string
Validity
integer

Returns

Definitions

SendMessageResponse

Reference Id
string
Reference Id.

SendActionResponse

Action instance Id
string
Action instance Id. It can be used to query responses using Get Action Details.
Reference Id
string
Reference Id.

CreateGroupResponse

Group Id
string
Group identifier of the created group.

UploadMediaResponse

Media Resource
string
Media Resource Identifier which can be used to send media (as attachment) to other apis.

AnnouncementSchema

Description
string
Description of the announcement
Medias
string
List of Media urls and filenames
Sender Mobile Number
string
Mobile number of the sender
Sender Name
string
Name of the sender
Sender Profile Picture Url
string
Profile picture url of the sender
Title
string
Title of the announcement

ActionCreatedSchema

Action Title
string
Title of the action
Creator Mobile Number
string
Mobile number of the creator
Creator Name
string
Name of the creator
Creator Profile Picture Url
string
Profile picture url of the creator
Questions
string
List of questions

GroupAddedSchema

Added By
string
Mobile number of the person
Added By
string
Name of the person
Creator Profile Picture url
string
Profile picture url of the creator
Subgroup Identifier
string
Identifier of the subgroup
Subgroup Name
string
Name of the subgroup
Subgroup Picture Url
string
Picture url of the subgroup
Subgroup Type
string
Type of the subgroup

GroupRemovedSchema

Creator Profile Picture url
string
Profile picture url of the creator
Removed By
string
Mobile number of the person
Removed By
string
Name of the person
Subgroup Identifier
string
Identifier of the subgroup
Subgroup Name
string
Name of the subgroup
Subgroup Picture url
string
Picture url of the subgroup
Subgroup Type
string
Type of the subgroup

MemberAddedSchema

Added By
string
Mobile number of the person
Added By
string
Name of the person
Creator Profile Picture url
string
Profile picture url of the creator
Member Mobile Number
string
Mobile number of the member
Member Name
string
Name of the member
Member Profile Picture url
string
Profile picture url of the member
Membership Type
string
Type of membership

MemberRemovedSchema

Creator Profile Picture url
string
Profile picture url of the creator
Member Mobile Number
string
Mobile number of the member
Member Name
string
Name of the member
Member Profile Picture url
string
Profile picture url of the member
Membership Type
string
Type of membership
Removed By
string
Mobile number of the person
Removed By
string
Name of the person

SurveyCreatedSchema

Creator Mobile Number
string
Mobile number of the creator
Creator Name
string
Name of the creator
Creator Profile Picture url
string
Profile picture url of the creator
Questions
string
List of questions
Survey Title
string
Title of the survey

TextMessageCreatedSchema

Creator Mobile Number
string
Mobile number of the creator
Creator Name
string
Name of the creator
Creator Profile Picture url
string
Profile picture url of the creator
Text Message
string
Text of the message

Limits

Name Calls Renewal Period
API calls per connection10060 seconds