Documentation Index Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Back to API List Create SMS Campaign (Without SMS Template) API - v2 Use this API to create an SMS campaign without a template.
Method POST Endpoint https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign?accountId={{accountId}}\&campaignType=smsContent-Type application/jsonAuthorization auth: {{JWT}} See How to generate the JWT Token .API Scope Campaign Management
Path Parameters Parameter Description Type hostEnvironment URL, for example, https://platform.kore.ai string, required streamIdBot ID or Stream ID. You can get it from the general settings page. string, required
Query Parameter Parameter Description Type campaignTypeType of Campaign. Use "sms" string, required
Sample Request curl --location 'https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign?accountId={{accountId}}&campaignType=sms' \ --header 'auth: <token>' \ --header 'Content-Type: application/json' \ --header 'accountid: 67777ce93e25326494exxxxx' \ --header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \ --data '{ "name": "Event Reminder SMS Campaign71", "description": "Sends a one-time message to remind users about an upcoming event. No template or personalization is used—just a plain, direct message.", "contactLists": [ "CL Only 2020 Dec 4" ], "dncLists": { "name": "DNC CL Dec 4" }, "campaignType": "sms", "priority": "5", "format": "simple", "message": { "message": "TWVzc2FnZSBmb3IgeW91ciB0YXJnZXRlZCBjdXN0b21lcg%xxxxx" }, "dialingStrategy": { "callerId": { "phoneNumber": "+9195616xxxxx" }, "callingHours": { "frequency": "WEEKLY", "timezone": "Asia/Kolkata", "days": [ { "day": "MO", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TU", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "WE", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TH", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "FR", "start": "9:00 AM", "end": "6:00 PM" } ] } }, "schedule": { "isSchedulingEnabled": false } }'
Header Description Required/Optional authJWT token for authentication. required iidThe Application Id. required accountIdThe Account Id. required
Body Parameters Parameter Description Type nameName of the SMS campaign. Used for identification and reporting. Max 48 characters. string, required descriptionCampaign description. Explains the purpose and behavior of the SMS blast. Max 256 characters. string, required contactListsList of contact list names to target. Each must exist in the system. At least one required. array[string], required data.dncListsContains the contact lists added under the Do Not Call (DNC) list. object, optional data.dncLists.nameThe name of the contact list included in the Do Not Call (DNC) list. string, optional campaignTypeType of campaign. Must be either 'voice' or 'sms'. string, required priorityCampaign priority. Higher values indicate higher execution priority. Allowed values: 1, 2, 3, 4, 5. string, required formatFormat of the SMS message. 'simple' or 'advanced' means plain text without personalization. string, required message.templateIdTemplate ID for message content. If empty, no template is used. string, optional message.messageActual message text sent to contacts. Must comply with telecom rules. string, required dialingStrategy.callerId.phoneNumberSender ID or SMS phone number. string, required dialingStrategy.callingHours.frequencyFrequency of calling hours. Allowed values: 'WEEKLY', 'DAILY', 'CUSTOM'. string, required dialingStrategy.callingHours.timezoneTimezone used to enforce messaging hours. string, required dialingStrategy.callingHours.daysTime blocks when messages can be sent. Each object includes: day, start (for example, “9:00 AM”), end (for example, “6:00 PM”). Multiple entries allowed. array[object], required
Sample Response { "status": "success", "message": "Campaign Event Reminder SMS Campaign71 creation in progress", "data": { "_id": "cd-964e76d3-2e70-51a5-bd47-b09b4d4xxxxx", "name": "Event Reminder SMS Campaign71", "lname": "event reminder sms campaign71", "description": "Sends a one-time message to remind users about an upcoming event. No template or personalization is used—just a plain, direct message.", "status": "Ready", "dncLists": { "name": "DNC CL Dec 4" }, "priority": "5", "dialingStrategy": { "callerId": { "phoneNumber": "+9195616xxxxx" }, "callingHours": { "frequency": "WEEKLY", "timezone": "Asia/Kolkata", "days": [ { "day": "MO", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TU", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "WE", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "TH", "start": "9:00 AM", "end": "6:00 PM" }, { "day": "FR", "start": "9:00 AM", "end": "6:00 PM" } ] } }, "message": { "message": "TWVzc2FnZSBmb3IgeW91ciB0YXJnZXRlZCBjdXN0b21lcg%xxxxx" }, "isImported": false, "isFiltersEnabled": false, "createdAt": "2025-12-05T08:05:51.709Z", "updatedAt": "2025-12-05T08:05:51.709Z", "schedule": { "isSchedulingEnabled": false }, "contactLists": [ "CL Only 2020 Dec 4" ] "format": "simple" } }
Response Parameters Parameter Description Type _idUnique identifier for the campaign. string nameCampaign name. string lnameLowercase version of campaign name. string descriptionCampaign description. string statusCurrent campaign status. For example: Ready. string data.dncListsContains the contact lists added under the Do Not Call (DNC) list. object data.dncLists.nameThe name of the contact list included in the Do Not Call (DNC) list. string priorityCampaign priority. For example: 5 string dialingStrategyDialing configuration for the campaign. object dialingStrategy.callerIdCaller ID configuration. object dialingStrategy.callerId.phoneNumberCaller phone number in E.164 format. string dialingStrategy.callingHoursAllowed calling hours. object dialingStrategy.callingHours.frequencyFrequency of calls. Example: WEEKLY. string dialingStrategy.callingHours.timezoneTime zone used for calling hours. string dialingStrategy.callingHours.daysList of daily calling windows. array dialingStrategy.callingHours.days.dayDay of the week (for example, MO, TU). string dialingStrategy.callingHours.days.startStart time (for example, 9:00 AM). string dialingStrategy.callingHours.days.endEnd time (for example, 6:00 PM). string messageContains the Base64-encoded SMS content. object message.messageBase64-encoded SMS message string. string totalMessagesSentCount of messages sent. integer directionCampaign format type. For example: simple. string createdAtCampaign creation timestamp in ISO format. string updatedAtLast update timestamp in ISO format. string scheduleScheduling settings for the campaign. object schedule.isSchedulingEnabledIndicates if scheduling is enabled for the campaign. boolean contactListsList of contact list names used in the campaign. array data.formatSpecifies the message format (for example, simple). string
