Developers
HomeContact us
  • Overview
    • SMS / Overview
    • VOICE / Overview
  • SMS
    • SMS Transactional - API
      • Overview
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Attributes
      • Code Snippet Example
      • Review more methods for your integrations
    • Create a Group - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Attributes
      • Response
      • Response Attributes
    • List Group of Contacts - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Response
      • Response Attributes
    • Add New contacts to existing group - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Request Attributes
      • Response
      • Response Attributes
      • Note:
    • Delete contacts to existing group - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Request Attributes
      • Response
      • Response Attributes
    • Delete groups by ID - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Response
    • API Send SMS Bulk with an existing Group - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Request Attributes
      • Response body
      • Response Attributes
    • Send SMS Bulk without contacts - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Request Attributes
      • Response body
      • Response Attributes
    • Get campaign by ID - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Response body
      • Response Attributes
    • Get campaign by filters - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Response body
      • Request Attributes
      • Response
      • Response Attributes
    • Update scheduled campaign - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Request Body
      • Request Attributes
      • Response
      • Note
    • Cancel scheduled campaign - API
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Response
      • Note
    • Error Codes
  • VOICE
    • VOICE TRANSACTIONAL API
      • Overview
      • API Endpoint
      • Available HTTP methods
        • Status Codes
      • Headers
      • Attributes
      • Code Snippet Example
      • Review more methods for your integrations
Powered by GitBook
On this page
  1. SMS
  2. Get campaign by ID - API

Response Attributes

CampaignID

String

Campaign ID

CampaignName

String

Campaign name

Status

String

Name of the current campaign

status (Ongoing, Scheduled, Closing, Completed, Canceled).

CampaignTotalCost

Double

Campaign cost value

Countries

Array

Name of the countries to which

the campaigns are sent.

Prefixes

Array

Arrangements of numbers with the

prefix of the countries to which the campaigns are sent.

Message

String

Base message that was sent in the

campaign.

TotalMessages

Int

Number of contacts to whom the

campaign was sent.

MessageParts

Int

Number of parts of the base

message.

CreationDate

String

Campaign creation date (UTC 0).

Schedules

Array

Arrangement of objects with the

campaign schedule.

Percentage

Int

Percentage of campaign messages

sent.

DateScheduled

String

Date the campaign was sent (UTC

0).

StartRow

Double

Start of messages for the phase.

EndRow

Double

End of messages for the phase.

Last updated 1 year ago