Movider API Reference
MoviderMoviderAPI Reference
  • API Reference
Schemas
powered by Zudoku
Campaign API
Campaign API

Schemas


ERR400

​object

ERR401

​object

ERR404

​object

ERR500

​object

CAMPAIGN_SCHEDULE

campaignId
​integer

ID of the campaign

Example: 1
campaignName
​string

Name of the campaign

message
​string

Message for the campaign

balance
​string
senderName
​string

Sender name for the campaign

totalPhoneNumbers
​integer

Total phones

deliveredPhoneNumbers
​integer

Total delivered phones

status
​string
​object

CAMPAIGN_SCHEDULES

​CAMPAIGN_SCHEDULE[]
CAMPAIGN_SCHEDULE
campaignId
​integer

ID of the campaign

Example: 1
campaignName
​string

Name of the campaign

message
​string

Message for the campaign

balance
​string
senderName
​string

Sender name for the campaign

totalPhoneNumbers
​integer

Total phones

deliveredPhoneNumbers
​integer

Total delivered phones

status
​string
​object

CAMPAIGN_SCHEDULE_FORM

campaignName
​string · required

Name of the campaign

message
​string · required
  • For trial accounts, you are unable to edit the body message or sender name. The system automatically sends a default message with a default sender. If you would like to customize both the message and sender name, please upgrade your account.
  • If you do not provide a sender name, or if the sender name does not match the one in your registration, the system will automatically send a default message with a default sender name. Please ensure that your sender name is correct before sending.
​object · required

Phone numbers for the campaign

senderName
​string
  • The "senderName" field indicates the sender name or brand name used for sending messages to the recipient.
  • If you do not fill a sender name or brand name in the "senderName" field, the system will automatically use the default sender name.
  • You can send SMS messages with your own customized sender name by registering it with Movider.
  • Please note that the "senderName" field is case-sensitive. Ensure the sender name matches the case (lowercase or uppercase) you registered with Movider.
deliveryDate
​string · date-time

Delivery date for the campaign

Example: 2023-03-31T15:05:00.00+07:00

OK

campaignId
​integer

ID of the campaign

audienceType
​string

Type of audience for the campaign

campaignName
​string

Name of the campaign

balancePerMessage
​number · float

Balance per message for the campaign

message
​string

Message for the campaign

remainBalance
​number · float

Remaining balance

senderName
​string

Sender name for the campaign

​object

Total balance by country for the campaign

​object

Total phones by country for the campaign

totalBalance
​number · float

Total total of balance for the campaign

totalPhone
​integer

Total number of phones for the campaign

totalRows
​integer

Total number of rows for the campaign

On this page
  • ERR400
  • ERR401
  • ERR404
  • ERR500
  • CAMPAIGN_SCHEDULE
  • CAMPAIGN_SCHEDULES
  • CAMPAIGN_SCHEDULE_FORM
  • OK