Adwise 4.5 REST API Documentation

Adwise API
Adwise API is a set of RESTful services that can be accessed from other applications to exchange data. Different types of Adwise entities like channels or
campaigns can be created or listed by calling the RESTful services with different HTTP-methods. The responses are always in JSON format.
General considerations
Base Path: http://<host>:<port>/adwise/services
Version history:
REST API version Adwise version
1.1 3.4 or later
Authentication
Each invocation of a service is done with user credentials. The user must have the necessary permissions required to use the service. These and other types of
information are passed by using query parameters as follows.
Definition
GET|POST|PUT|DELETE /<resource>?username={username}&password={password}&...
Arguments
Parameter type Name Data type Mandatory Description Notes
Query username String Yes Login name for the consumer of this resource, i.e. the calling system. Valid characters: [a-zA-Z0-9]
Query password String Yes Password for the consumer of this resource, i.e. the calling system. Valid characters: [a-zA-Z0-9]
Response
Content-type: application/json
The following response status codes can be returned by all resources.
HTTP status code Reason
200 Method successfully completed.
500 Internal server error (see error object for more information).
Errors, i.e. status codes 3xx, 4xx and 5xx, contain an error object with the following attributes:
Name Type Description Notes
errorCode Integer Unique code defining the type of error. -
errorMessage String Message describing the error. -

Example:
{
"errorCode": 5,
"errorMessage": "Resource advertisers with id \"8\" not found"
}
Resources
Advertisers
GET /advertisers
Fetches all advertisers, i.e. all advertisers connected to the user. Admin user returns all advertisers in the system.
Parameters
None.
Response
A list of advertisers of type Advertiser.
Example:
[
{
"id": 17,
"companyName": "TheCompany",
"description": "A description of TheCompany",
"createdDate": "2013-09-25T13:14:23+0200",
"contactAddress": "99th Company Street",
"contactName": "Bob Comp",
"contactTitle": "",
"contactEmail": "a@b.com",
"campaignIds": [
17, 34, 99
]
},
...
]
Status codes
200 List of advertisers is successfully fetched.

GET /advertisers/{advertiserId}
Fetches an advertiser by its {advertiserId} .
Parameters
Path advertiserId Integer Yes Id of advertiser to fetch. -
Response
Advertiser of type Advertiser.
Example:
{
"id": 17,
"createdDate": "2013-09-25T13:14:23+0200",
"contactTitle": "",
"campaignIds": [
17, 34, 99
]
}
Status codes
200 Advertiser is successfully fetched.
401 (3) No permission for user to fetch advertiser.
404 (5) Advertiser not found.
POST /advertisers
Creates a new advertiser. Only administrators can create advertisers.
Parameters
An advertiser of type Advertiser.
Example:
{
"companyName": "MaxDonalds",
"description": "A description of MaxDonalds",
"contactAddress": "17th Maxy Street",
"contactName": "Ronald MaxDonald",
"contactTitle": "",
"contactEmail": "a@b.com"
}
Response
Created advertiser of type Advertiser.
Example:
{
"id": 104,
"createdDate": "2013-09-25T13:14:23+0200",
"contactTitle": "",
"campaignIds": []
}
Status codes
200 Advertiser is successfully created.
400 (1) Missing parameter.
400 (8) Parameter value is too long.
401 (3) No permission for user to create advertiser.
409 (9) Advertiser already exists.
PUT /advertisers/{advertiserId}
Updates an existing advertiser by its {advertiserId} . Only administrators can update advertisers.
Parameters
Path advertiserId Integer Yes Id of advertiser to update. -
An advertiser of type Advertiser. Only companyName , description , contactAddress , contactName , contactTitle and contactEmail
are updateable.
Example:
{
"contactTitle": "",
"contactEmail": "a@b.com"
}
Response
Updated advertiser of type Advertiser.
Example:
{
"id": 17,
"createdDate": "2013-09-25T13:14:23+0200",
"contactTitle": "",
"campaignIds": [
17, 34, 99
]
}
Status codes
200 Advertiser is successfully updated.
401 (3) No permission for user to update advertiser.
DELETE /advertisers/{advertiserId}
Removes an advertiser by its {advertiserId} . Only administrators can remove advertisers. In order to be removed, an advertiser
must not contain any connected campaigns (i.e. campaignIds -list must be empty) or all connected channels are marked as
DELETED nor any connected dp users with advertiser.
Parameters
Path advertiserId Integer Yes Id of advertiser to remove. -
Response
true if advertiser is successfully removed, otherwise false .
Example
true
Status codes
200 Advertiser is successfully removed.
401 (3) No permission for user to remove campaign.
403 (16) Advertiser must not contain any campaigns.
Campaigns
GET /campaigns
Fetches all campaigns, i.e. all campaigns that belong to the advertisers connected to the user. Admin user returns all campaigns
in the system.
Parameters
None.
Response
A list of campaigns of type Campaign.
Example:
[
{
"id": 108,
"campaignName": "My first campaign",
"description": "My first campaign created via the API",
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"additionalNotes": "Lorem ipsum ....",
"channelIds": [
17, 34, 99
]
},
...
]
Status codes
200 List of campaigns is successfully fetched.
GET /campaigns/{campaignId}
Fetches a campaign by its {campaignId} .
Parameters
Path campaignId Integer Yes Id of campaign to fetch. -
Response
Campaign of type Campaign.
Example:
{
"id": 108,
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"channelIds": [
17, 34, 99
]
}
Status codes
200 Campaign is successfully fetched.
401 (3) No permission for user to fetch campaign.
404 (5) Campaign not found.
POST /campaigns
Creates a new campaign. Only administrators are allowed to create campaigns belonging to any advertiser (i.e. advertiserId set
to -1). Non-administrators can only create campaigns for its own advertiser.
Parameters
A campaign of type Campaign.
Example:
{
"externalId": "",
"advertiserId": 7,
"additionalNotes": "Lorem ipsum ...."
}
Response
Created campaign of type Campaign.
Example:
{
"id": 108,
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"channelIds": [
]
}
Status codes
200 Campaign is successfully created.

401 (3) No permission for user to create campaign.
409 (9) Campaign already exists.
PUT /campaigns/{campaignId}
Updates an existing campaign by its {campaignId} .
Parameters
Path campaignId Integer Yes Id of campaign to update. -
A campaign of type Campaign. Only campaignName , description , referenceId and additionalNotes are updateable.
Example:
{
"externalId": "",
"additionalNotes": "Lorem ipsum ...."
}
Response
Updated campaign of type Campaign.
Example:
{
"id": 108,
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"channelIds": [
17, 34, 99
]
}
Status codes
200 Campaign is successfully updated.
401 (3) No permission for user to update campaign.
PUT /campaigns/archivings/{campaignId}
Archives an existing campaign by its {campaignId} .
Parameters
Path campaignId Integer Yes Id of campaign to archive. -
Response
Archived campaign of type Campaign.
Example:
{
"id": 108,
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"channelIds": [
17, 34, 99
]
}
Status codes
200 Campaign is successfully archived.
401 (3) No permission for user to archive campaign.
403 (16) Campaign is not applicable for archiving.
DELETE /campaigns/archivings/{campaignId}
Restores a previously archived campaign by its {campaignId} .
Parameters
Path campaignId Integer Yes Id of campaign to restore. -
Response
Restored campaign of type Campaign.
Example:
{
"id": 108,
"createdDate": "2013-09-25T13:14:23+0200",
"externalId": "",
"advertiserId": 7,
"channelIds": [
17, 34, 99
]
}
Status codes
200 Campaign is successfully restored.
401 (3) No permission for user to restore campaign.
DELETE /campaigns/{campaignId}
Removes a campaign by its {campaignId} . In order to be removed, a campaign must not contain any connected channels (i.e.
channelIds -list must be empty) or all connected channels are marked as DELETED.
Parameters
Path campaignId Integer Yes Id of campaign to remove. -
Response
true if campaign is successfully removed, otherwise false .
Example
true
Status codes
200 Campaign is successfully removed.
401 (3) No permission for user to remove campaign.
403 (16) Campaign must not contain any channels.
Target groups
GET /target-groups
Fetches all target groups, i.e. all target groups that belong to the attached advertiser connected to the user. Common target
groups with the "any" property will also be returned. Admin user returns all target groups in the system.
Parameters
None.
Response
A list of target groups of type TargetGroup.
Example:
[
{
"id": 9,
"name": "Target group name",
"description": "Description of target group",
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"advertiserId": -1
},
...
]
Status codes
200 List of target groups is successfully fetched.

GET /target-groups/{targetGroupId}
Fetches a target group by its {targetGroupId} .
Parameters
Path targetGroupId Integer Yes Id of target group to fetch. -
Response
Target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"advertiserId": -1
}
Status codes
200 Target group is successfully fetched.
401 (3) No permission for user to fetch target group.
404 (5) Target group not found.
POST /target-groups
Creates a new target group.
Parameters
A target group of type TargetGroup.
Example:
{
"advertiserId": -1,
"msisdn": [
"0706779598", "0736793445", "0786739127"
]
}
Invalid msisdn are disregarded.

Response
Created target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"advertiserId": -1
}
Status codes
200 Target group is successfully created.
401 (3) No permission for user to create target group.
409 (9) Target group already exists.
POST /target-groups/msisdn-list
Creates a new target group.
Parameters
Parameter Data
Name Mandatory Description Notes
type type
Query name String Yes Name on target group. Max 255 characters.
Query description String Yes Description of target group. Max 2000 characters.
Id on advertiser this group Administrators can create a target group that belongs to any advertiser by
Query advertiserid Integer Yes
shall belong to. defining this parameter to -1.
Content-type: multipart/form-data
A file containing msisdns separated by one or more of the following characters:
Newline ( \n )
Tab ( \t )
Comma ( , )
Semicolon ( ; )
Carriage return ( \r )
Supported file formats for target-group import are as follows:
.zip
.tar
.tar.gz
.txt.gz
.txt
.csv
Example:
0706779598;0736793445;0786739127
Response
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"advertiserId": -1
}
Status codes

POST /target-groups/parametrized
Creates a new Parametrized target group. This kind of target group is used by Personalized channels.
Parameters
Parameter Data
type type
Id on advertiser this group Administrators can create a target group that belongs to any advertiser by
Query advertiserid Integer No
shall belong to. defining this parameter to -1.
A CSV file containing msisdns and its parameters. The header of the file must be: "msisdn, parameter_name_1,
arameter_name_2, parameter_name_3, ..." where "parameter_names" correspond with the names of the parameters.
Supported file formats for target-group import are as follows:
.txt
.csv
Example:
MSISDN, CITY, COUNTRY

9999999001, Barcelona, Spain
9999999002, Cordoba, Spain
9999999003, Barcelona, Spain
Response
Example:
{
"id": 600,
"name": "PM_TG_Thu Jul 20 15:42:21 CEST 2017",
"description": "Parametrized target group",
"createdDate": "2017-07-20T15:42:21+0200",
"removable": true,
"state": "AVAILABLE",
"type": "GENERIC",
"advertiserId": -1,
"subscriberCount": 3
}
Status codes

PUT /target-groups/{targetGroupId}
Updates an existing target group by its targetGroupId . Only name and description are updateable. Numbers in msisdn -list are
added to target group (i.e. nothing is removed).
Parameters
Path targetGroupId Integer Yes Id of target group to update. -
A target group of type TargetGroup.
Example:
{
"msisdn": [
"0706779598", "0736793445", "0786739127"
]
}

