Convergent

Context

Convergent registration process follows the same structure as Only Mobile registration, but including some sections destinated to TV product, Fix phone and Internet elements (installation, installer, technology…). This different sections that will need to be reported in the sale process are detailed below. By clicking on the different objects, you will be redirected to the information

graph TD
    A[SEGMENT] --> B[BROADBAND]
    B --> |bundleld<br>and<br>TERRITORY OWNER| C[INSTALLATION]
    C --> D[LANDLINE]
    D --> E[INTERNET]
    E --> F[MOBILE]
    F --> G[TV]
    click A "convergent.md#segment" _self
    click B "convergent.md#broadband-section" _self
    click C "convergent.md#installation" _self
    click D "convergent.md#landline" _self
    click E "convergent.md#internet-singup" _self
    click F "convergent.md#mobile-lines" _self
    click G "convergent.md#tv" _self

Product Information

Following the “client” info section, the first new JSON part. In Only Mobile sales , must include a product section. In this case is not different than Mobile Only, but we must include new sections and values about fix phone and internet elements

Convergent package data - Structure

This table summarizes all the Convergent package’s data:

Name	Description
bundle_id	It marks the resume of the convergent package (Internet+fix phone ; Internet+fix phone+TV ; Internet +fix phone+TV+Mobile line…) it has associated speciffics `"product_id"`
landline product_id	Determinate de landline product
ftth or adsl product_id	Determinate FTTH or ADSL product (when sale is offline)
mobile_lines product_id	Determinate mobile subscription/s product

Segment

Different possibilities of SEGMENT object can be selected as follows:

graph TD
    A[SEGMENT] --> B[Residencial] & C[Bussines]
    B & C --> D[Online] & E[Offline]

Broadband Section

All the different objects about the Broadband section can be resumed in the following table:

Name	Description
bundle_id	It marks the resume of the convergent package (Internet+fix phone ; Internet+fix phone+TV ; Internet +fix phone+TV+Mobile line…) it has associated speciffics `"product_id"` and it´s a value determinated by catalogue.
territory_owner	The type of this object is a `string`. Information about network owner such as: Másmovil (FIBMM01, FIBMM02), Movistar (NEBA01), ADSL (MASMOVIL)
installation_info	Contains all info referent to installation, divided in 4 subsections: - `"contact"`: if the installation person is different from our “client” it must be indicated in this section (name, contact phone, mail, ID type and ID value - `"address"`: Contains info about the broadband installation address. This info must be proportionated by coverage tool when coverage is searched. Apart of the street, province… etc, a couple of very important values must be indicated -`"gescal"`: This is an info about address indicating province, postal code, building, floor, door…) with an alphanumeric value If broadband technology is ADSL, NEBA or VULA allows contain gescal17 (17 characters) indicating info until the number of the building If broadband technology is FTTH musts contain gescal37 (37 characters) indicating floor and door mandatory. -`"address_id"`: Every housing has it´s own addres_Id. `"delivery_info"`: If the delivery address and/or person is different to our “client” it must be indicated in this section `"promotions"`: If installation has any promotion can be imputed by `"id"`(number) and `"value"` (name).

An example of Broadband section:

plaintext

