Imported data
permissions apiKey | Resource | Description |
|---|---|
| Customers | Access to customers |
| Memos | Gate to access memos information. |
| Typifications | Access to ms-typifications api |
| Invoices | Access to invoices |
permissions apiKey | Resource | Description |
|---|---|
| Customers | Access to customers |
| Memos | Gate to access memos information. |
| Typifications | Access to ms-typifications api |
| Invoices | Access to invoices |
terminals field to devicesReturns financing info for mobile subscription devices for the purpose of calculating credit limits.
PATH PARAMETERS
organization name
customer identifier
OK successful operation
{
"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"
}
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
devices | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/customers/214748364/devices' \
-H 'Accept: application/json'Get all the memos, filtered by createStamp column if necessary. The number of elements in the response cam be limited by the user.
PATH PARAMETERS
organization name
QUERY PARAMETERS
Limit the elements numbers in response
Move the pointer to the first element in response
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01
OK successful operation
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_request | string | Url next set of data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Unauthorized Unauthorized
{
"code": 3,
"status": "UNAUTHORIZED",
"message": "Unauthorized",
"DetailMsg": "Tenant XXX could not be validated"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/memos?limit=100&offset=100&create-from=2020-01-01&create-to=2020-12-31' \
-H 'Accept: application/json'Get the memos by hostTable, filtered by createStamp column if necessary. The number of elements in the response cam be limited by the user.
PATH PARAMETERS
organization name
Name of table where this memo record is assignedSee HostTable.
QUERY PARAMETERS
Limit the elements numbers in response
Move the pointer to the first element in response
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01
OK successful operation
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_request | string | Url next set of data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Unauthorized Unauthorized
{
"code": 3,
"status": "UNAUTHORIZED",
"message": "Unauthorized",
"DetailMsg": "Tenant XXX could not be validated"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/memos/hosttable/:hosttable?limit=100&offset=100&create-from=2020-01-01&create-to=2020-12-31' \
-H 'Accept: application/json'Get the memos by customerId, filtered by createStamp column if necessary. The number of elements in the response cam be limited by the user.
PATH PARAMETERS
organization name
customer identifier
QUERY PARAMETERS
Limit the elements numbers in response
Move the pointer to the first element in response
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01
OK successful operation
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_request | string | Url next set of data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Unauthorized Unauthorized
{
"code": 3,
"status": "UNAUTHORIZED",
"message": "Unauthorized",
"DetailMsg": "Tenant XXX could not be validated"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/memos/customers/214748364?limit=100&offset=100&create-from=2020-01-01&create-to=2020-12-31' \
-H 'Accept: application/json'Get the memos by hostTable and customerId, filtered by createStamp column if necessary. The number of elements in the response cam be limited by the user.
PATH PARAMETERS
organization name
Name of table where this memo record is assignedSee HostTable.
customer identifier
QUERY PARAMETERS
Limit the elements numbers in response
Move the pointer to the first element in response
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01
OK successful operation
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next_request | string | Url next set of data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Unauthorized Unauthorized
{
"code": 3,
"status": "UNAUTHORIZED",
"message": "Unauthorized",
"DetailMsg": "Tenant XXX could not be validated"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/memos/hosttable/:hosttable/customers/214748364?limit=100&offset=100&create-from=2020-01-01&create-to=2020-12-31' \
-H 'Accept: application/json'PATH PARAMETERS
organization name
customer identifier
OK successful operation
{
"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
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
typifications | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v3/orgs/telco/customers/214748364/typifications' \
-H 'Accept: application/json'PATH PARAMETERS
organization name
customer identifier
typification parameters
{
"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
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
channel* | string | Channel where the typification was performed | ||
user_id* | string | User performing the typification. It takes an email format | ||
msisdn* | string | Phone number related to the typification | pattern: ^[6-9][0-9]{8}$ | |
conversation_id | string | Conversation identifier related to the typification | ||
operator | string | Operator related to the typification | ||
campaign* | string | Campaign related to the typification | ||
reason* | string | Typification reason | ||
subreason1 | string | Typification subreason1 | ||
subreason2 | string | Typification subreason2 | ||
result | string | Typification result | ||
subresult | string | Typification subresult | ||
description | string | Typification description | ||
initial_fee | number (float) |
Created Typification created successfully. No content to return.
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Unauthorized Unauthorized
{
"code": 3,
"status": "UNAUTHORIZED",
"message": "Unauthorized",
"DetailMsg": "Tenant XXX could not be validated"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Forbidden Forbidden resource
{
"code": 10,
"status": "FORBIDDEN",
"message": "Forbidden",
"DetailMsg": "The state does not allow login"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Internal Server Error Internal server error
{
"code": 2,
"status": "UNEXPECTED",
"message": "Unexpected error",
"DetailMsg": "com.masorange.mcus.core.application.errors.UnexpectedException: Unexpected error"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v3/orgs/telco/customers/214748364/typifications' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--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
}'PATH PARAMETERS
organization name
account identifier
{
"delivery_mode": "EMAIL"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
delivery_mode* | string
()
EMAILPAPERAPPLICATION | New delivery mode |
No Content Invoice configuration updated
Bad Request Invalid request body
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": 0,
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | integer (int32) | Custom error code | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X PATCH 'https://customers.sta.masstack.com/v3/orgs/telco/accounts/214748364/invoices' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"delivery_mode": "EMAIL"
}'