masstack

V2
V3
V4
API Overview Resources Schemas

Typifications

Access to ms-typifications api

Parameters

Name In Type Required Description
orgId path string true organization name
customerId path integer(int64) true customer identifier
body body CreateTypificationRequest true typification parameters

Request body - instance of 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

Request example

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


curl -X POST https://customers.sta.masstack.com/v3/orgs/telco/customers/214748364/typifications \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  '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
}"

Responses

Code Meaning Description Schema
201 Created Typification created successfully. No content to return. None
400 Bad Request Invalid request body ErrorMessage
401 Unauthorized Unauthorized ErrorMessage
403 Forbidden Forbidden resource ErrorMessage
500 Internal Server Error Internal server error ErrorMessage

Parameters

Name In Type Required Description
orgId path string true organization name
customerId path integer(int64) true customer identifier

Request example

1
2
3
4
5


curl -X GET https://customers.sta.masstack.com/v3/orgs/telco/customers/214748364/typifications \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation GetTypificationsResponse
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None
500 Internal Server Error Internal server error ErrorMessage

200 - instance of GetTypificationsResponse

Custom schema example

 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

500 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6

{
  "code": 2,
  "status": "UNEXPECTED",
  "message": "Unexpected error",
  "DetailMsg": "com.mm.mcus.core.errors.UnexpectedException: Unexpected error"
}
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

Endpoints

Customers

    Events

      Memos

        Typifications

          Invoices

            Accounts