Sending Messages To Subscribers (API)

This document aims to detail how to send a message to your subscribers via RESTFul api.

You can send standard messages to your subscribers via our RESTful API by making the following POST request:

Request

https://subscription-api.mobivate.com/subscriptions/v1/<campaign_id>/message

JSON Data

{
    "msisdn":"xxxxxxxxxxx"
    "keyword":"xxxxxxxx"
    "provider":"default"
    "cost":"100"
    "message":"Hello World"
    "signature":"xxxxxxxxxxxxxxxxxx"
}

Parameters

The only parameter required for the request is the message you want to send your subscribers.

Parameter	Description
msisdn	The unique MSISDN you are trying to unsubscribe.
keyword	Your unique Mobivate keyword.
provider	Network provider to use for the message. Can be either default or premium.
cost	The cost of the message to your subscriber, for example: 100.
message	Your message, for example: Hello World!
signature	Unique parameter consisting of three values: campaign_id, msisdn and account_id. For example: 1af289e14aa593c843da7cd869a8e2f7.

Successful response

If your user has been sent a message successfully you will receive the following response, HTTP Status Code 200:

{
  "authenticated" : True,
  "valid_msisdn" : True,
  "valid_campaign" : True,
  "campaign_status" : "active",
  "campaign_name" : "Test Campaign",
  "campaign_service" : "12345",
  "state" : "queued"
  "error" : Null,
  "reference": "AP:aaaaaaa-bbbbbbbbb-cccccccc"
}