Uso de la API REST de Be Aware 360

En esta sección podrá encontrar la información de la API REST de Be Aware 360 para consultar y administrar la información almacenada en su instancia de Be Aware 360.

Aquí podrá consultar:

• Información para obtener el token de autenticación para el uso de cualquier acción a través de la API.
• Descripción de cada uno de los recursos de la API REST.
• Una guía a través de ejemplos simples para el uso de los recursos de la API REST.

Adicional, podrá visualizar el webinar sobre la creación de casos usando la API de Be Aware 360.

El listado de todos los recursos de la API REST son:

Puede realizar muchos tipos de solicitudes HTTP utilizando las API REST de Be Aware 360. Puede realizar solicitudes para consultar, crear, actualizar o eliminar registros.

Por favor tenga en cuenta los pasos descritos a continuación para un correcto uso de la API de Be Aware 360.

Debido a que las API REST usan métodos HTTP para enviar y recibir contenido, se pueden probar utilizando cualquier lenguaje de programación o herramienta que admita el envío y la recepción de mensajes HTTP. Puede elegir entre muchos clientes API REST que interactúan con Be Aware 360, como:

• Postman. Nota: En nuestros ejemplos, usamos Postman.
• SoapUI.
• Su propio cliente desarrollado para conectarse con la API REST.

A través de un cliente API REST podrá probar el nombre de usuario, la contraseña y la URL de solicitud para el API REST y usar la información recopilada para construir y enviar varios tipos de solicitudes HTTP, como son de creación, actualización o eliminación de registros.

Para realizar una solicitud REST HTTP, debe contar con la siguiente información:

• URL Endpoint: Es la misma URL para todas los recursos: https://api.beaware360.com.
• Company: Corresponde al nombre de la instancia de Be Aweare 360.
• User: Corresponde al usuario de conexión a su instancia de Be Aware 360.
• Password: Corresponde a la contraseña del usuario de conexión a su instancia de Be Aware 360.

Nota: Se recomienda utilizar un usuario genérico de integraciones con permisos para acceder a los recursos que está utilizando.

Este paso es el más importante de todo el proceso, dado que es obligatorio estar autenticado y tener el Token que entrega Be Aware 360 para poder realizar cualquier otra acción a través de la API, ya sea consulta o envío de información.

Nota: El token tiene una duración que puede ser parametrizable. Para ver la duración que tiene su instancia, ingrese a la consola de Be Aware 360 y navegue al menú Otros > Lista de Parámetros. Luego, vaya a la sección Sitio general y corresponde al campo Tiempo de inactividad (Minutos). El valor por defecto es de 30 minutos.

POST

https://api.beaware360.com/ba360/apir/v10/login/auth.

Parámetros:

Este recurso no recibe parámetros. Se usa el Body con el formato en RAW JSON.

Campos:

Ejemplo:

{
	"company":"company",
	"pass":"password",
	"user":"usuario"
}

El sistema retorna la información completa del usuario, incluido el token que será obligatorio en todas las demás acciones que se realicen a través de la API.

El contenido de la respuesta contiene el Token.

Ejemplo:

{
    "token": "Jd0GW22NNAk8fdAc0W3WXJ02N3aeirkWhNtUe9MXfN36Y4aLYpG0W77XN26v6c1Jc5Pu1K9R4QA93R2irbkWsGNJkb9Fe3F88LkH4vaXidX1k5skh6QC4hFLfMeEdwVw",
    "contacto": null,
    "usuario": {
        "language": "es",
        "multisession": 0,
        "cf": {},
        "isopais": null,
        "cantidadcasos": 3,
        "portada": null,
        "avatar": null,
        "idgrupodesc": null,
        "idpermisodesc": null,
        "idpermiso": null,
        "identificador": null,
        "idgrupo": null,
        "acceso": null,
        "idusuario": null,
        "idroldesc": "Agente de atención",
        "idrol": 4,
        "nombre": "Agente",
        "apellido": "Atención",
        "user": "aatencion",
        "pass": "9438081aa3781af0dafa3f088482e534",
        "email": "aatencion@inmotion.cl",
        "idempresa": null,
        "idempresadesc": null,
        "gruposkills": [],
        "fechacreacion": "2020-02-21 21:29:24.0",
        "fechamodificacion": null,
        "timezone": "America/Santiago",
        "notificacionactiva": 1,
        "uuid": null,
        "eid": null,
        "id": 4
    },
    ...
}

Una vez haya obtenido el token, podrá consumir los recursos de la API REST de Be Aware 360.

GET

Existen distintas formas de consultar contactos a través de la API. A continuación, se detallan:

• Consultar todos los contactos: https://api.beaware360.com/ba360/apir/v10/contacto/get.
• Consultar contacto por parámetros: https://api.beaware360.com/ba360/apir/v10/contacto/get/?parametro=valor.
• Consultar contactos con paginación: https://api.beaware360.com/ba360/apir/v10/contacto/get/?pagina=<pagina>&cantidad=<cantidad_contactos_a_mostrar_por_pagina>.
• Consultar contacto por filtro: https://api.beaware360.com/ba360/apir/v10/contacto/get?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_contactos_a_mostrar_por_pagina>.

Autenticación:

Existen distintas formas de consultar contactos a través de la API. A continuación, se detallan:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos para el listado completo de contactos.

Parámetros:

identificador -> Recibe el identificador del contacto.
email -> Recibe el correo electrónico del contacto.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/contacto/get/?identificador=32456567
https://api.beaware360.com/ba360/apir/v10/contacto/get/?email=oskcar@gmail.invalid

—-

Parámetros:

pagina -> Indica el número de página a retornar.
cantidad -> Indica el número de contactos a retornar por página.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/contacto/get?pagina=1&cantidad=2

Parámetros:

filtrobuscar -> Permite buscar por nombre, apellido, email, dirección, título e identificador.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de contactos a mostrar por página.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/contacto/get?filtrobuscar=calle&pagina=1&cantidad=100

Retorna la lista de los contactos según el criterio de búsqueda.

Ejemplo:

{
    "data": [
        {
            "email": [
                "oskcar@gmail.invalid"
            ],
            "fono": [
                "3185676567"
            ],
            "fonocp": null,
            "idtipo": 1,
            "facebook": null,
            "twitter": null,
            "instagram": null,
            "emailcp": null,
            "direccion": "Calle 134 # 11 - 80",
            "idcuenta": null,
            "fechanacimiento": null,
            "titulo": null,
            "cargo": null,
            "idcuentadesc": null,
            "idsla": null,
            "cf": {},
            "identificador": "32456567",
            "nombre": "Oskar",
            "apellido": "Cantor",
            "pass": null,
            "gruposkills": [
                1
            ],
            "fechacreacion": "2020-02-21 19:24:34.0",
            "fechamodificacion": "1",
            "company": null,
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "email": [
                "janeth@hotmail.invalid"
            ],
            "fono": [],
            "fonocp": null,
            "idtipo": null,
            "facebook": null,
            "twitter": null,
            "instagram": null,
            "emailcp": null,
            "direccion": "Calle 123 # 45-67",
            "idcuenta": null,
            "fechanacimiento": "1983-10-20",
            "titulo": null,
            "cargo": null,
            "idcuentadesc": null,
            "idsla": null,
            "cf": {},
            "identificador": "87654321",
            "nombre": "Janeth",
            "apellido": "Cantor",
            "pass": null,
            "gruposkills": [
                1
            ],
            "fechacreacion": "2020-02-25 16:01:48.0",
            "fechamodificacion": "1",
            "company": null,
            "uuid": null,
            "eid": null,
            "id": 2
        },
        ...
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 0,
        "actualPage": null
    }
}

