---
title: "Get an RCS template"
method: GET
path: "/rcs/template/{template_id}"
tags: ["RCS Templates"]
---

# Get an RCS template

`GET /rcs/template/{template_id}`

## Request

- Base URL: `https://rcs-api.in.kaleyra.io/v1/XXXXX6913850XXXX`
- URL: `https://rcs-api.in.kaleyra.io/v1/XXXXX6913850XXXX/rcs/template/{template_id}`
- Auth: none declared. Required headers: `Content-Type`, `api-key`

## Path parameters

- `template_id` string, required

## Headers

- `Content-Type` 'application/json', required
- `api-key` string, required

## Response `200`

RCS Template details fetched successfully.

- GetTemplateResponse
  - `code` string
  - `message` string
  - `data` GetTemplateData
    - `template_id` string: Autogenerated template identification number.
    - `regions` string[]: Region for which the template was created.
    - `created_date` integer: Date when the template was created.
    - `agent_number` string: ID generated by Google during agent creation.
    - `template_type` '1' | '3' | '4' | '5': Template type. 1 is Text, 3 is File, 4 is Rich Card Standalone, and 5 is Rich Card Carousel.
    - `template_name` string: Unique template name.
    - `text` string: Text message in the template when applicable.
    - `status` 'DRAFT' | 'CREATED' | 'SUBMITTEDFORAPPROVAL' | 'ACTIVE' | 'FAILED' | 'DELETED': Template status. DRAFT can be edited. CREATED can be edited until ACTIVE. SUBMITTEDFORAPPROVAL indicates submission to the carrier. ACTIVE templates can be used for messaging and cannot be edited. FAILED and DELETED are documented workflow states.
    - `template_number` string: Unique identification number for the template.
    - `contentMessage` ContentMessage: Interactive content of the RCS message.
      - `suggestions` Suggestion[]: Suggestion chip list.
        - `action` Action
          - `text` string: Text displayed for the action.
          - `postback_data` string: Information received after the action is completed.
          - `shareLocationAction` object: Action to share the user's location in latitude and longitude.
          - `dial_action` DialAction
            - `phone_number` string: Phone number using which end users can contact you.
          - `open_url_action` OpenUrlAction
            - `url` string, uri: URL to open.
            - `application` string: Application in which the URL is opened.
            - `webview_view_mode` string: Webview display mode.
        - `reply` Reply
          - `text` string: Reply text.
          - `postback_data` string: Postback data.
          - `button_id` string: Button identifier.
    - `file` File
      - `file_url` string, uri: URL of the file to be sent.
      - `thumbnail_url` string, uri: URL of the thumbnail for the file.
      - `content_description` string: Description for the URL file.
      - `force_refresh` boolean: Indicates whether the media should be force refreshed.
    - `rich_card_standalone` RichCardStandalone
      - `card_orientation` 'VERTICAL' | 'HORIZONTAL': Card orientation. Can be VERTICAL or HORIZONTAL.
      - `thumbnail_image_alignment` 'LEFT' | 'RIGHT': Card alignment. Can be LEFT or RIGHT.
      - `content` RichCardContent
        - `title` string: Title of the card.
        - `description` string: Description of the card relevant to the title.
        - `media` Media
          - `height` 'SHORT' | 'MEDIUM' | 'TALL': Height of media file. Can be SHORT, MEDIUM, or TALL.
          - `file` File
            - `file_url` string, uri: URL of the file to be sent.
            - `thumbnail_url` string, uri: URL of the thumbnail for the file.
            - `content_description` string: Description for the URL file.
            - `force_refresh` boolean: Indicates whether the media should be force refreshed.
        - `suggestions` Suggestion[]: Suggestion chip list.
          - `action` Action
            - `text` string: Text displayed for the action.
            - `postback_data` string: Information received after the action is completed.
            - `shareLocationAction` object: Action to share the user's location in latitude and longitude.
            - `dial_action` DialAction
              - …
            - `open_url_action` OpenUrlAction
              - …
          - `reply` Reply
            - `text` string: Reply text.
            - `postback_data` string: Postback data.
            - `button_id` string: Button identifier.
    - `rich_card_carousel` RichCardCarousel
      - `card_width` 'SMALL' | 'MEDIUM': Width of cards in the carousel.
      - `card_contents` RichCardCarouselContent[]: List of cards in the carousel.
        - `title` string: Title of the card.
        - `description` string: Description of the card.
        - `media` Media
          - `height` 'SHORT' | 'MEDIUM' | 'TALL': Height of media file. Can be SHORT, MEDIUM, or TALL.
          - `file` File
            - `file_url` string, uri: URL of the file to be sent.
            - `thumbnail_url` string, uri: URL of the thumbnail for the file.
            - `content_description` string: Description for the URL file.
            - `force_refresh` boolean: Indicates whether the media should be force refreshed.
        - `suggestions` CarouselSuggestion[]: Suggestions associated with the card.
          - `reply` Reply
            - `text` string: Reply text.
            - `postback_data` string: Postback data.
            - `button_id` string: Button identifier.
  - `error` object

## Other responses

- `400`: RCS Channel is not enabled for this User.
- `500`: Internal Gateway Error.

---

[API](https://skmtc.dev/kaleyra/apis/kaleyra-rcs-template-api.md) - [All operations](https://skmtc.dev/kaleyra/apis/kaleyra-rcs-template-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kaleyra/apis/kaleyra-rcs-template-api/revisions/996348f423f0?raw)