API Sample Request

Find all the Request samples for all the Netcore CPaaS APIs

Template API

Create Template

Text Template

curl --request POST \
     --url https://soipapi.netcorecloud.com/template/create \
     --header 'content-type: application/json' \
     --data @- <<EOF
{
  "action_type": "text_message",
  "payload": {
    "template_name": "text_message_demo",
    "rcs_type": "text_message",
    "template_content": "Time to go big or go home because it's India VS Australia FINALS!",
    "suggestions": [
      {
        "suggestionType": "reply",
        "displayText": "Click to Win",
        "postback": "click_to_win"
      },
      {
        "suggestionType": "url_action",
        "url": "https://brandx.onelink.me/",
        "displayText": "Answer and Win",
        "postback": "answer_and_win"
      },
      {
        "suggestionType": "dialer_action",
        "phoneNumber": "+919876543212",
        "displayText": "Call Now Fast",
        "postback": "call_now_fast"
      }
    ]
  }
}
EOF

Carousel Template

curl --request POST \
     --url https://soipapi.netcorecloud.com/template/create \
     --header 'content-type: application/json' \
     --data '
{
  "action_type": "carousel",
  "payload": {
    "card_width": "SMALL_WIDTH",
    "card_height": "SHORT_HEIGHT",
    "rcs_type": "carousel",
    "save_type": "add",
    "cards": [
      {
        "type": 1,
        "image_file": "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAAC...",
        "url": "https://i.postimg.cc/7h0pYnGQ/tree-736885...",
        "thumbnail_url": "https://i.postimg.cc/Vsg8TG61/tree-736885...",
        "thumbnail_file": "",
        "title": "Hi hello welocme",
        "description": "hey good welcome",
        "is_button": true,
        "suggestions": [
          {
            "suggestionType": "url_action",
            "url": "https://netcorecloud.com/",
            "displayText": "Answer and Win",
            "postback": "answer_and_win",
            "webview": "Full"
          },
          {
            "suggestionType": "share_location",
            "displayText": "Share Location",
            "postback": "share_location_postback"
          },
          {
            "suggestionType": "calendar_event",
            "startTime": "2025-12-07 14:30:00",
            "endTime": "2025-12-30 15:00:00",
            "title": "Team Sync-up Meeting",
            "description": "Monthly team sync-up meeting - Updated",
            "displayText": "Schedule Updated Meeting",
            "postback": "meeting_scheduled_updated"
          },
          {
            "suggestionType": "view_location_latlong",
            "latitude": 19.076,
            "longitude": 72.877,
            "label": "Mumbai Store",
            "displayText": "View Location",
            "postback": "view_location_postback"
          }
        ]
      },
      {
        "type": 1,
        "image_file": "",
        "url": "https://i.postimg.cc/7h0pYnGQ/tree-736885...",
        "thumbnail_url": "",
        "thumbnail_file": "",
        "title": "[TITLE]",
        "description": "Welcome",
        "is_button": true,
        "suggestions": [
          {
            "suggestionType": "dialer_action",
            "phoneNumber": "+919876543212",
            "displayText": "Call Now Fast",
            "postback": "call_now_fast"
          },
          {
            "suggestionType": "url_action",
            "url": "https://netcorecloud.com/",
            "displayText": "Answer and Win",
            "postback": "answer_and_win"
          }
        ]
      }
    ],
    "template_name": "test_temp_16"
  }
}
'

Rich Card Template

curl --request POST \
     --url https://soipapi.netcorecloud.com/template/create \
     --header 'content-type: application/json' \
     --data '
{
  "action_type": "rich_card",
  "payload": {
    "orientation": "VERTICAL",
    "alignment": "MEDIUM_HEIGHT",
    "type": 2,
    "rcs_type": "rich_card",
    "template_id": "pqNP",
    "save_type": "add",
    "title": "box8 offer",
    "image_file": "data:video/mp4",
    "url": "",
    "thumbnail_file": "",
    "thumbnail_url": "https://i.postimg.cc/Vsg8TG61/tree-736885-960-720-7-3.jpg",
    "description": "new description",
    "suggestions": [
      {
        "suggestionType": "reply",
        "cta_id": "",
        "displayText": "trgrtrtgtrgr",
        "postback": "trgrtrtgtrgr[custom_param]",
        "url": "",
        "phoneNumber": ""
      },
      {
        "suggestionType": "url_action",
        "cta_id": "",
        "displayText": "ergergergreg",
        "postback": "ergergergreg",
        "url": "https://www.google.com",
        "phoneNumber": ""
      },
      {
        "suggestionType": "dialer_action",
        "cta_id": "",
        "displayText": "gt4ff45g45g",
        "postback": "gt4ff45g45g",
        "url": "",
        "phoneNumber": "+917977772497"
      }
    ],
    "template_name": "video_demo45"
  }
}
'

