Microsoft Azure

Azure Bot Service

Azure Bot Service is a platform for creating smart conversational agents.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Bot Service is a platform for creating smart conversational agents.

Endpoints 31

Bot

  • GETBots_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName?api-version=stringReturns a BotService specified by the parameters.
  • PUTBots_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName?api-version=stringCreates a Bot Service. Bot Service is a resource group wide resource type.
  • DELETEBots_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName?api-version=stringDeletes a Bot Service from the resource group.
  • PATCHBots_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName?api-version=stringUpdates a Bot Service
  • GETBots_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices?api-version=stringReturns all the resources of a particular type belonging to a resource group
  • GETBots_List/subscriptions/:subscriptionId/providers/Microsoft.BotService/botServices?api-version=stringReturns all the resources of a particular type belonging to a subscription.
  • POSTBots_GetCheckNameAvailability/providers/Microsoft.BotService/checkNameAvailability?api-version=stringCheck whether a bot name is available.

Channel

  • GETChannels_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName?api-version=stringReturns a BotService Channel registration specified by the parameters.
  • PUTChannels_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName?api-version=stringCreates a Channel registration for a Bot Service
  • DELETEChannels_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName?api-version=stringDeletes a Channel registration from a Bot Service
  • PATCHChannels_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName?api-version=stringUpdates a Channel registration for a Bot Service
  • POSTChannels_ListWithKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName/listChannelWithKeys?api-version=stringLists a Channel registration for a Bot Service including secrets
  • GETChannels_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels?api-version=stringReturns all the Channel registrations of a particular BotService resource
  • POSTDirectLine_RegenerateKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/channels/:channelName/regeneratekeys?api-version=stringRegenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource
  • POSTEmail_CreateSignInUrl/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/createEmailSignInUrl?api-version=stringCreates an email channel sign in url for a Bot Service

Operations

  • GETOperations_List/providers/Microsoft.BotService/operations?api-version=stringLists all the available BotService operations.

ListServiceProviders

  • POSTBotConnection_ListServiceProviders/subscriptions/:subscriptionId/providers/Microsoft.BotService/listAuthServiceProviders?api-version=stringLists the available Service Providers for creating Connection Settings

ListQnAMakerEndpointKeys

  • POSTQnAMakerEndpointKeys_Get/subscriptions/:subscriptionId/providers/Microsoft.BotService/listQnAMakerEndpointKeys?api-version=stringLists the QnA Maker endpoint keys

BotConnection

  • POSTBotConnection_ListWithSecrets/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections/:connectionName/listWithSecrets?api-version=stringGet a Connection Setting registration for a Bot Service
  • GETBotConnection_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections/:connectionName?api-version=stringGet a Connection Setting registration for a Bot Service
  • PUTBotConnection_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections/:connectionName?api-version=stringRegister a new Auth Connection for a Bot Service
  • DELETEBotConnection_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections/:connectionName?api-version=stringDeletes a Connection Setting registration for a Bot Service
  • PATCHBotConnection_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections/:connectionName?api-version=stringUpdates a Connection Setting registration for a Bot Service
  • GETBotConnection_ListByBotService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/connections?api-version=stringReturns all the Connection Settings registered to a particular BotService resource

BotHostSettings

  • GETHostSettings_Get/subscriptions/:subscriptionId/providers/Microsoft.BotService/hostSettings?api-version=stringGet per subscription settings needed to host bot in compute resource such as Azure App Service

OperationResults

  • GETOperationResults_Get/subscriptions/:subscriptionId/providers/Microsoft.BotService/operationresults/:operationResultId?api-version=stringGet the operation result for a long running operation.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/privateEndpointConnections?api-version=stringList all the private endpoint connections associated with the Bot.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringGets the specified private endpoint connection associated with the Bot.
  • PUTPrivateEndpointConnections_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringUpdate the state of specified private endpoint connection associated with the Bot.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDeletes the specified private endpoint connection associated with the Bot.

PrivateLinkResources

  • GETPrivateLinkResources_ListByBotResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName/privateLinkResources?api-version=stringGets the private link resources that need to be created for a Bot.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
31 operations on 20 pathsGET 13POST 7PUT 4DELETE 4PATCH 3
Main resources
Channel 8Bot 7BotConnection 6PrivateEndpointConnections 4BotHostSettings 1ListQnAMakerEndpointKeys 1ListServiceProviders 1OperationResults 1Operations 1PrivateLinkResources 1
Response formats
application/json
Description format
Swagger 2.0, API version 2022-09-15

How to test the Azure Bot Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Bot Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Bots_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BotService/botServices/:resourceName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Bot Service?

Azure Bot Service is a platform for creating smart conversational agents. It is listed under Developer tools and has 31 endpoints.

Who publishes the Azure Bot Service?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Bot Service?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Bot Service?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Bot Service have?

31 operations on 20 paths (13 GET, 7 POST, 4 PUT, 4 DELETE, 3 PATCH). The largest groups are Channel, Bot, BotConnection, PrivateEndpointConnections.

Is forking the Azure Bot Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.