API Overview Resources Schemas

Schemas

GetTypificationsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "typifications": [
    {
      "id": "string",
      "created_at": "2022-01-01T01:01:01Z",
      "channel": "agents",
      "tenant": "masmovil",
      "area": "RETENCION",
      "user_id": "string",
      "msisdn": "612789456",
      "campaign": "string",
      "reason": "string",
      "subreason1": "string",
      "subreason2": "string",
      "result": "string",
      "subresult": "string",
      "conversation_id": "string",
      "operator": "string",
      "description": "string",
      "initial_fee": 0.1
    }
  ]
}

Name	Type	Required	Description
typifications	[object]	false	none
» id	string	true	none
» created_at	string(date-time)	true	Typification creation date
» channel	string	true	Channel where the typification was performed
» tenant	string	false	Tenant where the typification was performed
» area	string	false	User area where the typification was performed
» user_id	string	true	User performing the typification.
» msisdn	string	true	Phone number related to the typification
» campaign	string	true	Campaign related to the typification
» reason	string	true	Typification reason
» subreason1	string	false	Typification subreason1
» subreason2	string	false	Typification subreason2
» result	string	false	Typification result
» subresult	string	false	Typification subresult
» conversation_id	string	false	Conversation identifier related to the typification
» operator	string	false	Operator related to the typification
» description	string	false	Typification description
» initial_fee	number(float)	false	none

CreateTypificationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "channel": "agents",
  "user_id": "string",
  "msisdn": "string",
  "conversation_id": "string",
  "operator": "string",
  "campaign": "string",
  "reason": "string",
  "subreason1": "string",
  "subreason2": "string",
  "result": "string",
  "subresult": "string",
  "description": "string",
  "initial_fee": 0.1
}

Name	Type	Required	Description
channel	string	true	Channel where the typification was performed
user_id	string	true	User performing the typification. It takes an email format
msisdn	string	true	Phone number related to the typification
conversation_id	string	false	Conversation identifier related to the typification
operator	string	false	Operator related to the typification
campaign	string	true	Campaign related to the typification
reason	string	true	Typification reason
subreason1	string	false	Typification subreason1
subreason2	string	false	Typification subreason2
result	string	false	Typification result
subresult	string	false	Typification subresult
description	string	false	Typification description
initial_fee	number(float)	false	none

DevicesInfoByCustomerId

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48


{
  "devices": [
    {
      "start_date": "2020-01-31T00:00:00Z",
      "subscription_id": 123654,
      "subscription_terminal_id": 214748364,
      "status": {
        "id": 214748364,
        "value": "ACTIVO"
      },
      "fees": {
        "upfront_fee": 0,
        "installment_plan": {
          "last_installment_fee": 0,
          "monthly_fee": 6,
          "duration": 0,
          "unpaid_installments": 10,
          "financed_by": "MASMOVIL"
        },
        "final_installment_plan": {
          "last_installment_fee": 0,
          "monthly_fee": 6,
          "duration": 0,
          "unpaid_installments": 10,
          "financed_by": "MASMOVIL"
        }
      },
      "permanence": {
        "campaign_id": 214748364,
        "description": "Permanencia 24M",
        "duration_months": 24,
        "start_date": "2020-01-31T00:00:00Z",
        "end_date": "2022-01-31T00:00:00Z",
        "category_type": 1
      },
      "is_mandatory": true,
      "expedition_info": {
        "item_number": 214748364,
        "request_date": "2020-01-31T00:00:00Z",
        "expedition_date": "2020-01-31T00:00:00Z",
        "status": {
          "id": 214748364,
          "value": "ACTIVO"
        }
      }
    }
  ]
}

Name	Type	Required	Description
devices	[DeviceResponseByCustomerId]	false	none

Memo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "id": "e18f3337-433a-45a2-95e4-0ebece657743",
  "host_table": "ModSub",
  "key_value": "CoRuleID",
  "memo_seq": 214748364,
  "customer_num": 214748364,
  "customer_external_id": 214748364,
  "subscription_id": 214748364,
  "memo_title": "FixedLine Barring",
  "memo_text": "En un lugar de la Mancha, de cuyo nombre no quiero acordarme, no ha mucho tiempo que vivía un hidalgo de los de lanza en astillero, adarga antigua, rocín flaco y galgo corredor. Una olla de algo más vaca que carnero, salpicón las más noches, duelos y quebrantos los sábados, lantejas los viernes, algún palomino de añadidura los domingos, consumían las tres partes de su hacienda. El resto della concluían sayo de velarte, calzas de velludo para las fiestas, con sus pantuflos de lo mesmo, y los días de entresemana se honraba con su vellorí de lo más fino. Tenía en su casa una ama que pasaba de los cuarenta y una sobrina que no llegaba a los veinte, y un mozo de campo y plaza que así ensillaba el rocín como tomaba la podadera. Frisaba la edad de nuestro hidalgo con los cincuenta años. Era de complexión recia, seco de carnes, enjuto de rostro, gran madrugador y amigo de la caza.",
  "memo_type": "Service",
  "source": 214748364,
  "create_stamp": "2020-01-31",
  "create_user": "123654",
  "change_stamp": "2020-01-31",
  "change_user": 214748364
}