Response
Updated target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"type": "GENERIC",
"advertiserId": -1
}
Status codes
200 List of msisdn are successfully added to target group.
401 (3) No permission for user to update target group.
417 (6) Resource target group not supported.
PUT /target-groups/{targetGroupId}/msisdn-list
Adds a list of msisdn to an existing target group.
Parameters
Path targetGroupId Integer Yes Id of target group to add msisdn to. -
Query name String No Name of target group to add msisdn to. -
Newline ( \n )
Tab ( \t )
Comma ( , )
Semicolon ( ; )
Example:
0706779598;0736793445;0786739127
Response
Updated target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": true,
"advertiserId": -1
}
Status codes
200 List of msisdn are successfully added to target group.
401 (3) No permission for user to update target group.
PUT /target-groups/archivings/{targetGroupId}
Archives an existing target group by its {targetGroupId} .
Parameters
Path targetGroupId Integer Yes Id of target group to archive. -
Response
Archived target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": false,
"state": "ARCHIVED",
"type": "GENERIC",
"advertiserId": -1
}
Status codes
200 Target group is successfully archived
401 (3) No permission for user to archive target group.
403 (16) Target group is not applicable for archiving.
DELETE /target-groups/{targetGroupId}
Removes a target group by its {targetGroupId} . In order to be removed, a target group must not be connected to any channel(or
all channels are marked as DELETED) and not connected to any provisioning.
Parameters
Path targetGroupId Integer Yes Id of target group to remove. -
Response
true if target group is successfully removed, otherwise false .
Example
true
Status codes
200 Target group is successfully removed.
401 (3) No permission for user to remove target group.
403 (16) Target group must be in a removable state.
DELETE /target-groups/archivings/{targetGroupId}
Restores a previously archived target group by its {targetGroupId} .
Parameters
Path targetGroupId Integer Yes Id of target group to restore. -
Response
Restored target group of type TargetGroup.
Example:
{
"id": 9,
"createdDate": "2013-08-13T14:05:16+0200",
"removable": false,
"type": "GENERIC",
"advertiserId": -1
}
Status codes
200 Target group is successfully restored.
401 (3) No permission for user to restore target group.
Channels
GET /channels
Fetches all channels, i.e. all channels in the campaigns that belong to the advertisers connected to the user. Admin user returns
all channels in the system. Adding following parameters to the requests would act as additional filters to the resultant channel
list
Parameters
Parameter Data
type type
Valid characters: Max 255 characters. Valid characters:

Query externalId String No externalId used while creating/updating channel
"a-z,A-Z,0-9,-,."
Provide start date filter criteria. Supported filter Valid date: format (ISO-8601): yyyy-MM-
Query startDate String No
operands: =,>,<,!. Support filter functions: between(). ddTHH:mm:ss[+|-]ZZZZ. Provided in single quotes.
Valid date format (ISO-8601): yyyy-MM-

Provide end date filter criteria. Supported filter operands:
Query endDate String No ddTHH:mm:ss[+|-]ZZZZ must be provided in single
=,>,<,!. Support filter functions: between().
quotes.
Example:
GET /channels?startDate=<='2017-03-29T07:38:09+0200'
GET /channels?endDate=between '2017-03-26T07:38:09+0200' and '2017-03-28T07:38:09+0200'
Response
A list of channels of type Channel.
Example:
[
{
"id": 2254,
"channelType": "HS",
"description": "Description of HS channel.",
"externalId": "Optional unique external id of HS channel",
"retries": 0,
"rateLimit": 0,
"rateLimitAssigned": 500,
"rateLimitUnit": "SM/s",
"state": "PUBLISHED",
"editable": false,
"removable": false,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"useUnicode": false,
"priority": "low",
"msisdnReportingIntervals": 0,
"statisticsReportingInterval": 0,
"advertisements": [
{
"message": "Message to display"
}
]
},
{
"id": 2363,
"channelType": "SPN",
"description": "Description of SPN channel.",
"externalId": "Optional unique external id of SPN channel",
"retries": 0,
"rateLimit": 0,
"editable": false,
"removable": false,
"campaignId": 2200,
"createdDate": "2013-10-03T13:51:57+0200",
"startDate": "2013-09-16T09:12:28+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "A message"
}
],
"spnDisplayOption": "DEFAULT"
},
{
"id": 2325,
"channelType": "CTI",
"description": "Description of CTI channel.",
"externalId": "Optional unique external id of CTI channel",
"retries": 0,
"rateLimit": 0,
"editable": false,
"removable": false,
"campaignId": 2200,
"createdDate": "2013-09-30T16:40:12+0200",
"startDate": "2013-09-14T14:12:28+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"numberOfCallsBetweenAds": 0,
"numberOfIterationsBetweenReports": 4,
"numberOfReportsBeforeStopping": 8,
"advertisements": [
{
"message": "Message to be displayed",
"prompt": null,
"selection1": null,
"selection2": null,
"disableAfterContinue": false,
"input": null,
"wibletUrl": null,
"wmlCode": null,
"optInTargetGroupId": null
},
...
]
},
{
"id": 2331,
"channelType": "WOWONOV",
"description": "A description of online overture WOW channel.",
"externalId": "Optional unique external id of WOW channel",
"retries": 0,
"rateLimit": 0,
"editable": false,
"removable": false,
"campaignId": 2199,
"createdDate": "2013-09-30T18:01:18+0200",
"startDate": "2013-09-26T14:04:45+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"primaryMessage": "A primary message to display",
"secondaryMessage": null,
"primaryAction": "5",
"primaryActionMessage1": "http://goggle.com/goggles",
"primaryActionMessage2": "http://goggle.com/goggles2",
"secondaryAction": "5",
"secondaryActionMessage1": "http://goggle.com/goggles3",
"confirmationType": "0",
"category": "0",
"condition1": "a",
"condition2": "b",
"condition3": "c",
"condition4": "d",
"condition5": "e"
}
],
"powerOnEvent": false,
"callDisconnectEvent": true,
"idleScreenEvent": false,
"sequenceId": 2273
},
...
]
Status codes
200 List of channels is successfully fetched.
GET /channels/wiblets
Fetches all local wiblets defined in the system.
Parameters
None.
Response
A list of local wiblets defined as name and script id pairs.
Example:
[
{
"name": "adwise_wow_event_idlescreen",
"scriptId": "02410369"
},
{
"name": "adwise_wow_menu",
"scriptId": "05A3B5F9"
},
{
"name": "adwise_wow_event_poweron",
"scriptId": "096B735D"
},
{
"name": "adwise_wow_compare_bits",
"scriptId": "0F8C665A"
},
...
]
Status codes
200 List of local wiblets is successfully fetched.
GET /channels/{channelId}
Fetches a channel by its {channelId} .
Parameters
Path channelId Integer Yes Id of channel to fetch. -
Response
Channel of type Channel.
Example (get of HS-channel):

