Created by User 87682, last modified on Aug 31, 2022

FeatureStore Parameters for GCP:

featurestore_id

entity_type_id

description

entity_id

telco_score_fs

score_label_features

 

customerId

Link to API doc - Telco Behaviour Score Reference Doc

FinScore response based on integration into AAI One-Stop-Platform (OSP). This is based on FinScore’s service - FS: FinScore - just that the response is customised due to integration by AAI. The responses below are based on responses sent by the Logging Service in OSP.

The relevant Telco Behaviour Score is found in the output field.

RESPONSE CODES

Response codes will be kept as a feature with feature_id: code

Status Code

Message

PARAMETER_ERROR

free Parameter error,please check your request whether has illegal parameters

free Invalid phone number,please check your phone number format

RETRY_LATER

free Query failed,please retry after the suggested time in HTTP Header

NO_RECORD

free No query record

UNSUPPORTED_PHONE_OPERATOR

free Phone numbers from this operator are not supported for now

Note: Don’t Forget to add handler for these Status Codes in Glossary as well

TELCO BEHAVIOUR SCORE RESPONSE DESCRIPTION - score_label_features

API Parameter Description:

Parameter

Description

code

Telco Behavior Score Status Code

transactionId

the request id, the max length is 64

pricingStrategy

whether the request will be charged, enum type: FREE, PAY

message

Status Code Explanation

data

score : Please click here for the description of the possible values of “score”

risklevel : Please click here for the description of the possible values of “risklevel”

city object : The result indicates whether the city is the most often stayed for the phone number in 3 different time periods(day,night and weekend)

cphoneNumber object : Please click here for the description of the possible values of fields in “cphoneNumber”

telcoBehaviors object : Please click here for the description of the possible values of fields in telcoBehaviors

extra

Extra response info (Exception Message)

Notes: Values of city,cphoneNumber and telcoBehaviors will always be null if phoneOperator is Globe

RESPONSE VALUE DETAILS

Score and Risklevel:

SubscriptionType

score

risklevel

risklevel notes

Smart Prepaid

300-350

1

Highest

351-402

2

Highest

403-438

3

High

439-464

4

High

465-484

5

Medium

485-500

6

Medium

501-516

7

Low

517-532

8

Low

533-550

9

Lowest

551-600

10

Lowest

91

91

Sun cellular Prepaid HIGH risk

92

92

Sun cellular Prepaid MID risk

93

93

Sun cellular Prepaid LOW risk

-8

-8

Smart broadband subscribers and others – HIGH risk

-6

-6

Inactive or disposed SIM Card

Smart Postpaid

880

21

High

920

22

Medium

960

23

Low

Sun Cellular Postpaid

921

921

High

922

922

Medium

923

923

Low

Globe Prepaid

300-342

1

Highest

343-371

2

Highest

372-390

3

High

391-405

4

High

406-419

5

Medium

420-433

6

Medium

434-447

7

Low

448-463

8

Low

464-487

9

Lowest

488-600

10

Lowest

-6

-6

Inactive SIM Card

-8

-8

Globe broadband subscribers and others – HIGH risk

Globe Postpaid

21

21

High

22

22

Medium

23

23

Low

cphoneNumber:

Field

value

notes

isTop10callin3m

0-10

The value indicates the ranking(1-10) of the contact phone number in terms of frequency called by the applicant in recent 3 months, ‘0’ will be returned if the number is not in the top10 most frequently called by the applicant.

isTop10smsin3m

0-10

The value indicates the ranking(1-10) of the contact phone number in terms of frequency messaged by the applicant in recent 3 months, ‘0’ will be returned if the number is not in the top10 most frequently messaged by the applicant.

isTop5pasaloadin3m

0-5

The value indicates the ranking(1-5) of the contact phone number in terms of load (airtime) amount sent by the applicant in recent 3 months, ‘0’ will be returned if the number is not in the top5 most load amount sent by the applicant.

isTop5pasaloadin6m

0-5