GET

https://api.beaware360.com/ba360/apir/v10/contacto/getby?id=<id_contacto>.

Parámetros:

id -> Recibe el id del contacto en Be Aware 360.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/contacto/getby?id=60

Retorna la información de un contacto en específico, según su Id en Be Aware 360.

Ejemplo:

{
    "data": {
        "email": [
            "e_apardo@inmotion.cl"
        ],
        "fono": [
            "12345678"
        ],
        "fonocp": null,
        "idtipo": 1,
        "idcuenta": 1,
        "direccion": "Ave. Las Perdices, Condominio Alto Casa Grande, Peñalolen ",
        "idsla": 1,
        "company": null,
        "emailcp": null,
        "grupocuentas": [],
        "facebook": null,
        "twitter": null,
        "instagram": null,
        "titulo": null,
        "idcuentadesc": "MPSoftTechnologies",
        "fechanacimiento": "1997-02-22",
        "cargo": "Informático J ",
        "nombre": "Aiman ",
        "apellido": "Jaafarr ",
        "pass": null,
        "gruposkills": [
            1
        ],
        "cf": {
            "RUT Empresa": "as",
            "FOE": "as"
        },
        "identificador": "8-965-87188",
        "fechacreacion": null,
        "fechamodificacion": "1",
        "id": 60,
        "uuid": null,
        "eid": null
    },
    "code": 200,
    "message": null,
    "pagination": null
}

POST

https://api.beaware360.com/ba360/apir/v10/contacto/add.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"email": ["carolis@gmail.invalid"],
	"fono": ["+5713682466","+5626804615"],
	"facebook": "12345678909876543",
	"twitter": "@carolistest",
	"instagram": "@carolisig",
	"direccion": "Calle 145 # 15A - 50",
	"grupocuentas": [2,5],
	"fechanacimiento": "1983-03-16",
	"cargo": "Bibliotecaria",
	"idsla": 1,
	"cf": {"hobbie_principal": "Lectura", "fecha_ingreso_empresa": "2020-01-06T05:00:00.000Z"},
	"identificador": "52822500",
	"nombre": "Carolina",
	"apellido": "Ortiz",
	"gruposkills": [1]
}

El sistema crea el contacto con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "email": [
            "carolis@gmail.invalid"
        ],
        "fono": [
            "+5713682466",
            "+5626804615"
        ],
        "fonocp": null,
        "idtipo": null,
        "facebook": "12345678909876543",
        "twitter": "@carolistest",
        "instagram": "@carolisig",
        "emailcp": "carolis@gmail.invalid",
        "direccion": "Calle 145 # 15A - 50",
        "idcuenta": null,
        "fechanacimiento": "1983-03-16",
        "titulo": null,
        "cargo": "Bibliotecaria",
        "idcuentadesc": null,
        "idsla": 1,
        "grupocuentas": [],
        "cf": {
            "hobbie_principal": "Lectura",
            "fecha_ingreso_empresa": "2020-01-06"
        },
        "identificador": "52822500",
        "nombre": "Carolina",
        "apellido": "Ortiz",
        "pass": null,
        "gruposkills": [
            1
        ],
        "fechacreacion": "2020-03-23 15:28:22.0",
        "fechamodificacion": null,
        "company": null,
        "uuid": null,
        "eid": null,
        "id": 8
    },
    "code": 200,
    "message": "Contacto creado exitosamente.",
    "pagination": null
}

Nota: Para utilizar este recurso es necesario siempre enviar todos los campos del contacto y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.

PUT

https://api.beaware360.com/ba360/apir/v10/contacto/upd.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"email": ["carolis@gmail.invalid"],
	"fono": ["+5713682466","+5626804615"],
	"facebook": "12345678909876543",
	"twitter": "@carolistest",
	"instagram": "@carolisig",
	"direccion": "Calle 145 # 15BIS - 50",
	"grupocuentas": [2],
	"fechanacimiento": "1983-03-16",
	"cargo": "Bibliotecaria",
	"idsla": 1,
	"cf": {"hobbie_principal": "Cine", "fecha_ingreso_empresa": "2020-01-06T05:00:00.000Z"},
	"identificador": "52822500",
	"nombre": "Carolina",
	"apellido": "Ortiz Godoy",
	"gruposkills": [1],
	"id": 8
}

El sistema actualiza el contacto con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "email": [
            "carolis@gmail.invalid"
        ],
        "fono": [
            "+5713682466",
            "+5626804615"
        ],
        "fonocp": null,
        "idtipo": null,
        "facebook": "12345678909876543",
        "twitter": "@carolistest",
        "instagram": "@carolisig",
        "emailcp": null,
        "direccion": "Calle 145 # 15BIS - 50",
        "idcuenta": null,
        "fechanacimiento": "1983-03-16",
        "titulo": null,
        "cargo": "Bibliotecaria",
        "idcuentadesc": "Mandomedio S.A.",
        "idsla": 1,
        "grupocuentas": [2],
        "cf": {
            "hobbie_principal": "Cine",
            "fecha_ingreso_empresa": "2020-01-06T05:00:00.000Z"
        },
        "identificador": "52822500",
        "nombre": "Carolina",
        "apellido": "Ortiz Godoy",
        "pass": null,
        "gruposkills": [
            1
        ],
        "fechacreacion": "2020-03-23 15:28:22.0",
        "fechamodificacion": "2020-03-23 16:43:44.0",
        "company": null,
        "uuid": null,
        "eid": null,
        "id": 8
    },
    "code": 200,
    "message": null,
    "pagination": null
}

DELETE

https://api.beaware360.com/ba360/apir/v10/contacto/del/?id=<id_contacto>.

Parámetros:

id -> Id del contacto.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/contacto/del/?id=5

Elimina un contacto en específico de la base de datos de Be Aware 360.

Ejemplo:

{
    "data": null,
    "code": 200,
    "message": "Contaccto eliminado con éxito.",
    "pagination": null
}

GET

Existen distintas formas de consultar cuentas a través de la API. A continuación, se detallan:

• Consultar todas las cuentas: https://api.beaware360.com/ba360/apir/v10/cuenta/get.
• Consultar cuenta por parámetros: https://api.beaware360.com/ba360/apir/v10/cuenta/get/?parametro=valor.
• Consultar cuentas con paginación: https://api.beaware360.com/ba360/apir/v10/cuenta/get/?pagina=<pagina>&cantidad=<cantidad_cuentas_a_mostrar_por_pagina>.
• Consultar cuenta por filtro: https://api.beaware360.com/ba360/apir/v10/cuenta/get/?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_cuentas_a_mostrar_por_pagina>.

Autenticación:

Existen distintas formas de consultar cuentas a través de la API. A continuación, se detallan:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Parámetros:

identificador -> Recibe el identificador de la cuenta.
idcuenta -> Recibe el id de Be Aware 360 correspondiente a la cuenta.
idcontacto -> Recibe el id de Be Aware 360 correspondiente al contacto asociado a la cuenta. Este parámetro busca entre los contactos que pertenecen a la cuenta.
idrepresentante -> Recibe el id del representante de la cuenta.
idsla -> Recibe el id del acuerdo al que está asociada la cuenta.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/cuenta/get/?identificador=7682345346-k
https://api.beaware360.com/ba360/apir/v10/cuenta/get/?idcuenta=38
https://api.beaware360.com/ba360/apir/v10/cuenta/get/?idcontacto=112
https://api.beaware360.com/ba360/apir/v10/cuenta/get/?idrepresentante=127
https://api.beaware360.com/ba360/apir/v10/cuenta/get/?idsla=1