Edit Template

Using File as URL

curl --request PUT \
     --url https://soipapi.netcorecloud.com/template/edit \
     --header 'content-type: application/json' \
     --data '
{
  "action_type": "carousel",
  "payload": {
    "card_width": "SMALL_WIDTH",
    "card_height": "SHORT_HEIGHT",
    "rcs_type": "carousel",
    "cards": [
      {
        "type": 1,
        "image_file": "",
        "url": "https://i.postimg.cc/7h0pYnGQ/tree-736885-960-720-2-1.gif",
        "thumbnail_url": "",
        "thumbnail_file": "",
        "title": "Sample Title 1",
        "description": "Sample Description 1",
        "suggestions": [
          {
            "suggestionType": "url_action",
            "displayText": "Visit Google",
            "postback": "Visit Google",
            "url": "https://www.google.com"
          }
        ]
      },
      {
        "type": 1,
        "image_file": "",
        "url": "https://i.postimg.cc/7h0pYnGQ/tree-736885-960-720-2-1.gif",
        "thumbnail_url": "",
        "thumbnail_file": "",
        "title": "Sample Title 2",
        "description": "Sample Description 2",
        "suggestions": [
          {
            "suggestionType": "reply",
            "displayText": "Reply Example",
            "postback": "Reply Example[custom_param]"
          }
        ]
      }
    ],
    "template_name": "carousel_template_example"
  }
}
'

Using Multiple Video Card File

curl --request PUT \
     --url https://soipapi.netcorecloud.com/template/edit \
     --header 'content-type: application/json' \
     --data '
{
  "action_type": "carousel",
  "payload": {
    "card_width": "SMALL_WIDTH",
    "card_height": "SHORT_HEIGHT",
    "rcs_type": "carousel",
    "cards": [
      {
        "type": 2,
        "image_file": "data:video/mp4;base64,<BASE64_VIDEO_STRING>",
        "url": "",
        "thumbnail_url": "https://i.postimg.cc/y6tQfV8p/tree-736885-960-720-2-1.jpg",
        "thumbnail_file": "",
        "title": "Sample Title 1",
        "description": "Sample Description 1",
        "suggestions": [
          {
            "suggestionType": "url_action",
            "displayText": "Visit Google",
            "postback": "Visit Google",
            "url": "https://www.google.com"
          }
        ]
      },
      {
        "type": 1,
        "image_file": "",
        "url": "https://i.postimg.cc/yxRHkhdD/dynamic.jpg",
        "thumbnail_url": "",
        "thumbnail_file": "",
        "title": "Sample Title 2",
        "description": "Sample Description 2",
        "suggestions": [
          {
            "suggestionType": "reply",
            "displayText": "Reply Example 1",
            "postback": "Reply Example 1[custom_param]"
          }
        ]
      },
      {
        "type": 1,
        "image_file": "",
        "url": "https://i.postimg.cc/yxRHkhdD/dynamic.jpg",
        "thumbnail_url": "",
        "thumbnail_file": "",
        "title": "Sample Title 3",
        "description": "Sample Description 3",
        "suggestions": [
          {
            "suggestionType": "reply",
            "displayText": "Reply Example 2",
            "postback": "Reply Example 2[custom_param]"
          }
        ]
      }
    ],
    "template_name": "carousel_combo9"
  }
}
'

Send Message API

RCS Text Message

curl --request POST \
     --url https://soipapi.netcorecloud.com/soip/rcs/v2/message \
     --header 'accept: application/json' \
     --header 'authorization: Bearer a3f1d5e792bc4e8aa6785c9d12f30b44' \
     --header 'content-type: application/json' \
     --data '
{
  "messages": [
    {
      "content": {
        "attributes": {
          "FIRSTNAME": "Akash"
        },
        "type": "template",
        "templateCode": "employee_campaign"
      },
      "tags": [
        "12"
      ],
      "to": "918983190458",
      "callbackData": "7890986"
    }
  ],
  "fallbackchain": [
    {
      "channel": "RCS"
    },
    {
      "from": "Travel agent",
      "channel": "SMS",
      "text": "Test Messages [FIRSTNAME] 😘🫣👿😻🤬 Netcore"
    }
  ]
}
'