Name	Type	Required	Description
id	string	false	primary key
host_table	string	true	HostTable in cassandra database
key_value	string	false	KeyValue in cassandra database
memo_seq	integer(int64)	false	MemoSeq in cassandra database
customer_num	integer(int64)	false	CustNum in cassandra database
customer_external_id	integer(int64)	false	Customer external Id
subscription_id	integer(int64)	false	Customer external Id
memo_title	string	false	MemoTitle in cassandra database
memo_text	string	false	MemoText in cassandra database
memo_type	string	false	MemoType in cassandra database
source	string(int64)	false	Source in cassandra database
create_stamp	string(date)	false	CreStamp in cassandra database
create_user	string	false	CreUser in cassandra database
change_stamp	string(date)	false	ChgStamp in cassandra database
change_user	string(int64)	false	ChgUser in cassandra database

Memos

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "memos": [
    {
      "id": "e18f3337-433a-45a2-95e4-0ebece657743",
      "host_table": "ModSub",
      "key_value": "CoRuleID",
      "memo_seq": 214748364,
      "customer_num": 214748364,
      "customer_external_id": 214748364,
      "subscription_id": 214748364,
      "memo_title": "FixedLine Barring",
      "memo_text": "En un lugar de la Mancha, de cuyo nombre no quiero acordarme, no ha mucho tiempo que vivía un hidalgo de los de lanza en astillero, adarga antigua, rocín flaco y galgo corredor. Una olla de algo más vaca que carnero, salpicón las más noches, duelos y quebrantos los sábados, lantejas los viernes, algún palomino de añadidura los domingos, consumían las tres partes de su hacienda. El resto della concluían sayo de velarte, calzas de velludo para las fiestas, con sus pantuflos de lo mesmo, y los días de entresemana se honraba con su vellorí de lo más fino. Tenía en su casa una ama que pasaba de los cuarenta y una sobrina que no llegaba a los veinte, y un mozo de campo y plaza que así ensillaba el rocín como tomaba la podadera. Frisaba la edad de nuestro hidalgo con los cincuenta años. Era de complexión recia, seco de carnes, enjuto de rostro, gran madrugador y amigo de la caza.",
      "memo_type": "Service",
      "source": 214748364,
      "create_stamp": "2020-01-31",
      "create_user": "123654",
      "change_stamp": "2020-01-31",
      "change_user": 214748364
    }
  ]
}

Name	Type	Required	Description
memos	[Memo]	false	none

MemosPag

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


{
  "data": {
    "memos": [
      {
        "id": "e18f3337-433a-45a2-95e4-0ebece657743",
        "host_table": "ModSub",
        "key_value": "CoRuleID",
        "memo_seq": 214748364,
        "customer_num": 214748364,
        "customer_external_id": 214748364,
        "subscription_id": 214748364,
        "memo_title": "FixedLine Barring",
        "memo_text": "En un lugar de la Mancha, de cuyo nombre no quiero acordarme, no ha mucho tiempo que vivía un hidalgo de los de lanza en astillero, adarga antigua, rocín flaco y galgo corredor. Una olla de algo más vaca que carnero, salpicón las más noches, duelos y quebrantos los sábados, lantejas los viernes, algún palomino de añadidura los domingos, consumían las tres partes de su hacienda. El resto della concluían sayo de velarte, calzas de velludo para las fiestas, con sus pantuflos de lo mesmo, y los días de entresemana se honraba con su vellorí de lo más fino. Tenía en su casa una ama que pasaba de los cuarenta y una sobrina que no llegaba a los veinte, y un mozo de campo y plaza que así ensillaba el rocín como tomaba la podadera. Frisaba la edad de nuestro hidalgo con los cincuenta años. Era de complexión recia, seco de carnes, enjuto de rostro, gran madrugador y amigo de la caza.",
        "memo_type": "Service",
        "source": 214748364,
        "create_stamp": "2020-01-31",
        "create_user": "123654",
        "change_stamp": "2020-01-31",
        "change_user": 214748364
      }
    ]
  },
  "next_request": "http://localhost:8081/memos/?limit=40&offset=0"
}

Name	Type	Required	Description
data	Memos	false	none
next_request	string	false	Url next set of data

DeviceResponseByCustomerId

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44


