apiba360

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: Atienda sus clientes de principio a fin con Be Aware 360.

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


Recursos Descripción Método URL Recurso
GetToken Retorna la información completa del usuario incluido el token que será obligatorio usar en todas los recursos que se consuman a través de la API. POST https://api.beaware360.com/ba360/apir/v10/login/auth
Recursos Descripción Método URL Recurso
Consultar contactos Retorna la lista de contactos según los parámetros de búsqueda. GET https://api.beaware360.com/ba360/apir/v10/contacto/get
Consultar contacto por ID Retorna la información de un contacto en específico, según su Id en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/contacto/getby?id=<id_contacto>
Crear contacto Crea un contacto en Be Aware 360 POST https://api.beaware360.com/ba360/apir/v10/contacto/add
Actualizar contacto Actualiza un contacto en Be Aware 360 PUT https://api.beaware360.com/ba360/apir/v10/contacto/upd
Eliminar contacto Elimina un contacto en Be Aware 360 DELETE https://api.beaware360.com/ba360/apir/v10/contacto/del/?id=<id_contacto>
Validar correo del contacto Envía el correo de verificación al contacto para que pueda verificar su correo electrónico. POST https://api.beaware360.com/ba360/apir/v10/contacto/verificar

Recursos Descripción Método URL Recurso
Consultar cuentas Retorna la lista de cuentas según los parámetros de búsqueda. GET https://api.beaware360.com/ba360/apir/v10/cuenta/get
Crear cuenta Crea una cuenta en Be Aware 360 POST https://api.beaware360.com/ba360/apir/v10/cuenta/add
Actualizar cuenta Actualiza una cuenta en Be Aware 360 PUT https://api.beaware360.com/ba360/apir/v10/cuenta/upd
Eliminar cuenta Elimina una cuenta en Be Aware 360 DELETE https://api.beaware360.com/ba360/apir/v10/cuenta/del/?id=<id_cuenta>

Recursos Descripción Método URL Recurso
Consultar casos Retorna la lista de los casos de acuerdo con el criterio de búsqueda. GET https://api.beaware360.com/ba360/apir/v10/caso/get/
Consultar caso por ID Retorna la información de un caso específico, según su Id en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/caso/getby?filtro=history&id=<id_caso>
Crear caso Hace la creación de un caso en Be Aware 360. POST https://api.beaware360.com/ba360/apir/v10/caso/add
Actualizar caso Actualiza la información de un caso específico, de acuerdo con la información enviada. PUT https://api.beaware360.com/ba360/apir/v10/caso/upd
Eliminar caso Elimina un caso de Be Aware 360. DELETE https://api.beaware360.com/ba360/apir/v10/caso/del

Recursos Descripción Método URL Recurso
Consultar productos Retorna la lista de productos creados en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/producto/get
Consultar motivos Retorna la lista de motivos creados en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/tipo/get
Consultar submotivos Retorna la lista de submotivos creados en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/subtipo/get
Consultar tipificación Retorna la lista de tipificaciones creadas en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/mtmultityping/get
Consultar prioridad Retorna la lista de prioridades creadas en Be Aware 360. GET https://api.beaware360.com/ba360/apir/v10/prioridad/get
Crear tipificación Crea una tipificación en Be Aware 360. POST https://api.beaware360.com/ba360/apir/v10/mtmultityping/add
Actualizar tipificación Actualiza una tipificación en Be Aware 360. PUT https://api.beaware360.com/ba360/apir/v10/mtmultityping/upd
Eliminar tipificación Elimina una tipificación en Be Aware 360. DELETE https://api.beaware360.com/ba360/apir/v10/mtmultityping/del?id=<id_tipificacion>
Recursos Descripción Método URL Recurso
Consultar notas del caso Consulta notas de un caso específico. GET https://api.beaware360.com/ba360/apir/v10/actividad/get?idobjeto=<id_caso>&tipoobjeto=casos
Agregar notas al caso Agrega notas a un caso específico. POST https://api.beaware360.com/ba360/apir/v10/actividad/add
Agregar archivos adjuntos al caso Agrega archivos adjuntos a un caso específico. POST https://api.beaware360.com/ba360/uploadfile
Descargar un archivo adjunto Descarga archivos adjuntos según ID. GET https://api.beaware360.com/ba360/downloadfile
Avanzar el paso de un caso Avanza el caso al siguiente paso. POST https://api.beaware360.com/ba360/apir/v10/workflow/next
Retroceder el paso de un caso Retrocede el caso al paso anterior. POST https://api.beaware360.com/ba360/apir/v10/workflow/back

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.


Método

POST


URL Recurso

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


Request:

Parámetros:

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

Campos:

Campo API Campo BA360 Tipo de dato Requerido
company Empresa String
user Usuario String
password Contraseña String

Ejemplo:

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

Response

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.


Método

GET


URL Recurso

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>.

Request:

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


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

Consultar todos los contactos

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos para el listado completo de contactos.

Consultar contacto por parámetros

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

—-

Consultar contactos con paginación

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

