Skip to content

Get Campaign Status API

Retrieves the current status of a specific campaign using its campaign ID. Use this API to check whether a campaign is active, stopped, or in another state.

Method POST
Endpoint https://{{host}}/agentassist/api/v1/public/{{streamId}}/campaign/{{CampaignId}}/status?accountId={{accountId}}&view=status
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
streamIId 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
view Value must be status to retrieve status only. string, optional

Sample Request

curl --location --request POST 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/campaign/{{CampaignId}}/status?accountId={{accountId}}&view=status' \
--header 'auth: <token>'

Sample Response

{
    "status": "success",
    "data": {
        "id": "cd-0e0475b-a418-400d-9164-21eb7e89xxxx",
        "status": "Stopped",
        "name": "Voice From API- With Preview Dialing Mode- 2"
    }
}

Response Body Parameters

Parameter Description Type
status API call result. Value: "success" or "failure". string
data.id Campaign ID. string
data.status Current campaign status (for example, Active, Stopped). string
data.name The campaign name. string