Start Voice Campaign API¶

Use this API to start an active Voice campaign for a given stream ID and campaign ID.

Method	POST
Endpoint	`https://{{host}}/campaign/api/v1/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}}&campaignType={{campaignType}}&trigger={{trigger}}`
Content-Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token
API Scope	Campaign Management

Path Parameters¶

Parameter	Description	Type
`host`	Environment URL, for example, https://platform.kore.ai	string, required
`streamId`	botId or streamId. You can access it from the General Settings page of the bot.	string, required
`campaignId`	Unique identifier of the campaign to trigger.	string, required

Query Parameters¶

Parameter	Description	Type
`accountId`	The unique ID associated with the account.	string, required
`campaignType`	Type of campaign. Use `"voice"` for voice campaign.	string, required
`trigger`	Action to perform. Use `"play"` to start.	string, required

Sample Request¶

curl --location 'https://{{host}}/campaign/api/v1/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}}&campaignType={{campaignType}}&trigger={{trigger}}' \
--header 'auth: <token>' \
--header 'Content-Type: application/json' \
--data '{}
'

Sample Response¶

{
    "status": "Active",
    "message": "Campaign Started",
    "totalCallsCompleted": 0,
    "updatedAt": "2025-06-27T07:01:45.416Z",
    "campaignInstanceId": "cid-dbb5e25-605e-4556-8912-9292181axxxx"
}

Response Body Parameters¶

Parameter	Description	Type
`status`	Indicates the current status of the campaign. For example, `Active`	string
`message`	Success confirmation message. For example, `Campaign Started`	string
`totalCallsCompleted`	Number of completed calls at the time of starting the campaign.	number
`updatedAt`	ISO timestamp when the campaign was activated.	string
`campaignInstanceId`	ID of the specific campaign instance that was started.	string

Send Feedback