Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
Get Campaign
curl --request GET \
  --url https://api.sigmamind.ai/v1/campaigns/{campaignId} \
  --header 'X-API-Key: <api-key>'
{
  "campaignId": "camp-XiQEBcj9cc5TFRB4",
  "campaignName": "My Campaign",
  "campaignStatus": "live",
  "scheduledDate": "2023-11-07T05:31:56Z",
  "concurrentCalls": 5,
  "agent": {
    "name": "Demo Agent",
    "agentId": "mJzLaPEo425lieb9",
    "status": "Testing"
  },
  "phoneNumber": {
    "sipPhoneNumber": "+14155552671",
    "provider": "twilio",
    "inboundAgentId": "D5D0p7TUs66TTAEAx",
    "outboundAgentId": "D5D0p7TUs66TTAEAx",
    "outboundPhoneNumber": "+14155552671",
    "active": true,
    "terminationSipURI": "sip.telnyx.com",
    "friendlyName": "Support Line - US"
  },
  "errors": [
    "<string>"
  ],
  "scheduled": true
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Path Parameters

​
campaignId
string
required

A unique identifier assigned to the campaign.

Response

OK

​
campaignId
string

A unique identifier assigned to the campaign.

Example:

"camp-XiQEBcj9cc5TFRB4"

​
campaignName
string

The name given to the campaign for reference or display purposes.

Example:

"My Campaign"

​
campaignStatus
enum<string>

Indicates the current status of the campaign.

Available options:
live, scheduled, paused, completed
Example:

"live"

​
scheduledDate
string<date-time>

The scheduled date and time when the campaign is set to launch

​
concurrentCalls
integer<int32>

Specifies the maximum number of outbound calls allowed to be active simultaneously within the campaign.

Example:

5

​
agent
object

Assigned agent for current campaign

Example:
{
  "name": "Demo Agent",
  "agentId": "mJzLaPEo425lieb9",
  "status": "Testing"
}
​
phoneNumber
object
​
errors
string[]
​
scheduled
boolean