Utiliza la API de interacciones de llamadas para registrar y gestionar llamadas en los registros del CRM.
POST
a /crm/v3/objects/calls
.
En el cuerpo de la solicitud, agrega detalles de la llamada en el objeto propiedades. También puedes agregar el objeto asociaciones para asociar la llamada con un registro existente (por ejemplo, contactos o empresas).
Campo | Descripción |
---|---|
hs_timestamp | Requerido. Este campo marca la hora de creación de la llamada y determina dónde se encuentra en la cronología del registro. Puedes usar una marca de tiempo Unix en milisegundos o en formato UTC. |
hs_call_body | La descripción de la llamada, incluidas las notas que deseas agregar. |
hs_call_callee_object_id | El ID del registro de HubSpot asociado con la llamada. Este será el destinatario de la llamada para llamadas OUTBOUND , o quien inicia la llamada para llamadas INBOUND . |
hs_call_callee_object_type | El tipo del objeto al que pertenece el registro asociado de la llamada (por ejemplo, especifica si el registro es un contacto o una empresa). Este será el objeto del destinatario para las llamadas OUTBOUND , o el objeto de quien inicia las llamadas para las llamadas INBOUND . |
hs_call_direction | La dirección de la llamada desde la perspectiva del usuario de HubSpot. Si el usuario es el destinatario de la llamada, la dirección debe establecerse como INBOUND . Si el usuario inició la llamada, la dirección debe establecerse como OUTBOUND . |
hs_call_disposition | El resultado de la llamada. Para establecer la disposición de llamada, debes usar el valor interno de GUID. Si tu cuenta configuró resultados personalizados para las llamadas, puedes encontrar los GUID de la disposición usando esta API. Las etiquetas de resultados predeterminadas de HubSpot y sus valores internos son:
|
hs_call_duration | La duración de la llamada en milisegundos. |
hs_call_from_number | El número de teléfono desde el que se hizo la llamada. |
hs_call_recording_url | La URL que almacena la grabación de la llamada. Las URL a archivos .mp3 o .wav se pueden reproducir en registros del CRM. Solo se aceptarán HTTPS o URL seguras. |
hs_call_status | El estado de la llamada. Los estados son BUSY , CALLING_CRM_USER , CANCELED , COMPLETED , CONNECTING , FAILED , IN_PROGRESS , NO_ANSWER , QUEUED y RINGING . |
hs_call_title | El título de la llamada. |
hs_call_source | El origen de la llamada. Esto no es obligatorio, pero es necesario para aprovechar el pipeline de grabación y transcripciones. Si la propiedad está configurada, debe establecerse como INTEGRATIONS_PLATFORM . |
hs_call_to_number | El número de teléfono que recibió la llamada. |
hubspot_owner_id | El ID del propietario asociado con la llamada. Este campo determina el usuario que aparece como creador de la llamada en la cronología del registro. |
hs_activity_type | El tipo de llamada. Las opciones se basan en los tipos de llamadas definidos en tu cuenta de HubSpot. |
hs_attachment_ids | Los ID de los archivos adjuntos de la llamada. Los ID de varios archivos adjuntos están separados por un punto y coma. |
Campo | Descripción |
---|---|
to | El registro que deseas asociar con la llamada, especificado por su valor id único. |
types | El tipo de asociación entre la llamada y el registro. Incluye associationCategory y associationTypeId . Los ID de los tipos de asociación predeterminados se enumeran en esta página, o puedes obtener el valor de los tipos de asociación personalizados (es decir, etiquetas) a través de la API de asociaciones. |
GET
a /crm/v3/objects/calls/{callId}
. Puedes incluir los siguientes parámetros en la URL de la solicitud:
Parámetro | Descripción |
---|---|
properties | Una lista separada por comas de las propiedades que se devolverán. |
associations | Una lista separada por comas de los tipos de objetos para obtener los ID asociados. En la respuesta no aparecerán las asociaciones que no existen. Más información sobre la API de asociaciones. |
GET
a /crm/v3/objects/calls
. Puedes incluir los siguientes parámetros en la URL de la solicitud:
Parámetro | Descripción |
---|---|
limit | El número máximo de resultados que se mostrarán por página. |
properties | Una lista separada por comas de las propiedades que se devolverán. |
callId
que puedes usar para obtener, actualizar y eliminar la llamada.
hs_call_recording_url
. Si tu cuenta tiene acceso a las llamadas entrantes, para diferenciar entre las llamadas que se completaron y grabaron frente a las llamadas entrantes con un mensaje de voz, incluye las siguientes propiedades en tu solicitud: hs_call_status
y hs_call_has_voicemail
.
Si una llamada tiene un mensaje de voz, el valor hs_call_status
será missed
, y el valor hs_call_has_voicemail
será true
. El valor hs_call_has_voicemail
será false
para una llamada entrante en la que no se dejó ningún mensaje de voz o null
si la llamada tiene un estado distinto a perdida.
PATCH
a /crm/v3/objects/calls/{callId}
.
En el cuerpo de la solicitud, incluye las propiedades de llamada que deseas actualizar:
PUT
a /crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
. La URL de la solicitud contiene los siguientes campos:
Campo | Descripción |
---|---|
callId | El ID de la llamada. |
toObjectType | El tipo de objeto con el que deseas asociar la llamada (por ejemplo, contacto o empresa) |
toObjectId | El ID del registro con el que deseas asociar la llamada. |
associationTypeId | Un identificador único para indicar el tipo de asociación entre la llamada y el otro objeto. El ID se puede representar numéricamente o con palabras separadas por guion bajo (por ejemplo, call_to_contact ). Puedes obtener el valor a través de la API de asociaciones. |
https://api.hubspot.com/crm/v3/objects/calls/17591596434/associations/contact/104901/194
DELETE
en la misma URL que la anterior:
/crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
id
de las llamadas en el campo hs_pinned_engagement_id
al crear o actualizar un registro a través de las API de objetos. Obtén más información sobre el uso de las API de empresas,contactos, negocios, tickets y objetos personalizados.
DELETE
a /crm/v3/objects/calls/{callId}
.
Para saber más sobre cómo eliminar llamadas, consulta la documentación de referencia.