Rich Card Message

curl --request POST \
     --url https://soipapi.netcorecloud.com/soip/rcs/v2/message \
     --header 'accept: application/json' \
     --header 'authorization: Bearer a3f1d5e792bc4e8aa6785c9d12f30b44' \
     --header 'content-type: application/json' \
     --data '
{
  "messages": [
    {
      "content": {
        "content": {
          "media": {
            "file": {
              "url": "https://m.media-amazon.com/images/G/01/AdProductsWebsite/images/AUX/sbv-hero._TTW_.jpg"
            },
            "thumbnail": {
              "url": "https://m.media-amazon.com/images/G/01/AdProductsWebsite/images/AUX/sbv-hero._TTW_.jpg"
            },
            "height": "MEDIUM"
          },
          "title": "Amazon Black Friday Sale 2021,",
          "description": "Online shopping for Black Friday Sale from a great selection at Electronics Store."
        },
        "orientation": "vertical",
        "alignment": "right",
        "type": "CARD"
      },
      "tags": [
        "asd",
        "sdfdf",
        "dfdf"
      ],
      "To": "919999999999",
      "callbackData": "Callback data"
    }
  ],
  "fallbackchain": [
    {
      "channel": "RCS"
    }
  ],
  "fallbackstatus": true
}
'

Carousel Message

curl --request POST \
     --url https://soipapi.netcorecloud.com/soip/rcs/v2/message \
     --header 'accept: application/json' \
     --header 'authorization: Bearer a3f1d5e792bc4e8aa6785c9d12f30b44' \
     --header 'content-type: application/json' \
     --data '
{
  "messages": [
    {
      "content": {
        "contents": [
          {
            "media": {
              "file": {
                "url": "https://v.fastcdn.co/u/014b5490/56308202-0-Personalization-P1-0.png"
              },
              "thumbnail": {
                "url": "https://media.istockphoto.com/photos/blurred-abstract-photo-of-light-burst-among-trees-and-glitter-golden-picture-id1061974964?b=1&k=20&m=1061974964&s=170667a&w=0&h=Ch21MBSBEZak9naxA3hHaI7qyPAjr_eEgiQBSNFtDsg="
              },
              "height": "MEDIUM"
            },
            "suggestions": [
              {
                "text": "Click Image",
                "postbackData": "imageClick",
                "type": "REPLY"
              },
              {
                "text": "Click to Call",
                "postbackData": "call",
                "phoneNumber": "385977666618",
                "type": "DIAL_PHONE"
              },
              {
                "text": "Map",
                "postbackData": "map",
                "latitude": 45.793418,
                "longitude": 15.946297,
                "label": "label",
                "type": "SHOW_LOCATION"
              },
              {
                "text": "Share",
                "postbackData": "share",
                "type": "REQUEST_LOCATION"
              }
            ],
            "title": "title,",
            "description": "description"
          },
          {
            "media": {
              "file": {
                "url": "https://v.fastcdn.co/u/014b5490/56308572-0-Email-arketing-First.png"
              },
              "thumbnail": {
                "url": "https://media.istockphoto.com/photos/blurred-abstract-photo-of-light-burst-among-trees-and-glitter-golden-picture-id1061974964?b=1&k=20&m=1061974964&s=170667a&w=0&h=Ch21MBSBEZak9naxA3hHaI7qyPAjr_eEgiQBSNFtDsg="
              },
              "height": "MEDIUM"
            },
            "suggestions": [
              {
                "text": "Click Image",
                "postbackData": "imageClick",
                "type": "REPLY"
              },
              {
                "text": "Click to Call",
                "postbackData": "call",
                "phoneNumber": "385977666618",
                "type": "DIAL_PHONE"
              },
              {
                "text": "Map",
                "postbackData": "map",
                "latitude": 45.793418,
                "longitude": 15.946297,
                "label": "label",
                "type": "SHOW_LOCATION"
              },
              {
                "text": "Share",
                "postbackData": "share",
                "type": "REQUEST_LOCATION"
              }
            ],
            "title": "title,",
            "description": "description"
          }
        ],
        "type": "CAROUSEL",
        "cardWidth": "MEDIUM"
      },
      "tags": [
        "asd",
        "sdfdf",
        "dfdf"
      ],
      "To": "919999999999",
      "callbackData": "Callback data"
    }
  ],
  "fallbackchain": [
    {
      "channel": "RCS"
    }
  ]
}
'