Lista de Salesbots

El método permite obtener una lista de Salesbots en la cuenta.

Limitaciones
El método está disponible para todos los usuarios de la cuenta.

Parámetros "with"

ParámetroDescripción
favoriteAñade la propiedad is_favorite a la respuesta, la cual define si el Salesbot está añadido a favoritos del usuario actual de la cuenta.

Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json

Encabezado de tipo de datos en caso de error
Content-Type: application/problem+json

Parámetros de respuesta

ParámetroTipo de datoDescripción
idintID del Salesbot.
namestringNombre del Salesbot.
is_visual_editorboolDefine el tipo de editor del Salesbot. true significa que el Salesbot está en modo editor visual; false significa que está en modo texto (código).
type_functionalitystringTipo de funcionalidad del Salesbot: regular – Salesbot de flujo básico, greeting – bot de mensaje de bienvenida, marketing – mensajes de difusión, nps – encuesta.
settingsobjConfiguración del Salesbot.
settings[active]boolDefine si el Salesbot está activo.
is_favoriteboolSe requiere el parámetro GET with. Define si el Salesbot está añadido a favoritos.
Query Params
integer

Página de la respuesta

integer

Cantidad de entidades devueltas por solicitud (límite: 250)

filter[type_functionality][]
array of strings

Filtrar por tipo de funcionalidad del Salesbot. Valores posibles: regular – Salesbot de flujo básico, greeting – bot de mensaje de bienvenida, marketing – bot para envío de mensajes de difusión, nps – bot para realizar encuestas NPS

filter[type_functionality][]
filter[id][]
array of integers

Filtrar por IDs de Salesbots

filter[id][]
string

Este parámetro acepta una cadena que puede contener varios valores (consulte la tabla anterior) separados por comas.

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
text/html
application/problem+json