INinfobip
customer-engagement
conversations
bots

Get bot

Use this method to get a bot. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#connect-external-bots-self-service-automation" target="_blank">More info</a>

get/ccaas/1/bots/{botId}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

botIdstring required

Id of the Bot to get.

Response

OK

displayNamestring required

Bot name to be displayed.

webhookUrlstring

Webhook url the message will be forwarded to.

destinationstring required

Bot destination phone number, FB messenger ID or live chat widget ID.

enabledboolean

Bot enable/disable toggle.

messagePersistencePolicy'PERSIST_ALL' | 'PERSIST_NONE'

Message persistence policy. If set to PERSIST_NONE, messages exchanged between customers and bot will not be persisted to the database nor visible to agents once they take over the conversation.

channel'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'UNKNOWN' | 'EMAIL' | 'LIVE_CHAT' | 'UNUSED' | 'VOICE' | 'VIDEO' | 'APPLE_BUSINESS_CHAT' | 'LINE' | 'GOOGLE_BUSINESS_MESSAGES' | 'TELEGRAM' | 'CALLS' | 'INTERNAL' | 'VIBER_BOT' | 'FACEBOOK_POST' | 'INSTAGRAM_POST' | 'TWITTER_POST' | 'INSTAGRAM_MESSAGING' | 'GOOGLE_PLAY' | 'KAKAO_SANGDAM' | 'TWITTER_DM' | 'WHATSAPP_CALLS' | 'VIBER_CALLS' | 'OPEN_CHANNEL' | 'TIKTOK' | 'ZALO' required
sessionTimeoutInSecinteger

Time elapsed from last client message, after which conversation will be closed. If not set, conversation will be closed after 24 hours.

webhookHeadersobject
webhookEventUrlstring
webhookEventHeadersobject
idstring

Example response

{
  "displayName": "My Whatsapp Bot",
  "webhookUrl": "www.webhookurl.com/link1",
  "destination": "447492263897",
  "channel": "WHATSAPP",
  "messagePersistencePolicy": "PERSIST_ALL",
  "enabled": true,
  "sessionTimeoutInSec": 120
}

Changes

No recorded changes to this operation across all 1 revision of this API.