{
"id": 2254,
"externalId": "External id of HS channel",
"retries": 0,
"rateLimit": 0,
"editable": false,
"removable": false,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
]
}
Status codes
200 Channel is successfully fetched.
401 (3) No permission for user to fetch channel.
404 (5) Channel not found.
GET /channels/types/{channelType}
Fetches all channels by its {channelType} .
Parameters
Path channelType String Yes Type on channels to fetch. -
Response
List of channels of type Channel.
Example (get of HS-type channels):
{
{
"id": 2254,
"externalId": "External id of WOW channel",
"retries": 0,
"rateLimit": 0,
"editable": false,
"removable": false,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
]
},
...
]
Status codes
200 List of channels is successfully fetched.
400 (14) Illegal channel type value in path parameter.
POST /channels
Creates a new channel.
Parameters
A channel of type Channel.
JSON samples
HS-channel
Request
{
"rateLimit": 0,
"retries" 2,
"campaignId": 2199,
"startDate": "2013-09-25T13:15:07+0200",
"endDate": "2013-10-25T13:15:07+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
]
}
Response
{
"id": 2254,
"externalId": "Unique external id of HS channel",
"retries": 2,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": "2013-10-25T13:15:07+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
]
}
SPN-channel
Request
{
"channelType: "SPN",
"externalId": "External id of SPN channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 2200,
"startDate": "2013-09-16T09:12:28+0200",
"endDate": "2013-10-25T13:15:07+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
],
}
Response
{
"id": 2363,
"externalId": "Unique external id of SPN channel",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2200,
"createdDate": "2013-10-03T13:51:57+0200",
"startDate": "2013-09-16T09:12:28+0200",
"endDate": "2013-10-25T13:15:07+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
],
}
CTI-channel
Request
{
"channelType: "CTI",
"retries": 0,
"rateLimit": 0,
"campaignId": 2200,
"startDate": "2013-09-14T14:12:28+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"prompt": null,
"selection1": null,
"selection2": null,
"input": null,
"wibletUrl": null,
"wmlCode": null,
},
...
]
}
Response
{
"id": 2325,
"externalId": "Unique external id of CTI channel",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2200,
"createdDate": "2013-09-30T16:40:12+0200",
"startDate": "2013-09-14T14:12:28+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"prompt": null,
"selection1": null,
"selection2": null,
"input": null,
"wibletUrl": null,
"wmlCode": null,
},
...
]
}
WOWONOV-channel
Request
{
"channelType: "WOWONOV",
"retries": 0,
"rateLimit": 0,
"campaignId": 2199,
"startDate": "2013-09-26T14:04:45+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"category": "0",
"condition1": "a",
"condition2": "b",
"condition3": "c",
"condition4": "d",
"condition5": "e"
}
],
"sequenceId": 2273
}
Response
{
"id": 2331,
"externalId": "Optional unique external id of WOW channel",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2199,
"createdDate": "2013-09-30T18:01:18+0200",
"startDate": "2013-09-26T14:04:45+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"category": "0",
"condition1": "a",
"condition2": "b",
"condition3": "c",
"condition4": "d",
"condition5": "e"
}
],
"sequenceId": 2273
}
TI-channel
Request
{
"channelType": "TI",
"description": "TI Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 3,
"createdDate": "2016-02-24T07:57:33+0100",
"startDate": "2016-02-24T09:53:37+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"advertisements": [
{
"interactiveChannelSteps": [
{
"stepType": "MESSAGE",
"displayMessageInfo": {
"displayMessage": "Persistent message",
"persistent": true
}
},
{
"stepType": "INPUT",
"inputInfo": {
"message": "Input step"
}
},
{
"stepType": "SELECT",
"selectInfo": {
"selectText": "Select title",
"selectOptions": [
{
"optionText": "Option 1",
"optionValue": "Option 1"
},
{
},
{
}
]
}
},
{
"stepType": "CONFIRM",
"selectInfo": {
"selectText": "Confirm title",
"selectOptions": [
{
},
{
}
]
}
},
{
"stepType": "WEB_SERVICE",
"webServiceInfo": {
"url": "http://www.gi-de.com",
"serviceParameterInfoList": [
{
"parameterText": "inputData"
},
{
"parameterText": "selectData"
}
]
}
}
]
}
],
"effectiveDate": "2016-02-24T12:00:00+0100",
"expiryDate": "2016-02-25T12:00:00+0100",
"maxDisplay": 5,
"sendReportFrequency": -1
}
Response
{
"id": 58,
"description": "TI Channel",
"retries": 0,
"rateLimit": 0,
"state": "PROPOSED",
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:03:14+0100",
"startDate": "2016-02-24T09:53:37+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 60,
"persistent": true,
"unicode": false
}
},
{
"inputInfo": {
"stepId": 61,
"message": "Input step",
"unicode": false
}
},
{
"selectInfo": {
"stepId": 62,
"selectText": "Select title",
"selectOptions": [
{
"optionValue": "Option 1",
"optionId": 63,
"order": 0,
"stepId": 62,
"unicode": false
},
{
"optionId": 64,
"order": 1,
"stepId": 62,
"unicode": false
},
{
"optionId": 65,
"order": 2,
"stepId": 62,
"unicode": false
}
],
"unicode": false
}
},
{
"selectInfo": {
"stepId": 66,
"selectText": "Confirm title",
"selectOptions": [
{
"optionId": 67,
"order": 0,
"stepId": 66,
"unicode": false
},
{
"optionId": 68,
"order": 1,
"stepId": 66,
"unicode": false
}
],
"unicode": false
}
},
{
"webServiceInfo": {
"stepId": 69,
"serviceParameterInfoList": [
{
"parameterText": "inputData",
"parameterId": 70,
"stepId": 69,
"connectedStepId": 61
},
{
"parameterText": "selectData",
"parameterId": 71,
"stepId": 69,
}
],
"unicode": false
}
}
]
}
],
"effectiveDate": "2016-02-24T12:00:00+0100",
"expiryDate": "2016-02-25T12:00:00+0100",
"maxDisplay": 5,
}
PI-channel
Request
{
"channelType": "PI",
"description": "PI Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 3,
"createdDate": "2016-12-24T09:01:14+0100",
"startDate": "2016-12-24T09:59:36+0100",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"displayMessage": "Simple message",
"persistent": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"message": "Send text message",
"number": "9999999999",
"serviceCenterAddress": null
}
},
{
"stepType": "SETUP_CALL",
"setupCallInfo": {
"toNumber": "9999999999"
}
},
{
"stepType": "LAUNCH_BROWSER",
"launchBrowserInfo": {
"url": "http://www.gi-de.com"
}
}
]
}
],
"sendReportValue": 0
}
Response
{
"id": 72,
"description": "PI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:23:03+0100",
"startDate": "2016-12-24T09:59:36+0100",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 74,
"persistent": false,
"unicode": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 75,
"number": "9999999999",
"serviceCenterAddress": null,
"unicode": false
}
},
{
"setupCallInfo": {
"stepId": 76,
"toNumber": "9999999999",
"unicode": false
}
},
{
"stepId": 77,
"unicode": false
}
}
]
}
],
}
WP-channel
Request
{
"channelType": "WP",
"description": "Wib Push Advance channel",
"campaignId": 3,
"startDate": "2017-11-27T12:26:16+0200",
"targetGroupIds": [
2
],
"advertisements": [
{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <wml xmlns=\"http://www.smarttrust.com/WIG-WML/5.0\" xmln
s:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.smarttrust.com/WIG-WML/5.0 http://www.sma
rttrust.com/xsd/wigwml-5.0.xsd\"> <card id=\"Main\"> Welcome to wib push advance channel </card> </wml>"
}
]
}
Response
{
"id": 9,
"description": "Wib Push Advance channel",
"externalId": null,
"retries": 0,
"rateLimit": 0,
"pauseDelivery": null,
"editable": true,
"removable": true,
"campaignId": 2,
"createdDate": "2017-11-17T12:01:47+0100",
"startDate": "2017-11-27T11:26:16+0100",
"targetGroupIds": [
3
],
"advertisements": [
{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <wml xmlns=\"http://www.smarttrust.com/WIG-WML/5.0\" xmln
s:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.smarttrust.com/WIG-WML/5.0 http://www.sma
rttrust.com/xsd/wigwml-5.0.xsd\"> <card id=\"Main\"> Welcome to wib push advance channel </card> </wml>"
}
],
}
WPI-channel
Request
{
"channelType": "WPI",
"description": "WPI Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 3,
"createdDate": "2016-02-24T09:01:14+0100",
"startDate": "2016-02-24T09:59:36+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"persistent": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"number": "9999999999",
}
},
{
"setupCallInfo": {
"toNumber": "9999999999"
}
},
{
"url": "http://www.gi-de.com"
}
},
{
"stepType": "STATISTICS",
"statisticsInfo": {
"statisticsLabelInfoList": [
{
"labelText":"labelMessage"
},
{
"labelText":"labelSMS"
},
{
"labelText":"labelSetUpCall"
},
{
"labelText":null
}]
}
}
]
}
]
}
Response
{
"id": 78,
"description": "WPI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:24:54+0100",
"startDate": "2016-02-24T09:59:36+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 79,
"unicode": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 80,
"number": "9999999999",
"unicode": false
}
},
{
"setupCallInfo": {
"stepId": 81,
"toNumber": "9999999999",
"unicode": false
}
},
{
"stepId": 82,
"unicode": false
}
},
{
"statisticsInfo": {
"stepId": 83,
{
"labelText": "labelMessage",
"labelId": 84,
"stepId": 83,
"connectedStepId": 80,
"labelUsed": true
},
{
"labelText": "labelLaunchBrowser",
"labelId": 85,
"stepId": 83,
"labelUsed": true
},
{
"labelText": "labelWebService",
"labelId": 86,
"stepId": 83,
"labelUsed": true
},
{
"labelText": null,
"labelId": 87,
"stepId": 83,
"labelUsed": false
}
],
"unicode": false
}
}
]
}
]
}
STMI-channel
Request
{
"channelType": "STMI",
"description": "STMI Channel",
"retries": 0,
"rateLimit": 0,
"originatingAddress":"Originating Address",
"msisdnReportingIntervals":2,
"campaignId": 3,
"createdDate": "2016-02-24T07:57:33+0100",
"startDate": "2016-02-24T09:53:37+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"stepType": "STATIC_TEXT_MESSAGE",
"staticTextMessageInfo": {
"message": "Welcome to static text message"
}
}
]
}
]
Response
{
"id": 83,
"retries": 0,�
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:26:10+0100",
"startDate": "2016-02-24T09:53:37+0100",
"endDate": "2016-03-25T13:15:07+0200",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 84,
"message": "Welcome to static text message",
"unicode": false
}
}
]
}
],
"originatingAddress": "Originating Address"
}
SPI-channel
Request
{
"channelType":"SPI",
"description":"SPI Channel",
"retries":0,
"rateLimit": 0,
"campaignId":3,
"createdDate":"2016-02-24T07:57:33+0100",
"startDate":"2016-02-24T09:53:37+0100",
"targetGroupIds":[
2
],
"advertisements":[
{
"interactiveChannelSteps":[
{
"stepType":"MESSAGE",
"displayMessageInfo":{
"displayMessage":"Persistent message"
}
},
{
"stepType":"SMS",
"sendSmsInfo":{
"message":"Send text message",
"number":"1234567890"
}
},
{
"statisticsInfo": {
{
"labelText": "labelMessage"
},
{
"labelText": "labelSMS"
}
],
"unicode": false
}
}
]
}
]
}
Response
{
"channelType": "SPI",
"id": 85,
"description": "SPI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:27:20+0100",
"startDate": "2016-02-24T09:53:37+0100",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 86,
"persistent": true,
"unicode": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 87,
"number": "1234567890",
"unicode": false
}
},
{
"statisticsInfo": {
"stepId": 88,
{
"labelText": "labelMessage",
"labelId": 89,
"stepId": 88,
"labelUsed": true
},
{
"labelText": "labelSMS",
"labelId": 90,
"stepId": 88,
"labelUsed": true
}
],
"unicode": false
}
]
}
]
}
PUSH-channel
Request
{
"channelType": "PUSH",
"description": "API Personalized Push Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 335,
"priority": "medium",
"startDate": "2017-07-21T10:00:00+0200",
"targetGroupIds": [585],
"parameterList": [{
"parameterName": "NAME",
"parameterSampleValue": "Luisdo"
},
{
"parameterName": "AGE",
"parameterSampleValue": "30"
}],
"pushContentType": "SAT",
"advertisements": [{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE satml SYSTEM \"http://www.simalliance.org/DT
D/satml106.dtd\"><satml><card id=\"MAIN\">Hi #NAME#, yor age is: #AGE#!</card></satml>"
}]
}
Response
{
"channelType": "PUSH",
"id": 621,
"description": "API Personalized Push Channel",
"externalId": null,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 335,
"createdDate": "2017-07-21T08:48:59+0200",
"startDate": "2017-07-21T10:00:00+0200",
"endDate": null,
"targetGroupIds": [
585
],
"advertisements": [
{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE satml SYSTEM \"http://www.simalliance.org/DTD/sat
ml106.dtd\"><satml><card id=\"MAIN\">Hi #NAME#, yor age is: #AGE#!</card></satml>"
}
],
"parameterList": [
{
},
{
}
]
}
PUSHI-channel
Request
{
"channelType": "PUSHI",
"description": "API Personalized Push Interactive Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 335,
"startDate": "2017-07-21T10:00:00+0200",
"targetGroupIds": [585],
"parameterList": [{
},
{
}],
"pushContentType": "WIB",
"advertisements": [
{
{
"displayMessage": "Hi, #NAME#",
"persistent": false
}
},
{
"inputInfo": {
"message": "Are you #AGE#? How old are you?"
}
},
{
"statisticsInfo": {
{
},
{
}
]
}
},
{
"selectInfo": {
"selectText": "#NAME#, what is your favourite color?",
"selectOptions": [
{
"optionText": "red",
"optionValue": "red"
},
{
"optionText": "blue",
"optionValue": "blue"
}
]
}
},
{
"selectInfo": {
"selectText": "#NAME#, do you want to exit?",
"selectOptions": [
{
"optionText": "yes",
"optionValue": "yes"
},
{
"optionText": "no",
"optionValue": "no"
}
]
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"message": "#NAME# has received a push message with parameters!",
"number": "123456",
}
}
]
}
]
}
Response
{
"channelType": "PUSHI",
"id": 621,
"description": "API Personalized Push Interactive Channel",
"externalId": null,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 335,
"createdDate": "2017-07-21T08:48:59+0200",
"startDate": "2017-07-21T10:00:00+0200",
"endDate": null,
"targetGroupIds": [
585
],
"advertisements": [
{
{
"stepId": 225,
"unicode": false
}
},
{
"inputInfo": {
"stepId": 226,
"message": "Are you #AGE#? How old are you?",
"unicode": false
}
},
{
"stepId": 227,
"statisticsInfo": {
{
"labelText":"labelMessage",
"labelId": 228,
"stepId": 227,
"labelUsed": true
},
{
"labelText":"labelSMS",
"labelId": 229,
"stepId": 227,
"labelUsed": true
}
]
}
},
{
"selectInfo": {
"stepId": 227,
"selectOptions": [
{
"optionValue": "red",
"optionId": 228,
"order": 0,
"stepId": 227,
"unicode": false
},
{
"optionValue": "blue",
"optionId": 229,
"order": 1,
"stepId": 227,
"unicode": false
}
],
"unicode": false
}
},
{
"selectInfo": {
"stepId": 230,
"selectOptions": [
{
"optionValue": "yes",
"optionId": 231,
"order": 0,
"stepId": 230,
"unicode": false
},
{
"optionText": "no",
"optionValue": "no",
"optionId": 232,
"order": 1,
"stepId": 230,
"unicode": false
}
],
"unicode": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 233,
"number": "5555",
"unicode": false
}
}
]
}
],
"parameterList": [
{
},
{
}
]
}
IP-channel
Request
{
"channelType": "IP",
"description": "API Push live advanced Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 335,
"startDate": "2017-07-21T10:00:00+0200",
"parameterList": [{
},
{
}],
"advertisements": [{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE satml SYSTEM \"http://www.simalliance.org/DT
D/satml106.dtd\"><satml><card id=\"MAIN\">Hi #NAME#, yor age is: #AGE#!</card></satml>"
}]
}
Response
{
"channelType": "IP",
"id": 621,
"description": "API Push live advanced Channel",
"externalId": null,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 335,
"createdDate": "2017-07-21T08:48:59+0200",
"startDate": "2017-07-21T10:00:00+0200",
"endDate": null,
"targetGroupIds": null,
"advertisements": [
{
"message": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><!DOCTYPE satml SYSTEM \"http://www.simalliance.org/DTD/sat
ml106.dtd\"><satml><card id=\"MAIN\">Hi #NAME#, yor age is: #AGE#!</card></satml>"
}
],
"parameterList": [
{
},
{
}
]
}
IPI-channel
Request
{
"channelType": "IPI",
"description": "API Push live interactive Channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 335,
"startDate": "2017-07-21T10:00:00+0200",
"parameterList": [{
},
{
}],
"advertisements": [
{
{
"persistent": false
}
},
{
"inputInfo": {
"message": "Are you #AGE#? How old are you?"
}
},
{
"statisticsInfo": {
{
},
{
}
]
}
},
{
"selectInfo": {
"selectOptions": [
{
"optionValue": "red"
},
{
"optionValue": "blue"
}
]
}
},
{
"selectInfo": {
"selectOptions": [
{
"optionValue": "yes"
},
{
"optionText": "no",
"optionValue": "no"
}
]
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"number": "123456",
}
}
]
}
]
}
Response
{
"channelType": "IPI",
"id": 621,
"description": "API Push live interactive Channel",
"externalId": null,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 335,
"createdDate": "2017-07-21T08:48:59+0200",
"startDate": "2017-07-21T10:00:00+0200",
"advertisements": [
{
{
"stepId": 225,
"unicode": false
}
},
{
"inputInfo": {
"stepId": 226,
"message": "Are you #AGE#? How old are you?",
"unicode": false
}
},
{
"stepId": 227,
"statisticsInfo": {
{
"labelText":"labelMessage",
"labelId": 228,
"stepId": 227,
"labelUsed": true
},
{
"labelText":"labelSMS",
"labelId": 229,
"stepId": 227,
"labelUsed": true
}
]
}
},
{
"selectInfo": {
"stepId": 227,
"selectOptions": [
{
"optionValue": "red",
"optionId": 228,
"order": 0,
"stepId": 227,
"unicode": false
},
{
"optionValue": "blue",
"optionId": 229,
"order": 1,
"stepId": 227,
"unicode": false
}
],
"unicode": false
}
},
{
"selectInfo": {
"stepId": 230,
"selectOptions": [
{
"optionValue": "yes",
"optionId": 231,
"order": 0,
"stepId": 230,
"unicode": false
},
{
"optionText": "no",
"optionValue": "no",
"optionId": 232,
"order": 1,
"stepId": 230,
"unicode": false
}
],
"unicode": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 233,
"number": "5555",
"unicode": false
}
}
]
}
],
"parameterList": [
{
},
{
}
]
}
Status codes
200 Channel is successfully created.
400 (7) Date parameter has wrong format.
400 (11) Too many slots.
400 (15) Invalid WML.
401 (3) No permission for user to create channel.

