Sending Campaigns

Learn how to send campaigns using our JSON API.

If your service provider is already integrated with Mobivate SMS, you should be able to configure your API Key on their platform and this should enable you to send SMS directly from the 3rd Party software.

The API Key, you can find on our portal under the User Profile section.

If your service provider is not already integrated, you can ask them to do so. It should only take them few minutes to complete the integration using this simple API:

Request URL

https://api.mobivatebulksms.com:443/send/campaign?api_key={API_Key which you provide to them}

Content Type

application/json

Post Data (raw)

{
  "scheduleDateTime" : "2022-04-23T12:00:00.996+0200",
  "routeId" : "mglobal",
  "excludeOptouts" : true,
  "excludeDuplicates" : false,
  "spreadHours" : 3,
  "recipients" : [
   {
    "reference" : "Testing",
    "text" : "Hello World",
    "routeId" : "mglobal",
    "originator" : "TEST",
    "recipient" : "447930000000",
    }
  ],
  "shortenUrls" : false,
  "name" : "Test Name",
}

Campaign Parameters:

Parameter	Required?	Description
scheduleDateTime	No	.A date/time parameter to be used if you want to schedule your request to be sent in the future. Must contain hours, minutes and seconds. Timezone follows the ISO 8601 time formatting.
routeId	Yes	Mobivate recommends using "mglobal", but other Route IDs are available. The route ID, can be specified in each recipient.
excludeOptouts	No	A true or false field indicating if you want to exclude OptOuts.
excludeDuplicates	No	A true or false field indicating if you want to exclude duplicate records.
spreadHours	No	An integer indicating how many hours you want to spread the messages across.
recipients	Yes	A list of Recipient Objects.
shortenUrls	No	A true/false field can be used to shorten URL's in the body text. Additional costs apply.
name	No	The campaign name.

Recipient Object Parameters:

Parameter	Required?	Description
reference	No	Individual message reference, if declared must be unique per recipient.
text	Yes	The text body of the message being sent.
routeId	No	Allows to override the routeID set on the campaign per recipient.
originator	Yes	11 alpha-numeric sender name or 15 digit number.
recipient	Yes	Recipient number, MSISDN / International number E.G. 447930000000.