{
  "start_date": "2020-01-31T00:00:00Z",
  "subscription_id": 123654,
  "subscription_terminal_id": 214748364,
  "status": {
    "id": 214748364,
    "value": "ACTIVO"
  },
  "fees": {
    "upfront_fee": 0,
    "installment_plan": {
      "last_installment_fee": 0,
      "monthly_fee": 6,
      "duration": 0,
      "unpaid_installments": 10,
      "financed_by": "MASMOVIL"
    },
    "final_installment_plan": {
      "last_installment_fee": 0,
      "monthly_fee": 6,
      "duration": 0,
      "unpaid_installments": 10,
      "financed_by": "MASMOVIL"
    }
  },
  "permanence": {
    "campaign_id": 214748364,
    "description": "Permanencia 24M",
    "duration_months": 24,
    "start_date": "2020-01-31T00:00:00Z",
    "end_date": "2022-01-31T00:00:00Z",
    "category_type": 1
  },
  "is_mandatory": true,
  "expedition_info": {
    "item_number": 214748364,
    "request_date": "2020-01-31T00:00:00Z",
    "expedition_date": "2020-01-31T00:00:00Z",
    "status": {
      "id": 214748364,
      "value": "ACTIVO"
    }
  }
}

Name	Type	Required	Description
start_date	string(date-time)	false	none
subscription_id	integer(int64)	false	identification subscription
subscription_terminal_id	integer(int64)	false	subscription terminal id
status	StatusDevices	false	status device
fees	Fees	false	device info
permanence	Permanence	false	permanence info
is_mandatory	boolean	false	none
expedition_info	ExpeditionInfo	false	expedition info

StatusDevices

1
2
3
4


{
  "id": 214748364,
  "value": "ACTIVO"
}

Name	Type	Required	Description
id	integer(int32)	true	identification device status
value	string	true	Device status value

Permanence

1
2
3
4
5
6
7
8


{
  "campaign_id": 214748364,
  "description": "Permanencia 24M",
  "duration_months": 24,
  "start_date": "2020-01-31T00:00:00Z",
  "end_date": "2022-01-31T00:00:00Z",
  "category_type": 1
}

Name	Type	Required	Description
campaign_id	number(int32)	false	id campaig
description	string	false	permanence description
duration_months	integer(int32)	false	duration months
start_date	string(date-time)	false	binding start date
end_date	string(date-time)	false	binding end date
category_type	integer(int32)	false	category type

Fees

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "upfront_fee": 0,
  "installment_plan": {
    "last_installment_fee": 0,
    "monthly_fee": 6,
    "duration": 0,
    "unpaid_installments": 10,
    "financed_by": "MASMOVIL"
  },
  "final_installment_plan": {
    "last_installment_fee": 0,
    "monthly_fee": 6,
    "duration": 0,
    "unpaid_installments": 10,
    "financed_by": "MASMOVIL"
  }
}

Name	Type	Required	Description
upfront_fee	number(double)	false	upfront fee (initial payment)
installment_plan	InstallmentPlan	false	request detail
final_installment_plan	InstallmentPlan	false	request detail

InstallmentPlan

1
2
3
4
5
6
7


{
  "last_installment_fee": 0,
  "monthly_fee": 6,
  "duration": 0,
  "unpaid_installments": 10,
  "financed_by": "MASMOVIL"
}

Name	Type	Required	Description
last_installment_fee	number(double)	false	final payment
monthly_fee	number(double)	false	monthly fee
duration	integer(int32)	false	duration (total permanence)
unpaid_installments	integer(int32)	false	pending fees
financed_by	string	false	none

ExpeditionInfo

1
2
3
4
5
6
7
8
9


{
  "item_number": 214748364,
  "request_date": "2020-01-31T00:00:00Z",
  "expedition_date": "2020-01-31T00:00:00Z",
  "status": {
    "id": 214748364,
    "value": "ACTIVO"
  }
}

Name	Type	Required	Description
item_number	number(int64)	false	item number
request_date	string(date-time)	false	request date
expedition_date	string(date-time)	false	expedition date
status	Status	false	status

Status

1
2
3
4


{
  "id": 214748364,
  "value": "ACTIVO"
}

Name	Type	Required	Description
id	integer(int32)	true	identification status
value	string	true	status value

Credential

1
2
3


{
  "username": "username@masmovil.com"
}

Name	Type	Required	Description
username	string	false	Username

ErrorMessage

1
2
3
4
5
6


{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}

Name	Type	Required	Description
code	integer(int32)	false	Custom error code
status	string	false	Status
message	string	false	Status message
detailMsg	string	false	Detailed description of the error

InvoiceConfigUpdate

1
2
3


{
  "delivery_mode": "EMAIL"
}

Name	Type	Required	Description
delivery_mode	string	true	New delivery mode

Property	Values
delivery_mode	one of [EMAIL, PAPER, APPLICATION]

PaymentMethodUpdate

1
2
3


{
  "payment_method": "BANK_TRANSFER"
}

Name	Type	Required	Description
payment_method	string	true	none

Property	Values
payment_method	one of [BANK_TRANSFER]