Azure Bot Service

Name: Azure Bot Service API
Brand: Azure Bot Service
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsChat Messagingoauth227 EndpointsREST

For Agents

Provision Azure bot resources and manage their channels, OAuth connections, and enterprise channels through the Microsoft.BotService control plane. Supports 27 endpoints across bots, channels, connections, and enterprise infrastructure.

Connect the Azure Bot Service to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Azure Bot Service, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Azure Bot Service API.

Create and update Azure bot resources under Microsoft.BotService/botServices

Configure bot OAuth connections to third-party identity providers like AAD, Google, or Facebook

Provision enterprise channel resources for high-scale, dedicated bot infrastructure

GET STARTED

Start building with Azure Bot Service API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Azure Bot Service, keeping it validated and agent-ready.

The Azure Bot Service control-plane API provisions and manages bot resources, channels, connections, and enterprise channel infrastructure. It exposes 27 endpoints for creating Microsoft.BotService/botServices resources, registering channels such as Teams, Slack, Webchat, and Email, and configuring OAuth bot connections to third-party identity providers. It also covers enterprise channels for high-scale deployments and name-availability checks needed during onboarding.

Use Cases

Patterns agents use Azure Bot Service API for, with concrete tasks.

★ Provision a Teams Customer Support Bot

Create an Azure bot resource and attach a Microsoft Teams channel so a conversational support agent can be installed in tenant-wide Teams clients. The Bot Service API exposes Bots_Create plus a channels endpoint that accepts MsTeamsChannel configuration in a single PUT. End-to-end provisioning from name check to channel registration usually takes minutes from an automation script.

Check name availability for 'acme-support-bot', PUT a botService resource to rg-bots, then PUT an MsTeamsChannel on that bot with isEnabled=true.

Multi-Channel Bot Rollout

Roll a single bot out across Teams, Slack, Web Chat, and Email channels by issuing the same Bots_CreateOrUpdate call followed by a series of channel registrations. Each channel resource has a typed properties block (e.g. SlackChannel requires clientId, clientSecret, signingSecret) so agents can compose the full surface deterministically. Typical multi-channel deployments take under an hour with the API versus a half-day in the portal.

For bot 'orders-bot' in rg-bots, register MsTeamsChannel, SlackChannel with the provided OAuth credentials, and WebChatChannel with siteName='public-site' via successive PUT calls.

Bot OAuth Connection Setup

Configure an OAuth connection on a bot so users can sign in to a downstream service such as Microsoft Graph or Salesforce inside the conversation. The BotConnection_ListServiceProviders endpoint returns supported providers and their parameter schemas, and a follow-up PUT creates the connection with clientId, clientSecret, scopes, and provider name. Once configured, the bot framework exchanges tokens for the user automatically.

List available auth service providers, then PUT an OAuth connection on bot 'graph-bot' with serviceProviderName=Aadv2 and the configured clientId, clientSecret, and scopes.

Agent-Driven Bot Lifecycle Management

A Jentic agent enumerates every bot in a tenant via Bots_List, prunes channels that are no longer used, and updates messaging endpoints when an underlying compute resource moves. The agent operates across the same 27 endpoints in this spec, replacing manual Azure portal visits with a search-load-execute workflow that scales across many subscriptions.

List all bots in subscription 1111-2222, find any with disabled WebChatChannel resources, and delete those channels via the channels DELETE endpoint.

Key Endpoints

27 endpoints — the azure bot service control-plane api provisions and manages bot resources, channels, connections, and enterprise channel infrastructure.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices

List bots in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices

List bots in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}

Get a single bot resource

POST

/providers/Microsoft.BotService/checkNameAvailability

Check whether a bot name is available

POST

/providers/Microsoft.BotService/checkEnterpriseChannelNameAvailability

Check enterprise channel name availability

POST

/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders

List supported auth service providers for bot OAuth connections

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}

Delete a bot resource

GET

/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices

List bots in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices

List bots in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}

Get a single bot resource

POST

/providers/Microsoft.BotService/checkNameAvailability

Check whether a bot name is available

POST

/providers/Microsoft.BotService/checkEnterpriseChannelNameAvailability

Check enterprise channel name availability

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure AD service principal credentials are stored encrypted in the Jentic MAXsystem vault. Channel-level secrets such as Slack signing secrets can be stored alongside, and the agent receives short-lived bearer tokens at execution time, so neither AAD nor channel credentials enter the prompt.

Intent-based discovery

Agents search Jentic by intent (e.g. "register teams channel on azure bot") and Jentic returns the matching Microsoft.BotService operation with its full request schema, including the channel-specific properties block.

Time to first call

Direct integration: 2-3 days for AAD setup, channel-specific schema modelling, and Bots_CreateOrUpdate polling. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Cognitive Services Management

Manages Cognitive Services accounts that bots call for language understanding and QnA.

Use when the agent needs to provision the AI accounts the bot uses for natural language processing.

Complementary

QnA Maker Runtime

Runtime knowledge-base lookups that bots invoke to answer user questions.

Use alongside this API when the bot's responses come from a curated QnA knowledge base.

Alternative

Twilio Messaging

Programmable messaging and voice platform for SMS, WhatsApp, and IVR-driven bots.

Choose Twilio when the conversational surface is SMS, WhatsApp, or PSTN voice rather than Teams or Slack.

FAQs

Specific to using Azure Bot Service API through Jentic.

What authentication does the Azure Bot Service API use?

Azure Active Directory OAuth 2.0 via the azure_auth scheme (user_impersonation scope) against https://management.azure.com/. Jentic stores the AAD app credentials in the MAXsystem vault and supplies the agent with a scoped bearer token at runtime, never the secret itself.

Can I register a Slack channel on an Azure bot with this API?

Yes. PUT a SlackChannel resource under /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/SlackChannel with the Slack clientId, clientSecret, and signingSecret in the properties block.

What are the rate limits for the Azure Bot Service API?

It shares Azure Resource Manager subscription throttling, typically 12,000 reads and 1,200 writes per hour per subscription. Channel registration calls are also bound by per-channel constraints documented separately for Teams, Slack, and WebChat.

How do I create a bot with a Teams channel through Jentic?

Search Jentic for "create azure bot with teams channel", load the schemas for Bots_Create and the channels CreateOrUpdate operation with channelName=MsTeamsChannel, and execute them in sequence with your subscriptionId, resourceGroupName, and resource name. Sign up at https://app.jentic.com/sign-up.

Does this API send messages to users?

No. This is the control plane for provisioning bot resources and channels. Conversational message exchange uses the Bot Framework data plane (Direct Line, channel adapters) running against the bot's messaging endpoint.

What is the difference between channels and enterprise channels?

Channels bind a bot to a public messaging surface like Teams or Slack and run on shared Azure infrastructure. Enterprise channels are dedicated, isolated channel infrastructure provisioned via the enterpriseChannels endpoints in this API for high-scale or compliance-sensitive deployments.