{
    "broadband": {
      "bundle_id": 123,
      "territory_owner": "FIBMM01",
      "installation_info": {
        "contact": {
          "name": "contact",
          "phone": "622222222",
          "email": "test2@example.com",
          "document_type_id": 1,
          "document_value": "12341234J"
        },
        "address": {
          "street_type_id": 1,
          "street_name": "Alcala",
          "number": "123",
          "supplement": "1 IZQUERDA",
          "state_id": 28,
          "locality": "Madrid",
          "postal_code": "28028",
          "gescal": "4600116356130000100000000000110000000",
          "pair_vacancy": true,
          "address_id": "12341231241U"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "Name3",
          "phone": "633333333",
          "email": "test3@example.com",
          "document_type_id": 1,
          "document_value": "12341234Q"
        },
        "address": {
          "street_type_id": 1,
          "street_name": "Cartagena",
          "number": "58",
          "supplement": "4 DERECHA",
          "state_id": 0,
          "locality": "Madrid",
          "postal_code": "28028",
          "observation": "Madrid"
        }
      },
      "promotions": [
        {
          "id": 35,
          "value": "PROMO_FREE_INSTALLATION"
        }
      ],

Installation

The Installation object can contains this fields:

Contact
Address
Delivery info
Promotions

Landline

In relation to LANDLINE object, see below the different possibilities

graph TD
A[LANDLINE<br>Possibilities] --> B[Portability] & C[New Number]
B --> D[Schedule] & E[Inmediately]
D & E --> F['client'<br> donor user] & G[different<br> donor user]
C & F & G --> H[Optional<br>Objects]

In addition, optional objects can be added, such as:

Bonuses
Campaign
Promotions
SVA’s

graph TD
A[INTERNET] --> B[FTTH] & C[ADSL]
B --> D[Connection type]
D --> E[Installer]
E --> F[Terminal]
F --> G[SVA]
G --> H[Promotions]
C --> I[Install tech<br>support] & J[Billable]
I & J --> K(True/False)
K --> G

Following an example of Installation can be found:

plaintext

{
      "landline": {
        "product_id": 543,
        "portability_info": {
          "scheduled_date": "2020-04-20",
          "iccid": "",
          "operator_id": "345",
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "donor_user": {
            "name": "USER",
            "middlename": "USER1",
            "lastname": "USER2",
            "document_type_id": 1,
            "document_value": "11111111H",
            "email": "test4@email.com",
            "birthdate": "1999-01-31",
            "nationality_id": 63,
            "contact_phone": "655555555",
            "gender": "M",
            "language_id": 90,
            "address": {
              "street_name": "Avenida Toreros 1",
              "state_id": 28,
              "locality": "Madrid",
              "postal_code": "28028",
              "country": "Madrid"
            }
          }
        },
        "number": "911111111",
        "bonuses": [
          {
            "id": 12
          }
        ],
        "promotions": [
          {
            "id": 55,
            "value": "PROMO_LANDLINE"
          }
        ],
        "services": [
          {
            "id": 6
          }
        ],
        "wants_communications": true
      }

Same structure as a mobile subscription in “Only Mobile”. Could be with or without portability or new numeration, and different (or not) donor user

FTTH or ADSL Section:

IMPORTANT - Only one of them per request.

FTTH

plaintext

{
      "ftth": {
        "product_id": 2345,
        "promotions": [
          {
            "id": 4456,
            "value": "FTTH_PROMO"
          }
        ],
        "connection_type": "",
        "installer": "MM",
        "iua": "ADHGSD35346",
        "terminals": [
          {
            "id": 346,
            "financed": true,
            "imei": "",
            "serial_number": "123235346"
          }
        ],
        "wants_communications": true
      }

Name	Description
connection_type	Info provided by coverage tool. It depends on CTO (fiber network element). Could be empty or “N”, “NV” or “R” values
iua	Could be empty or include a value indicated by customer. If customer provide it, could speeds ups provision proccess.

* Could includes promos and terminal (router)

ADSL

plaintext

{
      "adsl": {
        "product_id": 3424,
        "promotions": [
          {
            "id": 345,
            "value": "PROMO_ADSL"
          }
        ],
        "wants_communications": true,
        "install_tech_support": true,
        "tech_support_billiable": true
      }

"install_tech_support" true indicates neeeds technician assistance, false indicates not needed.

"tech_support_billiable" when the technician’s visit is not necessary as the router is self-installable, but the customer requests technical for other reasons, this may incur cost.

Mobile Lines

An approach of all the differents objects that Mobile lines has coul be following diagram:

graph TD
    A[Mobile<br>main] --> B[PORTABILITY] & C[NEW MSISDN]
    B --> D[INMEDIATELY] & E[SCHEDULED]
    D & E --> F[ORIGIN]
    F --> G[POSTPAID] & H[PREPAID]
    G --> J[donor ICC]
    H --> J
    J --> K[DONOR USER]
    K--> L[client] & M[Different user<br>to 'client']
    L & M & C --> N[EXPEDITION INFO]
    N --> O[Same address<br>and/or<br>user to 'client'] & P[Different address<br>and/or<br>user to 'client']
    O & P --> Q[BONUS]
    Q --> R[CAMPAINGS]
    R --> S[PROMOTIONS]
    S --> T[TERMINAL]
    T --> U[OFFLINE] & V[ONLINE]
    U --> X[ICC assignament]
    V --> Y[NO ICC assignament<br>'assigned by logistic']
    X & Y --> Z[MOBILE<br>additional]
    Z --> 1[TV]
    1 --> 2['registration_mail'<br>'contact_phone'<br>'install_tech_support']
    2 --> 3[BONUS]
    3 --> 4[CAMPAINGS]
    4 --> 5[PROMOTIONS]
    5 --> 6[TERMINALS]

* By default, the value of the donor ICC is **8934040000000000002**.

"main" and "additional"

plaintext

      {
          "type": "main",
          "product_id": 12,
          "portability_info": {
            "scheduled_date": "2020-04-20",
            "iccid": "8934040000000000002",
            "operator_id": "456",
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "donor_user": {
              "name": "USER5",
              "middlename": "USER",
              "lastname": "USER",
              "document_type_id": 1,
              "document_value": "11111111H",
              "email": "test1@email.com",
              "birthdate": "1999-01-31",
              "nationality_id": 63,
              "contact_phone": "677777777",
              "gender": "M",
              "language_id": 90,
              "type": "client",
              "address": {
                "street_name": "Cartagena 20",
                "state_id": 0,
                "locality": "Madrid",
                "postal_code": "28028",
                "country": "Madrid"
              }
            }
          },
          "msisdn": "612123123",
          "iccid": "8934042419120320860",
          "fabrication_type_sim_id": 7,
          "bonuses": [
            {
              "id": 234
            }
          ],
          "promotions": [
            {
              "id": 654,
              "value": "PROMO_MOBILE"
            }
          ],
          "terminals": [
            {
              "id": 435,
              "financed": true,
              "imei": "12331425",
              "serial_number": "QEW988AF23"
            }
          ],
          "wants_communications": true,
          "expedition_info": {
            "address": {
              "street_name": "Alcalá 35 1º",
              "state_id": 28,
              "locality": "Madrid",
              "postal_code": "28028",
              "country": "Madrid"
            },
            "name": "User",
            "middlename": "User",
            "lastname": "User",
            "document_type_id": 1,
            "document_value": "11111111H",
            "email": "test3@email.com",
            "birthdate": "1999-01-31",
            "nationality_id": 63,
            "contact_phone": "678888888",
            "gender": "M",
            "language_id": 90
          }

Name Description

type “main” or “additional” depending on the type we want. Not possible an additional without a main line in the package

The same structure as “Only Mobile” except we have to indicate in this section if the expedition address is different to “client” address

Could be with portability or new numeration (MSISDN) with the same or diferent user to “client”, wit promos, terminal, campaigns, bonus…

Name	Description
type	`“main”` or `“additional”` depending on the type we want. Not possible an additional without a main line in the package The same structure as “Only Mobile” except we have to indicate in this section if the expedition address is different to `“client”` address Could be with portability or new numeration (MSISDN) with the same or diferent user to `“client”`, wit promos, terminal, campaigns, bonus…

TV

plaintext

{
      "tv": {
        "product_id": 4356,
        "number_associated": "911111111",
        "registration_email": "tester@example.com",
        "contact_phone": "689999999",
        "install_tech_support": true,
        "promotions": [
          {
            "id": 345,
            "value": "PROMO_TV"
          }
        ],
        "terminals": [
          {
            "id": 34,
            "financed": true,
            "imei": "",
            "serial_number": "JDEG9ASF00"
          }
        ]
      }

Type of sale and associated information

See below an example of convergent sale, which contains:

Offline sale
FTTH (In case of ADSL, section are different in the request)
Different installation user to “client”
Landline with portability. Different donor user to “client” user, with bonus, promo, and SVA´s
Main mobile line with portability. Different donor user to “client” user, with bonus, promotion and terminal
TV with promo
Additional mobile line. New numeration (MSISDN) with promo, bonus and campaigns

plaintext

{
  "sales_type": "telecomunications",
  "sales_info": {
    "channel": "channel1",
    "dealer_id": "C00000",
    "shop_id": "C00-16",
    "agent_id": "AGENT1",
    "logistic": false
  },
  "clients": {
    "sector_id": 1,
    "attributes": [
      {
        "type": "client",
        "name": "Name",
        "middlename": "middlename",
        "lastname": "lastname",
        "document_type_id": 1,
        "document_value": "35317901K",
        "email": "testtest@email.com",
        "birthdate": "1971-01-22",
        "nationality_id": 63,
        "contact_phone": "611111111",
        "gender": "M",
        "language_id": 90,
        "address": {
          "street_name": "Pau, 1",
          "number": "1",
          "state_id": 46,
          "locality": "Ontinyent",
          "postal_code": "46870",
          "country": "España"
        }
      }
    ]
  },
  "payment": {
    "billing_type_id": 1,
    "scoring": {
      "scoring_value": 0,
      "id_value": 0,
      "forced_value": 0,
      "up_front": 0
    },
    "info": {
      "bank_account": "00492345281234512345",
      "swift_bic": "SWIFT12345"
    },
    "tpv_response": {
      "amount": "30",
      "card_number": "000000******0000",
      "expiry_date": "0121"
    },
  },
  "products": {
    "broadband": {
      "bundle_id": 123,
      "territory_owner": "FIBMM01",
      "installation_info": {
        "contact": {
          "name": "contact",
          "phone": "622222222",
          "email": "test2@example.com",
          "document_type_id": 1,
          "document_value": "12341234J"
        },
        "address": {
          "street_type_id": 1,
          "street_name": "Alcala",
          "number": "123",
          "supplement": "1 IZQUERDA",
          "state_id": 28,
          "locality": "Madrid",
          "postal_code": "28028",
          "gescal": "4600116356130000100000000000110000000",
          "pair_vacancy": true,
          "address_id": "12341231241U"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "Name3",
          "phone": "633333333",
          "email": "test3@example.com",
          "document_type_id": 1,
          "document_value": "12341234Q"
        },
        "address": {
          "street_type_id": 1,
          "street_name": "Cartagena",
          "number": "58",
          "supplement": "4 DERECHA",
          "state_id": 0,
          "locality": "Madrid",
          "postal_code": "28028",
          "observation": "Madrid"
        }
      },
      "promotions": [
        {
          "id": 35,
          "value": "PROMO_FREE_INSTALLATION"
        }
      ],
      "landline": {
        "product_id": 543,
        "portability_info": {
          "scheduled_date": "2020-04-20",
          "iccid": "",
          "operator_id": "345",
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "donor_user": {
            "name": "USER",
            "middlename": "USER1",
            "lastname": "USER2",
            "document_type_id": 1,
            "document_value": "11111111H",
            "email": "test4@email.com",
            "birthdate": "1999-01-31",
            "nationality_id": 63,
            "contact_phone": "655555555",
            "gender": "M",
            "language_id": 90,
            "address": {
              "street_name": "Avenida Toreros 1",
              "state_id": 28,
              "locality": "Madrid",
              "postal_code": "28028",
              "country": "Madrid"
            }
          }
        },
        "number": "911111111",
        "bonuses": [
          {
            "id": 12
          }
        ],
        "promotions": [
          {
            "id": 55,
            "value": "PROMO_LANDLINE"
          }
        ],
        "services": [
          {
            "id": 6
          }
        ],
        "wants_communications": true
      },
      "ftth": {
        "product_id": 2345,
        "promotions": [
          {
            "id": 4456,
            "value": "FTTH_PROMO"
          }
        ],
        "connection_type": "",
        "installer": "MM",
        "iua": "ADHGSD35346",
        "terminals": [
          {
            "id": 346,
            "financed": true,
            "imei": "",
            "serial_number": "123235346"
          }
        ],
        "wants_communications": true
      },
      "adsl": {
        "product_id": 3424,
        "promotions": [
          {
            "id": 345,
            "value": "PROMO_ADSL"
          }
        ],
        "wants_communications": true,
        "install_tech_support": true,
        "tech_support_billiable": true
      },
      "mobile_lines": [
        {
          "type": "main",
          "product_id": 12,
          "portability_info": {
            "scheduled_date": "2020-04-20",
            "iccid": "8934040000000000002",
            "operator_id": "456",
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "donor_user": {
              "name": "USER5",
              "middlename": "USER",
              "lastname": "USER",
              "document_type_id": 1,
              "document_value": "11111111H",
              "email": "test1@email.com",
              "birthdate": "1999-01-31",
              "nationality_id": 63,
              "contact_phone": "677777777",
              "gender": "M",
              "language_id": 90,
              "type": "client",
              "address": {
                "street_name": "Cartagena 20",
                "state_id": 0,
                "locality": "Madrid",
                "postal_code": "28028",
                "country": "Madrid"
              }
            }
          },
          "msisdn": "612123123",
          "iccid": "8934042419120320860",
          "fabrication_type_sim_id": 7,
          "bonuses": [
            {
              "id": 234
            }
          ],
          "promotions": [
            {
              "id": 654,
              "value": "PROMO_MOBILE"
            }
          ],
          "terminals": [
            {
              "id": 435,
              "financed": true,
              "imei": "12331425",
              "serial_number": "QEW988AF23"
            }
          ],
          "wants_communications": true,
          "expedition_info": {
            "address": {
              "street_name": "Alcalá 35 1º",
              "state_id": 28,
              "locality": "Madrid",
              "postal_code": "28028",
              "country": "Madrid"
            },
            "name": "User",
            "middlename": "User",
            "lastname": "User",
            "document_type_id": 1,
            "document_value": "11111111H",
            "email": "test3@email.com",
            "birthdate": "1999-01-31",
            "nationality_id": 63,
            "contact_phone": "678888888",
            "gender": "M",
            "language_id": 90
          }
        }
      ],
      "tv": {
        "product_id": 4356,
        "number_associated": "911111111",
        "registration_email": "tester@example.com",
        "contact_phone": "689999999",
        "install_tech_support": true,
        "promotions": [
          {
            "id": 345,
            "value": "PROMO_TV"
          }
        ],
        "terminals": [
          {
            "id": 34,
            "financed": true,
            "imei": "",
            "serial_number": "JDEG9ASF00"
          }
        ]
      }
    },
    "mobile_lines": {
      "type": "additional",
      "product_id": 12,
      "msisdn": "string",
      "iccid": "8934045550006780002",
      "fabrication_type_sim_id": 7,
      "bonuses": [
        {
          "id": 124
        }
      ],
      "promotions": [
        {
          "id": 346,
          "value": "PROMO_ADDITIONAL_MOBILE"
        }
      ],
      "campaign": [
        {
          "id": 346
        }
      ],
      "wants_communications": true
    }
  }
}

Context

Product Information

Convergent package data - Structure

Segment

Broadband Section

Installation

Landline

Internet Signup

FTTH or ADSL Section:

FTTH

ADSL

Mobile Lines

TV

Type of sale and associated information