Consultar contacto por filtro

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

Response

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
    }
}


Método

GET


URL Recurso

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


Request:

Parámetros:

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

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

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

Response

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
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
nombre Nombre del contacto String “Josefina”
apellido Apellido del contacto String “Fernández”
identificador Identificador del contacto String Debe ser único “25291667-8”
email Correo electrónico del contacto String (Lista) Acepta hasta 3 correos electrónicos [“correo1@beaware.com”, “correo2@beaware.com”, “correo3@beaware.com”]
facebook Id de Facebook del contacto String No “1234567890”
twitter Usuario de Twitter del contacto String No “@josefa”
instagram Usuario de Instagram del contacto String No “@josefaig”
direccion Dirección del contacto String No “Calle 123 # 56 - 90”
grupocuentas Cuenta a la que pertenece el contacto String (Lista) No Corresponde a un arreglo con los Ids de las cuentas a las que pertenece el contacto separados por coma ,. [3,5,10]
fechanacimiento Fecha de nacimiento del contacto String No Formato: aaaa-mm-dd “1983-11-20”
cargo Cargo del contacto String No “Jefe de proyectos”
idsla Acuerdo del contacto Integer No Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará al contacto 1
gruposkills Grupo al que pertenece el contacto String (Lista) No Corresponde a un arreglo con los Ids de los grupos a los que pertenece el contacto separados por coma , [1,2,5]
fono Teléfono del contacto String (Lista) No Acepta hasta 3 teléfonos.

El sistema hace las siguientes validaciones del teléfono:
\\» Solo números.
» Símbolo + al inicio.
» Símbolo ( antes del primer número.
» Símbolo ) luego del tercer número antes del cuarto.
» Longitud mínima 8 números (sin considerar símbolos).
» Longitud máxima 20 números (considerando símbolos).

Ejemplos de números aceptados (límites):
» +(549)23232323232323
» 5492323232323232399
» +(549)23232
» 54923232
» +54923232
» (549)23232
[“+5713682466”,“+5626804615”]
cf Campos personalizados del contacto Lista (depende del tipo de campo) No Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“hobbie_principal”: “Lectura”, “fecha_ingreso_empresa”: “2020-01-06T05:00:00.000Z”}

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]
}

Response

El sistema crea el contacto con la información que se ha enviado a través de la API. Si se quiere enviar el correo de verificación al contacto, se debe utilizar la API de Validación de correo del contacto.

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.


Método

PUT


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
nombre Nombre del contacto String “Josefina”
apellido Apellido del contacto String “Fernández”
identificador Identificador del contacto String Debe ser único “25291667-8”
email Correo electrónico del contacto String (Lista) Acepta hasta 3 correos electrónicos [“correo1@beaware.com”, “correo2@beaware.com”, “correo3@beaware.com”]
facebook Id de Facebook del contacto String No “1234567890”
twitter Usuario de Twitter del contacto String No “@josefa”
instagram Usuario de Instagram del contacto String No “@josefaig”
direccion Dirección del contacto String No “Calle 123 # 56 - 90”
grupocuentas Cuenta a la que pertenece el contacto String (Lista) No Corresponde a un arreglo con los Ids de las cuentas a las que pertenece el contacto separados por coma ,. [3,5,10]
fechanacimiento Fecha de nacimiento del contacto String No Formato: aaaa-mm-dd “1983-11-20”
cargo Cargo del contacto String No “Jefe de proyectos”
idsla Acuerdo del contacto Integer No Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará al contacto 1
gruposkills Grupo al que pertenece el contacto String (Lista) No Corresponde a un arreglo con los Ids de los grupos a los que pertenece el contacto separados por coma , [1,2,5]
fono Teléfono del contacto String (Lista) No Acepta hasta 3 teléfonos.

El sistema hace las siguientes validaciones del teléfono:
\\» Solo números.
» Símbolo + al inicio.
» Símbolo ( antes del primer número.
» Símbolo ) luego del tercer número antes del cuarto.
» Longitud mínima 8 números (sin considerar símbolos).
» Longitud máxima 20 números (considerando símbolos).

Ejemplos de números aceptados (límites):
» +(549)23232323232323
» 5492323232323232399
» +(549)23232
» 54923232
» +54923232
» (549)23232
[“+5713682466”,“+5626804615”]
cf Campos personalizados del contacto Lista (depende del tipo de campo) No Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“hobbie_principal”: “Lectura”, “fecha_ingreso_empresa”: “2020-01-06T05:00:00.000Z”}
id Id del contacto que se va a actualizar Integer 8

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
}

Response

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
}


Método

DELETE


URL Recurso

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


Request:

Parámetros:

id -> Id del contacto.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

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

Response

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
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
email Correo electrónico del contacto String Se debe usar el correo del contacto que recibirá el correo de verificación. “correo1@beaware.com”
idcontacto Id del contacto Integer Corresponde al Id que le otorga Be Aware 360 al contacto. 1409
origin Nombre de la instancia de Be Aware 360 String “ba360review.deskbeaware.com”

Ejemplo:

