Skip to main content

SMS campaign model

You can send SMS and get statistics of your campaigns through API.

Properties​

AttributesTypeDescription
idintegerA unique identifier for the campaign which is given by User.com automatically.
created_atstringA creation date of a campaign.
descriptionstringA description of the SMS campaign.
etastringA datetime when a campaign should be sent. If not provided, the campaign will be sent right away.
finished_atstringA finish date of a campaign.
namestringA SMS campaign name.
phone_numberstringA phone number where SMS will be sent
recipientsobjectA list of user_ids.
recipients_countintegerA number of recipients.
started_atstringA date when SMS campaign started.
statusintegerA status of your campaign (1 - draft, 2 - active, 3 - finished, 4- archived).
typeintegerA type of SMS campaign (1 - simple, 2 - automated).
updated_atstringA date of last campaign update.