Parámetros:

pagina -> Indica el número de página a retornar.
cantidad -> Indica el número de cuentas a retornar por página.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/cuenta/get/?pagina=1&cantidad=10

Parámetros:

filtrobuscar -> Permite buscar por Id SLA (Acuerdo), Nombre representante, Id contacto, Identificador y Razón social.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de cuentas a mostrar por página.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/cuenta/get/?filtrobuscar=soft&pagina=1&cantidad=10

Retorna la lista de todas las cuentas.

Ejemplo:

{
    "data": [
        {
            "fechacreacion": null,
            "fechamodificacion": "2020-03-19 18:42:15.0",
            "cf": {
                "TTT": "ppp",
                "campo_ex": "2020-01-16T03:00:00.000Z",
                "NOMBRE": "1221",
                "nombre": "10",
                "BBB": "ll"
            },
            "isopais": null,
            "identificador": "7682345346-k",
            "direccion": "Nueva Lyon 0124",
            "facebook": null,
            "instagram": null,
            "idrepresentante": 127,
            "razonsocial": "MPSoftTechnologies",
            "idsla": 1,
            "grupocontactos": [
                113,
                112,
                116,
                118,
                127,
                60
            ],
            "xpos": "-33.421013",
            "ypos": "-70.610858",
            "idsladesc": "SLA 24 Horas",
            "telefono": null,
            "giro": "MPSoftTechnologies Por giro",
            "paginaweb": null,
            "correo": null,
            "idrepresentantedesc": "Mariano Pivatto",
            "id": 1,
            "uuid": null,
            "eid": null
        },
        {
            "fechacreacion": null,
            "fechamodificacion": "2020-03-19 18:42:15.0",
            "cf": {
                "TTT": "ppp",
                "campo_ex": "2020-01-16T03:00:00.000Z",
                "NOMBRE": "1221",
                "nombre": "10",
                "BBB": "ll"
            },
            "isopais": null,
            "identificador": "7682345346-k",
            "direccion": "Nueva Lyon 0124",
            "facebook": null,
            "instagram": null,
            "idrepresentante": 127,
            "razonsocial": "MPSoftTechnologies",
            "idsla": 1,
            "grupocontactos": [
                113,
                112,
                116,
                118,
                127,
                60
            ],
            "xpos": "-33.421013",
            "ypos": "-70.610858",
            "idsladesc": "SLA 24 Horas",
            "telefono": null,
            "giro": "MPSoftTechnologies Por giro",
            "paginaweb": null,
            "correo": null,
            "idrepresentantedesc": "Mariano Pivatto",
            "id": 1,
            "uuid": null,
            "eid": null
        },
        ...
    ],
    "code": null,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 0,
        "actualPage": null
    }
}

POST

https://api.beaware360.com/ba360/apir/v10/cuenta/add.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"razonsocial": "In Motion de México S.A.S.",
	"identificador": "900262503-1",
	"idsla": 1,
	"direccion": "Carrera 11A # 93- 52",
	"facebook": "1234567890987654",
	"instagram": "@imcol",
        "twitter": "@immex",
	"correo": "contacto@grupoinmotion.com.invalid",
	"giro": "Giro",
	"paginaweb": "www.grupoinmotion.com",
	"telefono": "525511929352",
	"idrepresentante": 118,
	"grupocontactos": [112, 113, 118],
	"cf": {"campo_ex": "2020-03-02T05:00:00.000Z", "nombre": "prueba"}
}

El sistema crea la cuenta con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "fechacreacion": "2020-03-24 16:07:05.0",
        "fechamodificacion": null,
        "cf": {
            "campo_ex": "2020-03-02T05:00:00.000Z",
            "nombre": "prueba"
        },
        "isopais": null,
        "identificador": "900262503-1",
        "direccion": "Carrera 11A # 93- 52",
        "facebook": "1234567890987654",
        "instagram": "@imcol",
        "twitter": "@immex",
        "idrepresentante": 118,
        "razonsocial": "In Motion de México S.A.S.",
        "idsla": 1,
        "grupocontactos": [
            112,
            113,
            118
        ],
        "xpos": null,
        "ypos": null,
        "idsladesc": "SLA 24 Horas",
        "telefono": "525511929352",
        "giro": "Giro",
        "paginaweb": "www.grupoinmotion.com",
        "correo": "contacto@grupoinmotion.com.invalid",
        "idrepresentantedesc": "Jesus  De la Fuente ",
        "id": 39,
        "uuid": null,
        "eid": null
    },
    "code": 200,
    "message": "Cuenta creada con éxito.",
    "pagination": null
}

Nota: Para utilizar este recurso es necesario siempre enviar todos los campos de la cuenta y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.

PUT

https://api.beaware360.com/ba360/apir/v10/cuenta/upd.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"razonsocial": "In Motion de México S.A.S.",
	"identificador": "900262503-1",
	"idsla": 1,
	"direccion": "Carrera 11A # 93- 52",
	"facebook": "1234567890987654",
	"instagram": "@imcol",
        "twitter": "@immex",
	"correo": "contacto@grupoinmotion.com.invalid",
	"giro": "Empresa que presta servicios de tecnología",
	"paginaweb": "www.grupoinmotion.com",
	"telefono": "525511929352",
	"idrepresentante": 118,
	"grupocontactos": [112, 113, 118],
	"cf": {"campo_ex": "2020-03-02T05:00:00.000Z", "nombre": "123"},
	"id": 39
}

El sistema actualiza la cuenta con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "fechacreacion": "2020-03-24 16:07:05.0",
        "fechamodificacion": "2020-03-24 16:33:02.0",
        "cf": {
            "campo_ex": "2020-03-02T05:00:00.000Z",
            "nombre": "123"
        },
        "isopais": null,
        "identificador": "900262503-1",
        "direccion": "Carrera 11A # 93- 52",
        "facebook": "1234567890987654",
        "instagram": "@imcol",
        "twitter": "@immex",
        "idrepresentante": 118,
        "razonsocial": "In Motion de México S.A.S.",
        "idsla": 1,
        "grupocontactos": [
            112,
            113,
            118
        ],
        "xpos": null,
        "ypos": null,
        "idsladesc": "SLA 24 Horas",
        "telefono": "525511929352",
        "giro": "Empresa que presta servicios de tecnología",
        "paginaweb": "www.grupoinmotion.com",
        "correo": "contacto@grupoinmotion.com.invalid",
        "idrepresentantedesc": "Jesus  De la Fuente ",
        "id": 39,
        "uuid": null,
        "eid": null
    },
    "code": 200,
    "message": null,
    "pagination": null
}

DELETE

https://api.beaware360.com/ba360/apir/v10/cuenta/del/?id=<id_cuenta>.

Parámetros:

id -> Id de la cuenta.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/cuenta/del/?id=37

Elimina una cuenta específica de la base de datos de Be Aware 360.

Ejemplo:

{
    "data": {
        "fechacreacion": null,
        "fechamodificacion": null,
        "cf": {},
        "isopais": null,
        "identificador": null,
        "direccion": null,
        "facebook": null,
        "instagram": null,
        "twitter": null,
        "idrepresentante": null,
        "razonsocial": null,
        "idsla": null,
        "grupocontactos": [],
        "xpos": null,
        "ypos": null,
        "idsladesc": null,
        "telefono": null,
        "giro": null,
        "paginaweb": null,
        "correo": null,
        "idrepresentantedesc": null,
        "id": 37,
        "uuid": null,
        "eid": null
    },
    "code": 200,
    "message": "Cuenta elimindada con exito.",
    "pagination": null
}