POST /channels/triggerIndividual
Trigger individual content for Live channels. Live channels are Push live advanced and Push live interactive. Triggers are allowed
when channel state is IDLE or ONGOING.
Parameters
Channel Id and individual content for this channel. Data is an array than include the MSISDN and parameters to use.
Request
{
"channelId": 596,
"data": [
{
"msisdn": "67060000001",
"params": {
"NAME": "Mukesh",
"AGE": "28"
}
},
{
"msisdn": "67060000002",
"params": {
"NAME": "Alex",
"AGE": "25"
}
},
{
"msisdn": "67060000003",
"params": {
"NAME": "Luis",
"AGE": "30"
}
}
]
}
Response
{
"channelId": 596,
"msisdnDatas": [
{
"msisdn": "67060000001",
"data": {
"NAME": "Mukesh",
"AGE": "28"
}
},
{
"msisdn": "67060000002",
"data": {
"NAME": "Alex",
"AGE": "25"
}
},
{
"msisdn": "67060000003",
"data": {
"NAME": "Luis",
"AGE": "30"
}
}
]
}
PUT /channels/{channelId}
Updates an existing channel by its {channelId} .
Parameters
Parameter type Name Type Mandatory Description Notes
Path channelId Integer Yes Id of channel to update. -
A channel of type Channel.
Example (update a HS-channel):

{
"description": "Updated description of HS channel.",
"externalId": "Updated unique external id of HS channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 2199,
"startDate": "2013-09-25T13:15:07+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message to display"
}
]
}
Example (update a SPN-channel):
{
"channelType: "SPN",
"description": "Updated description of SPN channel.",
"retries": 0,
"rateLimit": 0,
"campaignId": 2200,
"createdDate": "2013-10-03T13:51:57+0200",
"startDate": "2013-09-16T09:12:28+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message"
}
],
}
Example (update a CTI-channel):

{
"channelType: "CTI",
"description": "Updated description of CTI channel.",
"externalId": "Updated unique external id of CTI channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 2200,
"createdDate": "2013-09-30T16:40:12+0200",
"startDate": "2013-09-14T14:12:28+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message to be displayed",
"prompt": null,
"selection1": null,
"selection2": null,
"input": null,
"wibletUrl": null,
"wmlCode": null,
},
...
]
}
Example (update a WOWONOV-channel):

{
"channelType: "WOWONOV",
"description": "Updated description of online overture WOW channel.",
"externalId": "Updated unique external id of WOW channel",
"retries": 0,
"rateLimit": 0,
"campaignId": 2199,
"createdDate": "2013-09-30T18:01:18+0200",
"startDate": "2013-09-26T14:04:45+0200",
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"primaryMessage": "Another primary message to display",
"category": "0",
"condition1": "a",
"condition2": "b",
"condition3": "c",
"condition4": "d",
"condition5": "e"
}
],
"sequenceId": 2273
}
Response
Updated channel of type Channel.
Example (update of HS-channel):

{
"id": 2254,
"description": "Updated description of HS channel.",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message to display"
}
]
}
Example (update a SPN-channel):

{
"id": 2363,
"description": "Updated description of SPN channel.",
"externalId": "Updated unique external id of SPN channel",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2200,
"createdDate": "2013-10-03T13:51:57+0200",
"startDate": "2013-09-16T09:12:28+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message"
}
],
}
Example (update a CTI-channel):

{
"id": 2325,
"description": "Updated description of CTI channel.",
"externalId": "Updated unique external id of CTI channel",
"retries": 0,
"rateLimit": 0,
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2200,
"createdDate": "2013-09-30T16:40:12+0200",
"startDate": "2013-09-14T14:12:28+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"message": "Another message to be displayed",
"prompt": null,
"selection1": null,
"selection2": null,
"input": null,
"wibletUrl": null,
"wmlCode": null,
},
...
]
}
Example (update an TI-channel):

{
"id": 57,
"description": "Updated TI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2015-12-24T08:50:54+0100",
"startDate": "2015-12-24T09:53:37+0100",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"stepId": 59,
"displayMessage": "Updated persistent message",
"persistent": true
}
},
{
"inputInfo": {
"stepId": 60,
"message": "Updated input step"
}
},
{
"selectInfo": {
"stepId": 61,
"selectText": "Updated select title",
"selectOptions": [
{
"optionText": "Updated Option 1",
"optionValue": "Updated Option 1",
"optionId": 62,
"order": 0,
"stepId": 61
},
{
"optionId": 63,
"order": 1,
"stepId": 61
},
{
"optionId": 64,
"order": 2,
"stepId": 61
}
]
}
},
{
"selectInfo": {
"stepId": 65,
"selectText": "Updated Confirm title",
"selectOptions": [
{
"optionId": 66,
"order": 0,
"stepId": 65
},
{
"optionId": 67,
"order": 1,
"stepId": 65
}
]
}
},
{
"webServiceInfo": {
"stepId": 68,
"url": "http://www.gi-de.com/updated",
"serviceParamterInfos": [
{
"parameterText": "updatedInputData",
"parameterId": 70,
"stepId": 68,
},
{
"parameterText": "updatedSelectData",
"parameterId": 71,
"stepId": 68,
}
]
}
}
]
}
],
"effectiveDate": "2015-12-24T12:00:00+0100",
"expiryDate": "2015-12-25T12:00:00+0100",
"maxDisplay": 1,
}
Example (update an PI-channel):

{
"id": 77,
"description": "Updated PI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2015-12-24T09:48:31+0100",
"startDate": "2015-12-24T09:59:36+0100",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"stepId": 79,
"displayMessage": "Updated Simple message",
"persistent": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 80,
"message": "Updated Send text message",
"number": "8888888888",
}
},
{
"setupCallInfo": {
"stepId": 81,
"toNumber": "6666666666"
}
},
{
"stepId": 82,
"url": "http://www.gi-de.com/updated"
}
}
]
}
],
}
Example (update an WPI-channel):

{
"id": 78,
"description": "Updated WPI Channel",
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2015-12-24T09:48:31+0100",
"startDate": "2015-12-24T09:59:36+0100",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"stepId": 79,
"displayMessage": "Updated Simple message",
"persistent": false
}
},
{
"stepType": "SMS",
"sendSmsInfo": {
"stepType": "SMS",
"stepId": 80,
"message": "Updated Send text message",
"number": "8888888888",
}
},
{
"setupCallInfo": {
"stepId": 81,
"toNumber": "6666666666"
}
},
{
"stepId": 82,
"url": "http://www.gi-de.com/updated"
}
}
]
}
]
}
Example (update STMI-channel):
{
"id": 4,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-01-20T12:05:11+0100",
"startDate": "2016-12-24T09:53:37+0100",
"targetGroupIds": [
2
],
"advertisements": [
{
{
"stepId": 5,
"message": "Updated static text message"
}
}
]
}
]
}
Example (update a WOWONOV-channel):

{
"id": 2331,
"description": "Updated description of online overture WOW channel.",
"externalId": "Updated unique external id of WOW channel",
"state": "DRAFT",
"editable": true,
"removable": true,
"campaignId": 2199,
"createdDate": "2013-09-30T18:01:18+0200",
"startDate": "2013-09-26T14:04:45+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
"primaryMessage": "Another primary message to display",
"category": "0",
"condition1": "a",
"condition2": "b",
"condition3": "c",
"condition4": "d",
"condition5": "e"
}
],
"sequenceId": 2273
}
Status codes
200 Channel is successfully updated.
400 (7) Date parameter has wrong format.

401 (3) No permission for user to update channel.
409 (14) Channel can not change type.
409 (14) Id in object differs from channelId in URL path.
409 (14) Channel is in a non-editable state.
PUT /channels/approvals/{channelId}
Approves an existing channel by its {channelId} . A channel must be editable in order to be approved. The channel is immediately
published after it is approved.
Parameters
Parameter type Name Type Mandatory Description Notes
Path channelId Integer Yes Id of channel to approve. -
Response
Example (approve of HS-channel):

{
"id": 2254,
"retries": 0,
"rateLimit": 0,
"state": "INITIALIZING",
"editable": false,
"removable": false,
"campaignId": 2199,
"createdDate": "2013-09-25T13:14:23+0200",
"startDate": "2013-09-25T13:15:07+0200",
"endDate": null,
"targetGroupIds": [
2202
],
"priority": "low",
"advertisements": [
{
}
]
}
Status codes
200 Channel is successfully approved.
401 (3) No permission for user to approve channel.
403 (16) Channel is in a non-editable state.
PUT /channels/copy/{channelId}
Create copy of existing channel by its {id} .
Parameters
Path channelId Integer Yes Id of channel to copy -
Query campaignId String No Valid campaign Id under which channel will be copied -
Response
Example (copy of STMI-channel):
{
"id": 83,
"retries": 0,
"rateLimit": 0,
"editable": true,
"removable": true,
"campaignId": 3,
"createdDate": "2016-02-17T10:26:10+0100",
"startDate": "2016-02-24T09:53:37+0100",
"targetGroupIds": [
2
],
"priority": "low",
"advertisements": [
{
{
"stepId": 84,
"message": "Welcome to static text message",
"unicode": false
}
}
]
}
],
"originatingAddress": "Originating Address"
}
Status codes
201 Channel successfully copied
401 (3) No permission for user to copy channel.
403 (16) Channel can't be copied.

DELETE /channels/{channelId}
Removes a channel by its {channelId} . A channel must be removable and must be in final state (PUBLISHED, ARCHIVED,
FINALIZED, FINISHED) or PROPOSED state in order to be removed.
Parameters
Path channelId Integer Yes Id of channel to remove. -
Response
true if channel successfully removed, otherwise false .
Example (get of HS-channel):
true
Status codes
200 Channel is successfully removed.
401 (3) No permission for user to remove channel.
403 (16) Channel is in a non-removable state.
Symphonies
GET /symphonies
Fetches all symphonies.
Parameters
None.
Response
A list of symphonies of type Symphony.
Example:
[
{
"id": 2273,
"name": "Name of symphony",
"description": "Description of symphony",
"externalId": "Some external reference",
"createdDate": "2013-09-26T10:56:07+0200",
"channelId": [
2394, 3788, 4865
]
},
...
]
Status codes
200 List of symphonies is successfully fetched.
GET /symphonies/{symphonyId}
Fetches a symphony by its {symphonyId} .
Parameters
Path advertiserId Integer Yes Id of advertiser to fetch. -
Response
Symphony of type Symphony.
Example:
{
"id": 2273,
"createdDate": "2013-09-26T10:56:07+0200",
"channelId": [
2394, 3788, 4865
]
}
Status codes
200 Symphony is successfully fetched.

401 (3) No permission for user to fetch symphony.
404 (5) Symphony not found.
POST /symphonies
Creates a new symphony.
Parameters
An symphony of type Symphony.
Example:
{
"channelId": [
2394, 3788, 4865
]
}
Response
Created symphony of type Symphony.
Example:
{
"id": 2273,
"createdDate": "2013-09-26T10:56:07+0200",
"channelId": [
2394, 3788, 4865
]
}
Status codes
200 Symphony is successfully created.
401 (3) No permission for user to create symphony.

PUT /symphonies/{symphonyId}
Updates an existing symphony by its {symphonyId} . There are specific requirements for how selected member channels (i.e.
channelId -list) can be update:
Channels with downloads or in final state can note be removed.

The order between channels in final state can not be changed.
Parameters
Path advertiserId Integer Yes Id of advertiser to update. -
A symphony of type Symphony. Only name , description , and externalReference are updateable.
Example:
{
"name": "Updated name of symphony",
"description": "Another description of symphony",
"externalId": "Changed external reference",
"channelId": [
2394, 5532, 3788, 4865
]
}
Response
Updated symphony of type Symphony.
Example:
{
"id": 2273,
"name": "Updated name of symphony",
"description": "Another description of symphony",
"externalId": "Changed external reference",
"createdDate": "2013-09-26T10:56:07+0200",
"channelId": [
2394, 5532, 3788, 4865
]
}
Status codes
200 Symphony is successfully updated.

401 (3) No permission for user to update symphony.
DELETE /symphonies/{symphonyId}
Removes a symphony by its {symphonyId} . In order to be removed, a symphony must not contain any selected channel members
(i.e. channelId -list must be empty) or be connected to any WOWOOFF- and/or WOWONOV-channel.
Parameters
Path symphonyId Integer Yes Id of symphony to remove. -
Response
true if symphony is successfully removed, otherwise false .
Example
true
Status codes
200 Symphony is successfully removed.
403 (16) Symphony must not contain any selected member channels.
403 (16) Symphony must not be connected to any WOWOOFF- and/or WOWONOV-channels.
Opt-outs
GET /opt-outs
Fetches a summary of number of opt-outed msisdn per {channelType} .
Parameters
None.
Response
Map with "Channel-type:Number-of-msisdn" entries of type String and Integer.
Example:
{
"CT": 14238,
"HS": 107318,
"SMS": 178
...
}
Status codes
200 Summary is successfully fetched.
GET /opt-outs/{channelType}
Fetches a list of msisdn that are opted-out for a specific {channelType} . The first 4000 msisdn is retrieved if there are more than
4000 msisdn for the requested {channelType} . See also GET /opt-outs/{channelType}/page/{page} .
Parameters
Path channelType ChannelType Yes Type of channel to fetch opted-out msisdn for. For valid values, refer to ChannelType.
Response
Paged list of msisdn of type String.
Example:
{
"totalNoOfItems": 3,
"currentPage": 1,
"pageSize": 4000,
"items": [
"0704567266", "0786736543", "07153774476"
]
}
Status codes
200 Opt-out list is successfully fetched.
400 (14) Invalid parameter.

GET /opt-outs/{channelType}/page/{page}
Fetches a list of msisdn that are opted-out for a specific {channelType} .
Parameters
Parameter
Name Data type Mandatory Description Notes
type
For valid values, refer to

Path channelType ChannelType Yes Type of channel to fetch opted-out msisdn for.
ChannelType.
The page to retrieve msisdn for. First page is 1. The page size is
Path page Integer Yes Must be greater or equals to 1.
4000.
Response
Paged list of msisdn of type String.
Example:
{
"totalNoOfItems": 5638,
"currentPage": 2,
"pageSize": 4000,
"items": [
"0704567266", "0786736543", "07153774476", ...
]
}
Status codes
200 Opt-out list is successfully fetched.
GET /opt-outs/msisdn/{msisdn}
Fetches a list of channel types that {msisdn} is opted-out for.
Parameters
Path msisdn String Yes msisdn to fetch opted-out channel types for. Valid characters: "\+?\d{3,25}"
Response
List of channel types of type ChannelType.
Example:
[
"HS", "SMS"
]
Status codes
200 List of opt-outed channel types for msisdn is successfully fetched.
POST /opt-outs
Adds a list of msisdn to be opted-out for a set of {ChannelType} .
Parameters
Parameter
type
Types of channel to add If the {channelType} is empty, misidn will be removed for all
Query channeltype ChannelType[] Yes
opted-out msisdn for. {channelType} . For valid values, refer to ChannelType.
A list of msisdn of type String. Invalid msisdn are disregarded.
Example:
[
"0704567266", "0786736543", "07153774476"
]
POST example:
POST /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Number of valid msisdn added.
Example:
Status codes

200 Msisdn are sucessfully added to opt-out list for channel types.
POST /opt-outs/msisdn-list
Adds a list of msisdn to be opted-out for a set of {ChannelType} .
Parameters
Query channeltype ChannelType[] Yes Types of channel to fetch opted-out msisdn for. For valid values, refer to ChannelType.
Newline ( \n )
Tab ( \t )
Comma ( , )
Semicolon ( ; )
File example:
0706779598;0736793445;0786739127
POST example:
POST /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Number of bytes in file received.
Example:
20348
Status codes
200 Msisdn are sucessfully added to opt-out list for channel types.
400 (14) Invalid parameter .

PUT /opt-outs
Replace a list of msisdn to be opted-out for a set of {ChannelType} .
Parameters
Parameter
type
Types of channel to replace If the {channelType} is empty, misidn will be removed for all
Example:
[
"0704567266", "0786736543", "07153774476"
]
PUT example:
PUT /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Number of valid msisdn replaced.
Example:
Status codes
200 Msisdn are sucessfully replaced in opt-out list for channel types.
PUT /opt-outs/msisdn-list
Replace a list of msisdn to be opted-out for a set of {ChannelType} .
Parameters
Query channeltype ChannelType[] Yes Types of channel to replace opted-out msisdn for. For valid values, refer to ChannelType.
Newline ( \n )
Tab ( \t )
Comma ( , )
Semicolon ( ; )
File example:
0706779598;0736793445;0786739127
PUT example:
PUT /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Example:
20348
Status codes
200 Msisdn are sucessfully replaced in opt-out list for channel types.
DELETE /opt-outs
Removes msisdn from being opted-out for a set of {ChannelType} .
Parameters
Parameter
type
Types of channel to delete If the {channelType} is empty, misidn will be removed for all

Example:
[
"0704567266", "0786736543", "07153774476"
]
If list of channel types is empty, msisdn will be removed for all channel types.
If list of msisdn is empty, all msisdn for channel types will be removed.
DELETE example:
DELETE /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Number of valid msisdn removed.
Example:
Status codes
200 Msisdn are sucessfully removed from opt-out list for channel types.
DELETE /opt-outs/msisdn-list
Removes msisdn from being opted-out for a set of {ChannelType} .
Parameters
Parameter
type
Types of channel to fetch If the {channelType} is empty, misidn will be removed for all
Newline ( \n )
Tab ( \t )
Comma ( , )
Semicolon ( ; )
File example:
0706779598;0736793445;0786739127
DELETE example:
DELETE /opt-outs/msisdn-list?channeltype=CT&channeltype=SMS&...
Response
Example:
20348
Status codes
200 Msisdn are successfully removed from opt-out list for channel types.
Reports
GET /reports
Generates a report containing a list of advertisers and their campaigns and channels with statistics for user actions and statistics
about delivery and impression.
Parameters
Parameter Data
type type
Query msisdn String No msisdn for subscriber to find statistics for. Valid characters: "\+?\d{3,25}"
Query advertiserid Integer No Unique id on advertiser to find statistics for. -
List of campaign identifiers. Resource returns report for all

Query campaignid Integer[] No -
campaigns if empty.
List of channel type identifiers. Resource returns report for all For valid values refer to
Query channeltypeid String[] No
channel types if empty. ChannelType
Start date (included) of time period for applicable campaigns.
Query startdate String No Created date for a campaigns to be included in the report must be Valid format: yyyyMMdd.
after or equal to this date.
End date (included) of time period for applicable campaigns. Created enddate must be equal or after
Query enddate String No date for campaigns to be included in the report must be before or startdate if both are defined. Valid
equal to this date format: yyyyMMdd.
Example:
GET /reports?msisdn=0000000000000&advertiserId=17&...
Response
A report of type AdvertiserStatisticsReport
Example:
{
"filter": {
"msisdn": "0000000000000",
"advertiserId": null,
"campaignId": [],
"channelTypeId": [],
"startDate": null,
"endDate": null
},
"advertiser": [
{
"id": 7,
"name": "Test",
"description": "A description of Test",
"createdDate": "2013-08-13T12:03:10+0200",
"campaign": [
{
"id": 8,
"name": "Test",
"description": "A description of campaign",
"createdDate": "2013-08-13T12:03:34+0200",
"createdBy": "adwiseadm",
"channel": [
{
"id": 21,
"description": "Test of user action collection.",
"startDate": "2013-08-13T12:12:28+0200",
"endDate": null,
"createdDate": "2013-08-13T12:11:41+0200",
"approvedDate": "2013-08-13T12:13:37+0200",
"approvedBy": "adwiseadm",
"onDemandStatistics": [],
"automaticSubscriberStatistics": [
{
"id": 28,
"msisdn": "0000000000000",
"iccid": null,
"enabled": -1,
"iterations": 3,
"actualChannelId": 21,
"requestedChannelId": 21,
"createdDate": "2013-08-13T12:16:48+0200",
"slotOne": 1,
"slotTwo": 0,
"slotThree": 1,
"slotFour": 1,
"slotFive": 1,
"slotSix": 0
},
...
]
},
{
"id": 232,
"description": "Test a Wib push channel with impression report",
"startDate": "2017-06-30T13:30:25+0200",
"endDate": null,
"createdDate": "2017-06-30T13:28:48+0200",
"approvedDate": "2017-06-30T13:29:58+0200",
"approvedBy": "adwiseadm",
"onDemandStatistics": [],
"automaticSubscriberStatistics": [],
"channelStatisticsSummary": null,
"wowSequenceStatistics": [],
"interactiveStatistics": [],
"interactiveStatisticsSummary": null,
"statisticsSummaryByStep": null,
"statisticsDelivery": {
"externalId": "WP-EXAMPLE",
"targetGroupId": 2,
"importSource": "GUI",
"status": null,
"time": null,
"impressionSteps": [
{
"stepNum": 1,
"stepLabel": "Name",
"stepType": "in",
"stepDate": "2017-06-30T13:32:04+0200",
"stepValue": "Luis"
},
{
"stepNum": 2,
"stepLabel": null,
"stepType": "dm",
"stepDate": "2017-06-30T13:32:04+0200",
"stepValue": null
},
{
"stepNum": 3,
"stepLabel": "Color",
"stepType": "sel",
"stepDate": "2017-06-30T13:32:04+0200",
"stepValue": null
}
]
}
},
...
]
},
...
]
},
...
]
}
Status codes
200 Report is successfully generated.
400 (7) Date parameter has wrong parameter.
GET /reports/impression/state/{channelId}
Check if the impression report (CSV file) is available for a channel.
Parameters
Path channelId Integer Yes Id of channel to get report. -
Response
The state of the CSV impression report
Example:
{
{
"enable": "true",
"state": "PENDING"
}
}
Status codes
200 Status of Impression report is successfully fetched.
GET /reports/impression/{channelId}
Get the impression report (CSV file) by channel.
Parameters
Response
A Zip file, with the CSV report inside.
Content-type: application/octet-stream
Status codes
200 Impression report is successfully fetched.
GET /reports/delivery/{channelId}
Get the delivery report (CSV file) by channel.
Parameters
Response
A Zip file, with the CSV report inside.
Content-type: application/octet-stream
Status codes
200 elivery report is successfully fetched.
Wib
POST /wib
Immediately pushes a WML to a list of msisdns.
Parameters
A list of msisdns and the wml code to be pushed to the Wib. The list can contain at most 100 msisdns.
Example:
{
"msisdns": [
"730258371", "773346821"
],
"wml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <wml xmlns=\"http://www.smarttrust.com/WIG-WML/5.0\" xmlns:xsi=\"http://
www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.smarttrust.com/WIG-WML/5.0 http://www.smarttrust.com/xs
d/wigwml-5.0.xsd\"><card id=\"Main\"> Hello world!</card></wml>"
}
Response
A list of targeted msisdns.
Example:
[
"730258371", "773346821"
]
Status codes
200 WML is successfully pushed to WIB.
401 (3) No permission for user to push to WIB.
HealthCheck
GET /manage/health
For check the ADWISE server health status.
Parameters
Simple GET request without any parameters.
Response
Provide the server status.
Example:
{
"status": "UP"
}
Status codes
200 The service is functional and ready to serve requests.
503 The service is not functional and can not serve requests.
503 The service is deliberately taken out of service (e.g. due to maintenance) and can not serve requests.
200 The status of the service can not be determined currently.
Data types
Advertiser
Represents a specific advertiser.
Attributes
Mandatory (in
POST/PUT)
id Integer No Unique id on advertiser. -
Name of company advertiser

companyName String Yes Max 255 characters.
represents.
description String No Description of advertiser. Max 2000 characters.

Date and time advertiser was Valid format (ISO-8601):
createdDate String No
created. yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
contactAddress String No Contact address for advertiser. Max 255 characters.
contactName String No Name of contact for advertiser. Max 255 characters.
contactTitle String No Title of the advertiser's contact. Max 255 characters.
E-mail address to contact for

contactEmail String No Max 255 characters.
advertiser.
Ids on campaigns connected to

campaignIds Integer[] No -
advertiser.
Only available if rate limit per advertiser is enabled. In this case, it is

rateLimit Integer No Rate limit assigned to an advertiser.
mandatory.
rateLimitUnit String No Units of Rate limit. Only available if rate limit per advertiser is enabled.
Campaign
Represents a specific campaign.
Attributes
Name Type Mandatory (in POST/PUT) Description Notes
id Integer No Unique id on campaign -
campaignName String Yes Name of campaign. Max 32 characters.
description String No Description of campaign. Max 2000 characters.
Valid format (ISO-8601):

createdDate String No Date and time campaign was created.
yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
externalId String No Adertiser's internal reference id for campaign. Max 255 characters. Valid characters: "a-z,A-Z,0-9,-,."
advertiserId Integer Yes Id of advertiser this campaign belongs to. -
additionalNotes String No Additional information about this campaign. Max 255 characters.
channelIds Integer[] No Ids on channels connected to campaign. -
TargetGroup
Represents a specific target group.
Attributes
Mandatory
Name Type (in Description Notes
POST/PUT)
Unique id on target
id Integer No -
group.
targetGroupName String Yes Name of target group. Max 255 characters.
Description of target
description String No Max 2000 characters.
group.
Date and time target

createdDate String No Valid format (ISO-8601): yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
group was created.
true if target group is A target group can be removed when it is not connected to any provisionings and/or
removable Boolean No removable, otherwise channels. Note that the state of this property can have been changed after the last time it
false was read.
Id on advertiser this
advertiserId Integer Yes Value -1 if target group belongs to any advertiser.
target group belongs to.
msisdn String[] Yes List of msisdn. Valid characters for msisdn: "\+?\d{3,25}"
Channel
Represents a specific channel. The channel types have different sets of attributes, but some of the attributes are common for all
types of channels.
Attributes for presentation channels

The following attributes are (unless noted) applicable for all presentation channels.
Mandatory
POST/PUT)
id Integer No Unique id on channel. -
channelType String Yes Type of channel. For valid values, refer to ChannelType.
description String No Description of channel. Max 2000 characters.
Optional unique external

externalId String No Max 255 characters. Valid characters: "a-z,A-Z,0-9,-,."
identifier of the channel
Defines the number of

Max number if iterations is 10. If omitted no retries will be performed.
retries Integer No retries that should be
Not applicable for CBHS -channel.
performed for expired cards.
Rate limit configured by user

This value will be validated against configured values of rate limit
rateLimit Integer No to be used by BOM to send
Bom/RateLimit in registry
advertisement.
Rate limit to be used by BOM

rateLimitAssigned Integer No This value is read only.
to send advertisement.
Rate limit unit to be used by

rateLimitUnit String No This value is read only.
BOM to send advertisement.
Defines the reporting interval

msisdnReportingIntervals Integer No for generating MSISDN CSV This value will 1,2,4,6,8,12...
and Delivery report.
Defines the reporting interval

statisticsReportingInterval Integer No for generating CSV It only applies to Wib push and S@t push channels
Impression report.
A semicolon separated list
with hours (in 24-hour Range [0-23], ex: "1;5;21". The numbers must be in chronological
pauseDelivery String No format) representing the order. At least one hour must be left out. Default value is specified in
time when no information is the system registry. Not applicable for CBHS -channel.
sent to the phone.
state String No Current state of channel. For valid values, refer to ChannelState.
true if channel is editable, A channel in one of the following states: DRAFT or PROPOSED , can be
editable Boolean No e.g. possible to approve, edited. Note that the state of this property can have been changed
otherwise false . after the last time it was read.
A channel in one of the following states: DRAFT , PROPOSED , FAILED or

true if channel is
removable Boolean No CANCELED , can be removed. Note that the state of this property can
removable, otherwise false
have been changed after the last time it was read.
Id on campaign channel
campaignId Integer Yes -
belongs to.
Date and time channel was Valid format (ISO-8601):

created. yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Date and time channel is Valid format (ISO-8601):

startDate String Yes
starts. yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Mandatory only for CBHS channel for other channels this field is
optional. Must be after startDate . Valid format (ISO-8601): yyyy-MM-
Date and time when channel
endDate String Yes/No ddTHH:mm:ss[+|-]ZZZZ Channel will neither resume or start past the
ends.
end date and time. Channel will not be created or copied past it's end
date and time
Ids on target groups

targetGroupIds Integer[] Yes Live channels don't support target groups.
connected to channel.
Valid values: "DEFAULT" or "DISPLAY_TOGETHER_WITH_NET-

Tells if SIM Service Provider
spnDisplayOption Boolean No WORK_OPERATOR_NAME". Only applicable for SPN -channels. If
Name shall be displayed.
omitted then "DEFAULT" value will be used.
numberOfCalls- Number of calls between Only applicable for CTI -channels. Default 0 (i.e. each call). Valid
Integer No
BetweenAds each ad display. values [0..8].
numberOfIterations- Number of calls before a Only applicable for CT - and CTI -channels. Default 0. Valid values
Integer No
BetweenReports report is sent. [0..8].
numberOfReports- Number of reports before Only applicable for CT - and CTI -channels. Default 0. Valid values
Integer No
BeforeStopping channel is disabled. [0..8].
true if advertisements are

useUnicode Boolean Yes -
in Unicode, otherwise false .
priority String No The priority of the channel. log , medium or high values accepted.
Content type for Mandatory only for PUSH and PUSHI channels; for other channels this
pushContentType String Yes/No
Personalized Push channels. field is not used. WIB or SAT values accepted.
List of Parameters for Mandatory only for PUSH and PUSHI channels; for other channels this
parameterList Parameter[] Yes/No
Personalized Push channels. field is not used. For Parameter attributes, see below.
For Advertisement attributes, see below. Valid data: At least one

Presentation channel advertisement. CT -, CT installed -, CTI - and CTI installed -channels
advertisements Advertisement[] Yes
advertisements. may contain up to six (6) advertisements. Other types of channels
must have one (1) advertisements only.
Advertisement
For WP -channels use this for the WML-code. The following rules are
applicable for CTI - and CTI_INSTALL -channels only:
Can be disabled for CTI - and CTI_INSTALL -channels by setting
message String Yes Message to be displayed. it to null .
At least one of message , prompt , input or
[wmlCode | wibletUrl | optInTargetGroupId] must have a valid
value.
Applicable for CTI - and CTI installed -channels only. Disabled when
prompt String Yes Question to proceed. set to null . At least one of message , prompt , input or
[wmlCode | wibletUrl | optInTargetGroupId] must have a valid value.
Defines the "Continue" Applicable for CTI - and CTI installed -channels only. Must have a
selection1 String Yes
selection. value when property prompt has a value.
Applicable for CTI - and CTI installed -channels only. Must have a
selection2 String No Defined the "Exit" selection.
value when property prompt has a value.
true if slot should be

Default value: false . Applicable for CTI - and CTI installed -channels
disableAfterContinue Boolean Yes disabled after user has
only. Disabled when property message is set to null .
proceeded.
Applicable for CTI - and CTI installed -channels only. Disabled when
Question after user has
input String Yes set to null . At least one of message , prompt , input or
proceeded.
[wmlCode | wibletUrl | optInTargetGroupId] must have a valid value.
Applicable for CTI -channels only. Must be set to null when property
wmlCode String No Local wiblet wml wibletUrl is set to non- null . At least one of message , prompt , input
or [wmlCode | wibletUrl | optInTargetGroupId] must have a valid value.
Applicable for CTI - and CTI installed -channels only. Must be set to
Uri pointing to remote wiblet null when property wmlCode is set to non- null . At least one of
wibletUrl String Yes
wml. message , prompt , input or [wmlCode | wibletUrl | optInTargetGroupId]
must have a valid value.
Applicable for CTI - and CTI installed -channels only. At least one of
optInTargetGroupId Integer No Id on opt-in target group. message , prompt , input or [wmlCode | wibletUrl | optInTargetGroupId]
must have a valid value.
Parameter
Name of the parameter used

parameterName String Yes in the advertisements -
message.
Sample value for the

parameterSampleValue String No -
parameter.
Attribute to channel type mapping

CTI_INSTALL
CT_INSTALL
STATS
PUSH
CBHS
ASW
SMS
SPN
CTI
WP
HS
SP
CT
Attribute
IP
id X X X X X X X X X X X X X X
channelType X X X X X X X X X X X X X X
description X X X X X X X X X X X X X X
campaignId X X X X X X X X X X X X X X
createdDate X X X X X X X X X X X X X X
startDate X X X X X X X X X X X X X X
endDate X X X X X X X X X X X X X X
targetGroupIds X X X X X X X X X X X X X
msisdnReportingIntervals X X X X X X X X X X X X X X
statisticsReportingInterval X X X X
spnDisplayOption X
numberOfCallsBetweenAds X
numberOfIterationsBetweenReports X X
numberOfReportsBeforeStopping X X
useUnicode X X X X X X X X X X X X X X
priority X X X X X X X X X X X X X X
pushContentType X X
parameterList X X
advertisements X X X X X X X X X X X X X X
Advertisements
message X X X X X X X X X X X X X X
prompt X X
selection1 X X
selection2 X X
disableAfterContinue X X
input X X
wmlCode X
wibletUrl X X
optInTargetGroupId X X
Parameter
parameterName X X
parameterSampleValue X X
Attributes for interactive channels

The following attributes are (unless noted) applicable for all interactive channels.
Mandatory
POST/PUT)
channelType String Yes Type of channel. For valid values, refer to ChannelType.
Optional unique external Max 255 characters. Valid characters: "a-z,A-

externalId String No
identifier of the channel Z,0-9,-,."
Defines the number of

retries that should be Max number if iterations is 10. If omitted no
retries Integer No
performed for expired retries will be performed.
cards.
A semicolon separated list
Range [0-23], ex: "1;5;21". The numbers must
with hours (in 24-hour
be in chronological order. At least one hour must
pauseDelivery String No format) representing the
be left out. Default value is specified in the
time when no information
system registry.
is sent to the phone.
state String No Current state of channel. For valid values, refer to ChannelState.
A channel in one of the following states: DRAFT

true if channel is
or PROPOSED , can be edited. Note that the state
editable Boolean No editable, e.g. possible to
of this property can have been changed after the
approve, otherwise false .
last time it was read.
A channel in one of the following states: DRAFT ,

true if channel is
PROPOSED , FAILED or CANCELED , can be removed.
removable Boolean No removable, otherwise
Note that the state of this property can have
false
been changed after the last time it was read.
Id on campaign channel
campaignId Integer Yes -
belongs to.
Originating Address of the

originatingAddress String No Max 20 characters length
STM Channel
Defines the reporting

interval for generating
msisdnReportingIntervals Integer No This value will 1,2,4,6,8,12...
MSISDN CSV and Delivery
report.
Date and time channel Valid format (ISO-8601):

was created. yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Date and time channel is Valid format (ISO-8601):

startDate String Yes
starts. yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Must be after startDate . Valid format (ISO-

8601): yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Date and time when
endDate String No Channel will neither resume or start past the end
channel ends.
date and time. Channel will not be created or
copied past it's end date and time
Ids on target groups

targetGroupIds Integer[] Yes -
connected to channel.
Valid only for TI channel. Valid format (ISO-

Time from which this
effectiveDate String No 8601):
channel will be effective.
Valid only for TI channel. Valid format (ISO-

Time after which this
expiryDate String No 8601):
channel will be expired.
Maximum no of times
Valid only for TI channel. Value should be
maxDisplay Integer Yes channel will be displayed
-1(No limit) or from 1-255
to the user.
Frequency for sending Valid only for TI channel. Value should be

sendReportFrequency Integer Yes
reports back to adwise. -1(Never) or 0(On disable only) or from 1-15
Report should be sent Valid only for PI channel. Value should be

sendReportValue Integer Yes
back or not. 1(No) or 0(Yes)
Interactive channel For Advertisement attributes, see below. Valid

advertisements Advertisement[] Yes
advertisements. data: Should have only one advertisement only.
Advertisement
Interactive channels steps list,

interactiveChannelSteps InteractiveChannelStep[] Yes List of all interactive steps. interactiveChannelSteps size should be greater
than 0 and less than 16.
InteractiveChannelStep
Step type defines the type
stepType StepType No of step available, other -
steps will be null.
This step will show a A prompt message will be displayed using this
displayMessageInfo ChannelInteractiveDisplayMessageInfo No
prompt on user screen. step.
A message of 160*(Max Sm configured)

This step will send static
staticTextMessageInfo ChannelInteractiveStaticTextMessageInfo No characters in GSM and 80*(Max Sm configured)
message to user device.
characters in unicode is allowed.
This step will show up an A prompt input of will be displayed using this
inputInfo ChannelInteractiveInputInfo No
input prompt to the user. step.
This step will open a

launchBrowserInfo ChannelInteractiveLaunchBrowserInfo No browser in user device User need to enter a URL
with provided URL.
This step will select with

selectInfo ChannelInteractiveSelectInfo No multiple options on the User can select from multiple available options
user device.
This step will send inbox

sendSmsInfo ChannelInteractiveSendSmsInfo No User need to enter message and phone number
message to user device.
This step will disable

disableInfo ChannelInteractiveDisableInfo No further execution of the No information is required by this step.
any existing campain
This step will place a call

setupCallInfo ChannelInteractiveSetupCallInfo No from user device to User need to enter phone number.
provided phone number.
This step will send specific This step can take values from input and select
webServiceInfo ChannelInteractiveWebServiceInfo No
information's to an URL. step as an input to web service
Optional Originating
originatingAddress String No Max 20 characters.
Address.
This step will allows the

User need to set a label for each step in the
statisticsInfo ChannelInteractiveStatisticsInfo No user to take statistics of
statistics step.
the other steps.
Channel wise max length for interactive steps

The following attributes are applicable for all interactive steps.
PI/TI WPI STMI SPI PUSHI IPI

Step (Non- (Non- (Non- (Non- (Non- (Non-
unicode/Unicode) unicode/Unicode) unicode/Unicode) unicode/Unicode) unicode/Unicode) unicode/Unicode)
DisplayTextLength/(Half Depends on push Depends on push

DisplayMessage 240/120 of DisplayTextLength) NA 240/120 content type (WIB content type (WIB
from wig or SAT) or SAT)
Depends on push Depends on push

Input 236/118 158/78 NA 236/118/ content type (WIB content type (WIB
or SAT) or SAT)

LaunchBrowser 241/NA 253/NA NA 253/NA content type (WIB content type (WIB
or SAT) or SAT)

Select 233/114 188/92 NA 233/114 content type (WIB content type (WIB
or SAT) or SAT)

Option 233/114 94/47 NA 233/114 content type (WIB content type (WIB
or SAT) or SAT)
SendSms 229/NA 160/80 NA 160/NA content type (WIB content type (WIB
or SAT) or SAT)

SetupCall 25/NA 25/NA NA 25/NA content type (WIB content type (WIB
or SAT) or SAT)

WebService 1000/NA 158/NA NA NA content type (WIB content type (WIB
or SAT) or SAT)

WebServiceParameter 50/NA 50/NA NA NA content type (WIB content type (WIB
or SAT) or SAT)
160*(Max Sm
StaticTextMessage NA NA configured)/80*(Max NA NA NA
Sm configured)
Statistics NA 50/NA NA 50/NA 50/NA 50/NA
Attributes for interactive steps

The following attributes are applicable for all interactive steps.
Mandatory
POST/PUT)
StepType
Defines the
type of step
stepType String Yes -
available from
below.
ChannelInteractiveDisplayMessageInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Message for
displayMessage String Yes display -
message step.
True, when
message is to
persistent Boolean No be displayed -
persistently
on the device.
Read Only This

property will
If this property is provided,
be
unicode Boolean No property will be overridden by
autodetected,
server.
no need to set
this property.
ChannelInteractiveStaticTextMessageInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Message for
message String Yes static text -
message.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveInputInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Message to be
message String Yes used as input -
heading.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveLaunchBrowserInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
URL to be
used for
url String Yes -
launch
browser.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveSelectInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Title for select

selectText String Yes -
step.
optionText : Option text
value.
optionId : Unique Id need

Options for
select step. at the time of update.
Minimum two
options stepId : Id of the select
selectOptions ChannelInteractiveSelectOptionInfo[] Yes should always option to which options are
be added and to be added.
maximum two
options for
unicode : Read Only This
Confirm step.
property will be
autodetected, no need to
set this property.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveSendSmsInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Message to be
message String Yes sent using -
SMS step.
Number to
number String Yes which SMS is -
to be sent.
Number to be
used as
serviceCenterAddress String No -
service center
address.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveDisableInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveSetupCallInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Number to
toNumber String Yes which call is -
initiated.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveWebServiceInfo
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
URL to which
url String Yes collected data -
is to be sent.
parameterText : Parameter
name that is to used.
parameterId : Unique Id
need at the time of update.
stepId : Id of the
Parameters to webservice step to which
serviceParamterInfos ChannelInteractiveWebServiceParameterInfo[] No webservice parameters are to be
step. added.
connectedStepId : Id of the
select or input step used
by webservice, steps
should be before
webservice step.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
ChannelInteractiveStatisticsInfo
label : Parameter that
includes the list of labels. It
must contain one label per
step. If it is null user will
statisticsLabelInfoList ChannelInteractiveStatisticsInfo[] No
Statistics step not receive statistics of its
parameters.
step. (It is mandatory to
put this parameter. If user
do not need it, it must be
set to null.)
Defines the
type of step.
Unique Id
need at the
stepId Integer No -
time of
update.
Read Only This

property will
be
autodetected,
server.
no need to set
this property.
PUSHI
STMI
WPI
SPI
IPI
Attribute
PI
TI
id X X X X X X X
channelType X X X X X X X
description X X X X X X X
campaignId X X X X X X X
createdDate X X X X X X X
startDate X X X X X X X
endDate X X X X X X X
targetGroupIds X X X X X X
effectiveDate X
originatingAddress X
msisdnReportingIntervals X X X X X X X
expiryDate X
maxDisplay X
sendReportFrequency X
sendReportValue X
priority X X X X X X X
pushContentType X X
parameterList X X
advertisements X X X X X X X
Advertisements
interactiveChannelSteps X X X X X X X
InteractiveChannelSteps
stepType X X X X X X X
displayMessageInfo X X X X X X
staticTextMessageInfo X
inputInfo X X X X X X
launchBrowserInfo X X X X X X
selectInfo X X X X X X
sendSmsInfo X X X X X X
disableInfo X
setupCallInfo X X X X X X
webServiceInfo X X X X X
statisticsInfo X X X X
Parameter
parameterName X X
parameterSampleValue X X
StepType
Enumeration that defines a set of values valid for elements of StepType
Valid value set

Value Description
MESSAGE Step type is display message.
STATIC_TEXT_MESSAGE Static message sent as SMS.
INPUT Step type is input.
LAUNCH_BROWSER Step type is launch browser.
SELECT Step type is select.
SMS Step type is send short message.
DISABLE Step type is disable.
SETUP_CALL Step type is setup call.
WEB_SERVICE Step type is webservice.
CONFIRM Step type is confirm.
STATISTICS Step type is statistics.
Attributes for WOW channels

The following attributes are (unless noted) applicable for WOW channels, i.e. channel of type WOWOFFOV , WOWONOV , WOWMOV and
WOWCB .
Mandatory
POST/PUT)
channelType String No Type of channel. For valid values, refer to ChannelType.
Optional unique external identifier of

the channel
Defines the number of retries that

Max number if retries is 10. If omitted no retries will be
retries Integer No should be performed for expired
performed. Only applicable for WOWONOV -channel.
cards.
A semicolon separated list with hours Range [0-23], ex: "1;5;21". The numbers must be in
(in 24-hour format) representing the chronological order. At least one hour must be left out.
pauseDelivery String No
time when no information is sent to Default value is specified in the system registry. Only
the phone. applicable for WOWONOV -channel.
campaignId Integer Yes Id on campaign channel belongs to. -
Valid format (ISO-8601): yyyy-MM-

createdDate String No Date and time channel was created.
ddTHH:mm:ss[+|-]ZZZZ

startDate String Yes Date and time channel is starts.
Only applicable for WOWMOV - and WOWCB -channels. Must be

endDate String Yes Date and time channel ends. after startDate . Valid format (ISO-8601): yyyy-MM-
Ids on target groups connected to

targetGroupIds Integer[] Yes Not applicable for WOWOFFOV and WOWMOV -channels.
channel.
Not applicable for WOWCB -channel. At least one of

Wow channel is triggered when ME is
powerOnEvent Boolean Yes/No powerOnEvent , callDisconnectEvent or idleScreenEvent
turned on.
must be true . false if omitted.

Wow channel is triggered when user
callDisconnectEvent Boolean Yes/No powerOnEvent , callDisconnectEvent or idleScreenEvent
terminates a call.

Wow channel is triggered when ME
idleScreenEvent Boolean Yes/No powerOnEvent , callDisconnectEvent or idleScreenEvent
has idle screen.
true enables the "never-option"

showNever Boolean Yes Not applicable for WOWCB -channel.
while false disables it.
If true ME sends statistics to server

sendReport Boolean Yes Only applicable for WOWONOV - and WOWONOV -channels.
after last step. false if omitted.
If true then Wow functionality on ME

Not applicable for WOWCB -channel and not applicable if
disableWhenNever Boolean Yes will be disabled when never-option is
showNever is false.
selected.
Id of symphony connected to this

symphonyId Integer Yes Only applicable for WOWOFFOV - and WOWONOV -channels.
channel.
Initial promotion info to be stored in Only applicable for WOWOFFOV -channels. (See
initialPromotionInfo InitialPromotionInfo Yes
PAD area. InitialPromotionInfo.)
true if advertisements are in

Unicode, otherwise false .
priority String No The priority of the channel. log , medium or high values accepted.
For Advertisement attributes, see below. Valid data: At
least one advertisement. WOWCB -channels must have one
advertisements Advertisement[] Yes WOW channel advertisements.
(1) advertisement only. Other types of WOW channels may
contain up to four (4) advertisements.
Advertisement
primaryMessage String Yes Message to be displayed. Disabled when set to null .
Disabled when set to null . Not applicable for WOWCB -

secondaryMessage String No Message to be displayed.
channel.
Valid values are: "SETUP_CALL", "SEND_USSD",

Action to be triggered if user proceeds
primaryAction String Yes "LAUNCH_BROWSER", "SEND_SM", "REMOTE_WIBLET"
after primaryMessage .
and "LOCAL_WIBLET".
Valid values:
LAUNCH_BROWSER and REMOTE_WIBLET - must
be a valid URL.
LOCAL_WIBLET - must be the id on a local wiblet.
Interpretation is depending on the A list of local wiblet identifiers can be fetched with
primaryActionMessage1 String Yes
value of primaryAction . the service GET /channels/wiblets .
SEND_USSD - must be a valid USSD.
SETUP_CALL - must be a valid MSISDN.
SEND_SM - a large account. Max 10 characters.
Only applicable when primaryAction is "SEND_SM". Max

primaryActionMessage2 String Yes Text message.
15 characters.
Not applicable for WOWCB -channel. Valid values are:

Action to be triggered if user proceeds
secondaryAction String No "SETUP_CALL", "SEND_USSD", "LAUNCH_BROWSER",
after secondaryMessage .
"SEND_SM", "REMOTE_WIBLET" and "LOCAL_WIBLET".
Not applicable for WOWCB -channel. Valid values:

LAUNCH_BROWSER and REMOTE_WIBLET - must
be a valid URL.
LOCAL_WIBLET - must be the id on a local wiblet.
Interpretation is depending on the A list of local wiblet identifiers can be fetched with
secondaryActionMessage1 String No
value of secondaryAction . the service GET /channels/wiblets .
SEND_USSD - must be a valid USSD.
SETUP_CALL - must be a valid MSISDN.
SEND_SM - a large account. Max 10 characters.
Not applicable for WOWCB -channel. Only applicable when

secondaryActionMessage2 String No Text message.
secondaryAction is "SEND_SM". Max 15 characters.
Determines weather the double

confirmation should be a question or
confirmationType String Yes a message. Ex QUESTION ="would you Valid values are: "NONE", "MESSAGE" and "QUESTION".
like to proceed?", MESSAGE ="Press OK
to proceed")
condition1 String No Parameter to filter specific users.
Only applicable for WOWCB -channel. Valid values are:

Category of the advert. The advert "BANKING_FINANCIAL", "REAL_ESTATE", "EDUCATION",
category String No will not be displayed for the users that "HEALTH", "CONSUME_GOODS_AUTOMOBILES",
has blocked this category. "COMMUNICATION_ENTERTAINMENT_IT",
"TOURISM_LEISURE" and "RESERVED".

The following table shows which attributes are applicable for each type of channel.
WOWOFFOV
WOWONOV
WOWMOV
WOWCB
Attribute
id X X X X
channelType X X X X
description X X X X
campaignId X X X X
createdDate X X X X
startDate X X X X
endDate X
targetGroupIds X X
powerOnEvent X X X
callDisconnectEvent X X X
idleScreenEvent X X X
showNever X
promotionType X
sendReport X
disableWhenNever X
sequenceId X X
initialPromotionInfo X
useUnicode X X X X
advertisements X X X X
Advertisements
primaryMessage X X X X
secondaryMessage X X X
primaryAction X X X X
primaryActionMessage1 X X X X
primaryActionMessage2 X X X X
secondaryAction X X X
secondaryActionMessage1 X X X
secondaryActionMessage2 X X X
confirmationType X X X X
condition1 X X X X
condition2 X X X X
condition3 X X X X
condition4 X X X X
condition5 X X X X
category X
Attributes for administrative channels

The following attributes are (unless noted) applicable for administrative channels, i.e. channels of type ACDM , AEDC or ARDM .
Mandatory
POST/PUT)
channelType String No Type of channel. For valid values, refer to ChannelType.
campaignId Integer Yes Id on campaign channel belongs to. -
createdDate String No Date and time channel was created. Valid format (ISO-8601): yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
startDate String Yes Date and time channel is starts. Valid format (ISO-8601): yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Only applicable for CBHS -, WOWMOV - and WOWCB -channels.

endDate String No Date and time channel ends.
Valid format (ISO-8601): yyyy-MM-ddTHH:mm:ss[+|-]ZZZZ
Optional unique external identifier of the

channel
Defines the number of retries that should be Max number if retries is 10. If omitted no retries will be
retries Integer No
performed for expired cards. performed.
A semicolon separated list with hours (in 24- Range [0-23], ex: "1;5;21". At least one hour must be left
pauseDelivery String No hour format) representing the time when no out. Default value is specified in the system registry. The
information is sent to the phone. numbers must be in chronological order.
targetGroupIds Integer[] Yes Ids on target groups connected to channel. Not applicable for WOWOFFOV and WOWMOV -channels.
Valid values for ACDM and ARDM are: CT and CTI .

deliveryChannelType ChannelType[] Yes List of delivery channels. Valid values for AEDC are: CT , CT_INSTALL , CTI and
CTI_INSTALL .
true if messages are in Unicode, otherwise

false .
messages String[] No Only applicable for ACDM -channel.
isEnable Boolean No true if enabled, otherwise false . Only applicable for AEDC -channel.

The following table shows which attributes are applicable for each type of channel.
ARDM
ACDM
AEDC
Attribute
id X X X
channelType X X X
description X X X
campaignId X X X
createdDate X X X
startDate X X X
endDate
targetGroupIds X X X
deliveryChannelType X X X
useUnicode X X X
messages X
isEnable X
InitialPromotionInfo
Represents initial promotion info for a WOWOFFOV -channel.
Mandatory (in
POST/PUT)
A list of local wiblet identifiers can be fetched with the

scriptIdentifier String No Id of local wiblet to trigger at power on.
service GET /channels/wiblets .
Wiblet return mode after local wiblet is Valid values: one of NEVER , WHEN_NO_ACTION or ALWAYS . If
returnMode String No
triggered. omitted then WHEN_NO_ACTION will be used.
PAD area where initial promotion info

padStorageArea Integer Yes Valid values: [0..256].
shall be located.
Text to be displayed as rejection

rejectionQuestion String Yes Max 14 characters.
question.
Text to be displayed as "Never" answer

rejectionQuestionNever String Yes Max 14 characters.
to rejection question.
Text to be displayed as "Not now"

rejectionQuestionNotNow String Yes Max 14 characters.
answer to rejection question.
Text to be displayed as confirmation

confirmationMessage String Yes Max 36 characters.
message.
Text to be displayed as confirmation

confirmationQuestion String Yes Max 14 characters.
question.
Text to be displayed as positive answer

confirmationQuestionPositive String Yes Max 14 characters.
to confirmation question.
Text to be displayed as negative answer

confirmationQuestionNegative String Yes Max 14 characters.
to confirmation question.
customerCareMsisdn String Yes MSISDN to customer care. Valid characters for msisdn: "\+?\d{3,25}".
ChannelType
Enumeration that defines a set of values valid for elements of ChannelType
Valid value set

Value Description
ACDM ADMIN_CHANGE_DEFAULT_MESSAGE
AEDC ADMIN_ENABLE_DISABLE_CHANNEL
ARDM ADMIN_RESTORE_DEFAULT_MESSAGE
CT CALL_TERMINATED
CTI CALL_TERMINATED_INTERACTIVE
CT_INSTALL CALL_TERMINATED_INSTALL
CTI_INSTALL CALL_TERMINATED_INTERACTIVE_INSTALLED
HS HOMESCREEN
CBHS CELLBROADCAST_HOMESCREEN
SMS SEND_SMS
SPN SERVICE_PROVIDER_NAME
ASW APPLICATION_SPECIFIC_WIBLET
WP WIB_PUSH
SP SAT_PUSH
PUSH PUSH_MESSAGE
IP INDIVIDUAL_PERSONALIZED
WOWOFFOV WOW_OFFLINE_OVERTURE
WOWONOV WOW_ONLINE_OVERTURE
WOWMOV WOW_MOVEMENT
WOWCB WOW_CELLBROADCAST
PI PUSH_INTERACTIVE
TI TRIGGER_INTERACTIVE
WPI WIB_PUSH_INTERACTIVE
STMI STATIC_TEXT_MESSAGE_INTERACTIVE
SPI SAT_PUSH_INTERACTIVE
PUSHI PERSONALIZED_PUSH_INTERACTIVE
IPI INDIVIDUAL_PERSONALIZED_INTERACTIVE
ChannelState
Enumeration that defines a set of values valid for elements of ChannelState
Valid value set

Value Description
UNKNOWN Channel is in an unknown state.
DRAFT Channel is in a draft state.
PROPOSED Channel is proposed.
APPROVED Channel is approved.
INITIALIZING Channel is initializing.
PENDING Channel is pending.
ONGOING Channel is ongoing.
PAUSED Channel is paused.
PUBLISHED Channel is published.

ARCHIVED Channel is archived.
CANCELED Channel is cancelled.
FAILED Channel has failed.
FINALIZED Channel has finalized.
FINISHED Channel has finished.
IDLE Channel is waiting to be refilled.
Symphonies
Represents a WOW symphony.
Attributes
Mandatory (in
POST/PUT)
id Integer No Unique id on symphony. -
name String Yes Name of symphony. Max 256 characters.
description String No Description of symphony. Max 256 characters.
externalId String No External reference to entity in other system. Max 256 characters. Valid characters: "a-z,A-Z,0-9,-,."

createdDate String No Date and time symphony was created.
List of identities of channels selected for this

channelId Integer[] No -
symphony.
AdvertiserStatisticsReport
Represents the statistics collected for advertisers.
Attributes
Example:
{
"msisdn": value,
"advertiserId": value,
"campaignId": value,
filter Filter N/A Filter defined by caller.
"channelTypeId": value,
"startDate": value,
"endDate": value
}
advertiser AdvertiserStatisticsItem[] N/A Statistics collected for each advertiser. Refer to AdvertiserStatisticsItem
AdvertiserStatisticsItem
Represents the statistics collected for a specific advertiser.
Attributes
Mandatory (in
POST/PUT)
id Integer N/A Unique identifier. -
name String N/A Name on advertiser. -
description String N/A Description of advertiser. -
Date and time advertiser was added to Valid format (ISO-8601): yyyy-MM-
createdDate Date N/A
system. ddTHH:mm:ss[+|-]ZZZZ
campaign Campaign[] N/A List of campaigns belonging to advertiser. Refer to CampaignItem
CampaignItem
Represents the statistics collected for a specific campaign.
Attributes
Mandatory (in
POST/PUT)
name String N/A Name on campaign. -
description String N/A Description of campaign. -
Date and time campaign was added to Valid format (ISO-8601): yyyy-MM-
createdBy String N/A Creator of campaign. -
channel ChannelItem[] N/A List of channels belonging to campaign. Refer to ChannelItem
ChannelItem
Represents the statistics collected for a specific channel.
Attributes
Mandatory (in
POST/PUT)
channelType String N/A Type of channel. For valid values refer to ChannelType
description String N/A Description of channel. -

startDate Date N/A Date and time channel starts to be enabled.

endDate Date N/A Date and time channel ends to be enabled.
Date and time channel was added to Valid format (ISO-8601): yyyy-MM-

approvedDate Date N/A Date and time channel was approved.
createdBy String N/A Creator of channel. -
approvedBy String N/A Approver of channel. -
List of on demand statistics belonging to

onDemandStatistics OnDemandStatistics[] N/A Refer to OnDemandStatistics
channel.
automaticSubscriber- List of automatic subscriber statistics

SubscriberStatistics[] N/A Refer to SubscriberStatistics
Statistics belonging to channel.
List of interactive statistics belonging to

interactiveStatistics InteractiveStatistics[] N/A Refer to InteractiveStatistics
channel.
Only available when not filtering by

List of summary statistics by impression
statisticsSummaryByStep StatisticsSummaryByStep[] N/A MSISDN.
step belonging to channel.
Refer to StatisticsSummaryByStep
Reporting interval to create the impression If this value is 0, the impression report
statisticsReportingInterval Integer N/A
report. is not available
Only available when filtering by

List of summary statistics by impression
statisticsDelivery StatisticsDelivery N/A MSISDN.
step belonging to channel.
Refer to StatisticsDelivery
OnDemandStatistics
Represents the on demand statistics collected for a specific channel.
Attributes
Mandatory (in
POST/PUT)
Start date and time for which statistics are Valid format (ISO-8601): yyyy-MM-
startDate Date N/A
collected. ddTHH:mm:ss[+|-]ZZZZ
End date and time for which statistics are Valid format (ISO-8601): yyyy-MM-
endDate Date N/A
collected. ddTHH:mm:ss[+|-]ZZZZ
description String N/A Description of channel statistics. -
Percentage of subscribers i target group

targetPercentage Float N/A -
that ... .
targets Integer N/A Number of subscribers in target group. -
List of subscriber statistics belonging to

subscriberStatistics SubscriberStatistics[] N/A Refer to SubscriberStatistics
channel.
SubscriberStatistics
Represents the subscriber statistics collected for a specific channel.
Attributes

Adwise 4.5 REST API Documentation

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Adwise 4.5 REST API Documentation

Uploaded by

Copyright:

Available Formats

Adwise API

REST API version Adwise version

1.1 3.4 or later

The following response status codes can be returned by all resources.

HTTP status code Reason

200 Method successfully completed.

Name Type Description Notes

errorCode Integer Unique code defining the type of error. -

errorMessage String Message describing the error. -

HTTP status code Reason

200 List of advertisers is successfully fetched.

Parameter type Name Data type Mandatory Description Notes

Path advertiserId Integer Yes Id of advertiser to fetch. -

HTTP status code Reason

200 Advertiser is successfully fetched.

401 (3) No permission for user to fetch advertiser.

404 (5) Advertiser not found.

HTTP status code Reason

200 Advertiser is successfully created.

400 (1) Missing parameter.

400 (8) Parameter value is too long.

401 (3) No permission for user to create advertiser.

409 (9) Advertiser already exists.

Parameter type Name Data type Mandatory Description Notes

Path advertiserId Integer Yes Id of advertiser to update. -

HTTP status code Reason

200 Advertiser is successfully updated.

400 (1) Missing parameter.

400 (8) Parameter value is too long.

401 (3) No permission for user to update advertiser.

404 (5) Advertiser not found.

Parameter type Name Data type Mandatory Description Notes

Path advertiserId Integer Yes Id of advertiser to remove. -

HTTP status code Reason

200 Advertiser is successfully removed.

401 (3) No permission for user to remove campaign.

403 (16) Advertiser must not contain any campaigns.

404 (5) Advertiser not found.

HTTP status code Reason

200 List of campaigns is successfully fetched.

Parameter type Name Data type Mandatory Description Notes

Path campaignId Integer Yes Id of campaign to fetch. -

200 Campaign is successfully fetched.

401 (3) No permission for user to fetch campaign.

404 (5) Campaign not found.

HTTP status code Reason

200 Campaign is successfully created.

400 (8) Parameter value is too long.

401 (3) No permission for user to create campaign.

404 (5) Advertiser not found.

409 (9) Campaign already exists.

Parameter type Name Data type Mandatory Description Notes

Path campaignId Integer Yes Id of campaign to update. -

200 Campaign is successfully updated.

400 (1) Missing parameter.

400 (8) Parameter value is too long.

401 (3) No permission for user to update campaign.

404 (5) Campaign not found.

Parameter type Name Data type Mandatory Description Notes

Path campaignId Integer Yes Id of campaign to archive. -

HTTP status code Reason

200 Campaign is successfully archived.

401 (3) No permission for user to archive campaign.