{
    "email":"correo1@beaware.com",
    "idcontacto":1409,
    "origin":"ba360review.deskbeaware.com"
}

Response

El sistema envía el correo electrónico de verificación al contacto.

Ejemplo:

{
    "data": {
        "email": [],
        "fono": [],
        "fonocp": null,
        "facebook": null,
        "instagram": null,
        "twitter": null,
        "idsla": 1,
        "idcuenta": null,
        "company": null,
        "origin": null,
        "fechanacimiento": "1983-03-16",
        "grupocuentas": [],
        "emailcp": null,
        "cargo": "Bibliotecaria",
        "grupocuentasstring": "2",
        "lang": "es",
        "fechacreacion": "2021-08-18 17:38:27.0",
        "fechamodificacion": null,
        "cf": {
            "hobbie_principal": "Lectura",
            "fecha_ingreso_empresa": "2020-01-06T05:00:00.000Z"
        },
        "identificador": "42123222",
        "nombre": "Contacto",
        "apellido": "Prueba",
        "pass": null,
        "gruposkills": [],
        "idtipo": null,
        "direccion": "Calle 145 # 15A - 50",
        "titulo": null,
        "idcuentadesc": null,
        "uuid": null,
        "eid": null,
        "id": 1409
    },
    "code": 200,
    "message": null,
    "pagination": null
}


Método

GET


URL Recurso

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>.

Request:

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


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

Consultar todas las cuentas

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Consultar cuenta por parámetros

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

Consultar cuentas con paginación

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

Consultar cuenta por filtro

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

Response

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
    }
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
razonsocial Razón social de la cuenta String Este campo tiene una validación que sea menor a 255 caracteres. “In Motion”
identificador Identificador de la cuenta String Debe ser único. Este campo tiene una validación que sea menor a 20 caracteres. “900262501-1”
idsla Acuerdo de la cuenta Integer Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará a la cuenta 1
direccion Dirección de la cuenta String No Este campo tiene una validación que sea menor a 255 caracteres. “Carrera 11A # 93- 52”
email Correo electrónico de la cuenta String No Este campo tiene una validación que sea menor a 45 caracteres. “contacto@grupoinmotion.com.invalid”
facebook Id de Facebook de la cuenta String No Este campo tiene una validación que sea menor a 100 caracteres. “1234567890987654”
instagram Usuario de Instagram de la cuenta String No Este campo tiene una validación que sea menor a 100 caracteres. “@imcol”
twitter Usuario de Twitter de la cuenta String No Este campo tiene una validación que sea menor a 100 caracteres. “@immex”
giro Giro o actividad económica de la cuenta String No Este campo tiene una validación que sea menor a 200 caracteres. “Servicios de tecnología”
paginaweb Página web de la cuenta String No Este campo tiene una validación que sea menor a 100 caracteres. “www.grupoinmotion.com”
telefono Teléfono de la cuenta String No Solo acepta caracteres numéricos. Es importante que el teléfono vaya con el prefijo correspondiente “5713004627”
idrepresentante Contacto que corresponde al representante de la cuenta Integer No Id del contacto que corresponde al representante de la cuenta 118
grupocontactos Grupo de contactos asociados a la cuenta Integer (Lista) No Correspondes a los Ids de contactos que están asociados a la cuenta [112, 113, 118]
cf Campos personalizados de la cuenta Lista (depende del tipo de campo) No Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“campo_ex”: “2020-03-02T05:00:00.000Z”, “nombre”: “prueba”}

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"}
}

Response

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.


Método

PUT


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
razonsocial Razón social de la cuenta String “In Motion”
identificador Identificador de la cuenta String Debe ser único “900262501-1”
idsla Acuerdo de la cuenta Integer Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará a la cuenta 1
direccion Dirección de la cuenta String No “Carrera 11A # 93- 52”
email Correo electrónico de la cuenta String No “contacto@grupoinmotion.com.invalid”
facebook Id de Facebook de la cuenta String No “1234567890987654”
instagram Usuario de Instagram de la cuenta String No “@imcol”
twitter Usuario de Twitter de la cuenta String No “@immex”
giro Giro o actividad económica de la cuenta String No “Servicios de tecnología”
paginaweb Página web de la cuenta String No “www.grupoinmotion.com”
telefono Teléfono de la cuenta String No Solo acepta caracteres numéricos. Es importante que el teléfono vaya con el prefijo correspondiente “5713004627”
idrepresentante Contacto que corresponde al representante de la cuenta Integer No Id del contacto que corresponde al representante de la cuenta 118
grupocontactos Grupo de contactos asociados a la cuenta Integer (Lista) No Correspondes a los Ids de contactos que están asociados a la cuenta [112, 113, 118]
cf Campos personalizados de la cuenta Lista (depende del tipo de campo) No Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“campo_ex”: “2020-03-02T05:00:00.000Z”, “nombre”: “prueba”}
id Id de la cuenta que se va a actualizar Integer 38

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
}

Response

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
}


Método

DELETE


URL Recurso

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


Request:

Parámetros:

id -> Id de la cuenta.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

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

Response

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
}


Método

GET


URL Recurso

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 histórico de casos API ligera: https://api.beaware360.com/ba360/apir/v10/caso/historylite/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>.


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
    }
}


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

Retorna la lista de todos los casos sin tener en cuenta el estado, grupo o usuario asignado al caso. Este servicio entrega una respuesta acotada respecto al servicio de histórico normal. Con esto, se espera una respuesta del servicio en un tiempo menor permitiendo consultas de gran cantidad de casos.

La respuesta del servicio entrega los mismos campos que la API del histórico de casos, pero solo retornará valores para los siguientes campos:

Campo Descripción
id Identificador único del caso asignado por Be Aware 360.
idestado Identificador del estado asignado al caso.
idestadodesc Descripción del estado asignado al caso.
refnum Número del caso.
idcontacto Identificador del contacto asignado al caso.
idcontactodesc Nombre del contacto asignado al caso.
idcuenta Identificador de la cuenta asignada al caso.
razonsocial Nombre de la cuenta asignada al caso.
idusuarioasignado Identificador del usuario asignado al caso.
idusuarioasignadodesc Nombre del usuario asignado al caso.
idproducto Identificador del producto asignado al caso.
idproductodesc Nombre del producto asignado al caso.
idtipo Identificador del motivo asignado al caso.
idtipodesc Nombre del motivo asignado al caso.
idsubtipo Identificador del submotivo asignado al caso.
idsubtipodesc Nombre del submotivo asignado al caso.
origen Nombre del canal por el cual se creó el caso.
asunto Asunto del caso.
fechacreacion Fecha de creación del caso.
finalizado Indica si el caso está finalizado. 0 indica que el caso no está finalizado y 1 indica que sí está finalizado el caso.

Ejemplo:

{
    "data": [
        {
            "checkList": null,
            "idworkflow": null,
            "idtipo": 53,
            "idworkflowdesc": null,
            "idestado": 7,
            "fechamodificacionhora": null,
            "idusuariocreacion": null,
            "idusuarioasignado": 91,
            "idstageactual": null,
            "asunto": "Caso de prueba",
            "descripcion": null,
            "idproducto": 1,
            "idsubtipo": 22,
            "origen": "Voz",
            "finalizado": 1,
            "idsla": null,
            "idcontacto": 116,
            "idcuenta": null,
            "cf": {},
            "fechacreacion": "2021-01-12",
            "idusuariomodificacion": null,
            "porcentaje": null,
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "duedate": null,
            "destacado": null,
            "refnum": "210112-000540",
            "idprioridad": null,
            "fechamodificacion": null,
            "cantidadcasos": null,
            "idcuentadesc": null,
            "idusuarioasignadodesc": "dquinapallo",
            "idcontactodesc": "JUAN PEREZ",
            "idestadodesc": "Solucionado",
            "sistemaexterno": null,
            "slavalue": null,
            "fingreso": null,
            "flexible": null,
            "primerpaso": null,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "idsladesc": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2021-01-12T00:00",
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": null,
            "idstageactualdesc": null,
            "idtipodesc": "Soporte back",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": null,
            "idproductodesc": "Requerimiento",
            "idsubtipodesc": "Soporte",
            "idprioridaddesc": null,
            "logauditoria": null,
            "fechafinalizacionhoralimit": null,
            "fechamodificacionhoralimit": null,
            "fechareapertura": null,
            "id": 82432,
            "eid": null,
            "uuid": null
        },
        {
            "checkList": null,
            "idworkflow": null,
            "idtipo": 10,
            "idworkflowdesc": null,
            "idestado": 7,
            "fechamodificacionhora": null,
            "idusuariocreacion": null,
            "idusuarioasignado": 33,
            "idstageactual": null,
            "asunto": "Caso de prueba 2",
            "descripcion": null,
            "idproducto": 2,
            "idsubtipo": 22,
            "origen": "Voz",
            "finalizado": 1,
            "idsla": null,
            "idcontacto": 29740,
            "idcuenta": null,
            "cf": {},
            "fechacreacion": "2021-01-12",
            "idusuariomodificacion": null,
            "porcentaje": null,
            "canal": null,
            "idinteraccion": null,
            "idconversacion": null,
            "duedate": null,
            "destacado": null,
            "refnum": "210112-000539",
            "idprioridad": null,
            "fechamodificacion": null,
            "cantidadcasos": null,
            "idcuentadesc": null,
            "idusuarioasignadodesc": "rortiz",
            "idcontactodesc": "MARTA ALVARADO",
            "idestadodesc": "Solucionado",
            "sistemaexterno": null,
            "slavalue": null,
            "fingreso": null,
            "flexible": null,
            "primerpaso": null,
            "psolucionado": "0",
            "pcreado": "0",
            "ppendiente": "0",
            "horastranscurridas2": null,
            "idsladesc": null,
            "totalnotas2": null,
            "horastranscurridas": null,
            "urgente": null,
            "normal": null,
            "totalnotas": null,
            "solucionado": null,
            "creado": null,
            "pendiente": null,
            "totalcasos": null,
            "fechacreacionstr": "2021-01-12T00:00",
            "fechamodificacionstr": null,
            "timeactual": null,
            "idprioridadcolor": null,
            "idstageactualdesc": null,
            "idtipodesc": "Solicitud",
            "idusuariomodificaciondesc": null,
            "idusuariocreaciondesc": null,
            "idproductodesc": "Requerimiento",
            "idsubtipodesc": "No aplica",
            "idprioridaddesc": null,
            "logauditoria": null,
            "fechafinalizacionhoralimit": null,
            "fechamodificacionhoralimit": null,
            "fechareapertura": null,
            "id": 82431,
            "eid": null,
            "uuid": null
        }
    ],
    "code": 200,
    "message": null,
    "pagination": {
        "cantPages": 41040,
        "size": 82079,
        "actualPage": 100
    }
}


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
    },
    ...
}


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
    },
    ...
}


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

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

