Template APIs

Fetch Template API

Fetch your approved RCS templates. Apply query parameters to refine results. No request body is required.

get/template

Request

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

Query parameters

statusstring

Filter templates by status (e.g., approved).

limitstring

Set the number of templates to return.

exclude_typestring

Exclude templates of a specific type (e.g., rich_card).

template_typestring

Filter templates by type (e.g., carousel).

offsetstring

Skip a specific number of records before fetching results.

namestring

Search for a template by name.

Headers

api_keystring required

Example:a3f1d5e792bc4e8aa6785c9d12f30b44

Enter your API key for authentication.

Content-Typestring required

Set this to application/json.

nc_bot_idstring

Example:abc123

Optional bot ID. If not provided, the default bot configured on your panel will be used.

Response

Successfully fetched template data.

{
   "status":"success",
   "message":"Data fetched successfully",
   "client_id":<CLIENT_ID>,
   "data":{
      "bot_id":"<BOT_ID>",
      "bot_type":"Promotional",
      "bot_name":"Netcore Cloud promotional",
      "templates":[
         {
            "template_id":<TEMPLATE_ID>,
            "template_name":"<TEMPLATE_NAME>",
            "template_type":"carousel",
            "template_status":"approved",
            "display_template_type":"Rich card carousel",
            "created_at":"2024-04-24 17:13:09",
            "modified_at":"2024-04-24 17:13:09"
         }
      ],
      "total_rows":1
   }
}

No templates found:

{
   "status":"success",
   "message":"No data found",
   "client_id":77865,
   "data":{
      "templates":[],
      "total_rows":0
   }
}

Changes

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