The value indicates the ranking(1-5) of the contact phone number in terms of load (airtime) amount sent by the applicant in recent 6 months, ‘0’ will be returned if the number is not in the top5 most load amount sent by the applicant.

isTop5pasaloadin12m

0-5

The value indicates the ranking(1-5) of the contact phone number in terms of load (airtime) amount sent by the applicant in recent 12 months, ‘0’ will be returned if the number is not in the top5 most load amount sent by the applicant.

telcoBehaviors:

Field

value

notes

TimeWithSmart

New SIM

1-365 days

Young SIM

1-2 years

Matured

2-3 years

Established

3-5 years

Loyal

5+ yearts

null

SubscriptionType

smart prepaid

smart postpaid

Sun cellular prepaid

Sun cellular postpaid

Talk'n'Text

Broadband device

SmsUsage/TopUp/MobileDataUsage/AvgDailyActivities

Lowest

bottom 20% of Smart users

Low

over 20% of Smart users

Mid

over 40% of Smart users

High

over 60% of Smart users

Highest

top 20% of Smart users

null

Lack of data/Newly registered/Fake number

SMART PHONE OPERATOR - SUCCESS RESPONSE

{
  "transId": "353dee0379933dae",
  "flowId": "117",
  "node": {
    "id": "30123",
    "name": "3:Telco Behavior Score",
    "startTime": "2022-08-22T10:20:54.310Z",
    "endTime": "2022-08-22T10:20:54.313Z",
    "opTime": "2022-08-22T10:20:54.312Z",
    "cacheHit": true,
    "input": [
      {
        "customerId": "999dfbce-adda-4a90-98c0-e035861319d3"
      },
      {
        "name": "phoneNumber",
        "value": "+639188888888"
      },
      {
        "name": "city",
        "value": [
          "Taguig",
          "Makati"
        ]
      },
      {
        "name": "cphoneNumber",
        "value": [
          "639188888888"
        ]
      }
    ],
    "output": {
      "code": "SUCCESS",
      "message": "OK",
      "data": {
        "score": "960",
        "risklevel": "23",
        "telcoBehaviors": {
          "CustomerLoyalty": "Loyal",
          "SubscriptionType": "Smart Postpaid",
          "SMSUsage": "Null",
          "TopUp": "Null",
          "MobileDataUsage": "Mid",
          "AvgDailyActivities": "Low"
        },
        "risklevelNotes": "2",
        "cities": [
          {
            "cityIndex": "c1",
            "day": false,
            "night": false,
            "weekend": false
          },
          {
            "cityIndex": "c2",
            "day": false,
            "night": false,
            "weekend": false
          }
        ],
        "cityStayedPeriod": null,
        "callin3m": "0",
        "smsin3m": "0",
        "pasaloadin3m": "0",
        "cphoneNumbers": [
          {
            "cphoneNumberIndex": "p1",
            "isTop10callin3m": "0",
            "isTop10smsin3m": "0",
            "isTop5pasaloadin3m": "0",
            "isTop5pasaloadin6m": "0",
            "isTop5pasaloadin12m": "0"
          }
        ]
      },
      "extra": null,
      "transactionId": "2c537d2be89f2264",
      "pricingStrategy": "PAY"
    }
  }
}

Response Result

Description

feature_id

Atomic

Type

customerId

customerid

message

message

code

code

Yes

STRING

score

score

Yes

INT

risklevel

risklevel

Yes

INT

cities

{"cities": [
  {
    "cityIndex": "c1",
    "day": false,
    "night": false,
    "weekend": false
  },
  {
    "cityIndex": "c2",
    "day": false,
    "night": false,
    "weekend": false
  }
]}

cities To be stored as To be stored as JSON serialised as STRING

Yes

RECORD

cphoneNumbers

{"cphoneNumbers": [
  {
    "cphoneNumberIndex": "p1",
    "isTop10callin3m": "0",
    "isTop10smsin3m": "0",
    "isTop5pasaloadin3m": "0",
    "isTop5pasaloadin6m": "0",
    "isTop5pasaloadin12m": "0"
    }
]}

