Get Channel Settings

This endpoint will retrieve the current bot settings for a specific channel.

Settings calls are throttled at 1 call per bot per channel every 15 minutes. Trying to use this endpoint before the expired time will result in an error.

Request

The following request will publish a chatbot on the currently active channels

curl --location --request GET 'https://<SERVICE ENDPOINT>/bots/publish/channel/<providerid>' \
--header 'Authorization: Bearer <BOT_AUTH_TOKEN>' \
--header 'Content-Type: application/json'

the <providerid> value must be one of the available Xenioo channels in full signature value (e.g. Xenioo.Bots.Web.WebChannel) or simple common name (e.g. Web).

Full signature	Name
Xenioo.Bots.Alexa.AlexaChannel	Alexa
Xenioo.Bots.APIHook.APIHookChannel	APIHook
Xenioo.Bots.Discord.DiscordChannel	Discord
Xenioo.Bots.Facebook.FacebookChannel	Facebook
Xenioo.Bots.Genesys.GenesysChannel	Genesys
Xenioo.Bots.GoogleBusinessMessages.GBMChannel	Business Messages
Xenioo.Bots.Instagram.InstagramChannel	Instagram
Xenioo.Bots.MSTeams.MSTeamsChannel	Microsoft Teams
Xenioo.Bots.Phone.PhoneChannel	Phone
Xenioo.Bots.RCS.RCSChannel	RCS
Xenioo.Bots.Slack.SlackChannel	Slack
Xenioo.Bots.SMS.SMSChannel	SMS
Xenioo.Bots.Telegram.TelegramChannel	Telegram
Xenioo.Bots.Viber.ViberChannel	Viber
Xenioo.Bots.Web.WebChannel	Web
Xenioo.Bots.WhatsApp.WhatsAppChannel	WhatsApp

This request requires a specific API Integration flag that might not be enabled by default on your account.

Response

If successful, the request will return the selected channel channel configuration.

Please note that while the returned fields match the fields used in the Xenioo UI when configuring a channel, settings are considered as an external channel configuration and used as a raw string that only the final provider is supposed to parse as a complete model.

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code	Meaning
200	Ok. The request has been successfully fulfilled.
400	Bad Request
401	Unauthorized
404	Not Found. The specified chatbot has not been found or the requested channel is not enabled.