Skip to main content

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 (Using Template) API-v2

Use this API to create an SMS campaign using a predefined message template.
MethodPOST
Endpointhttps://{{host}}/campaign/api/v2/public/{{streamId}}/campaign?accountId={{accountId}}\&campaignType=sms
Content-Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeCampaign Management

​
Path Parameters

ParameterDescriptionType
hostEnvironment URL, for example, https://platform.kore.aistring, required
streamIdBot ID or Stream ID. You can get it from the general settings page.string, required

​
Query Parameters

ParameterDescriptionType
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 'accountid: 67777ce93e25326494exxxxx' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \
--data '{
    "name": "Billing Alert Template Campaign-21",
    "description": "Uses a pre-approved message template to alert customers about pending bills. Includes dynamic fields for customer name, due date, and bill amount",
    "contactLists": [
        "CL Only 2020 Dec 4"
    ],
    "dncLists": {
        "name": "testdnc"
    },
    "campaignType": "sms",
    "priority": "5",
    "format": "simple",
    "message": {
        "template_name": "Welcome",
        "message": "VGhpcyBpcyBhIHJlbWluZGVyIHRoYXQgeW91ciBwYXltZW50IGlzIGR1ZSBzb29uLiBQbGVhc2UgY29tcGxldGUgdGhlIHBheW1lbnQgb24gdGltZSB0byBhdm9pZCBhbnkgc2VydmljZSBpbnRlcnJ1cHRpb24uIFZpc2l0IHlvdXIgYWNjb3VudCB0byBwYXkgbm93Lg%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
    }
}'

​
Headers

HeaderDescriptionRequired/Optional
authJWT token for authentication.required
iidThe Application Id.required
accountIdThe Account Id.required

​
Body Parameters

ParameterDescriptionType
nameName of the SMS campaign. Used for identification and reporting. Max 48 characters.string, required
descriptionDescription of the campaign’s purpose. Helpful for internal reference. Max 256 characters.string, required
contactListsList of contact list names that will receive the message. Must already exist. At least one required.array of strings, 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. 'simple' = plain template without personalization logic.string, required
message.template_nameName of the pre-approved message template to use.string, required
message.messageBase64-encoded message body to be sent. Should match the registered template body exactly.string (Base64), required
dialingStrategy.callerId.phoneNumberSender phone number or ID used to send SMS. Must be approved and linked to your SMS provider.string, required
dialingStrategy.callingHours.frequencyFrequency of calling hours. Allowed values: 'WEEKLY', 'DAILY', 'CUSTOM'.string, required
dialingStrategy.callingHours.timezoneTimezone used to interpret calling hours. Example: "Asia/Kolkata".string, required
dialingStrategy.callingHours.daysList of day/time ranges when messaging is allowed. Each object includes: day, start (for example, “9:00 AM”), end (for example, “6:00 PM”). Multiple blocks allowed.array of objects, required

​
Sample Response

{
    "status": "success",
    "message": "Campaign Billing Alert Template Campaign-21 creation in progress",
    "data": {
        "_id": "cd-99f05887-5638-59ef-90d9-5dc9ebdxxxxx",
        "name": "Billing Alert Template Campaign-21",
        "lname": "billing alert template campaign-21",
        "description": "Uses a pre-approved message template to alert customers about pending bills. Includes dynamic fields for customer name, due date, and bill amount",
        "status": "Ready",
        "dncLists": {
            "name": "testdnc"
        },
        "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": {
            "template_name": "Welcome",
            "message": "R3JlZXRpbmdzLCA8Rmlyc3QgTmFtZT4hIFdlJ3JlIHRocmlsbGVkIHRvIGhhdmUgeW91IGpvaW4gdXMuIEFjY2VzcyBvdXIgdG9wIHRocmVlIGJlZ2lubmVyJ3MgdGlwcyBieSBjbGlja2luZyBvbiB0aGlzIGxpbms6IGh0dHBzOi8veW91cndlYnNpdGUuY29tL3RpcHMuIElmIHlvdSBoYXZlIGFueSBpbnF1aXJpZXMsIGRvbid0IGhlc2l0YXRlIHRvIHNlbmQgdXMgYSByZXBseSByaWdodCBoZXJxxxxx",
            "templateId": "cmt-88fcd16f-bdb2-4d4d-8a2c-0324c7fxxxxx"
        },
        "isImported": false,
        "isFiltersEnabled": false,
        "createdAt": "2025-12-05T08:08:45.668Z",
        "updatedAt": "2025-12-05T08:08:57.490Z",
        "schedule": {
            "isSchedulingEnabled": false
        },
        "contactLists": [
            "CL Only 2020 Dec 4"
        ],
        "format": "simple"
    }
}

​
Response Parameters

ParameterDescriptionType
_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: 5string
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