CreateCampaign

POST

Create Campaign

Creating a Campaign is the starting point when you are ready to optimize through Advertising using the LBA channel. This API allows the developer to start Creating a campaign.

 

To create a campaign, every request must pass in the access_token value in the header. For more information on how to generate your access_token, please refer to this section.

 

 

Request

Method URL
GET https://blinke-stage.apigee.net/lba/campaign

 

 

Request Headers

Name Description Mandatory
Authorization Bearer access_token Yes
Content-Type application/json Yes

 

 

Request Body

Request body is a JSON formatted text containing the following fields:

Name Description
name*
string
Campaign name
description*
string
Campaign description
categoryId*
integer

Campaign category identifier. The valid category id is listed as follows:

  • 3 : Arts & Entertainment
  • 4 : Automotive
  • 5 : Business
  • 6 : Careers
  • 7 : Education
  • 8 : Family & Parenting
  • 9 : Health & Fitness
  • 10 : Food & Drinks
  • 11 : Hooby & Interest
  • 12 : Home & Garden
  • 13 : Law, Gov't & Politics
  • 14 : News
  • 15 : Personal Finance
  • 16 : Society
  • 17 : Science
  • 18 : Pets
  • 19 : Sports
  • 20 : Style & Fashion
  • 21 : Technology & Computing
  • 22 : Travel
  • 23 : Real Estate
  • 24 : Shopping
  • 25 : Relligion and Spirituality
  • 26 : Uncategorized
channels*
array
An array of channel information

 

channels[]* struct A single lba channel information

 

sender*
string
Message sender information. This will be provided upon successful registration as partner in production environment.
locationId*
integer
The location where channel will distribute the message.
smsQty*
integer
The number of sms lba to distribute in this channel.
message*
string
The message content to distribute in the channel.
startDate*
string
The string represents date/time when the channel starts distributing message. Date time must be in ISO 8601 format.
endDate*
string
The string represents date/time when the channel stops distributing message. Date time must be in ISO 8601 format.
telcoId*
string
Telco provider to distribute the message. The valid telco id is listed as follows:

  • isat : Indosat Ooredoo
  • xl : XL
  • tsel : Telkomsel

 

 

Response

Result of the successful request contains following information:

Name Description
success
boolean
Return true if success.
message
string
The message information if the request has been successfully processed.
campaignId
string
The campaign ID from Blinke API.
channels
array
An array contains unique identifier for each channel created in the campaign.
status
string
The status of published campaign. If the campaign is successfully published, the value is "Published".

 

 

Response (Example)

HTTP Code Response
200
{
    "campaignId": "IWIC7BBC",
    "success": true,
    "message": "Campaign has been successfully created.",
    "channels": [
        "IWIC7BBC-01",
        "IWIC7BBC-02",
        "IWIC7BBC-03"
    ],
    "status": "Published"
}
400
{
    "success": false,
    "error": {
        "code": "G-400003",
        "message": "Unable to create campaign due to incomplete / invalid data."
    }
}

Depending on the request, other error code may occurs.

401
{
    "fault": {
        "faultstring": "Invalid Access Token",
        "detail": {
            "errorcode": "keymanagement.service.invalid_access_token"
        }
    }
}

 

 

Sandbox limitation
  • The sandbox environment will not be able to send the message to designated channel.
  • Please use the following json to be used as request body in sandbox environment:
    {
    	"name": "I-WIC DEV Event",
    	"description": "I-WIC DEV Event",
    	"categoryId": 21,
    	"channels": [
    		{
    			"sender": "IWIC2017",
    			"locationId": 89,
    			"smsQty": 1000,
    			"message": "Hello Indosat users in KPPTI, welcome to I-WIC",
    			"startDate": "2017-11-30T10:00:00.000+07:00",
    			"endDate": "2017-12-31T23:59:59.000+07:00",
    			"telcoId": "isat"
    		},
    		{
    			"sender": "IWIC2017",
    			"locationId": 416,
    			"smsQty": 1000,
    			"message": "Hello Indosat user in GI - West Mall, wlcome to I-WIC",
    			"startDate": "2017-11-30T10:00:00.000+07:00",
    			"endDate": "2017-12-31T23:59:59.000+07:00",
    			"telcoId": "isat"
    		},
    		{
    			"sender": "IWIC2017",
    			"locationId": 167,
    			"smsQty": 1000,
    			"message": "Hello Indosat user in GI - East Mall, welcome to I-WIC",
    			"startDate": "2017-11-30T10:00:00.000+07:00",
    			"endDate": "2017-12-31T23:59:59.000+07:00",
    			"telcoId": "isat"
    		}
    	]
    } 
    

Resource URL

https://blinke-stage.apigee.net /lba/campaign

Header Parameters


Name Values Description
Content-Type
(required)

The content-type should be in json format

Authorization
(required)

Bearer access_token

Body Parameters


Name Values Description
Content

This is the main content

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Working...