GetCampaignResult

GET

Get Campaign Result

After you have successfully created a Campaign, this will allow you to Return results of your created campaign. The result can be accessed based on the campaign identifier given upon campaign creation.

 

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/{campaignId}/result

 

 

Request Headers

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

 

 

Path Parameter

Name Description
campaignId*
string
Campaign identifier. The value is generated upon campaign creation.

 

 

Response

Result of the successful request contains following information:

Name Description
success
boolean
Return true if success.
name
string
Campaign name
description
string
Campaign description
categoryId
integer

Campaign category identifier.

campaignId
string
The campaign ID from Blinke API.
smsQty
integer
Total number of sms to distribute in this campaign.
smsSuccess
integer
Total number of sms that has been successfully delivered in this campaign.
smsFailed
integer
Total number of sms that has been failed to distribute in this campaign.
status
string
The status of created campaign. The status can be Completed, Rejected, Stopped, Published or Expired.
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.
channelId
string
Channel identifier that generated upon campaign creation.
smsSuccess
integer
Total number of sms that has been successfully delivered in this channel.
smsFailed
integer
Total number of sms that has been failed to distribute in this channel.

 

 

Response (Example)

HTTP Code Response
200
{
    "success": true,
    "name": "IWIC DEV Event",
    "description": "IWIC DEV Event",
    "categoryId": 21,
    "status": "Expired",
    "campaignId": "IWICA3AE",
    "smsQty": 3000,
    "smsSuccess": 1500,
    "smsFailed": 1500,
    "channels": [
        {
            "sender": "IWIC2017",
            "locationId": 89,
            "smsQty": 1000,
            "message": "Hello Indosat users in KPPTI, welcome to IWIC",
            "startDate": "2017-11-30T10:00:00.000+07:00",
            "endDate": "2017-12-31T23:59:59.000+07:00",
            "telcoId": "isat",
            "channelId": "IWIC8910-01",
            "smsSuccess": 500,
            "smsFailed": 500
        },
        {
            "sender": "IWIC2017",
            "locationId": 416,
            "smsQty": 1000,
            "message": "Hello Indosat user in GI - West Mall, welcome to IWIC",
            "startDate": "2017-11-30T10:00:00.000+07:00",
            "endDate": "2017-12-31T23:59:59.000+07:00",
            "telcoId": "isat",
            "channelId": "IWIC8910-02",
            "smsSuccess": 500,
            "smsFailed": 500
        },
        {
            "sender": "IWIC2017",
            "locationId": 167,
            "smsQty": 1000,
            "message": "Hello Indosat user in GI - East Mall, welcome to IWIC",
            "startDate": "2017-11-30T10:00:00.000+07:00",
            "endDate": "2017-12-31T23:59:59.000+07:00",
            "telcoId": "isat",
            "channelId": "IWIC8910-02",
            "smsSuccess": 500,
            "smsFailed": 500
        }
    ]
}
400
{
    "success": false,
    "error": {
        "code": "G-404001",
        "message": "Cannot find campaign or you are not authorized"
    }
}

Depending on the request, other error code may occurs.

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

Resource URL

https://blinke-stage.apigee.net /lba/campaign/{lba_campaign_id}/result

Header Parameters


Name Values Description
Content-Type
(required)

The content-type should be in json format

Authorization
(required)

Bearer access_token

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

Working...