Skip to content

PureCloudGetContactList

Element Name: Outbound / Pure Cloud Get Contact List

Category: Genesys Cloud.

Description: Advanced functionality, consisting of an input field for JavaScript code structuring, has a customizable name and a group of configurable parameters to query outbound campaign contact lists in Genesys Cloud.

Functionality: Allows querying a group of contact lists from outbound campaigns in Genesys Cloud, obtaining all the data related to those lists and details of the records through an integration with the Genesys Cloud REST API. For more details about these Genesys Cloud APIs, visit Genesys Cloud Documentation.

Action Configuration Fields

[Name]: Unique configuration box descriptor for identification purposes in the flow.

Credentials Subset

[ClientID]: GUID field indicating the Genesys Cloud API Client Id for creating a connection token.

[Token]: Alphanumeric string field in which to indicate the creation token or client secret for the connection to Genesys Cloud.

Configuration Subset

[Include Import Status]: Boolean type field. Select Yes to allow the delivery of the list import status information, that is, the total number of existing lists, the number of imported lists, and the % of imported lists. Select No to deny the importation of such information, the contact list group will still be imported.

Example

-- Input: Yes

-- Result:

"importStatus": 
{

    "totalRecords": 20,

    "completedRecords": 20,

    "percentComplete": 100

},

[Include Size:] Boolean type field. Select Yes to activate the Page Size field. Select No to deny the display of the Page Size field.

[Page Size:] Numeric integer field. In this tag, the number of contact lists to be displayed per JSON page must be defined. For example, if 10 is defined, the JSON will show information for 10 contact lists on one page. The maximum value that will be returned is 100 contact lists.

[Page Number:] Numeric integer field. The page number to be analyzed must be defined here.

[Filter Type:] String Expression type field. Expression that, combined with the contact list name field, helps apply a specific search filter. This field accepts the following values: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith

[Contact List Name:] The specific name of the contact list returned by the GCloud API. In the API, this field is displayed with the name Name, which, combined with the Filter Type field, results in all campaigns that match the applied filter.

-- Input

[Filter Type:] Prefix

[Contact List Name:] demo

-- Result: Note that the resulting JSON returns 2 contact lists whose "name" contains the word "demo"

"name": "demo2" and "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 Contact List]: Field of type String list, must contain the specific ID of the contact list to be queried. Allows more than one list ID.

[Division ID(s)]: Field of type String list, where the ID of the division of the organization in Genesys Cloud where the contact list is hosted should be placed. Allows more than one division ID.

[Order by]: Field of type string. In this field, it must be defined by which parameter of the Json the requested information will be sorted.

[Sorting order]: Field of type string. Define how the requested information (Json) will be sorted in ascending or descending order according to the parameter of the Json selected in [Order by]. Accepts the following values: ascending, descending

Example

-- Input:

[Order by]: dateCreated

[Sorting order]: ascending

-- Result: Note that the resulting Json returns 2 contact lists whose "dateCreated" is sorted

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

[Name of the entity where to store the result obtained from an expression or service]: Field of string type. Here you should enter the name of the entity where the result obtained from an expression or service will be stored. The entity must be created beforehand.

[Intent to execute in case of error]: The action flow will be interrupted, and the error description will be passed to the selected intent with the name: 'PURE_CLOUD_OUTBOUND_ON_ERROR'.

Description of 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

Note 馃搼 For more details on Gcloud API RESPONSE codes, refer to GET /api/v2/outbound/contactlists, section API/v2/outbound/contactlist.

Example of Pure Cloud Get ContactList Implementation

-- Input

[Include import status]: Yes

[Include size]: Yes

[Page size]: 1

[Filter type]: Prefix

[Name of the contact list]: List1

[ID of the contact list]: 22222222-bc5f-4603-9c25-ddddddddddddd

[ID of division(s)]: aaaaaaa-77ce-491e-b5ee-cccccccccccccc

[Sort by]: Empty

[Sort order]: Empty

[Name of the entity where to store the result obtained from an expression or service]: List_out1 --> empty

[Intent to execute in case of error]: error_List_out1

-- Result 聽

[Name of the entity where to store the result obtained from an expression or service] --> List_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
聽 聽 聽 聽 }
    ]
}