PureCloudGetContactList
Nombre del elemento: Outbound / Pure Cloud Get Contact List
Categoría: Módulo de extensión.
Descripción: Funcionalidad avanzada, compuesta de un campo de entrada para estructuración de código JavaScript, posee nombre personalizable y un grupo de parámetros configurables para consultar listas de contactos de campañasoutbound en Genesys cloud.
Funcionalidad: Permite consultar un grupo de listas de contactos de campañas outbound en Genesy Cloud, obteniendo todos los datos referentes a esas listas y detalles de los registros a través de una integración con el API REST de Genesys Cloud. Para más detalle sobre estas API de Genesys Cloud visitar Documentación Genesys Cloud
Campos de configuración de acción
[Nombre]: Descriptor único de caja de configuración con fines de identificar la misma en el flujo.
Subconjunto Credenciales
[ClientID]: Campo de tipo GUID en el cual se indica el Client Id de la API de Genesys Cloud para crear token de conexión.
[Token]: Campo de tipo string alfanumérico en el cual se debe indicar el Token de creación o secreto del cliente para la conexión a Genesys Cloud.
Subconjunto Configuración
[Incluir estado de importación]: Campo de tipo boolean. Seleccione Si para permitir la entrega de la información del estado de la importación de la lista, es decir, la cantidad total de listas existentes, cantidad de listas importadas y el % de listas importadas. Seleccione No para denegar la importación de dicha información, igualmente el grupo de listas de contacto se importará.
Ejemplo
-- Entrada: Si
-- Resultado:
"importStatus":
{
"totalRecords": 20,
"completedRecords": 20,
"percentComplete": 100
},
[Incluir tamaño:] Campo de tipo boolean. Seleccione Si para activar el campo Tamaño de la página. Seleccione No para denegar la visualización del campo Tamaño de la página.
[Tamaño de página:] Campo de tipo int(numérico). En esta etiqueta debe definirse la cantidad de listas de contacto que aparecen por página de Json. Por ejemplo, si se define 10, el Json mostrar información de 10 listas de contactos en una página. El máximo valor que se devolverá es 100 listas de contactos.
[Número de página:] Campo de tipo int(numérico). Aquí debe definirse el número de la página a analizar.
[Tipo de Filtro:] Campo de tipo String Expression. Expresión que combinada con el campo nombre de la lista de contactos ayuda a aplicar filtro de búsqueda específico. este campo acepta lo siguientes valores: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith
[Nombre de la lista de contactos:] el nombre especifico de la lista de contactos que devuelve la API de GCloud. En la API este campo se visualiza con el nombre de Name que combinada con el campo Tipo de Filtro trae como resultado todas aquellas campañas que concuerden con el filtro aplicado.
-- Entrada
[Tipo de Filtro:] Prefix
[Nombre de la lista de contactos:] demo
-- Resultado: nótese que el Json resultado devuelve 2 listas de contactos cuyo "name" contiene la palabra "demo"
"name": "demo2" y "name": "DEMO_CLIENTE"*:
"entities": [
{
"id": "9d40f414-6cab-47fe-9db3-XXXX750667",
"name": "demo2",
"dateCreated": "2018-07-07T14:43:14.226Z",
"version": 1,
"division": {
"id": "000000c-1e89-4608-898c-3d80de90db1b",
"name": "Home",
"selfUri": "/api/v2/authorization/divisions/000000-1e89-4608-898c-3d80de90db1b"
},
"columnNames": [
"Id_Contacto",
"cli_nombre",
"cli_apellido_pat",
],
"phoneColumns": [
{
"columnName": "fono12",
"type": "Móvil1"
}
],
"emailColumns": [],
"previewModeColumnName": "",
"previewModeAcceptedValues": [],
"automaticTimeZoneMapping": false,
"selfUri": "/api/v2/outbound/contactlists/9d40f414-6cab-47fe-9db3-123d57750667"
},
{
"id": "cab9a25d-acdf-48c6-a7c4-eb3fc36f0cad",
"name": "DEMO\_CLIENTE",
"dateCreated": "2020-04-09T02:59:49.658Z",
"version": 1,
"division": {
"id": "59324a6c-0000-4608-898c-3d8XXXXXdb1b",
"name": "Home",
"selfUri": "/api/v2/authorization/divisions/59324a6c-0000-4608-898c-3d8XXXXXdb1b"
},
"columnNames": [
"Id_Registro",
"Identificacion_Cliente",
"Telefono_1",
],
"phoneColumns": [
{
"columnName": "Telefono_1",
"type": "Móvil"
},
],
"emailColumns": [],
"previewModeColumnName": "",
"previewModeAcceptedValues": [],
"automaticTimeZoneMapping": false,
"selfUri": "/api/v2/outbound/contactlists/0000000-acdf-48c6-XXXXX-eb3fc36f0cad"
},
"pageSize": 84,
"pageNumber": 1,
"total": 2,
"firstUri": "/api/v2/outbound/contactlists?pageSize=84&pageNumber=1",
"lastUri": "/api/v2/outbound/contactlists?pageSize=84&pageNumber=1",
"selfUri": "/api/v2/outbound/contactlists?pageSize=84&pageNumber=1",
"pageCount": 1
}
[ID Lista de contactos]: Campo de tipo String list, debe contener el ID específico de la lista de contactos que se desea consultar. Permite más de un ID de lista.
[ID de división(es)]: Campo de tipo String list, donde se debe colocar el ID de la división de la organización en Genesys Cloud a donde se aloja la lista de contactos. Permite más de una ID de división.
[Ordena por]: Campo de tipo string. En este campo se debe definir por cual parámetro del Json se ordenará la entrega de información solicitada.
[Orden de clasificación]: Campo de tipo string. Definir como se ordenará la información solicitada (Json) de forma ascendente o descendente según el parámetro del Json seleccionado en [Ordenar por]. Acepta lo siguientes valores: ascending, descending
Ejemplo
-- Entrada
[Ordena por]: dateCreated
[Orden de clasificación]: ascending
-- Resultado: nótese que el Json resultado devuelve 2 listas de contactos cuyo "dateCreated" está ordenado
{
"entities":
[
{
"id": "a2f0e721-OOOO-4418-8655-03954eXXXXXX",
"name": "Test",
"dateCreated": "2019-07-29T19:41:24.553Z",
"version": 1,
"division":
{
"id": "YYY24a6c-XXXX-4608-898c-3d80de900000",
"name": "Home",
"selfUri": "/api/v2/authorization/divisions/YYY24a6c-XXXX-4608-898c-3d80de900000"
},
"columnNames":
[
"CELULAR",
"RUT",
],
"phoneColumns":
[
{
"columnName": "CELULAR",
"type": "Móvila"
}
],
"emailColumns": [],
"previewModeColumnName": "",
"previewModeAcceptedValues": [],
"automaticTimeZoneMapping": false,
"selfUri": "/api/v2/outbound/contactlists/YYYYe721-0000-4418-8655-03954e2RRRRRR"
},
{
"id": "000000-ccf4-4d49-FFFF-310b028460df",
"name": "NUEVA\_LISTA\_CONTACTO",
"dateCreated": "2020-01-14T15:45:20.153Z",
"version": 1,
"division":
{
"id": "PPPPPP-1e89-4608-YYYY-3d80de90db1b",
"name": "Home",
"selfUri": "/api/v2/authorization/divisions/000000-1e89-4608-898c-3d80de90db1b"
},
"columnNames": [ "Organization","Name","PAGO"],
"phoneColumns":
[
{
"columnName": "PHONE_NUMBER_Mobile_1",
"type": "Móvil5"
}
],
"emailColumns": [],
"previewModeColumnName": "",
"previewModeAcceptedValues": [],
"automaticTimeZoneMapping": false,
"selfUri": "/api/v2/outbound/contactlists/000000-ccf4-YYYY-a993-310b028460df"
}
],
"pageSize": 2,
"pageNumber": 1,
"total": 84,
"pageCount": 42
}
[El nombre de la entidad donde almacenar el resultado obtenido de una expresión o servicio]: Campo de tipo de string. Aquí debe ingresar el nombre de la entidad donde se almacenará el resultado obtenido de una expresión o servicio. La entidad debe estar creada previamente.
[La intención a ejecutar en caso de error]: El flujo de la acción se interrumpirá y la descripción del error se pasará a la intención seleccionada con el nombre: 'PURE_CLOUD_OUTBOUND_ON_ERROR'.
Descripción de parámetros Request Parameters
-Method GET /api/v2/outbound/contactlists
| Parameter | Description |
|---|---|
| includeImportStatus | (boolean) Include import status |
| includeSize | (boolean) Include size |
| pageSize | (integer) Page size. The max that will be returned is 100. |
| pageNumber | (integer) Page number |
| allowEmptyResult | (boolean) Whether to return an empty page when there are no results for that page |
| filterType | (string) Filter type |
| name | (string) Name |
| id | (array) id |
| divisionId | (array) Division ID(s) |
| sortBy | (string) Sort by |
| sortOrder | (string) Sort order |
Nota 📑 para conocer más detalles de los códigos API RESPONSE de Gcloud consultar GET /api/v2/outbound/contactlists, apartado API/v2/outbound/contactlist
Ejemplo de implementación de Pure Cloud Get ContactList
-- Entrada
[Incluir estado de importación]: Si
[Incluir tamaño]: Si
[Tamaño de página]: 1
[Tipo de Filtro]: Prefix
[Nombre de la lista de contactos]: Lista1
[ID Lista de contactos]: 22222222-bc5f-4603-9c25-ddddddddddddd
[ID de division(es)]: aaaaaaa-77ce-491e-b5ee-cccccccccccccc
[Ordena por]: Vacio
[Orden de clasificación]: Vacio
[El nombre de la entidad donde almacenar el resultado obtenido de una expresión o servicio]: Lista_out1 -->vacio
[La intención a ejecutar en caso de error]: error_Lista_out1
-- Resultado
[El nombre de la entidad donde almacenar el resultado obtenido de una expresión o servicio] --> Lista_out1
{
"entities": [
{
"id": "22222222-bc5f-4603-9c25-ddddddddddddd",
"name": "Lista1\_diciembre",
"dateCreated": "2022-06-02T20:06:41.109Z",
"version": 1,
"division":
{
"id": "aaaaaaa-77ce-491e-b5ee-cccccccccccccc",
"name": "Home",
"selfUri": "/api/v2/authorization/divisions/aaaaaaa-77ce-491e-b5ee-cccccccccccccc"
},
"columnNames":
[
"NOMBRE_LISTA",
"CEDENTE",
"TIPO_CARTERA",
"RUT",
"TIPO_PRODUCTO",
"NOMBRES",
"DIREC",
"COMUNA",
"FECHA_APERCUENTA",
"CORREO",
"FONO1",
"FONO2",
"FONO3",
"FONO4",
"FONO5",
"PERIODO_CASTIGO",
"TRAMO_ANTIGUEDAD",
"FECHA_ASIG_CANAL",
"COBRADOR",
"NRO_OPERACION",
"SUPERVISOR",
"FECHA_INMORA",
"TASA\_INTERES",
"CAPITAL",
"INTERES",
"SALDO_TOTAL",
"DESCUENTO",
],
"phoneColumns":
[
{
"columnName": "FONO1",
"type": "Móvil"
}
],
"previewModeColumnName": "",
"previewModeAcceptedValues": [],
"automaticTimeZoneMapping": false,
"selfUri": "/api/v2/outbound/contactlists/22222222-bc5f-4603-9c25-ddddddddddddd"
},
],
"pageSize": 1,
"pageNumber": 1,
"total": 1,
"firstUri": "/api/v2/outbound/contactlists?pageSize=0&pageNumber=1",
"nextUri": "/api/v2/outbound/contactlists?pageSize=0&pageNumber=1",
"lastUri": "/api/v2/outbound/contactlists?pageSize=0&pageNumber=2147483647",
"selfUri": "/api/v2/outbound/contactlists?pageSize=0&pageNumber=0",
"pageCount": 2147483647
}
]
}