Template APIs

Template Preview API

Retrieve detailed preview information for a specific RCS template. This endpoint returns template content, status, orientation, alignment, and all suggestion details.

get/rcs/template/preview

Request

Base URL
https://soipapi.netcorecloud.com
URL
https://soipapi.netcorecloud.com/rcs/template/preview
Auth
HTTP bearer

Query parameters

template_idinteger required

Example:9753

The ID of the template to preview.

Headers

api_keystring required

Example:a3f1d5e792bc4e8aa6785c9d12f30b44

Enter your API key for authentication.

Content-Typestring required

Example:application/json

Must be set to application/json.

nc_bot_idstring

Example:abc123

Optional bot ID. If not provided, the default bot configured on your panel will be used. You can locate the nc_bot_id in the General Settings on the CPaaS >> Bot ID.

Response

Successfully fetched template preview data.

{
    "status": "success",
    "message": "Data fetched successfully",
    "template_id": 9753,
    "data": {
        "template_name": "test_half",
        "template_type": "text_message",
        "template_status": "auto-approved",
        "template_content": "Hello welocme to netcore",
        "orientation": "",
        "alignment": "",
        "height": "",
        "width": "",
        "suggestion_details": [
            {
                "suggestion_type": "2",
                "suggestion": "{\"displayText\":\"Visit half\",\"postback\":\"Visit half\",\"url\":\"https://www.netcorecloud.com/\",\"webview\":\"Half\"}"
            },
            {
                "suggestion_type": "1",
                "suggestion": "{\"displayText\":\"Click here\",\"postback\":\"Click here\"}"
            },
            {
                "suggestion_type": "8",
                "suggestion": "{\"displayText\":\"Visit Tall\",\"postback\":\"Visit Tall\",\"url\":\"https://www.netcorecloud.com\",\"domain\":\"https://qa.nctrckg.com\",\"suggestionAttr\":\"[button_3_url]\",\"webview\":\"Tall\"}"
            },
            {
                "suggestion_type": "2",
                "suggestion": "{\"displayText\":\"Visit Full\",\"postback\":\"Visit Full\",\"url\":\"https://www.abcccccc.com/\",\"webview\":\"Full\"}"
            },
            {
                "suggestion_type": "2",
                "suggestion": "{\"displayText\":\"Visit Default\",\"postback\":\"Visit Default\",\"url\":\"https://www.netcorecloud.com/\"}"
            },
            {
                "suggestion_type": "4",
                "suggestion": "{\"displayText\":\"Get Location\",\"postback\":\"Get Location\",\"latitude\":\"23.455\",\"longitude\":\"54.566\",\"label\":\"Netcore\"}"
            }
        ],
        "created_date": "2025-11-07 18:41:08",
        "updated_date": "2025-11-07 18:45:00"
    }
}

statusstring

Response status

messagestring

Response message

template_idinteger

The ID of the template

Example response

{
  "status": "success",
  "message": "Data fetched successfully",
  "template_id": 9753,
  "data": {
    "template_name": "test_half",
    "template_type": "text_message",
    "template_status": "auto-approved",
    "template_content": "Hello welocme to netcore",
    "suggestion_details": [
      {
        "suggestion_type": "2",
        "suggestion": "{\"displayText\":\"Visit half\",\"postback\":\"Visit half\",\"url\":\"https://www.netcorecloud.com/\",\"webview\":\"Half\"}"
      }
    ],
    "created_date": "2025-11-07 18:41:08",
    "updated_date": "2025-11-07 18:45:00"
  }
}

Changes

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