Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anteriorRevisión previaPróxima revisión | Revisión previa | ||
| apiba360_105 [2023/09/29 00:28] – [Consultar histórico de casos] scantor | apiba360_105 [2024/10/12 02:19] (actual) – [Consultar submotivos] scantor | ||
|---|---|---|---|
| Línea 73: | Línea 73: | ||
| | [[apiba360_105# | | [[apiba360_105# | ||
| | [[apiba360_105# | | [[apiba360_105# | ||
| + | |||
| + | ==== Actividades programadas ==== | ||
| + | |||
| + | ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^ | ||
| + | | [[apiba360_105# | ||
| ===== Primeros pasos ===== | ===== Primeros pasos ===== | ||
| Línea 1456: | Línea 1461: | ||
| * **[[apiba360_105# | * **[[apiba360_105# | ||
| * **[[apiba360_105# | * **[[apiba360_105# | ||
| + | * **[[apiba360_105# | ||
| + | * **[[apiba360_105# | ||
| ---- | ---- | ||
| Línea 2842: | Línea 2849: | ||
| === URL Recurso === | === URL Recurso === | ||
| - | **%%https:// | + | **%%https:// |
| ---- | ---- | ||
| Línea 2974: | Línea 2981: | ||
| " | " | ||
| " | " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Consultar casos abiertos creados por el usuario ==== | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === Método === | ||
| + | |||
| + | '' | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === URL Recurso === | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === Request: === | ||
| + | |||
| + | **Parámetros: | ||
| + | |||
| + | filtro -> created. | ||
| + | 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 | // | ||
| + | |||
| + | |||
| + | ---- | ||
| + | |||
| + | === Response === | ||
| + | |||
| + | Retorna la lista de todos los casos creados por el usuario que está autenticado y que se encuentran abiertos, independientemente de quién los tenga asignados. | ||
| + | |||
| + | **Ejemplo: | ||
| + | |||
| + | <code java> | ||
| + | { | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| } | } | ||
| } | } | ||
| Línea 3123: | Línea 3475: | ||
| " | " | ||
| }, | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Consultar caso por búsqueda avanzada ==== | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === Método === | ||
| + | |||
| + | '' | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === URL Recurso === | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === Request: === | ||
| + | |||
| + | **Parámetros: | ||
| + | |||
| + | Al ser una búsqueda avanzada se podrán usar como parámetros los campos estándar de un caso y/o también los campos personalizados (Custom Fields) definidos para los casos, en este último caso se debe **enviar como parámetro el valor del campo __label__**. | ||
| + | |||
| + | La búsqueda corresponde a un operador AND, por lo tanto, el resultado retornará los casos que cumplen con todos los parámetros de búsqueda. | ||
| + | | ||
| + | A continuación, | ||
| + | |||
| + | ^ 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. | | ||
| + | |||
| + | |||
| + | **Campos:** | ||
| + | |||
| + | No requiere enviar campos. | ||
| + | | ||
| + | **Autenticación: | ||
| + | |||
| + | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
| + | | Basic Auth | // | ||
| + | |||
| + | |||
| + | **Ejemplo: | ||
| + | |||
| + | <code java> | ||
| + | https:// | ||
| + | </ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === Response === | ||
| + | |||
| + | Retorna la lista de todos los casos que cumplen con los criterios de búsqueda especificados en los parámetros. | ||
| + | |||
| + | **Ejemplo: | ||
| + | |||
| + | <code java> | ||
| + | { | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| " | " | ||
| " | " | ||
| Línea 3340: | Línea 3882: | ||
| | asunto | Asunto del caso | String | Sí | Máximo 500 caracteres. Si se supera este tamaño, la API responderá código de error 422. | “Asunto del caso” | | | asunto | Asunto del caso | String | Sí | 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 | Sí | Acepta los siguientes valores: FormWEB, AgenteWeb, Voz, Chat, Email, SMS, TWDirect, Messenger, Facebook, Whatsapp, Telegram, Hangout, Instagram | “FormWEB” | | | origen | Canal del caso | String | Sí | 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 | Sí | Este campo se compone de: ###### | + | | refnum | Número de referencia del caso | String | No | Este campo se compone de: ###### |
| | idestado | Id del estado asociado al caso | Integer | No | | 1 | | | idestado | Id del estado asociado al caso | Integer | No | | 1 | | ||
| | idprioridad | Id de la prioridad asociada al caso | Integer | No | | 1 | | | idprioridad | Id de la prioridad asociada al caso | Integer | No | | 1 | | ||
| Línea 3632: | Línea 4174: | ||
| **%%https:// | **%%https:// | ||
| + | |||
| + | Este endpoint devuelve los productos, teniendo en cuenta el valor que esté configurado en la Lista de parámetros de la instancia. | ||
| + | |||
| + | Cuando consume este endpoint, se mostrarán los productos según la información que está en los parámetros de configuración en el apartado **Tipificación caso en creación**: | ||
| + | |||
| + | * //No considerar grupos// → Muestra todos los productos dado que no considera grupos de contactos o agentes. | ||
| + | |||
| + | * // | ||
| + | |||
| + | * // | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | Este endpoint devuelve todos productos cargados en la instancia sin importar la parametrización de la Lista de parámetros. | ||
| + | |||
| + | Para más información sobre la parametrización de Tipificación caso en creación, haga clic [[parametrosdeconfiguracion# | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | Este endpoint devuelve todos productos cargados en la instancia que puede visualizar un contacto en particular. | ||
| ---- | ---- | ||
| Línea 3704: | Línea 4266: | ||
| **%%https:// | **%%https:// | ||
| + | |||
| + | Este endpoint retorna todos los motivos que existen en la plataforma. | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | Este endpoint retorna todos los motivos que pertenecen a un producto específico y que el contacto puede visualizar. | ||
| ---- | ---- | ||
| Línea 3782: | Línea 4350: | ||
| **%%https:// | **%%https:// | ||
| + | Este endpoint retorna todo el listado de submotivos registrados en la plataforma. | ||
| + | |||
| + | **%%https:// | ||
| + | |||
| + | Este endpoint retorna todos los submotivos que pertenecen al producto y motivo y que solo el contacto puede visualizar. | ||
| ---- | ---- | ||