GET

Existen distintas formas de consultar casos a través de la API. A continuación, se detallan:

• Consultar histórico de casos: https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.
• Consultar casos abiertos: https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=getall&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.
• Consultar casos en espera: https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=waiting&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.
• Consultar caso por filtro: https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>&filtrobuscar=<filtro>.
• Consultar caso por Id contacto: https://api.beaware360.com/ba360/apir/v10/caso/get/?icontacto=<id_contacto_ba360>.

GET

https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.

Parámetros:

filtro -> history.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de casos a mostrar por página.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de todos los casos sin tener en cuenta el estado, grupo o usuario asignado al caso.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "idprioridad": 1,
            "idtipo": 6,
            "idsubtipo": 1,
            "idproducto": 21,
            "idstageactual": 104,
            "finalizado": 0,
            "idusuarioasignado": 94,
            "idcuenta": 5,
            "idestado": 1,
            "porcentaje": -440,
            "idusuariomodificacion": null,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "Prueba caso",
            "idworkflow": 51,
            "idworkflowdesc": "Prueba Asignación Usuario",
            "idcontacto": 173,
            "idusuariocreacion": 94,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200325-000007",
            "fechacreacionstr": "2020-03-25T00:00",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Ingresado",
            "idcuentadesc": "Stadio Italiano",
            "idusuariocreaciondesc": "Integración API",
            "idusuariomodificaciondesc": null,
            "idusuarioasignadodesc": "integracion",
            "slavalue": 10,
            "fingreso": "2020-03-25 15:45:26.0",
            "duedate": "2020-03-25 12:55:26.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Ingreso de Información",
            "idtipodesc": "Facturación y Pago",
            "idproductodesc": "Crediagil Uber",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2020-03-25",
            "fechamodificacion": null,
            "id": 957,
            "uuid": null,
            "eid": null
        },
        {
            "checkList": null,
            "idprioridad": 1,
            "idtipo": 6,
            "idsubtipo": 1,
            "idproducto": 21,
            "idstageactual": 104,
            "finalizado": 0,
            "idusuarioasignado": 93,
            "idcuenta": 6,
            "idestado": 1,
            "porcentaje": -470,
            "idusuariomodificacion": null,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "caso al usuario",
            "idworkflow": 51,
            "idworkflowdesc": "Prueba Asignación Usuario",
            "idcontacto": 173,
            "idusuariocreacion": 93,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200325-000006",
            "fechacreacionstr": "2020-03-25T00:00",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Ingresado",
            "idcuentadesc": "Parque Arauco",
            "idusuariocreaciondesc": "API USER",
            "idusuariomodificaciondesc": null,
            "idusuarioasignadodesc": "api_user",
            "slavalue": 10,
            "fingreso": "2020-03-25 15:41:32.0",
            "duedate": "2020-03-25 12:51:32.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Ingreso de Información",
            "idtipodesc": "Facturación y Pago",
            "idproductodesc": "Crediagil Uber",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2020-03-25",
            "fechamodificacion": null,
            "id": 956,
            "uuid": null,
            "eid": null
        },
        ...
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 490,
        "actualPage": null
    }
}

GET

https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=getall&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.

Parámetros:

filtro -> getall.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de casos a mostrar por página.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de todos los casos activos dentro de un proceso, independientemente del usuario o grupo asignado al caso.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "idprioridad": 1,
            "idtipo": 6,
            "idsubtipo": 1,
            "idproducto": 21,
            "idstageactual": 104,
            "finalizado": 0,
            "idusuarioasignado": 94,
            "idcuenta": 5,
            "idestado": 1,
            "porcentaje": -450,
            "idusuariomodificacion": null,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "Prueba caso",
            "idworkflow": 51,
            "idworkflowdesc": "Prueba Asignación Usuario",
            "idcontacto": 173,
            "idusuariocreacion": 94,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200325-000007",
            "fechacreacionstr": "2020-03-25T00:00",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Ingresado",
            "idcuentadesc": "Stadio Italiano",
            "idusuariocreaciondesc": "Integración API",
            "idusuariomodificaciondesc": null,
            "idusuarioasignadodesc": "integracion",
            "slavalue": 10,
            "fingreso": "2020-03-25 15:45:26.0",
            "duedate": "2020-03-25 12:55:26.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Ingreso de Información",
            "idtipodesc": "Facturación y Pago",
            "idproductodesc": "Crediagil Uber",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2020-03-25",
            "fechamodificacion": null,
            "id": 957,
            "uuid": null,
            "eid": null
        },
        {
            "checkList": null,
            "idprioridad": 1,
            "idtipo": 6,
            "idsubtipo": 1,
            "idproducto": 21,
            "idstageactual": 104,
            "finalizado": 0,
            "idusuarioasignado": 93,
            "idcuenta": 6,
            "idestado": 1,
            "porcentaje": -490,
            "idusuariomodificacion": null,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "caso al usuario",
            "idworkflow": 51,
            "idworkflowdesc": "Prueba Asignación Usuario",
            "idcontacto": 173,
            "idusuariocreacion": 93,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200325-000006",
            "fechacreacionstr": "2020-03-25T00:00",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Ingresado",
            "idcuentadesc": "Parque Arauco",
            "idusuariocreaciondesc": "API USER",
            "idusuariomodificaciondesc": null,
            "idusuarioasignadodesc": "api_user",
            "slavalue": 10,
            "fingreso": "2020-03-25 15:41:32.0",
            "duedate": "2020-03-25 12:51:32.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Ingreso de Información",
            "idtipodesc": "Facturación y Pago",
            "idproductodesc": "Crediagil Uber",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2020-03-25",
            "fechamodificacion": null,
            "id": 956,
            "uuid": null,
            "eid": null
        }
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 426,
        "actualPage": null
    },
    ...
}

GET

https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=waiting&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>.

Parámetros:

filtro -> waiting.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de casos a mostrar por página.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de todos los casos que se encuentran en un estado de Espera, independientemente del usuario o grupo asignado al caso.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "idprioridad": 1,
            "idtipo": 1,
            "idsubtipo": 4,
            "idproducto": 10,
            "idstageactual": 86,
            "finalizado": 0,
            "idusuarioasignado": 81,
            "idcuenta": null,
            "idestado": 4,
            "porcentaje": -402295,
            "idusuariomodificacion": 12,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "asdfgh",
            "idworkflow": 46,
            "idworkflowdesc": "Proceso Diego Meza Prueba",
            "idcontacto": 131,
            "idusuariocreacion": 81,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200128-000004",
            "fechacreacionstr": "2020-01-28T00:00",
            "idcontactodesc": "Manuel Garcia",
            "idestadodesc": "Pausado",
            "idcuentadesc": null,
            "idusuariocreaciondesc": "Diego Meza",
            "idusuariomodificaciondesc": "Gerardo Medina Pivatto",
            "idusuarioasignadodesc": "DMezar",
            "slavalue": 20,
            "fingreso": "2020-01-29 19:23:54.0",
            "duedate": "2020-01-29 16:43:54.0",
            "flexible": null,
            "primerpaso": 0,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": "2020-01-29T00:00",
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Paso 3 (Clone) (Clone)",
            "idtipodesc": "Reclamo ",
            "idproductodesc": "Crédito Convencional",
            "idsladesc": null,
            "idsubtipodesc": "Petición",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2020-01-28",
            "fechamodificacion": "2020-01-29",
            "id": 826,
            "uuid": null,
            "eid": null
        },
        {
            "checkList": null,
            "idprioridad": 2,
            "idtipo": 4,
            "idsubtipo": 1,
            "idproducto": 32,
            "idstageactual": 72,
            "finalizado": 0,
            "idusuarioasignado": null,
            "idcuenta": null,
            "idestado": 4,
            "porcentaje": -2060,
            "idusuariomodificacion": 12,
            "idsla": null,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "SLA 2 PRUEBA 2",
            "idworkflow": 42,
            "idworkflowdesc": "Test Procesos SLA",
            "idcontacto": null,
            "idusuariocreacion": 12,
            "canal": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "191112-000002",
            "fechacreacionstr": "2019-11-12T00:00",
            "idcontactodesc": null,
            "idestadodesc": "Pausado",
            "idcuentadesc": null,
            "idusuariocreaciondesc": "Gerardo Medina Pivatto",
            "idusuariomodificaciondesc": "Gerardo Medina Pivatto",
            "idusuarioasignadodesc": null,
            "slavalue": 1440,
            "fingreso": "2019-11-12 14:17:49.0",
            "duedate": "2019-11-18 16:18:00.0",
            "flexible": null,
            "primerpaso": 0,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": "2019-11-12T00:00",
            "timeactual": null,
            "idprioridadcolor": "#27AE60",
            "idstageactualdesc": "Validación ",
            "idtipodesc": "Soporte Técnico",
            "idproductodesc": "Producto Nuevo",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Media",
            "logauditoria": null,
            "cf": {},
            "cantidadcasos": null,
            "fechacreacion": "2019-11-12",
            "fechamodificacion": "2019-11-12",
            "id": 718,
            "uuid": null,
            "eid": null
        }
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 6,
        "actualPage": null
    },
    ...
}

GET

https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>&filtrobuscar=<filtro>.

Parámetros:

filtro -> history. Permite buscar por todos los casos.
pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
cantidad -> Indica la cantidad de casos a mostrar por página.
filtrobuscar -> Permite buscar por Número de referencia, Asunto, Contacto, Fecha de creación, Tipo, Estado y Canal.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=1&cantidad=100&filtrobuscar=200325-000006
https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=1&cantidad=100&filtrobuscar=2020-01-22

Retorna la información de casos, según el filtro que se especifique. Los filtros que se manejan son: Número de referencia, Asunto, Contacto, Fecha de creación, Tipo, Estado y Canal.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "idusuariomodificacion": null,
            "idusuariocreacion": 93,
            "porcentaje": -13530,
            "idusuarioasignado": 93,
            "idcuenta": 6,
            "idestado": 1,
            "idworkflow": 51,
            "idprioridad": 1,
            "idproducto": 21,
            "idtipo": 6,
            "idsubtipo": 1,
            "idstageactual": 104,
            "finalizado": 0,
            "idcontacto": 173,
            "origen": "AgenteWeb",
            "descripcion": null,
            "asunto": "caso al usuario",
            "idworkflowdesc": "Prueba Asignación Usuario",
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "destacado": false,
            "refnum": "200325-000006",
            "idsla": null,
            "fechacreacion": "2020-03-25",
            "fechamodificacion": null,
            "cf": {},
            "cantidadcasos": null,
            "idcontactodesc": "Cristian Vargas",
            "fechacreacionstr": "2020-03-25T00:00",
            "idestadodesc": "Ingresado",
            "idcuentadesc": null,
            "idusuariocreaciondesc": "API USER",
            "idusuariomodificaciondesc": null,
            "idusuarioasignadodesc": "api_user",
            "sistemaexterno": null,
            "slavalue": 10,
            "fingreso": "2020-03-25 15:41:32.0",
            "duedate": "2020-03-25 12:51:32.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": "#C0392B",
            "idstageactualdesc": "Ingreso de Información",
            "idtipodesc": "Facturación y Pago",
            "idproductodesc": "Crediagil Uber",
            "idsladesc": null,
            "idsubtipodesc": "Solicitud",
            "idprioridaddesc": "Alta",
            "logauditoria": null,
            "id": 956,
            "uuid": null,
            "eid": null
        }
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": null,
        "size": 1,
        "actualPage": null
    }
}

GET

https://api.beaware360.com/ba360/apir/v10/caso/get/?icontacto=<id_contacto_ba360>.

Parámetros:

idcontacto -> Indica el identificador del contacto que otorga Be Aware 360.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de todos los casos asignados al contacto por el cual se está realizando la búsqueda.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "cf": {},
            "descripcion": null,
            "idworkflow": 11,
            "idprioridad": 2,
            "idproducto": 1,
            "idtipo": 1,
            "idsubtipo": 1,
            "idcontacto": 4,
            "origen": "AgenteWeb",
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "idusuarioasignado": 18,
            "idestado": 2,
            "idusuariocreacion": 18,
            "duedate": "2020-11-11 10:51:13.0",
            "porcentaje": -365160,
            "destacado": false,
            "refnum": "201111-000041",
            "idusuariomodificacion": null,
            "fechacreacion": "2020-11-11",
            "idstageactual": 17,
            "finalizado": 1,
            "asunto": "[C][SODIMAC] INCIDENTE ERROR DE ACCESO",
            "idworkflowdesc": "Proceso mismo asignado rol",
            "idcuenta": null,
            "fechamodificacionhora": "2020-11-11 10:55:07.0",
            "idsla": 1,
            "fechamodificacion": "2020-11-11",
            "cantidadcasos": null,
            "sistemaexterno": null,
            "slavalue": 30,
            "fingreso": "2020-11-11 13:21:13.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2020-11-11T00:00",
            "fechamodificacionstr": "2020-11-11T00:00",
            "timeactual": null,
            "idprioridadcolor": "#2ECC71",
            "idstageactualdesc": "Paso 1",
            "idtipodesc": "Defecto",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": "Usuario sismon",
            "idproductodesc": "Be Aware 360",
            "idsladesc": "Cliente VIP",
            "idsubtipodesc": "Error de producto",
            "idusuarioasignadodesc": "sismonusr",
            "idprioridaddesc": "Media",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Cerrado",
            "logauditoria": null,
            "idcuentadesc": null,
            "fechafinalizacionhoralimit": "2020-11-11 11:55:07",
            "fechamodificacionhoralimit": "2020-11-11 11:55:07",
            "fechareapertura": null,
            "uuid": null,
            "eid": null,
            "id": 4316
        },
        {
            "checkList": null,
            "cf": {},
            "descripcion": null,
            "idworkflow": 11,
            "idprioridad": 2,
            "idproducto": 1,
            "idtipo": 1,
            "idsubtipo": 1,
            "idcontacto": 4,
            "origen": "AgenteWeb",
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "idusuarioasignado": 18,
            "idestado": 2,
            "idusuariocreacion": 18,
            "duedate": "2020-09-07 08:30:00.0",
            "porcentaje": -5578,
            "destacado": false,
            "refnum": "200904-000004",
            "idusuariomodificacion": null,
            "fechacreacion": "2020-09-04",
            "idstageactual": 17,
            "finalizado": 1,
            "asunto": "test creando caso desde FLOW con la api",
            "idworkflowdesc": "Proceso mismo asignado rol",
            "idcuenta": null,
            "fechamodificacionhora": "2020-09-07 18:03:44.0",
            "idsla": 1,
            "fechamodificacion": "2020-09-07",
            "cantidadcasos": null,
            "sistemaexterno": null,
            "slavalue": 30,
            "fingreso": "2020-09-04 22:45:02.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2020-09-04T00:00",
            "fechamodificacionstr": "2020-09-07T00:00",
            "timeactual": null,
            "idprioridadcolor": "#2ECC71",
            "idstageactualdesc": "Paso 1",
            "idtipodesc": "Defecto",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": "Usuario sismon",
            "idproductodesc": "Be Aware 360",
            "idsladesc": "Cliente VIP",
            "idsubtipodesc": "Error de producto",
            "idusuarioasignadodesc": "sismonusr",
            "idprioridaddesc": "Media",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Cerrado",
            "logauditoria": null,
            "idcuentadesc": null,
            "fechafinalizacionhoralimit": null,
            "fechamodificacionhoralimit": "2020-09-07 19:03:44",
            "fechareapertura": null,
            "uuid": null,
            "eid": null,
            "id": 240
        },
        {
            "checkList": null,
            "cf": {},
            "descripcion": null,
            "idworkflow": 11,
            "idprioridad": 2,
            "idproducto": 1,
            "idtipo": 1,
            "idsubtipo": 1,
            "idcontacto": 4,
            "origen": "AgenteWeb",
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "idusuarioasignado": 18,
            "idestado": 2,
            "idusuariocreacion": 18,
            "duedate": "2020-09-07 08:30:00.0",
            "porcentaje": -5510,
            "destacado": false,
            "refnum": "200904-000003",
            "idusuariomodificacion": null,
            "fechacreacion": "2020-09-04",
            "idstageactual": 17,
            "finalizado": 1,
            "asunto": "test creando caso desde FLOW con la api",
            "idworkflowdesc": "Proceso mismo asignado rol",
            "idcuenta": null,
            "fechamodificacionhora": "2020-09-07 18:03:55.0",
            "idsla": 1,
            "fechamodificacion": "2020-09-07",
            "cantidadcasos": null,
            "sistemaexterno": null,
            "slavalue": 30,
            "fingreso": "2020-09-04 22:00:06.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2020-09-04T00:00",
            "fechamodificacionstr": "2020-09-07T00:00",
            "timeactual": null,
            "idprioridadcolor": "#2ECC71",
            "idstageactualdesc": "Paso 1",
            "idtipodesc": "Defecto",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": "Usuario sismon",
            "idproductodesc": "Be Aware 360",
            "idsladesc": "Cliente VIP",
            "idsubtipodesc": "Error de producto",
            "idusuarioasignadodesc": "sismonusr",
            "idprioridaddesc": "Media",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Cerrado",
            "logauditoria": null,
            "idcuentadesc": null,
            "fechafinalizacionhoralimit": null,
            "fechamodificacionhoralimit": "2020-09-07 19:03:55",
            "fechareapertura": null,
            "uuid": null,
            "eid": null,
            "id": 239
        },
        {
            "checkList": null,
            "cf": {},
            "descripcion": null,
            "idworkflow": 11,
            "idprioridad": 1,
            "idproducto": 1,
            "idtipo": 1,
            "idsubtipo": 1,
            "idcontacto": 4,
            "origen": "AgenteWeb",
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "idusuarioasignado": 18,
            "idestado": 2,
            "idusuariocreacion": 18,
            "duedate": "2020-09-04 16:47:09.0",
            "porcentaje": 690373,
            "destacado": false,
            "refnum": "200904-000002",
            "idusuariomodificacion": null,
            "fechacreacion": "2020-09-04",
            "idstageactual": 17,
            "finalizado": 1,
            "asunto": "creando caso desde postman con la api",
            "idworkflowdesc": "Proceso mismo asignado rol",
            "idcuenta": null,
            "fechamodificacionhora": "2020-09-07 18:04:08.0",
            "idsla": 1,
            "fechamodificacion": "2020-09-07",
            "cantidadcasos": null,
            "sistemaexterno": null,
            "slavalue": 30,
            "fingreso": "2020-09-04 20:17:09.0",
            "flexible": null,
            "primerpaso": 1,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2020-09-04T00:00",
            "fechamodificacionstr": "2020-09-07T00:00",
            "timeactual": null,
            "idprioridadcolor": "#E74A25",
            "idstageactualdesc": "Paso 1",
            "idtipodesc": "Defecto",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": "Usuario sismon",
            "idproductodesc": "Be Aware 360",
            "idsladesc": "Cliente VIP",
            "idsubtipodesc": "Error de producto",
            "idusuarioasignadodesc": "sismonusr",
            "idprioridaddesc": "Alta",
            "idcontactodesc": "Cristian Vargas",
            "idestadodesc": "Cerrado",
            "logauditoria": null,
            "idcuentadesc": null,
            "fechafinalizacionhoralimit": null,
            "fechamodificacionhoralimit": "2020-09-07 19:04:08",
            "fechareapertura": null,
            "uuid": null,
            "eid": null,
            "id": 238
        }
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": 2147483647,
        "size": 4,
        "actualPage": 0
    }
}

GET

https://api.beaware360.com/ba360/apir/v10/caso/getby?filtro=history&id=<id_caso>.

Parámetros:

filtro -> history. Este filtro es para que pueda buscar por la totalidad de casos.
id -> Recibe el id del caso en Be Aware 360.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/caso/getby?filtro=history&id=957

Retorna la información de un caso específico, según su Id en Be Aware 360.

Ejemplo:

{
    "data": {
        "checkList": null,
        "idusuariomodificacion": null,
        "idusuarioasignado": 94,
        "idcuenta": 5,
        "idcontacto": 173,
        "origen": "AgenteWeb",
        "idestado": 1,
        "idusuariocreacion": 94,
        "porcentaje": -4840,
        "asunto": "Prueba caso",
        "descripcion": null,
        "idworkflow": 51,
        "idworkflowdesc": "Prueba Asignación Usuario",
        "idprioridad": 1,
        "idproducto": 21,
        "idtipo": 6,
        "idsubtipo": 1,
        "idstageactual": 104,
        "finalizado": 0,
        "canal": null,
        "idconversacion": null,
        "destacado": false,
        "refnum": "200325-000007",
        "idsla": null,
        "cf": {},
        "cantidadcasos": null,
        "fechacreacion": "2020-03-25",
        "fechamodificacion": null,
        "fechacreacionstr": "2020-03-25T00:00",
        "idestadodesc": "Ingresado",
        "idcuentadesc": null,
        "idcontactodesc": "Cristian Vargas",
        "idusuariocreaciondesc": "Integración API",
        "idusuariomodificaciondesc": null,
        "idusuarioasignadodesc": "integracion",
        "slavalue": 10,
        "fingreso": "2020-03-25 15:45:26.0",
        "duedate": "2020-03-25 12:55:26.0",
        "flexible": null,
        "primerpaso": 1,
        "psolucionado": "0",
        "pcreado": "0",
        "ppendiente": "0",
        "horastranscurridas2": null,
        "totalnotas2": null,
        "horastranscurridas": null,
        "urgente": null,
        "normal": null,
        "totalnotas": null,
        "solucionado": null,
        "creado": null,
        "pendiente": null,
        "totalcasos": null,
        "fechamodificacionstr": null,
        "timeactual": null,
        "idprioridadcolor": "#C0392B",
        "idstageactualdesc": "Ingreso de Información",
        "idtipodesc": "Facturación y Pago",
        "idproductodesc": "Crediagil Uber",
        "idsladesc": null,
        "idsubtipodesc": "Solicitud",
        "idprioridaddesc": "Alta",
        "logauditoria": null,
        "id": 957,
        "uuid": null,
        "eid": null
    },
    "code": 200,
    "message": null,
    "pagination": null
}