cphonenumbers To be stored as JSON serialised as STRING

Yes

RECORD

telcoBehaviors 

{"telcoBehaviors": {
    "CustomerLoyalty": "Loyal",
    "SubscriptionType": "Smart Postpaid",
    "SMSUsage": "Null",
    "TopUp": "Null",
    "MobileDataUsage": "Mid",
    "AvgDailyActivities": "Low"
}}

customerloyalty

subscriptiontype

smsusage

topup

mobiledatausage

avgdailyactivities

Yes

ARRAY

GLOBE PHONE OPERATOR - SUCCESS RESPONSE

{
    "transId": "b942a95688f990e1",
    "flowId": "117",
    "node": {
        "id": 30123,
        "name": "3:Telco Behavior Score",
        "startTime": "2022-08-23T10:28:12.252Z",
        "endTime": "2022-08-23T10:28:12.254Z",
        "opTime": "2022-08-23T10:28:12.254Z",
        "cacheHit": true,
        "input": [
            {
                "name": "phoneNumber",
                "value": "+639566821079"
            },
            {
                "name": "city",
                "value": [
                    "Taguig",
                    "Makati"
                ]
            },
            {
                "name": "cphoneNumber",
                "value": [
                    "639566821079"
                ]
            }
        ],
        "output": {
            "code": "SUCCESS",
            "message": "OK",
            "data": {
                "score": 529,
                "risklevel": 10,
                "telcoBehaviors": {
                    "CustomerLoyalty": null,
                    "SubscriptionType": null,
                    "SMSUsage": null,
                    "TopUp": null,
                    "MobileDataUsage": null,
                    "AvgDailyActivities": null
                },
                "risklevelNotes": 1,
                "cities": [
                    {
                        "cityIndex": "c1",
                        "day": null,
                        "night": null,
                        "weekend": null
                    },
                    {
                        "cityIndex": "c2",
                        "day": null,
                        "night": null,
                        "weekend": null
                    }
                ],
                "cityStayedPeriod": null,
                "callin3m": -1,
                "smsin3m": -1,
                "pasaloadin3m": -1,
                "cphoneNumbers": [
                    {
                        "cphoneNumberIndex": "p1",
                        "isTop10callin3m": -1,
                        "isTop10smsin3m": -1,
                        "isTop5pasaloadin3m": -1,
                        "isTop5pasaloadin6m": -1,
                        "isTop5pasaloadin12m": -1
                    }
                ]
            },
            "extra": null,
            "transactionId": "b4bd8872da02c573",
            "pricingStrategy": "PAY"
        }
    }
}

Response Result

Description

feature_id

Atomic

Type

customerId

customerid

message

message

code

code

Yes

STRING

score

score

Yes

INT

risklevel

risklevel

Yes

INT

cities

"cities": [
    {
        "cityIndex": "c1",
        "day": null,
        "night": null,
        "weekend": null
    },
    {
        "cityIndex": "c2",
        "day": null,
        "night": null,
        "weekend": null
    }
]

cities To be stored as To be stored as JSON serialised as STRING

Yes

RECORD

cphoneNumbers

"cphoneNumbers": [
    {
        "cphoneNumberIndex": "p1",
        "isTop10callin3m": -1,
        "isTop10smsin3m": -1,
        "isTop5pasaloadin3m": -1,
        "isTop5pasaloadin6m": -1,
        "isTop5pasaloadin12m": -1
    }
]

cphonenumbers To be stored as JSON serialised as STRING

Yes

RECORD

telcoBehaviors 

{"telcoBehaviors": {
    "CustomerLoyalty": "Loyal",
    "SubscriptionType": "Smart Postpaid",
    "SMSUsage": "Null",
    "TopUp": "Null",
    "MobileDataUsage": "Mid",
    "AvgDailyActivities": "Low"
}}

customerloyalty

subscriptiontype

smsusage

topup

mobiledatausage

avgdailyactivities

Yes

ARRAY