Response

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
    }
}


Método

GET


URL Recurso

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


Request:

Parámetros:

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

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
    }
}


Método

GET


URL Recurso

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


Request:

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

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

Response

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
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
idcontacto Id del contacto asociado al caso Integer 788
idproducto Id del producto asociado al caso Integer 36
idtipo Id del motivo asociado al caso Integer 4
idsubtipo Id del submotivo asociado al caso Integer 3
asunto Asunto del caso String Máximo 500 caracteres. Si se supera este tamaño, la API responderá código de error 422. “Asunto del caso”
origen Canal del caso String Acepta los siguientes valores: FormWEB, AgenteWeb, Voz, Chat, Email, SMS, TWDirect, Messenger, Facebook, Whatsapp, Telegram, Hangout, Instagram “FormWEB”
idusuarioasignado Id del usuario asignado al caso Integer No Esta es la lógica que emplea Be Aware 360 cuando se se envía el usuario asignado en la creación de un caso:

* Si el usuario asignado NO se incluye en el request, se asigna el caso según el proceso (Asignación automática de BA360).
* Si el usuario asignado se incluye en el request con valor VACÍO, se asigna el caso según el proceso (Asignación automática de BA360).
* Si el usuario asignado se incluye en el request con valor NULL, se asigna el caso según el proceso (Asignación automática de BA360).
* Si el usuario asignado se incluye en el request con un ID de Usuario, se asigna el caso de acuerdo con las siguientes características:
- Si el ID de usuario es válido: Se crea el caso y se asigna al usuario correspondiente (ID).
- Si el ID de usuario es inválido: Se crea el caso y se asigna según el proceso (Asignación automática de BA360).
- Si el ID de Usuario corresponde a un Usuario Inactivo: Se crea el caso y se asigna según el proceso (Asignación automática de BA360).
7
idestado Id del estado asociado al caso Integer No 1
idprioridad Id de la prioridad asociada al caso Integer No 1
idcuenta Cuenta a la que pertenece el contacto que está asociada al caso Integer No 45
idsla Id del acuerdo asociado al caso Integer No 1
idworkflow Id del proceso asociado al caso Integer No No es necesario enviar este campo dado que la combinación del producto, motivo y submotivo asigna automáticamente el caso al proceso 2
cf Campos personalizados del caso Lista (depende del tipo de campo) Depende de la configuración del campo personalizado si fue marcado como obligatorio. Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“guia”: “2345”, “fecha guía”: “2020-01-06T05:00:00.000Z”}

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"
	}
}

Response

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.


Método

PUT


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
idcontacto Id del contacto asociado al caso Integer 788
idproducto Id del producto asociado al caso Integer 36
idtipo Id del motivo asociado al caso Integer 4
idsubtipo Id del submotivo asociado al caso Integer 3
asunto Asunto del caso String Máximo 500 caracteres. Si se supera este tamaño, la API responderá código de error 422. “Asunto del caso”
origen Canal del caso String Acepta los siguientes valores: FormWEB, AgenteWeb, Voz, Chat, Email, SMS, TWDirect, Messenger, Facebook, Whatsapp, Telegram, Hangout, Instagram “FormWEB”
refnum Número de referencia del caso String Este campo se compone de: ######-###### “200421-000010”
idestado Id del estado asociado al caso Integer No 1
idprioridad Id de la prioridad asociada al caso Integer No 1
idcuenta Cuenta a la que pertenece el contacto que está asociada al caso Integer No 45
idsla Id del acuerdo asociado al caso Integer No 1
idworkflow Id del proceso asociado al caso Integer No No es necesario enviar este campo dado que la combinación del producto, motivo y submotivo asigna automáticamente el caso al proceso 2
idusuarioasignado Id del usuario asignado al caso Integer No Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso:

