Método getCVRecords
Índice
- Finalidad
- Dirección URL de la solicitud
- Parámetros de la solicitud
- Códigos de error
- Ejemplos
- Para capturar todos los clientes potenciales abiertos desde el módulo de clientes potenciales
- Para capturar los clientes potenciales sin especificar el parámetro newFormat
- Para capturar con newFormat=2
- Para llamar con fromIndex=1, toIndex=25
- Para llamar con lastModifiedTime
- Para seleccionar todos los campos de clientes potenciales con newFormat=1
- Para seleccionar todos los campos de clientes potenciales con newFormat=2
- Para llamar con lastModifiedTime, fromIndex y toIndex
- Programa de prueba
Finalidad
Puede utilizar el método getCVRecords para capturar los datos relacionados con la vista personalizada en Zoho CRM.
Importante: Independientemente de la edición de Zoho CRM, puede enviar solo 250 solicitudes de API al día. En cada solicitud, puede capturar un máximo de 200 registros.
Dirección URL de la solicitud
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
Parámetros de la solicitud
Parámetro | Tipo de datos | Descripción |
authtoken* | Cadena | Cadena alfanumérica cifrada para autenticar sus credenciales de Zoho. |
scope* | Cadena | Especifique el valor como crmapi |
fromIndex | Entero | Valor predeterminado: 1 |
toIndex | Entero | Valor predeterminado: 20 Valor máximo: 200 |
cvName* | Cadena | Capture los datos de la vista personalizada especificada. Ejemplo: cvName=All Open Leads |
lastModifiedTime | DateTime | Default:null Si especifica la hora, se capturarán los datos creados o modificados después de la hora configurada. |
newFormat | Entero | newFormat=1: para excluir campos con valores "null" durante el ingreso de datos de su cuenta de CRM. newFormat=2: para incluir los campos con valores "null" durante el ingreso de datos de su cuenta de CRM. |
version | Entero | version = 1: (valor predeterminado) se capturarán las respuestas en función de la implementación anterior de la API, es decir, antes de las mejoras realizadas. La versión actual es 4. |
*: parámetro obligatorio
Códigos de error
Consulte los códigos de error.
Ejemplos
Para capturar todos los clientes potenciales abiertos desde el módulo de clientes potenciales
Para capturar clientes potenciales sin especificar el parámetro newFormat
Nota:
- Cuando no se especifique el formato de la respuesta, se asignará predeterminadamente el valor "1" al parámetro newFormat, es decir, newFormat = 1
Responderá como se muestra a continuación:
El valor del correo electrónico es null y, por lo tanto, no aparece en la respuesta.
Para capturar con newFormat=2
Responderá como se muestra a continuación:
Para llamar con fromIndex=1, toIndex=25
Nota:
- Esto restablecerá los primeros 25 registros.
Para llamar con lastModifiedTime
Nota:
- Si especifica la hora, se capturarán los datos modificados después de la hora configurada.
Para seleccionar todos los campos de clientes potenciales con newFormat=1
Nota:
- Esto restablecerá todos los campos con valores.
Para seleccionar todos los campos de clientes potenciales con newFormat=2
Nota:
- Esto restablecerá todos los campos, incluidos los campos con valor null.
Para llamar con lastModifiedTime, fromIndex y toIndex
Programa de prueba
Puede utilizar el programa adjunto para ejecutar y probar el funcionamiento del método getCVRecords en su entorno de Java. El programa Java contiene los siguientes elementos:
- el formato de generación de tokens
- los parámetros y sus valores
- el uso real del método
Haga clic aquí para descargar el programa.