Campaign API
integerstringstringstringstringintegerintegerstringintegerstringstringstringstringintegerintegerstringstring · requiredstring · requiredstringstring · date-timeintegerstringstringnumber · floatstringnumber · floatstringnumber · floatintegerinteger
Schemas
CAMPAIGN_SCHEDULE
campaignIdID of the campaign
Example: 1
campaignNameName of the campaign
messageMessage for the campaign
balancesenderNameSender name for the campaign
totalPhoneNumbersTotal phones
deliveredPhoneNumbersTotal delivered phones
statusobject
CAMPAIGN_SCHEDULES
campaignIdID of the campaign
Example: 1
campaignNameName of the campaign
messageMessage for the campaign
balancesenderNameSender name for the campaign
totalPhoneNumbersTotal phones
deliveredPhoneNumbersTotal delivered phones
statusobject
CAMPAIGN_SCHEDULE_FORM
campaignNameName of the campaign
message- 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- 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.
deliveryDateDelivery date for the campaign
Example: 2023-03-31T15:05:00.00+07:00
OK
campaignIdID of the campaign
audienceTypeType of audience for the campaign
campaignNameName of the campaign
balancePerMessageBalance per message for the campaign
messageMessage for the campaign
remainBalanceRemaining balance
senderNameSender name for the campaign
object
Total balance by country for the campaign
object
Total phones by country for the campaign
totalBalanceTotal total of balance for the campaign
totalPhoneTotal number of phones for the campaign
totalRowsTotal number of rows for the campaign