* Si se envía ID asignado válido, lo asigna al caso.
* Si se envía ID asignado inválido, deja Caso sin asignado.
* Si no se envía parámetro de asignado, deja Caso sin asignado.
* Si se envía ID asignado NULL, deja al Caso sin asignado.
* Si se envía un ID asignado de un usuario que está Inactivo, lo asigna al Caso.
3
cf Campos personalizados del caso Lista (depende del tipo de campo) Depende de la configuración del campo personalizado si fue marcado como obligatorio. Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. Nota: Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 {“guia”: “2345”, “fecha guía”: “2020-01-06T05:00:00.000Z”}
id Id del caso que se va a actualizar Integer 8

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
}

Response

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
}


Método

DELETE


URL Recurso

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


Request:

Parámetros:

id -> Id del caso.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

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

Response

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
}


Método

GET


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
}


Método

GET


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
}


Método

GET


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
}


Método

GET


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
}


Método

GET


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
nombre Nombre de la tipificación String Tipificación de prueba
mtproductos Listado de los productos que harán parte de la tipificación Id de producto Se debe indicar el Id de los productos separados por comas , y enmarcados en corchetes cuadrados [] [5, 6]
mttipos Listado de los motivos que harán parte de la tipificación Id de motivo Se debe indicar el Id de los motivos separados por comas , y enmarcados en corchetes cuadrados [] [3, 4, 5]
mtsubtipos Listado de los submotivos que harán parte de la tipificación Id de submotivo Se debe indicar el Id de los submotivos separados por comas , y enmarcados en corchetes cuadrados [] [3, 5]
descripcion Texto de explicación de la tipificación String No Descripción de tipificación de prueba

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:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.


Response

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.


Método

PUT


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
nombre Nombre de la tipificación String Tipificación de prueba
mtproductos Listado de los productos que harán parte de la tipificación Id de producto Se debe indicar el Id de los productos separados por comas , y enmarcados en corchetes cuadrados [] [5, 6]
mttipos Listado de los motivos que harán parte de la tipificación Id de motivo Se debe indicar el Id de los motivos separados por comas , y enmarcados en corchetes cuadrados [] [3, 4, 5]
mtsubtipos Listado de los submotivos que harán parte de la tipificación Id de submotivo Se debe indicar el Id de los submotivos separados por comas , y enmarcados en corchetes cuadrados [] [3, 5]
descripcion Texto de explicación de la tipificación String No Descripción de tipificación de prueba
id Identificador de la tipificación Integer 18

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
}

Response

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
}


Método

DELETE


URL Recurso

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


Request:

Parámetros:

id -> Id de la tipificación.

Campos:

No requiere enviar campos.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/mtmultityping/del?id=15

Response

Elimina una tipificación específica de la base de datos de Be Aware 360.

Ejemplo:

{
    "data": {
        "nombre": null,
        "mtproductos": null,
        "mttipos": null,
        "mtsubtipos": null,
        "descripcion": null,
        "eid": null,
        "uuid": null,
        "id": 15
    },
    "code": 200,
    "message": null,
    "pagination": null
}


Método

GET


URL Recurso

https://api.beaware360.com/ba360/apir/v10/actividad/get?idobjeto=<id_caso>&tipoobjeto=casos&pagina=<pagina>&cantidad=<cantidad_notas_a_mostrar_por_pagina>.


Request:

Parámetros:

idobjeto -> Corresponde al id del caso.
tipoobjeto -> Corresponde al tipo de objeto del cual se están consultando las notas. En este caso el valor corresponde a //caso//.
pagina -> Indica el número de página a retornar.
cantidad -> Indica el número de notas a retornar por página.

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Campos:

No requiere enviar campos.

Ejemplo:

https://api.beaware360.com/ba360/apir/v10/actividad/get?idobjeto=129&tipoobjeto=casos&pagina=1&cantidad=10


Response

El sistema retorna las notas del caso específico.

Ejemplo:

{
    "data": [
        {
            "idconversacion": null,
            "canal": null,
            "idobjeto": 27792,
            "tipoobjeto": "casos",
            "texto": "Nota 1",
            "fechahora": "17-08-2020 22:10:35",
            "idcontacto": 0,
            "privado": 1,
            "idarchivo": 0,
            "seen": 0,
            "cfinalizado": 0,
            "casos": [],
            "caso": "200817-000457",
            "message": null,
            "idusuario": 4,
            "idusuariodesc": "aatencion",
            "idusuarionombre": null,
            "idusuarioapellido": null,
            "nombrearchivo": null,
            "idarchivos": null,
            "tags": null,
            "idcontactodesc": null,
            "id": 84580,
            "uuid": null,
            "eid": null
        },
        {
            "idconversacion": null,
            "canal": null,
            "idobjeto": 27792,
            "tipoobjeto": "casos",
            "texto": "Nota 2",
            "fechahora": "17-08-2020 22:09:23",
            "idcontacto": 0,
            "privado": 1,
            "idarchivo": 0,
            "seen": 0,
            "cfinalizado": 0,
            "casos": [],
            "caso": "200817-000457",
            "message": null,
            "idusuario": 10,
            "idusuariodesc": "aatencion",
            "idusuarionombre": null,
            "idusuarioapellido": null,
            "nombrearchivo": null,
            "idarchivos": null,
            "tags": null,
            "idcontactodesc": null,
            "id": 84579,
            "uuid": null,
            "eid": null
        },
        {
            "idconversacion": null,
            "canal": null,
            "idobjeto": 27792,
            "tipoobjeto": "casos",
            "texto": "Nota 3",
            "fechahora": "17-08-2020 22:07:36",
            "idcontacto": 0,
            "privado": 1,
            "idarchivo": 0,
            "seen": 0,
            "cfinalizado": 0,
            "casos": [],
            "caso": "200817-000457",
            "message": null,
            "idusuario": 4,
            "idusuariodesc": "aatencion",
            "idusuarionombre": null,
            "idusuarioapellido": null,
            "nombrearchivo": null,
            "idarchivos": null,
            "tags": null,
            "idcontactodesc": null,
            "id": 84572,
            "uuid": null,
            "eid": null
        },
        {
            "idconversacion": null,
            "canal": null,
            "idobjeto": 27792,
            "tipoobjeto": "casos",
            "texto": "Nota 4",
            "fechahora": "17-08-2020 22:07:35",
            "idcontacto": 0,
            "privado": 1,
            "idarchivo": 0,
            "seen": 0,
            "cfinalizado": 0,
            "casos": [],
            "caso": "200817-000457",
            "message": null,
            "idusuario": 4,
            "idusuariodesc": "aatencion",
            "idusuarionombre": null,
            "idusuarioapellido": null,
            "nombrearchivo": null,
            "idarchivos": null,
            "tags": null,
            "idcontactodesc": null,
            "id": 84571,
            "uuid": null,
            "eid": null
        }
    ],
    "code": null,
    "message": null,
    "pagination": {
        "cantPages": 1,
        "size": 4,
        "actualPage": 1
    }
}


Método

POST


URL Recurso

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


Request:

Parámetros:

Este recurso no recibe parámetros

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
idobjeto Id del caso al que se le agregará la nota Integer 28
tipoobjeto Especifica el tipo de objeto de la nota String Valor: “casos” “casos”
texto Texto correspondiente a la nota String “Ejemplo de una nota agregada”
privado Identifica si la nota es privada o pública Integer Valores posibles:

0 → pública

1 → privada
1

Ejemplo:

{
	"idobjeto": 28,
	"tipoobjeto": "casos",
	"texto": "<p>Nota agregada</p>",
	"privado": 1
}

Response

El sistema agrega una nota al caso con la información que se ha enviado a través de la API.

Ejemplo:

{
    "data": {
        "canal": null,
        "idconversacion": null,
        "idobjeto": 28,
        "tipoobjeto": "casos",
        "texto": "<p>Nota agregada</p>",
        "idcontacto": 0,
        "seen": 0,
        "idusuariodesc": "Integración API BA360",
        "idusuarionombre": null,
        "idusuarioapellido": null,
        "casos": [],
        "idcontactodesc": null,
        "idusuario": 7,
        "message": null,
        "privado": 1,
        "fechahora": "2020-03-31 03:08:37.0",
        "uuid": null,
        "eid": null,
        "id": 19
    },
    "code": 200,
    "message": "Nota creada exitosamente.",
    "pagination": null
}


Método

POST


URL Recurso

https://api.beaware360.com/ba360/uploadfile.


Request:

Parámetros:

Este recurso no recibe parámetros

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
COMPANYNAME Instancia de Be Aware 360. String ba360review
IDOBJETO Id del caso al que se le agregará el archivo. Integer 203
TIPOOBJETO Especifica el tipo de objeto de la nota. String Valor: “casos” casos
TAGS Especifica la etiqueta que llevará el archivo adjunto al caso. String Acepta valores vacíos, pero es obligatorio que se envíe en el request. Prueba API
FILE Archivo adjunto del caso Archivo (Formato binario). De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario.
IDUSUARIO Identifica el ID de usuario que hace la carga del archivo al caso. Integer 3

Ejemplo:

Ejemplo de carga de archivos adjuntos desde Postman


Response

El sistema agrega un archivo al caso y retorna el Id del archivo adjunto.

Ejemplo:

{
	"id":"35"
}


Método

POST


URL Recurso

https://api.beaware360.com/ba360/downloadfile.


Request:

Parámetros:

Este recurso no recibe parámetros

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
COMPANYNAME Instancia de Be Aware 360. String ba360review
ID Id del archivo que se va a descargar. Integer 34

Ejemplo:

Ejemplo descarga de archivos adjuntos


Response

El sistema retorna el archivo adjunto en formato binario y en la cabecera de la respuesta se observa la información retornada.

Ejemplo:

Ejemplo respuesta descarga de archivos adjuntos



Método

POST


URL Recurso

https://api.beaware360.com/ba360/apir/v10/workflow/next.


Request:

Parámetros:

Este recurso no recibe parámetros

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
id Id del caso al que se le avanzará el paso. Integer 202

Ejemplo:

{
    "id": 202
}

Response

El sistema valida si los checklist asociados al paso del caso han sido completados y avanza al siguiente paso.

Ejemplo cuando se han marcado todos los checklists del paso:

{
    "data": {
        "checkList": null,
        "porcentaje": 100,
        "asunto": "Caso creado por API, prueba de checklist",
        "idcontacto": 1,
        "idproducto": 1,
        "idtipo": 2,
        "idsubtipo": 2,
        "origen": "FormWEB",
        "canal": null,
        "idinteraccion": null,
        "idconversacion": null,
        "idusuarioasignado": null,
        "idworkflow": 2,
        "idstageactual": 3,
        "finalizado": 0,
        "idestado": 3,
        "idusuariocreacion": 7,
        "descripcion": null,
        "fechacreacion": "2020-07-21",
        "idcuenta": null,
        "idworkflowdesc": "Nuevos requerimientos BA360",
        "destacado": false,
        "cf": {},
        "refnum": "200721-000002",
        "idusuariomodificacion": 7,
        "idprioridad": 1,
        "idsla": null,
        "idcontactodesc": "Oskar Cantor",
        "fechamodificacion": "2020-08-11",
        "cantidadcasos": null,
        "sistemaexterno": null,
        "slavalue": 10,
        "fingreso": "2020-08-11 22:31:45.0",
        "duedate": "2020-08-11 18:41:45.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,
        "fechacreacionstr": "2020-07-21T00:00",
        "fechamodificacionstr": "2020-08-11T00:00",
        "timeactual": null,
        "idprioridadcolor": "#E74A25",
        "idstageactualdesc": "Verificar incidente",
        "idtipodesc": "Requerimiento",
        "idusuariomodificaciondesc": "Integración API BA360",
        "idusuariocreaciondesc": "Integración API BA360",
        "idproductodesc": "Be Aware 360",
        "idsladesc": null,
        "idsubtipodesc": "Aprovisionamiento de nueva instancia",
        "idusuarioasignadodesc": null,
        "idprioridaddesc": "Alta",
        "idestadodesc": "En progreso",
        "logauditoria": null,
        "idcuentadesc": null,
        "eid": null,
        "uuid": null,
        "id": 202
    },
    "code": 200,
    "message": null,
    "pagination": null
}

Ejemplo cuando no se han marcado todos los checklists del paso:

{
    "data": null,
    "code": 500,
    "message": "No se han cumplido todos los checks de la lista.",
    "pagination": null
}


Método

POST


URL Recurso

https://api.beaware360.com/ba360/apir/v10/workflow/back.


Request:

Parámetros:

Este recurso no recibe parámetros

Autenticación:

Tipo de autenticación Usuario Contraseña
Basic Auth compañia/usuario. Por ejemplo ba360review/aatencion El Token obtenido en GetToken.

Campos:

Campo API Descripción Tipo de dato Requerido Comentario Ejemplo
id Id del caso al cual se retrocederá el paso. Integer 202

Ejemplo:

{
    "id": 202
}

Response

El sistema retrocede el caso al paso anterior.

Ejemplo:

{
    "data": {
        "checkList": null,
        "porcentaje": 100,
        "asunto": "Caso creado por API, prueba de checklist",
        "idcontacto": 1,
        "idproducto": 1,
        "idtipo": 2,
        "idsubtipo": 2,
        "origen": "FormWEB",
        "canal": null,
        "idinteraccion": null,
        "idconversacion": null,
        "idusuarioasignado": null,
        "idworkflow": 2,
        "idstageactual": 4,
        "finalizado": 0,
        "idestado": 1,
        "idusuariocreacion": 7,
        "descripcion": null,
        "fechacreacion": "2020-07-21",
        "idcuenta": null,
        "idworkflowdesc": "Nuevos requerimientos BA360",
        "destacado": false,
        "cf": {},
        "refnum": "200721-000002",
        "idusuariomodificacion": 7,
        "idprioridad": 1,
        "idsla": null,
        "idcontactodesc": "Oskar Cantor",
        "fechamodificacion": "2020-08-11",
        "cantidadcasos": null,
        "sistemaexterno": null,
        "slavalue": 15,
        "fingreso": "2020-08-11 22:39:35.0",
        "duedate": "2020-08-11 18:54:35.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-07-21T00:00",
        "fechamodificacionstr": "2020-08-11T00:00",
        "timeactual": null,
        "idprioridadcolor": "#E74A25",
        "idstageactualdesc": "Ingreso de datos",
        "idtipodesc": "Requerimiento",
        "idusuariomodificaciondesc": "Integración API BA360",
        "idusuariocreaciondesc": "Integración API BA360",
        "idproductodesc": "Be Aware 360",
        "idsladesc": null,
        "idsubtipodesc": "Aprovisionamiento de nueva instancia",
        "idusuarioasignadodesc": null,
        "idprioridaddesc": "Alta",
        "idestadodesc": "Creado",
        "logauditoria": null,
        "idcuentadesc": null,
        "eid": null,
        "uuid": null,
        "id": 202
    },
    "code": 200,
    "message": null,
    "pagination": null
}

  • apiba360.txt
  • Última modificación: hace 11 meses
  • por scantor