6 Rewards

Overview

Introduction

This chapter defines the CCS EDRs for rewards.

Reward Application Successful (EDR 16)

Introduction

All successful balance updates (for example: rated voice calls, voucher recharge, balance update or balance expiry, by whatever mechanism) may produce an EDR type 16 if the Rewards plug-in is being used and Rewards are configured, in addition to the normal update EDR(s).

Mandatory EDR 16 fields

This list identifies the mandatory EDR record fields for successful reward application using any of screens, IVR, PI or USSD (EDR type 16):

  • ACCOUNT_TYPE (Product Type ID)
  • ACS_CUST_ID (ACS Customer ID)
  • BALANCE_TYPES (account changed or created)
  • BALANCES (pre-call or account creation)
  • COSTS (rated calls)
  • CS (call status, S or D) (call status, S or D)
  • NEW_BALANCE_EXPIRIES (dates after voucher recharge)
  • OLD_BALANCE_EXPIRIES (dates before voucher recharge)
  • RESULT (voucher redemption, always Success)
  • REWARD (ID)
  • REWARD_AMOUNTS (value of reward)
  • REWARD_CATEGORY
  • REWARD_TYPES (balance types getting reward)

Optional EDR 16 fields

This list identifies the optional EDR record fields for successful reward application using any of screens, IVR, PI or USSD (EDR type 16):

  • BEARER_TYPE (bearer type for promotions) (bearer type for rewards)
  • CHANNEL (for rewards) (for rewards)
  • NEW_ACCT_EXPIRY (date after update)
  • OLD_ACCT_EXPIRY (dates before update)
  • REFERENCE (operator freeform) (rewards)

Account Activated additional fields

If the account is activated, the following fields are generated:

  • NEW_ACCT_STATE (always active - A)
  • OLD_ACCT_STATE (P or D before update)

Reload Bonus additional fields

If the account has a promotional reload bonus configured, the following fields are generated (EDR types 4, 15 and 16):

  • RELOAD_BONUS (promotion name)
  • RELOAD_BONUS_AMOUNT (amount applied)
  • RELOAD_BONUS_EXPIRY (date remaining bonus expires)
  • RELOAD_BONUS_LEFT (bonus amount remaining)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 16

ACCOUNT_TYPE=104|ACCT_ID=325|ACCT_REF_ID=305|ACS_CUST_ID=11|
BALANCES=1|BALANCE_NAMES=Free SMS|BALANCE_TYPES=6|BILLING_ENGINE_ID=1|CDR_TYPE=16|
COSTS=-1|CS=S|NEW_BALANCE_EXPIRIES=0|OLD_ACCOUNT_TYPE=|OLD_BALANCE_EXPIRIES=0|
RECORD_DATE=20120725122635|RESULT=Success|REWARD=295|REWARD_AMOUNTS=1|
REWARD_CATEGORY=TRACKER_THRESHOLD|REWARD_TYPES=6|SCP_ID=0|SEQUENCE_NUMBER=0

Note

The sequence of all fields output in an EDR is not guaranteed.

Reward Application Fails using Screens or IVR (EDR 16)

Introduction

All failed balance updates (for example: voucher recharge, balance update or balance expiry, by screens or IVR) will produce an EDR type 16 if the Rewards plug-in is being used, in addition to the normal update failed EDR(s).

Mandatory EDR 16 fields

This list identifies the mandatory EDR record fields for reward application failures using screens or IVR (EDR type 16):

  • ACS_CUST_ID (ACS Customer ID)
  • CS (call status, always D)
  • NACK (long list of codes)
  • REWARD (ID)
  • REWARD_AMOUNTS (value of reward)
  • REWARD_CATEGORY
  • REWARD_TYPES (balance types getting reward)

Optional EDR 16 fields

This list identifies the optional EDR record fields for reward application failures using screens or IVR (EDR type 16):

  • BATCH_DESCRIPTION (for voucher batch)

MSISDN additional fields

If the MSISDN ccsCDRLoader plug-in is installed on the SMS, the following field will be present:

  • MSISDN (account calling number)

Example EDR 16 (Remove21)

ACCT_ID=2129|ACCT_REF_ID=2124|ACS_CUST_ID=1|BILLING_ENGINE_ID=4|
CDR_TYPE=16|CS=D|NACK=BDVR|RECORD_DATE=20071101115704|
RESULT=Invalid Balance Type|REWARD=62|REWARD_AMOUNTS=1,2|
REWARD_CATEGORY=TRACKER_THRESHOLD|REWARD_TYPES=5,27|SCP_ID=110537566|
SEQUENCE_NUMBER=139450184

Note

The sequence of all fields output in an EDR is not guaranteed.