POST

https://api.beaware360.com/ba360/apir/v10/caso/add.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"idcontacto": 1,
	"idproducto": 1,
	"idtipo": 2,
	"idsubtipo": 2,
	"asunto": "Prueba Caso creado desde API",
	"origen": "FormWEB",
        "idusuarioasignado": 7,
	"idestado": 1,
	"idprioridad": 1,
	"idworkflow": null,
	"idsla": null,
	"cf": {
		"Acénto Ñ": "4567", "SPA_Número de Guía": "1234", "guia": "2345", "nombre": "Prueba"
	}
}

El sistema crea el caso con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "checkList": null,
        "asunto": "Prueba Caso creado desde API",
        "idcontacto": 1,
        "idproducto": 1,
        "idtipo": 2,
        "idsubtipo": 2,
        "canal": null,
        "idconversacion": null,
        "idstageactual": 4,
        "finalizado": 0,
        "idusuarioasignado": 7,
        "idestado": 1,
        "idusuariocreacion": 7,
        "idworkflowdesc": "Nuevos requerimientos BA360",
        "idworkflow": 2,
        "descripcion": null,
        "origen": "FormWEB",
        "destacado": false,
        "idprioridad": 1,
        "idcontactodesc": "Oskar Cantor",
        "idestadodesc": "Creado",
        "slavalue": 15,
        "fingreso": "2020-03-30 22:51:05.0",
        "duedate": "2020-03-31 08:15:00.0",
        "flexible": null,
        "primerpaso": 1,
        "psolucionado": "0",
        "pcreado": "0",
        "ppendiente": "0",
        "horastranscurridas2": null,
        "totalnotas2": null,
        "horastranscurridas": null,
        "urgente": null,
        "normal": null,
        "totalnotas": null,
        "solucionado": null,
        "creado": null,
        "pendiente": null,
        "totalcasos": null,
        "fechacreacionstr": "2020-03-30T00:00",
        "fechamodificacionstr": null,
        "timeactual": null,
        "idprioridadcolor": "#E74A25",
        "idstageactualdesc": "Ingreso de datos",
        "idtipodesc": "Requerimiento",
        "idusuariomodificaciondesc": null,
        "idusuariocreaciondesc": "Integración API BA360",
        "idproductodesc": "Be Aware 360",
        "idsladesc": null,
        "idsubtipodesc": "Aprovisionamiento de nueva instancia",
        "idusuarioasignadodesc": "integracion",
        "idprioridaddesc": "Alta",
        "idsla": null,
        "idusuariomodificacion": null,
        "logauditoria": null,
        "cf": {
            "Acénto Ñ": "4567",
            "SPA_Número de Guía": "1234",
            "guia": "2345",
            "nombre": "Prueba"
        },
        "cantidadcasos": null,
        "fechacreacion": "2020-03-30",
        "fechamodificacion": null,
        "porcentaje": 100,
        "refnum": "200330-000004",
        "uuid": null,
        "eid": null,
        "id": 30
    },
    "code": 200,
    "message": "Caso creado exitosamente.",
    "pagination": null
}        

Nota: Para utilizar este recurso es necesario siempre enviar todos los campos del caso y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.

PUT

https://api.beaware360.com/ba360/apir/v10/caso/upd.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
	"idcontacto": 1,
	"idproducto": 1,
	"idtipo": 1,
	"idsubtipo": 1,
	"asunto": "Caso actualizado desde API",
	"origen": "AgenteWeb",
	"idestado": 1,
	"idusuarioasignado": 3,
	"idprioridad": 2,
	"idworkflow": 11,
	"idsla": 9,
	"cf": 
	{
		"creadorInt": "4", 
		"guia": "0987655", 
		"fecha_compra": "2020-07-02T05:00:00.000Z", 
		"nombre": "Cambio de nombre"},
	"id": 183
}

El sistema actualiza el caso con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "checkList": null,
        "porcentaje": 0,
        "idcontacto": 1,
        "idproducto": 1,
        "idtipo": 1,
        "idsubtipo": 1,
        "asunto": "Caso actualizado desde API",
        "descripcion": null,
        "idcuenta": null,
        "origen": "AgenteWeb",
        "finalizado": 0,
        "idstageactual": null,
        "idworkflow": 11,
        "idworkflowdesc": "Proceso mismo asignado rol",
        "idusuarioasignado": 3,
        "refnum": "200701-000007",
        "idprioridad": 2,
        "idusuariocreacion": 3,
        "idusuariomodificacion": null,
        "cf": {
            "creadorInt": "4",
            "guia": "0987655",
            "fecha_compra": "2020-07-02T05:00:00.000Z",
            "nombre": "Cambio de nombre"
        },
        "destacado": false,
        "canal": null,
        "idinteraccion": null,
        "idconversacion": null,
        "idestado": 1,
        "idsla": 9,
        "fechacreacion": "2020-07-01",
        "fechamodificacion": "2020-07-08",
        "cantidadcasos": null,
        "sistemaexterno": null,
        "slavalue": 0,
        "fingreso": null,
        "duedate": null,
        "flexible": null,
        "primerpaso": 0,
        "psolucionado": "0",
        "pcreado": "0",
        "ppendiente": "0",
        "horastranscurridas2": null,
        "totalnotas2": null,
        "horastranscurridas": null,
        "urgente": null,
        "normal": null,
        "totalnotas": null,
        "solucionado": null,
        "creado": null,
        "pendiente": null,
        "totalcasos": null,
        "fechacreacionstr": "2020-07-01T00:00",
        "fechamodificacionstr": "2020-07-08T00:00",
        "timeactual": null,
        "idprioridadcolor": "#2ECC71",
        "idstageactualdesc": null,
        "idtipodesc": "Defecto",
        "idusuariomodificaciondesc": null,
        "idusuariocreaciondesc": "Sandra Cantor",
        "idproductodesc": "Be Aware 360",
        "idsladesc": "Atención normal",
        "idsubtipodesc": "Error de producto",
        "idusuarioasignadodesc": "scantor",
        "idprioridaddesc": "Media",
        "idcontactodesc": "Oskar Cantor",
        "idestadodesc": "Creado",
        "logauditoria": null,
        "idcuentadesc": null,
        "eid": null,
        "uuid": null,
        "id": 183
    },
    "code": 200,
    "message": null,
    "pagination": null
}

DELETE

https://api.beaware360.com/ba360/apir/v10/caso/del/?id=<id_caso>.

Parámetros:

id -> Id del caso.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/caso/del/?id=30

Elimina un caso específico de la base de datos de Be Aware 360.

Ejemplo:

{
    "data": {
        "checkList": null,
        "asunto": "Prueba Caso creado desde API 30/03/2020 5:50 pm",
        "idcontacto": 1,
        "idproducto": 1,
        "idtipo": 2,
        "idsubtipo": 2,
        "canal": null,
        "idconversacion": null,
        "idstageactual": null,
        "finalizado": 1,
        "idusuarioasignado": 4,
        "idestado": 2,
        "idusuariocreacion": 7,
        "idworkflowdesc": "Nuevos requerimientos BA360",
        "idworkflow": 2,
        "descripcion": null,
        "origen": "FormWEB",
        "destacado": false,
        "idprioridad": 2,
        "idcontactodesc": "Oskar Cantor",
        "idestadodesc": "Cerrado",
        "slavalue": 0,
        "fingreso": null,
        "duedate": null,
        "flexible": null,
        "primerpaso": 0,
        "psolucionado": "0",
        "pcreado": "0",
        "ppendiente": "0",
        "horastranscurridas2": null,
        "totalnotas2": null,
        "horastranscurridas": null,
        "urgente": null,
        "normal": null,
        "totalnotas": null,
        "solucionado": null,
        "creado": null,
        "pendiente": null,
        "totalcasos": null,
        "fechacreacionstr": "2020-03-30T00:00",
        "fechamodificacionstr": "2020-03-30T00:00",
        "timeactual": null,
        "idprioridadcolor": "#2ECC71",
        "idstageactualdesc": null,
        "idtipodesc": "Requerimiento",
        "idusuariomodificaciondesc": null,
        "idusuariocreaciondesc": "Integración API BA360",
        "idproductodesc": "Be Aware 360",
        "idsladesc": "Cliente VIP",
        "idsubtipodesc": "Aprovisionamiento de nueva instancia",
        "idusuarioasignadodesc": "aatencion",
        "idprioridaddesc": "Media",
        "idsla": 1,
        "idusuariomodificacion": null,
        "logauditoria": null,
        "cf": {},
        "cantidadcasos": null,
        "fechacreacion": "2020-03-30",
        "fechamodificacion": "2020-03-30",
        "porcentaje": 0,
        "refnum": "200330-000004",
        "uuid": null,
        "eid": null,
        "id": 30
    },
    "code": 200,
    "message": "Caso eliminado con éxito.",
    "pagination": null
}

GET

https://api.beaware360.com/ba360/apir/v10/producto/get.

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de productos creados en Be Aware 360.

Ejemplo:

{
    "data": [
        {
            "nombre": "Be Aware 360",
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "nombre": "Pure Cloud",
            "uuid": null,
            "eid": null,
            "id": 2
        },
        {
            "nombre": "Producto nuevo",
            "uuid": null,
            "eid": null,
            "id": 3
        }
    ],
    "code": 200,
    "message": null,
    "pagination": null
}

GET

https://api.beaware360.com/ba360/apir/v10/tipo/get.

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de motivos creados en Be Aware 360.

Ejemplo:

{
    "data": [
        {
            "nombre": "Defecto",
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "nombre": "Requerimiento",
            "uuid": null,
            "eid": null,
            "id": 2
        },
        {
            "nombre": "Implementación",
            "uuid": null,
            "eid": null,
            "id": 3
        },
        {
            "nombre": "Motivo nuevo",
            "uuid": null,
            "eid": null,
            "id": 4
        }
    ],
    "code": 200,
    "message": null,
    "pagination": null
}

GET

https://api.beaware360.com/ba360/apir/v10/subtipo/get.

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de submotivos creados en Be Aware 360.

Ejemplo:

{
    "data": [
        {
            "nombres": "Error de producto",
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "nombres": "Aprovisionamiento de nueva instancia",
            "uuid": null,
            "eid": null,
            "id": 2
        },
        {
            "nombres": "Solicitud de información",
            "uuid": null,
            "eid": null,
            "id": 3
        },
        {
            "nombres": "Submotivo nuevo",
            "uuid": null,
            "eid": null,
            "id": 4
        }
    ],
    "code": 200,
    "message": null,
    "pagination": null
}

GET

https://api.beaware360.com/ba360/apir/v10/mtmultityping/get.

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de tipificaciones creadas en Be Aware 360.

Ejemplo:

{
    "data": [
        {
            "descripcion": "Tipificación para Soporte de Be Aware 360.",
            "mtproductos": [
                1
            ],
            "mttipos": [
                1
            ],
            "mtsubtipos": [
                1
            ],
            "nombre": "Soporte Be Aware 360",
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "descripcion": "Atención de nuevos requerimientos para BA360",
            "mtproductos": [
                1
            ],
            "mttipos": [
                2
            ],
            "mtsubtipos": [
                2
            ],
            "nombre": "Requerimientos BA360",
            "uuid": null,
            "eid": null,
            "id": 2
        }
    ],
    "code": 200,
    "message": null,
    "pagination": null
}

GET

https://api.beaware360.com/ba360/apir/v10/prioridad/get.

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Retorna la lista de prioridades creadas en Be Aware 360.

Ejemplo:

{
    "data": [
        {
            "color": "#E74A25",
            "nivel": "Alta",
            "uuid": null,
            "eid": null,
            "id": 1
        },
        {
            "color": "#2ECC71",
            "nivel": "Media",
            "uuid": null,
            "eid": null,
            "id": 2
        },
        {
            "color": "#0283CC",
            "nivel": "Normal",
            "uuid": null,
            "eid": null,
            "id": 4
        },
        {
            "color": "#FFB136",
            "nivel": "Baja",
            "uuid": null,
            "eid": null,
            "id": 5
        },
        {
            "color": "#34495E",
            "nivel": "VIP",
            "uuid": null,
            "eid": null,
            "id": 6
        }
    ],
    "code": 200,
    "message": null,
    "pagination": null
}

POST

https://api.beaware360.com/ba360/apir/v10/mtmultityping/add.

Parámetros:

Este recurso no recibe parámetros.

Campos:

Ejemplo:

{
    "nombre": "Tipificación de prueba", 
    "mtproductos": [5, 6], 
    "mttipos": [3, 4, 5], 
    "mtsubtipos": [5, 3],
    "descripcion": "Descripción de tipificación de prueba"
}

Autenticación:

Retorna los datos de la tipificación creada incluyendo el identificador asignado por Be Aware 360.

Ejemplo:

{
    "data": {
        "nombre": "Tipificación de prueba",
        "mtproductos": [
            5,
            6
        ],
        "mttipos": [
            3,
            4,
            5
        ],
        "mtsubtipos": [
            5,
            3
        ],
        "descripcion": "Descripción de tipificación de prueba",
        "eid": null,
        "uuid": null,
        "id": 18
    },
    "code": 200,
    "message": null,
    "pagination": null
}

Nota: Para utilizar este recurso es necesario siempre enviar todos los campos de la tipificación y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.

PUT

https://api.beaware360.com/ba360/apir/v10/mtmultityping/upd.

Parámetros:

Este recurso no recibe parámetros

Campos:

Ejemplo:

{
    "nombre": "Tipificación de prueba actualizada", 
    "mtproductos": [5, 6], 
    "mttipos": [3, 4, 5], 
    "mtsubtipos": [6, 7],
    "descripcion": "Actualización de la descripción de tipificación de prueba",
    "id": 18
}

El sistema actualiza la tipificación con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "nombre": "Tipificación de prueba actualizada",
        "mtproductos": [
            5,
            6
        ],
        "mttipos": [
            3,
            4,
            5
        ],
        "mtsubtipos": [
            6,
            7
        ],
        "descripcion": "Actualización de la descripción de tipificación de prueba 2",
        "eid": null,
        "uuid": null,
        "id": 18
    },
    "code": 200,
    "message": null,
    "pagination": null
}

DELETE

https://api.beaware360.com/ba360/apir/v10/mtmultityping/del?id=<id_tipificacion>.

Parámetros:

id -> Id de la tipificación.

Campos:

No requiere enviar campos.

Autenticación:

Ejemplo: