Get subsriber offers by state

Retrieves all of the offers for a subscriber by offer state using a query parameter and passing the MSISDN of the subscriber.

Status options
  • ISSUED

  • VIEWED

  • ACKNOWLEDGED

  • ACCEPTED

  • CANCELLED

  • REJECTED


get campaign-manager/offers/<msisdn>?status=<status>


Header
Content-type

JSON

Accept

JSON

Response

If successful, returns a 200 HTTP code and a JSON response body containing the offer details..

Example response

[
    {
        "offer": {
            "id": {
                "uuid": "b708766d-7a37-44bc-8ac8-4de2503d057d",
                "msisdn": "967178861"
            },
            "createdTime": 1599140642000,
            "lastUpdatedTime": 1599140642000,
            "validityExpiryDate": 1599144242000,
            "status": "ACCEPTED",
            "offerDefinitionId": 3,
            "offerDefinitionExternalId": "123",
            "campaignId": 5,
            "campaignName": "Business Connect",
            "segment": null,
            "triggerType": "businessConnectChubb",
            "pushChannel": "someChannel",
            "hplmn": null,
            "vplmn": "26806",
            "country": "Portugal",
            "zone": "EU",
            "tenantId": "tenant"
        },
        "offerDefinition": {
            "id": 3,
            "createdTime": 1589209692000,
            "lastUpdatedTime": 1589209692000,
            "externalId": "123",
            "name": "Insurance",
            "description": "Insurance",
            "message": "Test",
            "validityPeriod": 3600,
            "priority": 1,
            "metadata": "",
            "threshold": null,
            "cost": null,
            "acceptanceValidity": 7200,
            "offerTrackingEnabled": true,
            "i18nMessages": {},
            "actions": [
                {
                    "objectType": "systemAction",
                    "id": 4,
                    "createdTime": 1591706687000,
                    "lastUpdatedTime": 1591706687000,
                    "data": "www.123.ie/$token",
                    "type": "SMS",
                    "i18nData": {},
                    "position": 0,
                    "delay": 0,
                    "actionClassification": {
                        "classification": "ISSUED"
                    },
                    "serverRequestName": null
                },
                {
                    "objectType": "systemAction",
                    "id": 3,
                    "createdTime": 1591706687000,
                    "lastUpdatedTime": 1591706687000,
                    "data": "you viewed a 123.ie offer",
                    "type": "SMS",
                    "i18nData": {},
                    "position": 1,
                    "delay": 0,
                    "actionClassification": {
                        "classification": "VIEWED"
                    },
                    "serverRequestName": null
                },
                {
                    "objectType": "systemAction",
                    "id": 5,
                    "createdTime": 1595865086000,
                    "lastUpdatedTime": 1595865086000,
                    "data": "Your insurance has expired",
                    "type": "SMS",
                    "i18nData": {},
                    "position": 2,
                    "delay": 0,
                    "actionClassification": {
                        "classification": "EXPIRED"
                    },
                    "serverRequestName": null
                }
            ]
        }
    }
]