Servicios Cuentas¶

Obtener lista de cuentas disponibles por canal¶

/v2/accounts/{sn}/ - GET

Permite obtener la lista de cuentas disponibles y sus propiedades. Se utiliza para poder inicar conversaciones proactivas u otras consultas utilizando el id de cuenta.

Un ejemplo de respuesta exitosa es:

{
    "accounts": [
        {
            "name": "Test Account",
            "social_network": "whatsapp",
            "allow_proactive": false,
            "active": true,
            "id": "au2geg72gs",
            "uid": "56911118888"
        }
    ],
    "sn": "whatsapp"
}

Es posible especificar all para obtener todas las cuentas disponibles, independiente de su canal, en este caso "sn" contendrá una lista sin repeticiones de los datos asociados a las cuentas.

AccountListResponse¶

Campo	Descripción	Tipo
sn	Canal al que pertenecen la lista de cuentas	`string`
accounts	Lista con las cuentas disponibles en Desk para el canal indicado	`list`

Account¶

Campo	Descripción	Tipo
name	Nombre de la cuenta	`string`
social_network	Nombre del canal asociado a la cuenta	`string`
allow_proactive	Indica si esta cuenta puede ser utilizada por el servicio de envío proactivo de mensajes	`boolean`
active	Indica si esta cuenta esta conectada	`boolean`
id	Identificador de la cuenta en Desk, usado por otros servicios	`integer`
uid	Identificador de la cuenta en el canal original	`string`

El campo uid tendrá distintos valores según el canal, acá se muestra el valor esperado por cada canal:

Canal	Descripción
WhatsApp	Número de teléfono
Facebook	Id de FanPage en Facebook
Twitter	Id de la cuenta en Twitter
Email	Correo electrónico
Instagram	Id de la cuenta en Instagram
Chat	Id de chat generado en Desk
Google Play	Nombre de la aplicación
App Store	Nombre de la aplicación