customer-engagement

conversations

templates

Get template

Use this method to get a single template. <a href="https://www.infobip.com/docs/conversations-api/templates" target="_blank">More info</a>

get/ccaas/1/templates/{templateId}

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

templateIdstring required

Id of the template to get.

Response

OK

idstring

Template id.

namestring

Template name.

languagestring

Language used when constructing template content.

languageCodestring

Language code used when constructing template content.

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' | 'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'LIVE_CHAT' | 'LINE' | 'APPLE_BUSINESS_CHAT' | 'TELEGRAM' | 'INSTAGRAM_MESSAGING' | 'KAKAO_SANGDAM' | 'VIBER_BOT' | 'EMAIL'

Available communication channels

externalboolean

Boolean flag that indicates whether the template is external, WhatsApp pre-registered, or internal user-defined. If the flag is true, then the template is WhatsApp pre-registered, otherwise, it is user-defined.

contentType'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'UNKNOWN' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'WA_BUTTON_FEEDBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'MEDIA_TEMPLATE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_QUICK_REPLY' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'SUGGESTION_RESPONSE' | 'ABC_MULTI_TYPE' | 'FOLLOW' | 'UNFOLLOW' | 'CALL' | 'EMAIL' | 'CARD' | 'CAROUSEL' | 'TEXT_WITH_SUGGESTION' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'VIBER_BOT_STICKER' | 'WHATSAPP_STICKER' | 'VIBER_BOT_CAROUSEL' | 'VIBER_BOT_EVENT' | 'VIBER_BOT_VIDEO' | 'VIBER_BOT_FILE' | 'URL' | 'LC_CAROUSEL' | 'INSTAGRAM_STICKER' | 'CALL_START' | 'CALL_HANGUP' | 'CALL_TRANSCRIPT' | 'CALL_FILE' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'APPLE_PAY_RESPONSE' | 'AUTHENTICATION_RESPONSE' | 'CLOSE_CONVERSATION' | 'BUTTON_LIST' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INSTAGRAM_TEMPLATE' | 'SHARE' | 'STORY_MENTION' | 'CUSTOM_INTERACTIVE_RESPONSE' | 'INTERACTIVE' | 'INTERACTIVE_LIST_REPLY' | 'INTERACTIVE_BUTTON_REPLY' | 'LC_FORM_RESPONSE' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'QUICK_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'WHATSAPP_TEXT_WITH_ADDITIONAL_DATA' | 'ORDER' | 'TELEGRAM_CONTACT' | 'FORM_RESPONSE' | 'LINE_TEMPLATE' | 'APPLE_FORM_CONTENT' | 'LINE_POSTBACK_EVENT' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'LINE_STICKER' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'BUNDLE' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'LIVE_CHAT_BUTTON' | 'TEXT_WITH_RATING' | 'EMPTY' | 'JSON' | 'ROADSIDE_ASSISTANCE' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY' | 'TIKTOK_SHARE_POST' | 'TIKTOK_REFERRAL_SHORT_LINK' | 'TIKTOK_REFERRAL_AD' | 'ZALO_GIF' | 'RCS_TEXT_WITH_PDF' | 'APPLE_MEDIA_CONTENT' | 'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_FORM_RESPONSE' | 'LC_QUICK_REPLY' | 'LC_CAROUSEL' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'ABC_MULTI_TYPE' | 'CARD' | 'SUGGESTION_RESPONSE' | 'CAROUSEL' | 'LINE_TEMPLATE' | 'TEXT_WITH_SUGGESTION' | 'EMAIL' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'WHATSAPP_STICKER' | 'VIBER_STICKER' | 'INSTAGRAM_STICKER' | 'INSTAGRAM_TEMPLATE' | 'CALL_FILE' | 'CALL_TRANSCRIPT' | 'CALL_HANGUP' | 'CALL_START' | 'ABC_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'QUICK_REPLY' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'BUTTON_LIST' | 'SHARE' | 'INTERACTIVE' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INTERACTIVE_BUTTON_REPLY' | 'INTERACTIVE_LIST_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'APPLE_FORM_CONTENT' | 'ROADSIDE_ASSISTANCE' | 'FORM_RESPONSE' | 'ORDER' | 'LINE_POSTBACK_EVENT' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY'

Content type

contentobject

Template content.

createdAtstring date-time

Timestamp when template was created.

updatedAtstring date-time

Timestamp when template was updated.

senderstring

Example response

{
  "id": "c4391685-b21a-4c21-a470-5453e9382752",
  "name": "Template name",
  "language": "English",
  "languageCode": "en",
  "channel": "SMS",
  "external": false,
  "content": "Simple text content",
  "createdAt": "2024-01-01T00:00:00.000+00:00",
  "updatedAt": "2024-01-01T00:00:00.000+00:00",
  "tags": [
    {
      "name": "Template tag",
      "createdAt": "2024-12-10T00:00:00.000+00:00",
      "updatedAt": "2024-12-10T00:00:00.000+00:00"
    }
  ],
  "attachments": []
}

Changes

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