• Instrucciones de integración del sistema de CRM propio y telefonía de Zadarma
• Integración del sistema de CRM propio y Zadarma
• Webhook para el funcionamiento con IVR: un robot de voz hecho por ti
• Creación de lead en CRM desde el formulario en la web
• Cómo integrar el teléfono web en tu sistema
• Telefonía bajo tu propia marca (White Label)
• Trabajo con números virtuales a través de API

• visualización y cambio de ajustes de SIP y centralita virtual;
• visualización de datos estadísticos y de saldo;
• envío de llamadas (CallBack a números externos y de extensión internos) y de mensajes SMS;
• notificación del servidor externo sobre cada llamada entrante en la centralita virtual, así como enrutamiento externo de llamadas.

Cada solicitud que requiere autorización se acompaña de un encabezado adicional, como:

"Authorization: contraseña_del usuario: firma"

Las contraseñas de autorización debes obtenerlas en el área personal.

La firma se realiza de acuerdo con el siguiente algoritmo:

• un conjunto de parámetros transmitidos (GET, POST, PUT, DELETE) ordenados alfabéticamente por el nombre de la tecla;
• del conjunto obtenido se genera una cadena de consulta (por ejemplo, la función http_build_query в PHP), ejemplo "from=DATEFROM&to=DATETO…";
• etc - se une mediante la fórmula: línea = nombre_método línea_solicitud md5( línea_solicitud ), dobde "nombre_método" - línea de la solicitud, comenzando por el dominio (indicando la versión API), antes de la enumeración de parámetros, por ejemplo - '/v1/sip/'
• la cadena resultante se transforma mediante la función de hash de acuerdo con el algoritmo sha1 con una contraseña del usuario: hash = hash( linea contraseña_secreta)
• y a continuación hash se codifica en base64 firma = base64_encode( hash )

                                    ksort($params);
$paramsStr = http_build_query($params, null, '&', PHP_QUERY_RFC1738);
$sign = base64_encode(hash_hmac('sha1', $method . $paramsStr . md5($paramsStr), $secret));
$header = 'Authorization: ' . $userKey . ':' . $sign;

La clase preparada de PHP para trabajar con API la puedes descargar en GitHub.

El encabezado Content-Type para las solicitudes POST debe ser application/x-www-form-urlencoded o multipart/form-data.

Formatos de respuesta: json (por defecto) y xml.

Para obtener respuesta en API en formato xml, se agrega un parámetro a la cadena de consulta "format=xml".

                                    {
    "status":"error",
    "message":"Check phone's number"
}

                                    <?xml version="1.0"?>
<answer>
    <status>error</status>
    <message>Check phone number</message>
</answer>

La respuesta también contiene información sobre los límites y la solicitud actual, por ejemplo:

X-Zadarma-Method: /v1/ X-RateLimit-Reset: 1434371160 X-RateLimit-Limit: 100 X-RateLimit-Remaining: 99

donde,

• X-Zadarma-Method - método de llamada actual;
• X-RateLimit-Remaining - número de solicitudes restantes, teniendo en cuenta el límite en el método y por usuario;
• X-RateLimit-Limit - número total de visitas por minuto;
• X-RateLimit-Reset - límite de tiempo de reinicio.

Limitaciones generales - 100 solicitudes por minuto, en métodos estadísticos: 3 solicitudes por minuto.

En caso de bloqueo, el método da la respuesta 429 con el encabezamiento "You exceeded the rate limit".

La respuesta se compone de la contraseña obligatoria "status" (success o bien error). Más adelante, en función del método se proporcionan sus contraseñas, con la información solicitada.

En caso de error, se proporciona una contraseña adicional "message" con la descripción del error.

Del mismo modo, todas las respuestas van acompañadas de los correspondientes encabezados HTTP.

saldo del usuario

                                    {
    "status":"success", 
    "balance":10.34, 
    "currency":"USD"
}

                                    <?xml version="1.0">
<answer>
    <status>success</status>
    <balance>10.34</balance>
    <currency>USD</currency>
</answer>

el coste de una llamada en base a la tarifa actual del usuario

                                    {
    "status":"success",
    "info": {
        "prefix":"4420",
        "description":"United Kingdom, London",
        "price":"0.009",
        "currency":"USD",
    }
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <info>
        <prefix>4420</prefix>
        <description>United Kingdom, London</description>
        <price>0.009</price>
        <currency>USD</currency>
    </info>
</answer>

Parámetros

• number – número de teléfono
• caller_id (opcional) – CallerID, que va a utilizarse para realizar la llamada.


huso horario del usuario

                                    {
    "status":"success",
    "unixtime":1483228800,
    "datetime":"2017-01-01 00:00:00",
    "timezone":"UTC+0"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <unixtime>1483228800</unixtime>
    <datetime>2017-01-01 00:00:00</datetime>
    <timezone>UTC+0</timezone>
</answer>

información sobre la tarifa actual del usuario

                                    {
    "status":"success",
    "info": {
        "tariff_id":5,
        "tariff_name":"Standart, special",
        "is_active":false,
        "cost":0,
        "currency":USD,
        "used_seconds":1643,
        "used_seconds_mobile":34,
        "used_seconds_fix":726,
        "tariff_id_for_next_period":5,
        "tariff_for_next_period":Standart, special
    }
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <info>
        <tariff_id>5</tariff_id>
        <tariff_name>Standart, special</tariff_name>
        <is_active>false</is_active>
        <cost>0</cost>
        <currency>USD</currency>
        <used_seconds>1643</used_seconds>
        <used_seconds_mobile>726</used_seconds_mobile>
        <used_seconds_fix>726</used_seconds_fix>
        <tariff_id_for_next_period>5</tariff_id_for_next_period>
        <tariff_for_next_period>Standart, special</tariff_for_next_period>
    </info>
</answer>

donde

• tariff_id– ID de la tarifa actual del usuario;
• tariff_name – nombre de de la tarifa actual del usuario;
• is_active – tarifa actual activa o inactiva;
• cost – coste de la tarifa;
• currency – moneda de la tarifa;
• used_seconds – cantidad de segundos utilizados de la tarifa;
• used_seconds_mobile –cantidad de segundos usados en teléfonos móviles;
• used_seconds_fix – cantidad de segundos utilizados de la tarifa a teléfonos fijos;
• used_seconds_speech_recognition – cantidad de segundos utilizados para el reconocimiento de voz;
• tariff_id_for_next_period – ID de la tarifa del usuario en el siguiente período;
• tariff_for_next_period – nombre de la tarifa del usuario en el siguiente período.

devolucion de llamada

                                    {
    "status":"success", 
    "from":442037691880, 
    "to":442037691881, 
    "time":1435573082
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <from>442037691880</from>
    <to>442037691881</to>
    <time>1435573082</time>
</answer>

Parámetros

• from – tu número de teléfono o SIP, o extensión de la centralita virtual, o el número de secuencia de comandos PBX al que se realiza la devolución de llamada;
• to – número de teléfono o SIP, al que se llama;
• sip (opcional) – número SIP del usuario o extensión de la centralita virtual (por ejemplo 100), a través del que se realiza la llamada. Se va a utilizar el CallerID de este número, en los datos estadísticos se va a mostrar este número SIP/АТС, si el número especificado incluye grabación de llamadas o prefijos de marcación, también se usarán;

• predicted (opcional) – si se especifica este indicador, entonces la solicitud es predicativa (el sistema llama inicialmente al número "to" y solo si se termina de marcar, se conecta a tu SIP o número de teléfono);

envío de SMS

                                    {
    "status":"success",
    "messages":1,
    "cost":0.24,
    "currency":"USD",
    "sms_detalization":[
        {
            "senderid":"xxxxxxxxxxx",
            "number":"1234567890",
            "cost":0.06
        }
    ],
    "denied_numbers":[
        {
            "number":"1234567890",
            "message":"The reason for the SMS not being sent to the number"
        }
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <value>
        <messages>1</messages>
        <cost>0.24</cost>
        <currency>1</currency>
        <sms_detalization>
            <value>
                <callerid>xxxxxxxxx</callerid>
                <number>1234567890</number>
                <cost>0.06</cost>
            </value>
        </sms_detalization>
        <denied_numbers>
            <value>
                <number>1234567890</number>
                <message>The reason for the SMS not being sent to the number</message>
            </value>
        </denied_numbers>
    </value>
</answer>

Parámetros

• number – número de teléfono para enviar SMS (se pueden enumerar varios separados por comas);
• message – mensaje (restricciones estándar sobre la longitud de los SMS, en caso de exceder el límite, dividido en varios SMS);
• sender – (opcional) el remitente de SMS (número virtual o texto) listado de valores disponibles se puede obtener por el método GET /v1/sms/senderid/
• language – (opcional) idioma de la plantilla SMS. Si no se indica se usará el idioma del área personal.

Obtener el listado de plantillas para SMS

                                    {
"list": [
    {
        "cath_id":"1",
         "title":"The name of the template category",
        "templates": [
            {
                "id":"1",
                "text":"The template text with a variable {$var}"
            },
            {
                "id":"2",
                "text":"Second template text"
            },
        ]
    }
]
}

                                    <answer>
<list>
    <value>
        <cath_id>1</cath_id>
        <title>The name of the template category</title>
        <templates>
            <value>
                <id>1</id>
                <text>The template text with a variable {$var}</text>
            </value>
            <value>
                <id>2</id>
                <text>Second template text</text>
            </value>
        </templates>
    </value>
</list>
</answer>

Parámetros

• skip – (opcional) número de plantillas a oscilar antes del inicio de selección, por defecto 0;
• limit – (opcional) número de plantillas a mostrar (por defecto 24, máximo 1000);
• language – (opcional) idioma de plantillas de SMS. Si no se selecciona se usará el idioma del área personal de la cuenta.

Obtener el listado de remitentes de SMS disponibles al número indicado

                                    {
    "senders": ["Teamsale", "1234567890"]
}

                                    <answer>
	<senders>
		<value>1234567890</value>
		<value>Teamsale</value>
	</senders>
</answer>

Parámetros

• phones – número de teléfono para el que se desea conocer el listado de remitentes disponibles.

confirmación del número

                                    {
    "status":"success",
    "from":442037691880,
    "to":442037691881,
    "lang":"fr",
    "time":1612779278
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <from>442037691880</from>
    <to>442037691881</to>
    <lang>fr</lang>
    <time>1612779327</time>
</answer>

Parámetros

• caller_id - número mostrado en llamadas, disponibles solo los números conecyados en Zadarma,
• to - número de teléfono o SIP al que llaman,
• code - código que se va a reproducir. Solo cifras y extensión inferior a 20 dígitos,
• lang - idioma de texto. En su ausencia se selecciona el del área personal del cliente, se verifica la presencia en los idiomas del sistema.

actualización de base de clientes

Parámetros

• numbers – listado de números para actualizar en formato internacional.

Si numbers contiene 1 número el resultado será devuelto inmediatamente, si se indica un listado de números el resultado será enviado a la dirección indicada en la página de actualización de contactos o al correo electrónico, en caso de no estar indicada la dirección.

¡Atención! los ajustes de este método se configuran en la página de actualización de base de clientes del área personal.

Ejemplo de respuesta para 1 número:

(Respuesta 1)

                                    Respuesta 1:
{
    "status":"success",
    "info":{
        "mcc":"24702",
        "mnc":"02",
        "mccName":"Latvia",
        "mncName":"Tele2",
        "ported":false,
        "roaming":false,
        "errorDescription":"No Error"
    }
}

Ejemplo de respuesta para varios números:

(Respuesta 2)

                                    Respuesta 2:
{
    "status":"success"
}

Ejemplo del resultado enviado a la dirección indicada en la página de actualización:

(Respuesta 3)

                                    Respuesta 3:
{
    "success":true,
    "description":"Success",
    "result": [
        {
            "mcc":"24702",
            "mnc":"02",
            "ported":false,
            "roaming":false,
            "errorDescription":"No Error",
            "mccName":"Latvia",
            "mncName":"Tele2",
            "number":"3712812858",
        }, ...
    ]
}

Listado de divisas

                                    {
    "status": "success",
    "currencies": [
        "USD",
        "EUR",
        "GBP",
        "PLN"
    ]
}

Listado de idiomas disponibles del área personal

                                    {
    "status": "success",
    "languages": [
        "en",
        "es",
        "de",
        "pl",
        "ru",
        "ua",
        "fr"
    ]
}

Listado de tarifas

                                    {
    "status": "success",
    "currency": "EUR",
    "tariffs": [
        {
            "tariff_id": 5,
            "name": "Standard",
            "cost": 0,
            "days": "30"
        },
        ...
    ],
    "package_tariffs": [
        {
            "id": 1,
            "name": "EU",
            "tariffs": [
                {
                    "tariff_id": 23,
                    "name": "Office",
                    "cost": 22,
                    "cost_annual": 216
                },
                ...
            ]
        },
        ...
    ]
}

Parámetros:

• currency – divisa

relación de números SIP del usuario

                                    {
    "status":"success",
    "sips":[
        {"id":"00001", "display_name":"SIP 1", "lines":3},
        {"id":"00002", "display_name":"SIP 2", "lines":3}
    ],
    "left":3
}

                                    <?xml version="1.0"?>
    <answer>
        <status>success</status>
        <sips>
            <value>
                <id>00001</id>
                <display_name>SIP 1</display_name>
                <lines>3</lines>
            </value>
            <value>
                <id>00002</id>
                <display_name>SIP 2</display_name>
                <lines>3</lines>
            </value>
        </sips>
        <left>1</left>
    </answer>

donde

• id– SIP-id;
• display_name – nombre en pantalla;
• lines – número de líneas;
• left – número de SIP restantes que se puede crear (depende del saldo del usuario y del número total de SIP ya creados).

estado online de número SIP del usuario

                                    {
    "status":"success",
    "sip":"00001",
    "is_online":"false"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <sip>00001</sip>
    <is_online>false</is_online>
</answer>

cambio del CallerID

                                    {
    "status":"success",
    "sip":"00001",
    "new_caller_id":"442037691880"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <sip>00001</sip>
    <new_caller_id>442037691880</new_caller_id>
</answer>

Parámetros

• id – ID SIP al cual cambian los CallerID;
• number – número, que se cambia en formato internacional (de la lista de números de usuarios confirmados o comprados).

visualización de reenvíos actuales por números SIP del usuario

                                    {
    "status":"success",
    "info": [
        {
            "sip_id":"00001",
            "status":"on",
            "condition":"always",
            "destination":"phone",
            "destination_value":"442037691880"
        },
    ...
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <info>
        <value>
            <sip_id>00001</sip_id>
            <status>on</status>
            <condition>always</condition>
            <destination>phone</destination>
            <destination_value>442037691880</destination_value>
        </value>
    ...
    </info>
</answer>

Parámetros

• id – selección (opcional) de id específico de SIP.

donde

• sip_id– Id de SIP del usuario;
• status – estado actual: on o bien off;
• condition – condiciones de reenvío: always – siempre (por defecto), unavailable – en el caso de no levantar el auricular o en caso de ausencia de una conexión SIP;
• destination – destino para el desvío: phone – a numero de teléfono, pbx – a la centralita virtual;
• destination_value – numero de desvío: numero de teléfono o ID de la centralita virtual.

activación/desactivación del reenvío en base al número SIP

                                    {
    "status":"success",
    "sip":"00001",
    "current_status":"on"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <sip>00001</sip>
    <current_status>on</current_status>
</answer>

Parámetros

• id – SIP id;
• status – el estado que se muestra en el número SIP seleccionado.

modificación de los parámetros de reenvío

                                    {
    "status":"success",
    "sip":"00001",
    "destination":"442037691880"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <sip>00001</sip>
    <destination>442037691880</destination>
</answer>

Parámetros

• id – SIP id;
• type – tipo de reenvío: phone – al teléfono;
• number – número de telefono.
• condition – parámetro opcional, condición de desvío (always - siempre, unavailable - en caso de no descolgar o ausencia de conexión SIP)

Agregar SIP

                                    {
    "status": "success",
    "sip": "123456"
}

Parámetros

• name - nombre mostrado;
• password - contraseña;
• callerid - número para CallerID;
• redirect_to_phone - parámetro opcional, desvío del SIP al teléfono;
• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos.

Cambio de contraseña en SIP

Parámetros

                                    {
    "status":"success",
    "sip":$sip,
}

• value - nueva contraseña;
• user_id - parámetro opcional, disponible para su uso solo por distribuidores y solo para los usuarios que ellos hayan creado.

obtención de estadísticas generales

(Respuesta 1)

                                    Respuesta 1:
{
    "status":"success",
    "start":"2015-06-01 00:00:00",
    "end":"2015-06-29 13:45:23",
    "stats":[
        {
            "id":"155112249",
            "sip":"00001",
            "callstart":"2015-06-02 12:20:25",
            "from":442037691880,
            "to":442037691881,
            "description":"United Kingdom, London",
            "disposition":"busy",
            "billseconds":0,
            "cost":0.1950,
            "billcost":0.0000,
            "currency":"USD"
        },
        …
    ]
}

                                    Respuesta 1:
<?xml version="1.0"?>
<answer>
    <status>success</status>
    <start>2015-06-01 00:00:00</start>
    <end>2015-06-29 13:58:22</end>
    <stats>
        <value>
            <id>155112249</id>
            <sip>00001</sip>
            <callstart>2015-06-02 12:20:25</callstart>
            <description>United Kingdom, London</description>
            <disposition>busy</disposition>
            <billseconds>0</billseconds>
            <cost>0.195</cost>
            <billcost>0</billcost>
            <currency>USD</currency>
            <from>442037691880</from>
            <to>442037691881</to>
        </value>
        …
    </stats>
</answer>

Parámetros

• start - fecha de comienzo vista de las estadísticas (formato - YYYY-MM-DD HH:MM:SS);
• end - fecha de final de vista de las estadísticas (formato - YYYY-MM-DD HH:MM:SS);
• sip (opcional) - filtro en función de determinado número SIP;
• cost_only (opcional) - vista solo del monto gastado para el período;
• type (opcional - solo en las estadísticas generales) - tipo de consulta: general (no se indica en la solicitud), toll y ru495. (para estadísticas de los números 800 y números libres 495);
• skip (opcional - no se tiene en cuenta para este parámetro cost_only) -el número de líneas que hay que omitir en la selección, la salida comenzará desde el salto de línea + 1 (usado para la paginación junto con el parámetro de límite, el valor predeterminado es 0); -limit(opcional - no se contabiliza para cost_only) es el límite en el número de líneas de salida (utilizado para la paginación con el parámetro de omisión, el valor máximo 1000, por defecto es 1000).

Plazo máximo para la recepción de datos estadísticos - mes. En caso de aumentar el límite de solicitud, el plazo se reduce automáticamente a 30 días. Si no se indica la fecha de inicio de la selección, se selecciona el inicio del mes en curso. Si no se indica la fecha de final de la selección, la selección se limita a la fecha y hora en curso.

Número máximo de líneas introducidas para una solicitud - 1000. Para la paginación, utiliza los parámetros skip y limit.

?type=cost_only:

(Respuesta 2)

                                    Respuesta 2:
{
    "status":"success",
    "start":"2015-06-01 00:00:00",
    "end":"2015-06-29 14:03:57",
    "stats":[
        {
            "cost":38.094,
            "currency":"USD",
            "seconds":9785
        }
    ]
}

                                    Respuesta 2:
<?xml version="1.0"?>
<answer>
    <status>success</status>
    <start>2015-06-01 00:00:00</start>
    <end>2015-06-29 14:03:30</end>
    <stats>
    <value>
        <cost>38.094</cost>
        <currency>USD</currency>
        <seconds>9785</seconds>
    </value>
    </stats>
</answer>

donde

• start – fecha de comienzo de visualización de estadísticas;
• end – fecha de final de visualización de estadísticas;
• id – id de llamada;
• sip – número SIP;
• callstart – hora del inicio de la llamada;
• description – descripción del destino de la llamada;
• disposition – estado de la llamada:
  • 'answered' – разговор,
  • 'busy' – ocupado,
  • 'cancel' - cancelado,
  • 'no answer' - sin respuesta,
  • 'call failed' - no ha sido posible,
  • 'no money' - no hay saldo, se ha superado el límite,
  • 'unallocated number' - el número no existe,
  • 'no limit' - se ha superado el límite,
  • 'no day limit' - se ha superado el límite diario,
  • 'line limit' - se ha superado el límite de la línea,
  • 'no money, no limit' - se ha superado el límite;
• billseconds – número de los segundos de la llamada;
• cost – coste del minuto de llamada a este destino;
• billcost –coste de los minutos abonados;
• currency – moneda del pago de la llamada;
• from – desde qué número se ha llamado;
• to – adónde se ha llamado.

estadística de la centralita

¡Atención! si necesitas la estadística actualizada de la centralita no es necesario solicitar cada minuto el método statistics/pbx/. Activa las notificaciones webhooks y obtén la información de cada llamada en el momento de su inicio y fin.

                                    {
    "status":"success",
    "start":"2015-06-01 00:00:00",
    "end":"2015-06-30 23:59:59",
    "version":2,
    "stats":[
        {
            "call_id":1439981389.2702773,
            "sip":200,
            "callstart":"2015-06-01 15:04:00",
            "clid":200,
            "destination":5,
            "disposition":"answered",
            "seconds":5,
            "is_recorded":true,
            "pbx_call_id":"in_ae6b03b3b0765d127ec0b739209346bbc4f0d52d"
        },
        …
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success<</status>
        <start>2015-06-01 00:00:00</start>
        <end>2015-06-30 23:59:59</end>
        <version>2</version>
        <stats>
        <value>
            <call_id>1439981389.2702773</call_id>
            <sip>200</sip>
            <callstart>2015-06-01 15:04:00</date>
            <clid>200</clid>
            <destination>5</destination>
            <disposition>answered</disposition>
            <seconds>5</seconds>
            <is_recorded>true</is_recorded>
            <pbx_call_id>in_ae6b03b3b0765d127ec0b739209346bbc4f0d52d</pbx_call_id>
        </value>
        …
    </stats>
</answer>

Parámetros

• start - fecha de inicio para revisión de datos estadísticos (formato - YYYY-MM-DD HH:MM:SS);
• end - fecha de fin para revisión de datos estadísticos (formato - YYYY-MM-DD HH:MM:SS);
• version - formato de introducción de datos estadísticos (2 - nuevo, 1 - antiguo);
• skip (opcional) - número de líneas omitidas en la selección, la selección empezará desde la línea skip +1 (se utiliza para la paginación conjunta con el parámetro limit que, por defecto es igual a 0);
• limit (opcional) - límite para las líneas generadas (se utiliza para la paginación conjunta con el parámetro skip, valor máximo 1000, valor por defecto 1000);
• call_type (opcional) - destino de llamadas ('in' para entrantes, 'out' para salientes). Si no se indica, se generarán todas las llamadas.

donde

• start – fecha de comienzo de visualización de estadísticas;
• end – fecha de final de visualización de estadísticas;
• version - formato de introducción de estadísticas (2 - nuevo, 1 - antiguo);
• call_id – id único de llamada, este id está indicado en el nombre del archivo con la grabación de la llamada (único para cada grabación en los datos estadísticos);
• sip – número SIP;
• callstart – hora de inicio de la llamada;
• clid – CallerID;
• destination – adónde se ha llamada;
• disposition – estado de la llamada:
  • 'answered' – conversación,
  • 'busy' – ocupado,
  • 'cancel' - cancelado,
  • 'no answer' - sin respuesta,
  • 'call failed' - no ha sido posible,
  • 'no money' - no hay saldo, se ha superado el límite,
  • 'unallocated number' - el número no existe,
  • 'no limit' - se ha superado el límite,
  • 'no day limit' - se ha superado el límite diario,
  • 'line limit' - se ha superado el límite de la línea,
  • 'no money, no limit' - se ha superado el límite;
• seconds – número de segundos de la llamada;
• is_recorded – (true, false) se ha grabado o no hay conversación;
• pbx_call_id – ID permanente de la llamada externa a la centralita virtual (no cambia al pasar scripts, menú de voz, transferencia, etc., se muestra en las estadísticas y notificaciones);

datos estadísticos del widget de devolución de llamada

                                    {
    "status":"success",
    "start":"2016-09-01 00:00:00",
    "end":"2016-09-30 23:59:59",
    "stats":[
        {
            "id":"57d16d6a1e46c53d1f8ce323",
            "widget_id":"1",
            "sip":"00001",
            "ip":"127.0.0.1",
            "actions":[
                {
                    "kind":"come",
                    "date":"2016-09-08 16:53:45",
                    "referrer_url":"http://test.domain.com/page1/",
                    "url":"http://home.domain.com/page2/"
                },
                {
                    "kind":"show",
                    "date":"2016-09-08 16:53:46",
                    "rate":15
                },
                {
                    "kind":"call_request",
                    "date":"2016-09-08 16:54:07",
                    "number":"442037691880",
                    "request_call_date":"2016-09-09 10:00:00",
                    "redial":"n"
                },
                {
                    "kind":"close",
                    "date":"2016-09-08 16:54:35"
                }
            ]
        },
        ...
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <start>2016-09-01 00:00:00</start>
    <end>2016-09-30 23:59:59</end>
    <stats>
        <value>
            <id>57d16d6a1e46c53d1f8ce323</id>
            <widget_id>1</widget_id>
            <sip>00001</sip>
            <ip>127.0.0.1</ip>
            <actions>
                <value>
                    <kind>come</kind>
                    <date>2016-09-08 16:53:45</date>
                    <referrer_url>http://test.domain.com/page1/</referrer_url>
                    <url>http://home.domain.com/page2/</url>
                </value>
                <value>
                    <kind>show</kind>
                    <date>2016-09-08 16:53:46</date>
                    <rate>15</rate>
                </value>
                <value>
                    <kind>call_request</kind>
                    <date>2016-09-08 16:54:07</date>
                    <number>442037691880</number>
                    <request_call_date>2016-09-09 10:00:00</request_call_date>
                    <redial>n</redial>
                </value>
                <value>
                    <kind>close</kind>
                    <date>2016-09-08 16:54:35</date>
                </value>
            </actions>
        </value>
            ...
    </stats>
</answer>

Parámetros

• start - fecha de comienzo de visualización de estadísticas (formato - YYYY-MM-DD HH:MM:SS);
• end - fecha de final de visualización de estadísticas (formato - YYYY-MM-DD HH:MM:SS);
• widget_id - (opcional) - la ID del widget, en caso de ausencia de un parámetro, se toman estadísticas para todos los widgets;

Plazo máximo para recibir estadísticas mes.En caso de exceder el límite en la solicitud, el plazo se reduce automáticamente a 30 días. Si no se especifica la fecha de inicio de la muestra, se selecciona el comienzo del mes actual. Si no se especifica la fecha de finalización de la muestra, la muestra está limitada a la fecha y hora actuales.

donde

• start – fecha de inicio de visualización de estadísticas;
• end – fecha de fin de visualización de estadísticas;
• id – id de la sesión;
• widget_id – id del widget;
• sip – número SIP;
• ip – dirección IP del visitante;
• kind – tipo de evento:
  • 'come' – el visitante llegó a la página con el widget,
  • 'show' – se indica la forma del widget,
  • 'call' – solicitud de devolución de llamada,
  • 'call_request' – solicitud de devolución de llamada diferida,
  • 'rate' – el visitante ha valorado la llamada,
  • 'fail' – el visitante ha señalado que no ha habido devolución de llamada,
  • 'close' – el visitante ha cerrado el icono de widget;
• date – fecha y hora del evento;
• referrer_url – dirección de la página desde la que el visitante ha llegado a la página mediante el widget (solo para el evento 'come');
• url – dirección de la página del widget (solo para el evento 'come');
• rate – para el evento 'show' - número de puntos, para el evento 'rate' - valoración de la conversación;
• request_call_date – fecha y hora especificadas por el visitante, según sea conveniente para la devolución de la llamada (solo para el evento) 'call_request');
• redial – (true, false) devuelto o no en respuesta a una solicitud de devolución diferida (solo para un evento) 'call_request');
• number – número introducido por el visitante (para el evento 'call', 'call_request', 'rate', 'fail').

Obtención de la estadística completa de llamadas entrantes

                                    {
    "status":"success",
    "start":"2015-06-01 00:00:00",
    "end":"2015-06-29 13:45:23",
    "stats":[
        {
            "id":"155112249",
            "sip":"00001",
            "callstart":"2015-06-02 12:20:25",
            "from":442037691880,
            "to":442037691881,
            "billseconds":0,
            "disposition":"busy",
            "description":"United Kingdom, London"
        },
        …
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <start>2015-06-01 00:00:00</start>
    <end>2015-06-29 13:58:22</end>
    <stats>
        <value>
            <id>155112249</id>
            <sip>00001</sip>
            <callstart>2015-06-02 12:20:25</callstart>
            <from>442037691880</from>
            <to>442037691881</to>
            <billseconds>0</billseconds>
            <disposition>busy</disposition>
            <description>United Kingdom, London</description>
        </value>
        …
    </stats>
</answer>

Parámetros

• start - fecha inicio de selección de estadística (formato - YYYY-MM-DD HH:MM:SS);
• end - fecha fin de selección de estadística (formato - YYYY-MM-DD HH:MM:SS);
• sip (opcional) - filtro por un determinado SIP;
• skip (opcional - no se tiene en cuenta al establecer el parámetro cost_only) - número de líneas que se deben omitir en la selección, la selección comienza desde la línea skip + 1 (se emplea para la paginación en conjunto con los parámetros limit, por defecto es igual a 0);
• limit (opcional - no se tiene en cuenta al establecer el parámetro cost_only) - límite en el número de líneas de salida (se utiliza para la paginación junto con el parámetro skip, el valor máximo es 1000, el valor predeterminado es 1000).

Período máximo de obtención de estadística - mes. En caso de superar el límite en la solicitud el periodo se reduce automáticamente hasta 30 días. Si no se indica la fecha de inicio de selección se selecciona desde el inicio del mes en curso. Si no se indica la fecha fin la selección se limita a fecha y hora actuales.

Número máximo de líneas de salida para una solicitud - 1000. Para la paginación usa los parámetros skip y limit.

Donde:

• start – fecha inicio de selección de estadística;
• end – fecha fin de selección de estadística;
• id – id de llamada;
• sip – SIP;
• callstart – hora inicio de llamada;
• from – desde qué número se ha llamado;
• to – a dónde se ha llamado;
• billseconds – duración de llamada en segundos;
• disposition – estado de llamada:
  • 'answered' – conversación,
  • 'busy' – ocupado,
  • 'cancel' - cancelado,
  • 'no answer' - sin respuesta,
  • 'failed' - no se ha podido realizar,
  • 'no money' - sin fondos, se ha superado el límite,
  • 'unallocated number' - número no existe,
  • 'no limit' - se ha superado el límite,
  • 'no day limit' - se ha superado el límite diario,
  • 'line limit' - se ha superado el límite de líneas,
  • 'no money, no limit' - se ha superado el límite;
• description – descripción del destino de llamada.

modificación de parámetros de reenvío en la extension de la centralita virtual

                                    {
    "status":"success",
    "current_status":"on",
    "pbx_id":"1234",
    "pbx_name":"100",
    "type":"phone",
    "destination":"79123456789",
    "condition":"noanswer"
}

                                    <?xml version="1.0"?>
    <answer>
    <status>success</status>
    <current_status>on</current_status>
    <pbx_id>1234</pbx_id>
    <pbx_name>100</pbx_name>
    <type>phone</type>
    <destination>79123456789</destination>
    <condition>noanswer</condition>
    </answer>

Parámetros

Para activar y configurar el reenvío:

• pbx_number – extensión de la centralita virtual, por ejemplo 100;
• status – on;
• type – tipo de reenvío voicemail o phone;
• destination – teléfono o correo electrónico, dependiendo de parámetro anterior;
• condition – la condición de reenvío, valores posibles: siempre o bien noanswer;
• voicemail_greeting – notificación sobre reenvío, posibles valores: no, standart, own. Se indica solo para el type = voicemail;
• greeting_file – archivo con notificación en el formato mp3 o bien wav hasta 5 MB. Se indica solo para el type = voicemail y voicemail_greeting = own;

Para la activación del reenvío:

• pbx_number – extensión de la centralita virtual, por ejemplo 100;
• status – off;

obtención de parámetros de reenvío en la extension de la centralita virtual

                                    {
    "status":"success",
    "current_status":"on",
    "pbx_id":"1234",
    "pbx_name":"100",
    "type":"phone",
    "destination":"79123456789",
    "condition":"noanswer",
}

Parámetros

• pbx_number – extensión de la centralita virtual, por ejemplo 100;

solicitud de un archivo de grabación de la llamada

Parámetros

• call_id – id único de llamada, este id está indicado en el nombre del archivo con la grabación de la llamada (único para cada grabación en los datos estadísticos);
• pbx_call_id – ID permanente de la llamada externa a la centralita virtual (no cambia cuando se pasa de escenario, menú de voz, transferencia etc., se refleja en los datos estadísticos y en las notificaciones);
• lifetime – (opcional) duración de vida del enlace en segundos (mínimo - 180, máximo - 5184000, por defecto - 1800).

Atención: es suficiente indicar uno de dos parámetros de identificación (pbx_call_id o bien call_id), al indicar pbx_call_id del enlace en una consulta, puede haber varias.

Ejemplo de respuesta cuando solo se especifica call_id, solo hay un enlace:

(Respuesta 1)

                                    Respuesta 1:
{
    "status":"success",
    "link": "https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3",
    "lifetime_till": "2016-01-01 23:56:22"
}

                                    Respuesta 1:
<?xml version="1.0"?>
<answer>
    <status>success</status>
    <link>https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3</link>
    <lifetime_till>2016-01-01 23:56:22</lifetime_till>
</answer>

Ejemplo de respuesta cuando solo se especifica pbx_call_id, puede haber varias referencias:

(Respuesta 2)

                                    Respuesta 2:
{
    "status":"success",
    "links":[
        "https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3",
        "https://api.zadarma.com/v1/pbx/record/download/pw7Cj..iOzn99/1-1458313475.213487-101-2016-01-11-100211.mp3"
    ],
    "lifetime_till": "2016-01-01 23:56:22"
}

                                    Respuesta 2:
<?xml version="1.0"?>
<answer>
    <status>success</status>
    <links>
        <value>https://api.zadarma.com/v1/pbx/record/download/NjM3M..NzM2Mg/1-1458313316.343456-100-2016-01-11-100155.mp3<</value>
        <value>https://api.zadarma.com/v1/pbx/record/download/pw7Cj..iOzn99/1-1458313475.213487-101-2016-01-11-100211.mp3</value>
    </links>
    <lifetime_till>2016-01-01 23:56:22</lifetime_till>
</answer>

Parámetros

• link – enlace al archivo de la conversación;
• lifetime_till – hasta qué día seguirá funcionando el enlace.

cargar melodía

Parámetros:

• file - el archivo

act/desact melodía para la centralita

Parámetros:

• state - estado (on - act, off - desact);
• melody - tipo de melodía (none - por defecto, sin melodía, mymelody - la melodía cargada por el usuario antes.

eliminar melodía

obtener ajustes de pbx call info

                                    {
    "status": "success",
    "url": "",
    "notifications": {
        "notify_start": "true",
        "notify_internal": "false",
        "notify_end": "true",
        "notify_out_start": "false",
        "notify_out_end": "false",
        "notify_answer": "false"
    }
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

cambiar url para pbx call info

                                    {
    "status": "success",
    "url": ""
}

Parámetros:

• url - enlace;
• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

modificar la reacción para el evento NOTIFY_* para pbx call info

                                    {
    "status": "success",
    "notifications": {
        "notify_start": "true",
        "notify_internal": "false",
        "notify_end": "true",
        "notify_out_start": "false",
        "notify_out_end": "false",
        "notify_answer": "false"
    }
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• notify_start - "true" o "false" parámetro opcional;
• notify_internal - "true" o "false" parámetro opcional
• notify_end - "true" o "false" parámetro opcional;
• notify_out_start - "true" o "false" parámetro opcional;
• notify_out_end - "true" o "false" parámetro opcional;
• notify_answer - "true" o "false" parámetro opcional.

eliminar url para pbx call info

                                    {
    "status": "success",
    "url": ""
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

crear centralita virtual

                                    {
    "status": "success",
    "stop_datetime": "2021-12-31 23:59:59"
}

Parámetros:

• sip_id - SIP para vincular a la centralita, si no se asigna se selecciona el SIP libre (parámetro opcional);
• password - contraseña para la primera extensión de la centralita '100';
• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

obtener ajustes de pbx webhooks

                                    {
    "status": "success",
    "url": "",
    "hooks": {
        "number_lookup": "true",
        "call_tracking": "false",
        "sms": "true",
        "speech_recognition": "true"
    }
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

cambiar url para pbx webhooks

                                    {
    "status": "success",
    "url": ""
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• url - enlace a tu script con el código de verificación <?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?> al inicio del script.

modificar reacción para el evento para otras notificaciones (Actualización de contactos, Calltracking, SMS y Analítica de voz)

                                    {
    "status": "success",
    "hooks": {
        "number_lookup": "true",
        "call_tracking": "false",
        "sms": "true",
        "speech_recognition": "true"
    }
}

Parámetros:

• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste;
• number_lookup - "true" o "false" parámetro opcional;
• call_tracking - "true" o "false" parámetro opcional;
• sms - "true" o "false" parámetro opcional;
• speech_recognition - "true" o "false" parámetro opcional.

eliminar url para otras notificaciones (Actualización de contactos, Calltracking, SMS y Analítica de voz)

                                    {
    "status": "success",
    "url": ""
}

Параметры:

• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste.

visualización de las extensiones de la centralita virtual

                                    {
    "status":"success",
    "pbx_id":1234,
    "numbers": [
        100,
        101,
        ...
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <pbx_id>1234</pbx_id>
    <numbers>
        <value>100</value>
        <value>101</value>
        ...
    </numbers>
</answer>

donde

• pbx_id – id de la PBX del usuario;
• numbers –listado de extensiones.

estado online de las extensiones de la centralita virtual

                                    {
    "status":"success",
    "pbx_id":1234,
    "number":100,
    "is_online":"false"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <pbx_id>1234</pbx_id>
    <number>100</number>
    <is_online>false</is_online>
</answer>

donde

• pbx_id – PBX-id;
• number – extensión de la centralita virtual;
• is_online – estado online (true|false).

información sobre la extensión de la centralita

                                    {
    "status": "success",
    "pbx_id": 12345,
    "number": 100,
    "name": "Extension 100",
    "caller_id": "+44000000000",
    "caller_id_app_change": "true",
    "caller_id_by_direction": "false",
    "lines": "3",
    "ip_restriction": "1.1.1.1",
    "record_store": "For automatic speech recognition",
    "record_email": "email@server.com",
    "supervisor_status": 1
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <pbx_id>12345</pbx_id>
    <number>100</number>
    <name>Extension 100</name>
    <caller_id>+44000000000</caller_id>
    <caller_id_app_change>true</caller_id_app_change>
    <caller_id_by_direction>false</caller_id_by_direction>
    <lines>3</lines>
    <ip_restriction>1.1.1.1</ip_restriction>
    <record_store>For automatic speech recognition</record_store>
    <record_email>email@server.com</record_email>
   <supervisor_status>1</supervisor_status>
</answer>

donde:

• pbx_id – id de la centralita;
• number – extensión de la centralita;
• name – nombre a mostrar;
• caller_id – CallerID;
• caller_id_app_change – cambio de CallerID desde la aplicación (true|false);
• caller_id_by_direction – CallerID por destino (true|false);
• lines – número de líneas;
• ip_restriction – restricción de acceso mediante ip (false si no establecido);
• record_store – grabación de llamadas en la nube (Without recognition|For manual recognition|For automatic speech recognition|false);
• record_email – email para envío de grabación de llamadas (false si desactivado).

activación de la grabación de llamadas en la extension de la centralita virtual

                                    {
    "status":"success",
    "internal_number":100,
    "recording":"on",
    "email":"test@test.com",
    "speech_recognition":"all"
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <internal_number>100</internal_number>
    <recording>on</recording>
    <email>on</email>
    <speech_recognition>all</speech_recognition>
</answer>

Parámetros

• id – extensión de la centralita virtual;
• estado – estado: "on" - habilitar, "off" - deshabilitar, "on_email" - conectar solo la grabación al correo, "off_email" - deshabilitar solo la grabación al correo, "on_store" - habilitar solo la grabación al repositorio, "off_store" - deshabilitar solo la grabación al repositorio;
• email – (opcional) cambio de la dirección de correo electrónico a la que se envían las grabaciones de las llamadas. Puedes indicar hasta  3 direcciones de correo electrónico seguidas por comas. speech_recognition – (opcional) la modificación de ajustes de reconocimiento de voz: "all" - reconocer todo, "optional" - reconocer selectivo desde la estadística, "off" - desactivar.

crear extensión de centralita

                                    {
    "status": "success",
    "numbers": [
        {
            "number": 200,
            "password": "PASSWORD"
        },
        {
            "number": 201,
            "password": "PASSWORD"
        }
    ]
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• start_number - número de inicio 100 ...999 o "any" comenzar desde cualquier número disponible dentro de 100-999;
• quantity - cantidad de extensiones creadas;
• return_password - parámetro opcional, si 'true' en respuesta aparecerán contraseñas para extensiones ya creadas.

solicitud de contraseña para la extensión de la centralita, contraseña mostrada disponible por un periodo de tiempo determinado

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

Ejemplo de respuesta:

                                    {
    "status": "success",
    "pbx_id": 114,
    "number": 200,
    "password": "PASSWORD"
}

donde

• password - puede tener el valor de hidden si la contraseña no está disponible para mostrar

cambiar contraseña de la extensión

                                    {
    "status": "success",
    "pbx_id": 114,
    "number": 200
}

Parámetros:

• value - nueva contraseña;
• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

cambio de extensión de la centralita virtual

Parámetros

• supervisor_status - estado de supervisor, 0 - deshabilitado, 1 - habilitado;
• user_id - parámetro opcional, disponible para el uso de dealers y usuarios que han sido creados por éstos.

listado de archivos guardados en la centralita

cargar archivo

Parámetros:

• name - nombre del archivo,
• file - el archivo.

eliminar archivo por id

Parámetros:

• id - identificador del archivo

listado de IVR

                                    {
    "status": "success",
    "pbx_id": 114,
    "ivrs": [
        {
            "menu_id": "0",
            "title": "",
            "type": "file",
            "status": "on",
            "waitexten": 5,
            "auto_responder": {
                "status": "on",
                "waitexten": 1,
                "working_days": [
                    {
                        "day": "mon",
                        "is_active": true,
                        "begin": {
                            "hour": 9,
                            "minute": 0
                        },
                        "end": {
                            "hour": 18,
                            "minute": 0
                        }
                    },
                    {
                        "day": "tue",
                        "is_active": true,
                        "begin": {
                            "hour": 9,
                            "minute": 0
                        },
                        "end": {
                            "hour": 18,
                            "minute": 0
                        }
                    },
                    ...
                    {
                        "day": "sun",
                        "is_active": false
                    }
                ]
            },
            "dinner_status": "on",
            "dinner_time": {
                "begin": {
                    "hour": 12,
                    "minute": 0
                },
                "end": {
                    "hour": 13,
                    "minute": 0
                }
            }
        },
        {
            "menu_id": "1",
            "title": "Menu 1",
            "type": "readtext",
            "status": "off",
            "waitexten": 5,
            "auto_responder": {
                "status": "off",
                "waitexten": 1
            }
        },
        ...
    ]
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

crear IVR

                                    {
    "status": "success",
    "menu_id": 2
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• buy - 'true' - crear menú de pago.

eliminar IVR

                                    {
    "status": "success"
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• menu_id - ha de ser > 0.

listado de escenarios del IVR

                                    {
    "status": "success",
    "scenarios": [
        {
            "id": "132",
            "title": "-1",
            "push_button": -1,
            "first_sips": [
                "102"
            ],
            "second_sips": [],
            "second_sips_delay": 10,
            "third_sips": [],
            "third_sips_delay": 20
        },
        ...
    ]
}

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste;
• menu_id - ID menú/IVR.

crear escenario IVR

                                    {
    "status": "success",
    "menu_id": 0,
    "scenario_id": 2
}

Parámetros:

• push_button - aplicar el escenario al pulsar el botón: si el llamante no pulsa ningún botón responde el escenario sin pulsar, 0-9 - botones, 10 - contestador automático, 11-30 - escenarios adicionales;
• title - nombre;
• extension - extensión o extensiones separados por espacios o "fax";
• menu_id - ID menú/IVR;
• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.
• trigger_to_did_ext_lines - parámetro opcional. Indica en las llamadas a qué números se aplica el escenario. Puede contener el número o el listado de números a través de espacios;
• trigger_from_clid_numbers - parámetro opcional. Indica en las llamadas desde qué números se aplica el escenario. Puede contener el número o el listado de números a través de espacios.

modificación del escenario IVR

Cuerpo PUT de solicitud:

(Respuesta 1)

                                    Respuesta 1:
[
  "id": "630cb6b3dc666e947503a77a",
  "title": "Scenario 1",
  "queue_strategy": "off",
  "queue_announce_position": 0,
  "numbers": [
    [
      "number": 100,
      "delay": 0,
      "duration": 20
    ],
    [
      "number": 101,
      "delay": 20,
      "duration": 20
    ],
    [
      "number": 102,
      "delay": 40,
      "duration": 20
    ],
  ]
]

Descripción:

• id - ID del escenario;
• title - nombre;
• queue_strategy - estrategia de distribución de llamadas entre extensiones por turnos (off, random, roundrobin, leastrecent, rrmemory, fewestcalls)
• queue_announce_position - comunicar el número en la cola
• numbers - conjunto de extensiones
  • parámetros de espera y duración de la llamada en la extensión:
  • number - extensión o "fax";
  • delay - retraso de llamada en segundos
  • duration - duración de llamada en segundos

Descripción de estrategias de distribución de llamadas en la cola entre extensiones:

• off - cola desactivada
• random - distribuir al azar
• roundrobin - distribuir uniformemente, priorizar al que no ha hablado en tiempo, a tener en cuenta todas las llamadas
• leastrecent - distribuir uniformemente, priorizar al que no ha hablado en tiempo, a tener en cuenta solo las llamadas contestadas
• rrmemory - distribuir uniformemente, priorizar al que menos ha hablado, a tener en cuenta todas las llamadas
• fewestcalls - distribuir uniformemente, priorizar al que menos ha hablado, a tener en cuenta solo las llamadas contestadas Parámetros de retraso y duración de llamada de extensiones se usan solo con la cola de llamadas activada (queue_strategy : "off").

Respuesta: (Respuesta 2)

                                    Respuesta 2:

{"status": "success"}

Error: (Respuesta 3)

                                    Respuesta 3:

{"status": "error","message": "Wrong parameters!"}

eliminar escenario de IVR

                                    {
    "status": "success"
}

Parámetros:

• scenario_id - ID de escenario;
• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste.

obtener resultado de reconocimiento

                                    {        
    "status":"success",
    "lang":"en-EN",
    "recognitionStatus":"in progress",
    "otherLangs":["es-ES"],
    "words": [
        {
            "result": [
                {
                    "s": 0.02,
                    "e": 0.22,
                    "w": "word",
                },
                {
                    "s": 0.31,
                    "e": 0.56,
                    "w": "one",
                }
            ],
            "channel": 1
        }
    ],
    "phrases":[
        {
            "result": "word one",
            "channel": 1
        }
    ]
}

Parámetros:

• call_id – id único de la llamada, este ID se indica en el nombre del archivo con grabación de llamada (único para cada grabación en la estadística);;
• lang - idioma de reconocimiento (opcional);
• return - resultado a devolver. Opciones: words - palabras, phrases - frases. (opcional. por defecto phrases);
• alternatives - si devolver opciones alternativas. Opciones: 0 - no, 1 - sí. (не obligatorio. por defecto 0).

donde

• lang – idioma;
• recognitionStatus: estado de reconocimiento. Opciones:
  • in progress - en proceso de reconocimiento,
  • error - se ha producido un error en el reconocimiento,
  • recognized - reconocido
  • ready for recognize - grabación lista para el reconocimiento,
  • not available for recognize - grabación no disponible para el reconocimiento.
• result:
  • words - conjunto:
    • result - listado de palabras (conjunto):
      • s - hora inicio de palabra
      • e - hora fin de palabra
      • w - palabra
    • channel - número de canal
  • phrases - conjunto:
    • result - frase
    • channel - número de canal

ejecución del reconocimiento de la llamada en la estadística de la centralita, previamente debe haberse activado el reconocimiento de voz seleccionado en los ajustes de la extensión

                                    {
    "status":"success"
}

Parámetros:

• call_id – id único de llamada, este id se indica en el nombre del archivo con grabación de llamada (único para cada grabación en la estadística);
• lang - idioma de reconocimiento (opcional).

información sobre números directos del usuario

                                    {
    "status":"success",
    "info": [
        {
            "number":"442030000000",
            "status":"on",
            "country":"Great Britain",
            "description":"London",
            "number_name":null,
            "sip":00001,
            "sip_name":null,
            "start_date":"2015-01-01 18:14:44",
            "stop_date":"2016-02-11 18:14:40",
            "monthly_fee":2,
            "currency":USD,
            "channels":2,
            "autorenew":"true",
            "is_on_test":"false",
            "type":"common"
        },
    ...
    ]
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <info>
        <value>
            <number>442037691880</number>
            <status>on</status>
            <country>Великобритания</country>
            <description>Лондон</description>
            <number_name>null</number_name>
            <sip>00001</sip>
            <sip_name>Example</sip_name>
            <start_date>2015-01-01 18:14:44</start_date>
            <stop_date>2016-02-11 18:14:40</stop_date>
            <monthly_fee>2</monthly_fee>
            <currency>USD</currency>
            <channels>2</channels>
            <autorenew>true</autorenew>
            <is_on_test>false</is_on_test>
            <type>common</type>
        </value>
    ...
    </info>
</answer>

Parámetros

Dependiendo del tipo de número, ¡el conjunto de campos puede diferir! Descripción de los campos:

• number – número comprado del usuario;
• status – estado del número;
  • on - número activado;
  • parking - número desactivado (falta de pago) pero permanece en la cuenta 7 días y puede ser restablecido después de la recarga;
  • checking - número conectado, pagado, todos los documentos han sido cargados, a la espera de activación;
  • checking_upload - número conectado, pagado, a la espera de carga de documentos;
  • reserved_on - número reservado hasta el momento del pago;
  • reserved_checking - número reservado hasta el momento del pago, todos los documentos han sido cargados;
  • reserved_checking_upload -número reservado hasta el momento del pago, a la espera de carga de documentos;
• country – país;
• description – descripción: ciudad o tipo;
• number_name – "nombre" de número virtual (se crea por el usuario);
• sip – SIP vinculado al número;
• sip_name – "nombre" SIP, vinculado al número;
• start_date – fecha de compra del número por parte del usuario;
• stop_date – fecha de finalización del plazo de pago del número por parte del usuario;
• monthly_fee – coste del número;
• currency – moneda de coste del número;
• channels – número de líneas en el número;
• minutes – duración general de las llamadas entrantes en el mes actual (para revenue);
• autorenew – si está activado la extensión del plazo de vigencia del número;
• is_on_test – si el número se encuentra en fase de pruebas;
• type – tipo de número: common (número virtual), rufree (número moscovita gratuito), order (reservado pero no conectado)

información sobre el número conectado

                                    {
    "status": "success",
    "info": {
    "number": "35924913550",
        "status": "on",
        "country": "Bulgaria",
        "description": "Sofia",
        "number_name": "TT",
        "sip": "00004",
        "sip_name": "SIP",
        "start_date": "2016-06-08 14:32:17",
        "stop_date": "2016-06-29 10:52:18",
        "monthly_fee": 2,
        "currency": "USD",
        "channels": "2",
        "autorenew": "true",
        "receive_sms": null,
        "is_on_test": "false"
    }
}

Parámetros

• number - número;

estado de autorenovación

                                    {
    "status": "success",
    "number": "35924913550",
    "autoprolongation": "on"
}

Parámetos

• number - número.

recepción de información sobre el error de verificación de documentos o dirección

                                    {
   "status":"success",
   "info":{
      "wrong_document":{
         "document_type":"contract",
         "message":"The passport has expired. It is considered invalid."
      },
      "wrong_address":{
         "message":"Invalid address"
      }
   }
}

Parámetros

• group_id - id del grupo de documentos.

modificar el estado de autorenovación

                                    {
    "status": "success",
    "number": "35924913550",
    "autoprolongation": "off"
}

Paámetros

• number - número;
• value - nuevo estado de autorenovación, on o off.

listado de países en los que se puede conectar el número

                                    {
    "status": "success",
    "info": [
        {
            "countryCode": "61",
            "countryCodeIso": "AU",
            "name": "Australia"
        },
        ...
    ]
}

Parámetros

• language - opcional, si no está establecido devolverá en el idioma del área personal.

listado de destinos en el país en el que se puede conectar el número

                                    {
    "status": "success",
    "info": [
        {
            "id": "3753",
            "countryCode": "49",
            "areaCode": "800",
            "name": "800 number (Toll-free)",
            "connect_fee": 0,
            "monthly_fee": 15,
            "currency": "USD",
            "restrictions": {
                "upload": [
                    "Certificate of registration copy or passport or ID copy (both sides)",
                    "Proof of address (a copy of utility bill no older than of 6 months) - 
                    your current address (city, street, number and postal code). 
                    The address must be located in the country of ordered phone number"
                ]
            },
            "receive_sms": "false",
            "is_toll": "true",
            "feature": "Available from all networks"
            "connect_time": "0"
        },
        {
            "id": "3766",
            "countryCode": "49",
            "areaCode": "821",
            "name": "Augsburg",
            "connect_fee": 3,
            "monthly_fee": 3,
            "currency": "USD",
            "restrictions": {
                "upload": [
                    "Passport or ID copy (both sides)"
                ],
                "specify": [
                    "You current address (city, street, number and postal code). 
                    The address must be located in the region of the city 
                    where you ordered the phone number"
                ]
            },
            "receive_sms": "false",
            "is_toll": "false",
            "feature": null,
            "connect_time": "0"
        },
        ...
    ]
}

Parámetros

• language - opcional, si no está estableciso devolverá en el idioma del área personal;
• country - código iso del país (ISO 3166-1 alpha-2).

configuración del Nombre del Número (caracteres latinos y hasta 30 dígitos)

                                    {
    "status": "success",
    "number": "+44000000000",
    "caller_name": "test"
}

Parámetros

• number - número;
• caller_name - para eliminar simplemente pasar el campo vacío.

vinculación del número al sip o activación del modo de pruebas

                                    {
    "status": "success",
    "number": "+44000000000",
    "sip_id": "00001"
}

Parámetros

• number - número;
• sip_id - sip o dirección del servidor externo (SIP URI);
• test_mode - opcional, (on|off) - para activar el modo de pruebas.

números disponibles para conectar

                                    {
    'status': 'success',
    'numbers': [
        {
            'id': 1712p0D1643D0t42r198658,
            'direction_id': 13755,
            'number': '+44000000001'
        },
        {
            'id': 184bdf85006c3f1676be200,
            'direction_id': 13755,
            'number': '+44000000000'
        },
        ...
    ]
}

Parámetros:

• DIRECTION_ID - ID del destino;
• mask - parámetro opcional, para la búsqueda de coincidencia por números.

pedido/compra del número

                                    {
    'status': 'success',
    'number': '+44000000000',
    'is_reserved': 'false',
    'is_activated': 'true'
}

Parámetros:

• number_id - ID del número solicitado, obtenido por el método GET /v1/direct_numbers/available/<DIRECTION_ID>/ por ejemplo: 1712p0D1643D0t42r198658 (si la selección del número está ausente el parámetro no se usa);
• direction_id - ID destino/ciudad;
• documents_group_id - ID del grupo de documentos del usuario;
• purpose - descripción de texto del propósito del uso del número (solo si se requiere);
• receive_sms - 1 - activación de recepción de SMS (solo si el número soporta la recepción de SMS);
• period - 'month' - un mes, '3month' - tres meses (parámetro opcional, la recepción de SMS se activa en números conectados por un periodo mínimo de 3 meses);
• autorenew_period - parámetro opcional, periodo de renovación (year, month), de éste depende la cuota mensual del número, por defecto month;
• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste.

extensión del número por un determinado periodo de meses

                                    {
    'status': 'success',
    'number': '+44000000000',
    'stop_date': '2021-05-01 12:00:00',
    'total_paid': {
        'amount': 2,
        'currency': 'USD'
    }
}

Parámetros:

• number - número a extender;
• months - cantidad de meses;
• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste.

activación de recepción de SMS (solo si el número soporta la recepción de SMS)

                                    {
    "status": "success", 
    "number": "", 
    "receive_sms": "on"
}

Parámetros:

• number - número
• value - valor (puede ser "on" u "off")
• documents_group_id - parámetro opcional, ID del grupo de documentos de la cuenta
• user_id - parámetro opcional, disponible para el uso de dealers y usuarios que han sido creados por éstos

listado de archivos/documentos en el grupo de documentos

                                    {
    "status": "success",
    "documents": [
        {
            "type": "passport",
            "is_verified": "true",
            "source": "upload",
            "name": "file1.jpg"
        },
        {
            "type": "receipt",
            "is_verified": "false",
            "source": "upload",
            "name": "file2.jpg"
        }
    ]
}

Parámetros:

• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste;
• group_id - parámetro opcional, ID del grupo de documentos, (0 o si no está determinado - grupo de documentos principal).

listado de grupo de documentos

                                    {
    "status": "success",
    "groups": [
        {
            "id": 0,
            "email": "email@server.com",
            "salutation": 'MR',
            "nationality": null,
            "first_name": "John",
            "middle_name": "Richard",
            "last_name": "Smith",
            "organization": "Company",
            "organization_description": null,
            "organization_reg_number": null,
            "country": "DE",
            "region": "",
            "city": "Berlin",
            "address": "Brudden Strasse 8, 76611",
            "zip_code": '76611',
            "street": 'Brudden Strasse',
            "street_code": null,
            "municipality_code": null,
            "building_number": "8",
            "building_letter": null,
            "phone": "4900000000",
            "type_of_id": "",
            "id_number": "123000099",
            "issuing_authority": null,
            "issuing_date": null,
            "is_readonly": true
        }
    ]
}

Parámetros:

• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste.

datos de un grupo determinado

                                    {
    "status": "success",
    "group": {
        "id": 0,
        "email": "email@server.com",
        "salutation": 'MR',
        "nationality": null,
        "first_name": "John",
        "middle_name": "Richard",
        "last_name": "Smith",
        "organization": "Company",
        "organization_description": null,
        "organization_reg_number": null,
        "country": "DE",
        "region": "",
        "city": "Berlin",
        "address": "Brudden Strasse 8, 76611",
        "zip_code": '76611',
        "street": 'Brudden Strasse',
        "street_code": null,
        "municipality_code": null,
        "building_number": "8",
        "building_letter": null,
        "phone": "4900000000",
        "type_of_id": "",
        "id_number": "123000099",
        "issuing_authority": null,
        "issuing_date": null,
        "is_readonly": true
    }            
}

Parámetros:

• ID - ID de grupo, 0 - grupo de documentos principal;
• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste.

verificación: si el grupo de documentos sirve para una determinada ciudad/destino

                                    {
    "status": "success",
    "is_information_match": "true",
    "is_documents_uploaded": "true",
    "is_documents_verified": "true",
    "is_address_match": "true"
}

Parámetros:

• ID - ID de grupo, 0 - grupo de documentos principal;
• user_id - parámetro opcional, disponible para el uso de socios o usuarios creados por éste;
• direction_id - ID de destino/ciudad.

crear un nuevo grupo de documentos

                                    {
    "status": "success",
    "group": {
        "id": 0,
        "email": "email@server.com",
        "salutation": 'MR',
        "nationality": null,
        "first_name": "John",
        "middle_name": "Richard",
        "last_name": "Smith",
        "organization": "Company",
        "organization_description": null,
        "organization_reg_number": null,
        "country": "DE",
        "region": "",
        "city": "Berlin",
        "address": "Brudden Strasse 8, 76611",
        "zip_code": '76611',
        "street": 'Brudden Strasse',
        "street_code": null,
        "municipality_code": null,
        "building_number": "8",
        "building_letter": null,
        "phone": "4900000000",
        "type_of_id": "",
        "id_number": "123000099",
        "issuing_authority": null,
        "issuing_date": null,
        "is_readonly": true
    }            
}

Parámetros:

• user_id - parámetro opcional, disponible para el uso de socio o usuarios creados por éste.
• email - email;
• salutation - saludo 'MR', 'MS', 'COMPANY';
• nationality - nacionalidad, código iso2 del país;
• first_name - nombre;
• middle_name - parámetro opcional, segundo apellido;
• last_name - primer apellido;
• date_of_birth - parámetro opcional, fecha de nacimiento;
• organization - parámetro opcional, nombre de empresa/organización;
• organization_description - parámetro opcional, descripción de actividad de empresa;
• organization_reg_number - parámetro opcional, número de registro de empresa;
• country - país, código iso2 del país;
• region - parámetro opcional, provincia/región;
• city - ciudad;
• address - dirección completa;
• zip_code - código postal;
• street - calle;
• street_code - parámetro opcional, código de calle, solo para Dinamarca;
• municipality_code - parámetro opcional, código de municipio, solo para Dinamarca;
• building_number - número;
• building_letter - parámetro opcional, letra;
• phone - número de teléfono de contacto;
• type_of_id - parámetro opcional, tipo de documento: "PASSPORT", "DNI", "NIE", "RESIDENCE_PERMIT", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION";
• id_number - parámetro opcional, número del documento;
• issuing_authority - parámetro opcional, autoridad de expedición;
• issuing_date - parámetro opcional, fecha de expedición;
• direction_id - parámetro opcional, ID de destino/ciudad para verificar el cumplimiento.

actualización de datos de grupos de documentos

                                    {
    "status": "success",
    "group": {
        "id": 0,
        "email": "email@server.com",
        "salutation": 'MR',
        "nationality": null,
        "first_name": "John",
        "middle_name": "Richard",
        "last_name": "Smith",
        "organization": "Company",
        "organization_description": null,
        "organization_reg_number": null,
        "country": "DE",
        "region": "",
        "city": "Berlin",
        "address": "Brudden Strasse 8, 76611",
        "zip_code": '76611',
        "street": 'Brudden Strasse',
        "street_code": null,
        "municipality_code": null,
        "building_number": "8",
        "building_letter": null,
        "phone": "4900000000",
        "type_of_id": "",
        "id_number": "123000099",
        "issuing_authority": null,
        "issuing_date": null,
        "is_readonly": true
    }            
}

Parámetros:

• user_id - parámetro opcional, disponible para el uso de socio o usuarios creados por éste.
• email - email;
• salutation - saludo 'MR', 'MS', 'COMPANY';
• nationality - nacionalidad, código iso2 del país;
• first_name - nombre;
• middle_name - parámetro opcional, segundo apellido;
• last_name - primer apellido;
• date_of_birth - parámetro opcional, fecha de nacimiento;
• organization - parámetro opcional, nombre de empresa/organización;
• organization_description - parámetro opcional, descripción de actividad de empresa;
• organization_reg_number - parámetro opcional, número de registro de empresa;
• country - país, código iso2 del país;
• region - parámetro opcional, provincia/región;
• city - ciudad;
• address - dirección completa;
• zip_code - código postal;
• street - calle;
• street_code - parámetro opcional, código de calle, solo para Dinamarca;
• municipality_code - parámetro opcional, código de municipio, solo para Dinamarca;
• building_number - número;
• building_letter - parámetro opcional, letra;
• phone - número de teléfono de contacto;
• type_of_id - parámetro opcional, tipo de documento: "PASSPORT", "DNI", "NIE", "RESIDENCE_PERMIT", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION";
• id_number - parámetro opcional, número del documento;
• issuing_authority - parámetro opcional, autoridad de expedición;
• issuing_date - parámetro opcional, fecha de expedición;
• direction_id - parámetro opcional, ID de destino/ciudad para verificar el cumplimiento.

cargar archivo para el grupo de documentos

Parámetros:

• user_id - parámetro opcional, disponible para uso de socios o usuarios creados por éste. ;
• group_id - ID de grupo, 0 - grupo de documentos principal;
• document_type - tipo de documento: 'certificate', 'contract', 'company_letter', 'inn_ua', passport', 'phone_bill', 'photo_with_doc', 'photo_with_passport', 'receipt', 'driver_id_us_ca', 'driver_id_other';
• file - uploaded file.

Ejemplo de solicitud:

                                    $zd = new \Zadarma_API_Test\Api(KEY, SECRET);
$zd->request(
    'documents/upload',
    [
        'group_id' => 0,
        'document_type' => 'passport',
        'file' => new CURLFile('passport.jpg', 'image/jpeg', 'passport.jpg')
    ],
    'post'
);

Ejemplo de respuesta:

                                    {
    "status": "success",
    "message": "The File passport.jpg has been successfully uploaded to the website.",
    "doc_name": "passport.jpg"
}

información sobre la cuenta de socio

                                    {
    "status": "success",
    "balance": 123,
    "credit": 0,
    "currency": "USD",
    "reseller_fee": 10,
    "user_fee": 10
}

Transferir saldo desde la cuenta del socio al balance de otra cuenta relacionada o viceversa

                                    {
    "status": "success",
    "user": {
        "balance": "62.0000",
        "currency": "EUR"
    },
    "reseller": {
        "balance": "94.825",
        "currency": "USD"
    }
}

Parámetros

• amount - importe;
• currency - divisa;
• type - destino de transferencia "to_reseller" y "to_user".

Listado de números de teléfono de contacto de usuario

                                    {
    "status": "success",
    "list": [
        {
            "id": 0,
            "number": "49025000897",
            "is_proved": false
        }
    ]
}

Parámetros

• user_id - id de usuario;

Añadir número de teléfono de contacto de usuario

                                    {
    "status": "success",
    "id": 98,
    "number": "359000000001",
    "is_proved": true
}

Parámetros

• user_id - id usuario;
• number - número.

Editar número de teléfono de usuario

                                    {
    "status": "success",
    "id": 99,
    "number": "359000000002",
    "is_proved": false
}

Parámetros

• user_id - id usuario;
• id - ID del número, 0 - número de teléfono principal del perfil;
• number - número.

Solicitud de confirmación del número de teléfono de contacto de usuario

                                    {
    "number": "359000000002",
    "status": "success",
    "message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}

Parámetros

• user_id - id usuario;
• number - número.
• confirm_number_reuse - confirmación del número que se usa en otra cuenta (parámetro opcional)

Solicitud de confirmación del número de contacto del usuario (será realizada una llamada y al contestar el cliente recibirá el código de confirmación)

                                    {
    "number": "359000000002",
    "status": "success",
    "message": "You were sent an SMS message with a code. Code is valid for 1 hour."
}

Parámetros:

• user_id - parámetro obligatorio, id del usuario;
• number - parámetro obligatorio, número a confirmar (en formato internacional)
• caller_id - número mostrado en una llamada, disponibles solo los números conectados en el sistema;
• language - idioma reproducido
• sip_id - parámetro opcional, si no se selecciona se escogerá el primer SIP de dealer,
• confirm_number_reuse - parámetro opcional, confirmación del número que se usa en otra cuenta

Confirmación del número de contacto por código de SMS

                                    {
    "status": "success",
    "message": "Your number confirmed!",
    "number": "35900000019"
}

Parámetros

• user_id - id de usuario;
• number - número.
• code - código de confirmación.

Registro de usuario

                                    {
    "status": "success",
    "user_id": 12345,
    "message": "You registered a new user in the system."
},{
    "status": "success",
    "message": "You registered a new user in the system. A registration confirmation link was sent to the email address you provided. To activate the account the user needs to click on that link, after which they can log in on the website."
},{
    "status": "success",
    "message": "You registered a new user in the system. A registration confirmation code was sent to the email address you provided. To activate the account the user needs to send code to you, after which you can confirm registration using API."
}

Parámetros

• email - correo electrónico del cliente;
• first_name - nombre del cliente;
• last_name - parámetro opcional;
• middle_name - parámetro opcional;
• organization - parámetro opcional;
• country - código ISO2 del país;
• city;
• address - parámetro opcional;
• phone - parámetro opcional;
• password - parámetro opcional;
• tariff - ID de la tarifa, (ID se puede obtener mediante el método GET /v1/info/lists/tariffs/) ;
• tariff_period - parámetro opcional, periodo de tarifa month | year;
• language - parámetro opcional, código de idioma, en;
• currency - parámetro opcional, código de divisa, USD;
• promocode - parámetro opcional, código promocional;
• gmt - parámetro opcional, GMT;
• id_card - parámetro opcional, número del documento de DNI, pasaporte.

Confirmar registro de usuario

                                    {
    "status": "success",
    "user_id": 12345
}

Parámetros

• code - código desde el email enviado por correo electrónico al usuario;
• email - dirección de email.

Listado de usuarios de socio por página (50)

                                    {
    "status": "success",
    "total": 205,
    "total_pages": 5,
    "page": 1,
    "users": [
        {
            "id": "1234",
            "email": "test@domain.com",
            "first_name": "Test",
            "last_name": "Test",
            "organization": "",
            "phone": "+44000000001",
            "created": "2021-01-26 14:21:04",
            "last_login": "2021-01-30 09:46:31",
            "balance": "0.4000",
            "currency": "GBP",
            "sips_count": "1",
            "is_active": true,
            "allow_topup": true,
            "allow_api_requests": true
        },
        ...
    ]
}

Parámetros

• page - número de página.

Buscar una cuenta por criterios (uno de los id, email, sip)

                                    {
    "status": "success",
    "user": {
        "id": "1234",
        "email": "test@domain.com",
        "first_name": "Test",
        "last_name": "Test",
        "organization": "",
        "phone": "+44000000001",
        "created": "2021-01-26 14:21:04",
        "last_login": "2021-01-30 09:46:31",
        "balance": "0.4000",
        "currency": "GBP",
        "sips_count": "1",
        "is_active": true,
        "allow_topup": true,
        "allow_api_requests": true
    }
}

Parámetros

• id - optional;
• sip - optional;
• email - optional.

Transferir saldo del socio al balance de usuario de la cuenta

                                    {
    "status": "success",
    "user_topup": {
        "amount": 10,
        "currency": "GBP"
    },
    "reseller_withdraw": {
        "amount": 10,
        "currency": "GBP"
    }
}

Parámetros

• user_id - id del usuario;
• amount- importe;
• currency - divisa.

Obtener actuales claves de acceso de usuario para API

                                    {
    "status": "success",
    "user_id": 1234,
    "last_request_datetime": "2021-02-18 10:45:01",
    "allow_reset": true,
    "key": "hidden",
    "secret": "hidden"
},{
    "status": "success",
    "user_id": 1234,
    "last_request_datetime": "2021-02-26 15:59:50",
    "allow_reset": false,
    "key": "abscd",
    "secret": "12345"
}

Parámetros

• user_id id del usuario.

Obtener nuevas claves de acceso de usuario para API

                                    {
    "status": "success",
    "user_id": 1234,
    "key": "abscd",
    "secret": "12345"
}

Parámetros

• user_id - id del usuario.

obtener clave para el widget webrtc. Tiempo de vida de clave - 72 horas.

                                    {
    "status":"success",
    "key": YOUR_KEY
}

                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <key>YOUR_KEY</key>
</answer>

Parámetros:

• sip – login del SIP o de la extensión de la centralita.

Crear integración del widget WebRTC

                                    {
    "status": "success"
}

Parámetros

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos;
• domain - nombre del dominio.

Modificar ajustes la integración del widget WebRTC

                                    {
    "status": "success"
}

Parámetros

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos;
• shape - forma del widget, valores posibles: 'square', 'rounded';
• position - ubicación del widget, valores posibles: 'top_left', 'top_right', 'bottom_right', 'bottom_left'.

Datos de la integración del widget WebRTC

                                    {
    "status": "success",
    "is_exists": true,
    "domains": [
        "test.domain.com"
    ],
    "settings": {
        "shape": "square",
        "position": "top_right"
    }
}

Параметры

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos;

Añadir dominio de la integración del widget WebRTC

                                    {
   "status": "success"
}

Parámetros

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos;
• domain - nombre del dominio.

Eliminar dominio de la integración del widget WebRTC

                                    {
   "status": "success"
}

Parámetros

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos;
• domain - nombre del dominio.

Eliminar la integración del widget WebRTC

                                    {
   "status": "success"
}

Parámetros

• user_id - parámetro opcional, disponible para ser usado por socios o usuarios creados por éstos.

Listado de dispositivos soportados para eSIM

Descripción de respuesta de éxito (Respuesta 1)

                                    Respuesta 1:
{
    "status": "success",
    "devices": {
        "acer": [
            "ACER Swift 3",
            "ACER Swift 7"
        ],
        "asus": [
            "ASUS Mini Transformer T103HAF",
            "ASUS NovaGo TP370QL",
            "ASUS Vivobook Flip 14 TP401NA"
        ],
        "xiaomi": [
            "Xiaomi 12T Pro",
            "Xiaomi 13 Lite"
        ]
    }
}

• devices (оbject[]) — listado de dispositivos agrupados por marca

  Descripción de respuesta en caso de error interno (Respuesta 2)

                                      Respuesta 2:
  {
    "status": "error",
    "message": "Getting devices internal error"
  }

• message (string) — contiene el mensaje del error

Listado de los paquetes disponibles

Descripción de respuesta de éxito (Respuesta 1)

                                    Respuesta 1:
{
  "status": "success",
  "packages": [
    {
      "duration": 7,
      "countries": [
        {
          "iso2": "cn",
          "name": "China",
          "aliases": []
        }
      ],
      "networks": [
        {
          "iso2": "CN",
          "network": "China Unicom",
          "type": "LTE"
        }
      ],
      "region": null,
      "id": "1-cn-7days-1gb",
      "price": 5,
      "data": 1,
      "duration_unit": "days",
      "data_unit": "GB",
      "top_up": true,
      "kyc_verify": false,
      "activation_policy": "first-usage",
      "activation_limit_days": null,
      "price_multi_currency": {
        "eur": 5,
        "usd": 5,
        "gbp": 4,
        "pln": 19,
        "kzt": 2000,
        "uah": 200
      },
    }
  ]
}

• packages (object[]) — listado de paquetes disponibles
• packages.*.duration (integer) — fecha de vigencia de eSIM. La unidad del valor se encuentra en el parámetro duration_unit
• packages.*.countries (object[]) — listado de países donde funciona la red de eSIM
• packages.*.networks (object[]) — listado de países donde funciona el Internet móvil de eSIM
• packages.*.region (null|string, europe|america|latin-america|asia|caribbean-islands|africa|south-africa|middle-east|oceania|iberica|scandinavia|eastern-europe) — región en la que funciona eSIM
• packages.*.id (string) — identificador interno de eSIM
• packages.*.price (float) — precio de eSIM
• packages.*.data (integer) — volumen de tráfico disponible. La unidad del valor se encuentra en el parámetro data_unit
• packages.*.duration_unit (string, days) — la unidad de valor de vigencia del parámetro duration
• packages.*.data_unit (string, GB|KB|MB) — la unidad de valor de tráfico del parámetro data
• packages.*.top_up (boolean) — contiene el valor de true si la eSIM está disponible para recargar
• packages.*.kyc_verify (boolean) — signo de la presencia de verificación de documentos para la compra de eSIM
• packages.*.activation_policy (null|string, first-usage|installation) — política de activación. Si tiene el valor "first-usage" se activará tras el primer uso. Si tiene el valor "installation" se activará en el momento de configuración de la eSIM en el dispositivo. Si null, no tiene política de actividad
• packages.*.price_multi_currency (object) — objeto de precios en cada divisa
• packages.*.activation_limit_days (null|integer) — Puede contener el número de días disponibles para activar la eSIM después de la conexión. En caso de null no tiene restricciones

Descripción de respuesta en caso de error interno (Respuesta 2)

                                    Respuesta 2:
{
  "status": "error",
  "message": "Getting packages error"
}

• message (string) — contiene el mensaje del error

Listado de paquetes activados

Parámetros

• user_id (integer)
  Campo opcional
  ID del usuario solicitado. Disponible solo para el uso de dealers y solo para usuarios que han sido creados por éste. Por defecto se aplicará el ID actual del usuario

Descripción de respuesta de éxito (Respuesta 1)

                                    Respuesta 1:
{
  "status": "success",
  "orders": [
    {
      "iccid": "8937204017175532566",
      "status": "inactive",
      "packages": [
        {
          "iccid": "8937204017175532566",
          "price": 4.5,
          "currency": "USD",
          "countries": [
            {
              "iso2": "al",
              "name": "Albania",
              "aliases": []
            }
          ],
          "duration": 30,
          "data": 1,
          "region": null,
          "id": "3-al-30days-1gb",
          "data_remaining": 1,
          "top_up": true,
          "created_at": 1730978058,
          "auto_prolong": false,
          "activated_at": null,
          "expired_at": null,
          "reference_id": "672ca10a84a28e977c0cfe39"
        }
      ],
      "title": null,
      "msisdn": null,
      "activation_code": "LPA:1$smdp.io$K2-2627GZ-1UM3Z3Y",
      "created_at": 1730978058
    }
  ]
}

• orders (оbject[]) — listado de paquetes conectados. Más información sobre los paquetes en el método/v1/esim/order/<iccid>/

Descripción de respuesta en caso de user_id incorrecto (Respuesta 2)

                                    Respuesta 2:
{
    "status": "error",
    "message": "You are not a reseller of the requested user"
}

• message (string) — contiene el mensaje del error

Información sobre el paquete activado por iccid

Parámetros

• iccid (string)
  Campo obligatorio
  ICCID solicitado
• user_id (integer)
  Campo opcional
  ID del usuario solicitado. Disponible solo para el uso de dealers y solo para usuarios que han sido creados por éste. Por defecto se aplicará el ID actual del usuario

Descripción de respuesta de éxito (Respuesta 1)

                                    Respuesta 1:
{
  "status": "success",
  "order": {
    "iccid": "8937204017175532566",
    "status": "inactive",
    "packages": [
      {
        "iccid": "8937204017175532566",
        "price": 4.5,
        "currency": "USD",
        "countries": [
          {
            "iso2": "al",
            "name": "Albania",
            "aliases": []
          }
        ],
        "duration": 30,
        "data": 1,
        "type": "one-off",
        "region": null,
        "id": "3-al-30days-1gb",
        "data_remaining": 1,
        "top_up": true,
        "created_at": 1730978058,
        "auto_prolong": false,
        "activated_at": null,
        "expired_at": null,
        "reference_id": "672ca10a84a28e977c0cfe39"
      }
    ],
    "title": null,
    "msisdn": null,
    "activation_code": "LPA:1$smdp.io$K2-2627GZ-1UM3Z3Y",
    "created_at": 1730978058
  }
}

• order.iccid (string) — ICCID del paquete de eSIM
• order.status (string, active|inactive|archived|blocked) — estado del paquete — activo, inactivo, archivado y bloqueado
• order.packages (object[]) — paquetes conectados. Datos para éste se describen en el método /v1/esim/esim/packages
• order.packages.*.data_remaining (float) — volumen de tráfico disponible. La unidad de este valor se encuentra en el parámetro order.packages.*.data_unit
• order.packages.*.expired_at (null|integer) — timestamp si la eSIM ha expirado
• order.title (null|string) — nombre de uso de la eSIM adquirida
• order.msisdn (null|string) — MSISDN si existe
• order.activation_code (string) — clave para generar el código QR o configuración manual
• order.created_at (integer) — timestamp de conexión de eSIM

Descripción de respuesta en caso de enviar ICCID que no existe (Respuesta 2)

                                    Respuesta 2:
{
  "status": "error",
  "message": "Not found"
}

• message (string) — contiene el mensaje del error

Activar paquete

Parámetros

• package_id (string)
  Campo obligatorio
  ID del paquete a conectar, packages.*.id del método /v1/esim/packages/
• user_id (integer)
  Campo opcional
  ID del usuario para conectar. Disponible solo para el uso de dealers y solo para usuarios que han sido creados por éste. Por defecto se aplicará el ID actual del usuario

Descripción de respuesta de éxito (Respuesta 1)

                                    Respuesta 1:
{
    "status": "success",
    "order": {
        "iccid": "8937204016150824154",
        "activation_code": "LPA:1$smdp.io$K2-1UYQA7-Z8B3BF",
        "status": "inactive",
        "packages": [
            {
                "iccid": "8937204016150824154",
                "price": 11.01,
                "currency": "EUR",
                "countries": [
                    {
                        "iso2": "us",
                        "name": "США",
                        "aliases": []
                    }
                ],
                "duration": 30,
                "data": 0,
                "data_remaining": 0,
                "top_up": true,
                "type": "one-off",
                "region": "change",
                "created_at": 1720700977,
                "auto_prolong": false,
                "activated_at": null,
                "expired_at": null,
                "reference_id": null,
                "id": "3-change-30days-0gb"
            }
        ],
        "created_at": 1720700977,
        "title": null,
        "msisdn": null
    }
}

• order (оbject) — datos sobre el paquete conectado. Descripción detallada de respuesta en el método /v1/esim/order/<iccid>/

Descripción de respuesta con error en caso de falta de saldo (Respuesta 2)

                                    Respuesta 2:
{
  "status": "error",
  "message": "Not enough money on your account"
}

• message (string) — contiene el mensaje del error

Solicitud de verificación con envío de notificación al usuario

El tiempo de vida de la solicitud de verificación es de 10 minutos.

Parámetros generales (para todos los canales)

• channel (string, sms|call_code|email|call_button)
  Campo obligatorio
  Canal para el envío de mensaje

Descripción del canal "sms"

Se enviará un mensaje SMS con un código de confirmación al número del destinatario. El envío a través de este canal puede requerir un pago, por lo que el usuario de la API debe tener un saldo positivo.

Parámetros

• to (string)
  Campo obligatorio
  El número de teléfono del destinatario en formato E.164.

• code (integer)
  Campo opcional
  Código de verificación de seis dígitos. Si no se especifica, se genera automáticamente.

• language (string, en|es|de|pl|ru|ua|fr)
  Campo opcional
  Idioma del mensaje. Si no se especifica se usa el idioma del usuario.

• template_id (integer)
  Campo opcional
  ID de la plantilla del usuario para SMS. Si no se especifica se usa la plantilla por defecto.

• caller_id (string)
  Campo opcional
  Número del remitente. Por defecto "Teamsale"

Descripción del canal "call_code"

Si se selecciona este canal, se realizará una llamada al número del destinatario, durante la cual se le comunicará el código de confirmación. El envío a través de este canal puede requerir un pago, por lo que el usuario de la API debe tener un saldo positivo.

Requisitos

Para utilizar este canal, el usuario de la API debe tener un número registrado en el sistema Zadarma.

Parámetros

• to (string)
  Campo obligatorio
  El número de teléfono del destinatario en formato E.164.
• from (string)
  Campo opcional
  El número de teléfono en formato E.164 desde el que se realiza la llamada. Se requiere si el usuario cuenta con más de un número conectado en el sistema Zadarma
• code (integer)
  Campo opcional
  Código de verificación de seis dígitos. Si no se especifica, se genera automáticamente.
• language (string, en|es|de|pl|ru|ua|fr)
  Campo opcional
  Idioma del mensaje. Si no se especifica se usa el idioma del usuario.

Descripción del canal "email"

Al utilizar este canal, se enviará un correo electrónico con un código de confirmación a la dirección especificada. Para el envío a través de este canal, el usuario de la API debe tener activada la integración de correo electrónico en el sistema CRM Teamsale.

Параметры

• to (string)
  Campo obligatorio
  dirección de email del destinatario
• from (string)
  Campo opcional
  email del remitente. Se especifica si el usuario tiene activadas más de una integración de email.
• code (integer)
  Campo opcional
  Código de verificación de seis dígitos. Si no se especifica, se genera automáticamente.
• language (string, en|es|de|pl|ru|ua|fr)
  Campo opcional
  Idioma del mensaje. Si no se especifica se usa el idioma del usuario..
• email_subject (string)
  Campo opcional
  Asunto (subject) del correo enviado. Si el parámetro no se especifica, se utiliza el valor predeterminado.
• email_body (string)
  Campo opcional
  Cuerpo (body) del correo enviado. Debe contener la línea "{#code#}" para la sustitución automática del código de verificación. Si el parámetro no se especifica, se utiliza el valor predeterminado.

Descripción del canal "call_button"

Este canal consiste en una llamada al número del destinatario, durante la cual el usuario debe seguir las instrucciones de los archivos de audio y presionar el botón "1" para confirmar. El envío a través de este canal puede requerir un pago, por lo que el usuario de la API debe tener un saldo positivo.

Para el uso de este canal se requiere

• Un número de teléfono en el servicio de Zadarma.
• Centralita virtual activada.
• Configuración de notificación de eventos.

Particularidades: el resultado de verificación a través de este canal se verifica con la ayuda de NOTIFY_OUT_END webhook y no a través del método /v1/verify/check/.

Parámetros

• to (string)
  Campo obligatorio
  El número de teléfono del destinatario en formato E.164.
• from (string)
  Campo opcional
  El número de teléfono en formato E.164 desde el que se realiza la llamada. Se requiere si el usuario cuenta con más de un número en la centralita
• greeting_sound_id (string)
  Campo obligatorio
  ID del archivo de voz que oirá el usuario tras la respuesta
• button_1_sound_id (string)
  Campo obligatorio
  ID del archivo de voz que oirá el usuario tras pulsar el botón "1"
• fallback_sound_id (string)
  Campo obligatorio
  ID del archivo de voz que oirá el usuario si no se pulsa el botón "1", se pulsa cualquier otro botón o no realiza ninguna acción

  Para el manejo de los archivos de audio que se usan en los parámetros greeting_sound_id, button_1_sound_id y fallback_sound_id, usa los métodos API disponibles en el apartado /v1/pbx/ivr/sounds/*.

Ejemplos

Al enviar una solicitud con éxito a través de los canales sms, call_code, email (Respuesta 1)

                                    Respuesta 1:
{
    "status": "success",
    "request_id": "NDlLMWlNcW5mR3EvOFkraWVtOWF1Q2c9"
}

• request_id (string) — ID de la solicitud, se requerirá para la siguiente verificación del código de verificación

Al usar el canal call_button la respuesta de éxito no contiene request_id ya que la verificación del resultado se realiza a través de NOTIFY_OUT_END webhook (Respuesta 2)

                                    Respuesta 2:
{
    "status": "success"
}

En caso de una solicitud no válida, la API devuelve una respuesta con el estado error y una descripción del error en el campo message (Respuesta 3)

                                    Respuesta 3:
{
    "status": "error",
    "message": "\"to\" param is required"
}

Al enviar la solicitud a través del canal email, si el parámetro from es obligatorio pero no se indica, el sistema devolverá la respuesta con el estado "error" y mensaje que notifica la falta del parámetro requerido (Respuesta 4)

                                    Respuesta 4:
{
    "status": "error",
    "message": "Can't find active email integration for the \"from\" param's email"
}

Verificación del código en la solicitud de verificación para los canales sms, call_code y email

Parámetros

• code (integer)
  Campo obligatorio
  Código de seis dígitos que se debe verificar.
• request_id (string)
  Campo obligatorio
  ID de la solicitud en la que se requiere verificar el código

La descripción de la respuesta exitosa, si el parámetro code coincide con el que se encuentra en la solicitud de verificación (Respuesta 1)

                                    Respuesta 1:
{
    "status": "success",
    "message": "Code is correct"
}

• status (string) — contiene el valor "success"
• message (string) — contiene el valor "Code is correct"

La descripción de la respuesta con error si la solicitud ha expirado o no se ha encontrado por request_id: (Respuesta 2)

                                    Respuesta 2:
{
    "status": "error",
    "message": "No such request id"
}

• message (string) — contiene el mensaje del error

La descripción de la respuesta con error, si el parámetro code no coincide con el que se encuentra en la solicitud (Respuesta 3)

                                    Respuesta 3:
{
    "status": "error",
    "message": "Invalid verification code"
}

• message (string) — contiene el mensaje del error

Para comprobar el canal call_button se debe usar NOTIFY_OUT_END webhook

Devuelve el listado de clientes

Parámetros

• search (opcional) - barra de búsqueda. La búsqueda se realiza de forma combinada por:
  • del nombre de cliente
  • a números de teléfono de cliente
  • descripción del cliente
  • dirección y código postal
  • sitio web
  • e-mail
  • Messengers
  • nombres de empleados
  • números de teléfono de empleados
  • descripción de empleados
  • e-mail de empleados
  • Messengers de empleados
• filter (opcional) — filtro de clientes. Estructura del filtro:

(Respuesta 1)

                                    Respuesta 1:
{
  "status": "company",
  "type": "client",
  "country": "GB",
  "city": "London",
  "label": 12,
  "utm": 19,
  "employees_count": "50",
  "responsible": 20
}

donde:

• status — estado del cliente. Valores disponibles:
  • individual — persona física
  • company — empresa
• type — tipo de cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — реселлер
  • partner — colaborador
• country — país del cliente. Código de dos letras (ES, US, etc)
• city — ciudad del cliente (línea)
• label — etiqueta (identificador)
• employees_count — número de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• responsible — responsable (identificador del usuario)

Cualquiera de los parámetros del filtro se puede omitir, es decir, es opcional.

• sort (opcional) — clasificación de clientes. Estructura del parámetro:

(Respuesta 2)

                                    Respuesta 2:
{
    "attr": "name",
    "desc": 0
}

donde:

• attr — campo de clasificación. Valores disponibles:
  • name — nombre del cliente
  • status — estado del cliente
  • type — tipo del cliente
• desc — sentido de clasificación. Valores disponibles:
  • 0 — crecientes
  • 1 — decrecientes
  • take (para la muestra por página) — cuántos clientes devolver (por defecto 20)
  • skip (para la muestra por página) - cuántos clientes saltarse (por defecto 0)

Respuesta

(Respuesta 3)

                                    Respuesta 3:
{
  "totalCount": 82,
  "customers": [
    {
      "id": 65,
      "name": "Good company",
      "status": "company",
      "type": "client",
      "responsible_user_id": 20,
      "employees_count": "50",
      "comment": "",
      "country": "GB",
      "city": "London",
      "address": "",
      "zip": "",
      "website": "",
      "created_at": "2020-04-28 05:47:47",
      "created_by": 20,
      "lead_source": "manual",
      "lead_created_at": null,
      "lead_created_by": null,
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "good_company@example.com"
        }
      ],
      "labels": [
        {
          "id": 12,
          "label": "Best clients"
        }
      ],
      "utms": [
        {
          "id": 19,
          "param": "utm_source",
          "value": "google",
          "display_value": "Google"
        }
      ]
    }
  ]
}

donde:

• totalCount — número total de clientes (incluyendo la barra de búsqueda y el filtro)
• customers — conjunto de clientes (teniendo en cuenta la muestra por página). Cada elemento del conjunto contiene los siguientes parámetros:
  • id — identificador del cliente
  • name — nombre del cliente
  • status — estado del cliente. Valores posibles:
    • individual — persona física
    • company — empresa
  • type — tipo de cliente. Valores posibles:
    • potential — cliente potencial
    • client — cliente
    • reseller — agente
    • partner — colaborador
  • responsible_user_id — responsable (identificador del usuario)
  • employees_count — cantidad de empleados. Valores posibles:
    • 50 — inferior a 50
    • 50_250 — 50 – 250
    • 250_500 — 250 – 500
  • comment — descripción del cliente
  • country — país del cliente. Código de dos letras (ES, US, etc.)
  • city — ciudad del cliente
  • address — domicilio del cliente
  • zip — código postal
  • website — página web del cliente
  • created_at — fecha y hora de creación del cliente (en formato YYYY-MM-DD HH:mm:ss)
  • created_by — creado por (identificador del usuario)
  • lead_source — fuente. Valores posibles:
    • manual — manual
    • call_incoming — llamada entrante
    • call_outgoing — llamada saliente
    • form — forma
  • lead_created_at — fecha y hora de la creación del lead si el cliente ha sido creado a través del lead (en formato YYYY-MM-DD HH:mm:ss)
  • lead_created_by — por quien ha sido creado el lead si el cliente ha sido creado a través del lead (identificador del usuario)
    • type — tipo de número. Valores posibles:
      • work — de trabajo
      • personal — personal
    • phone — valor del número
  • contacts — conjunto de contactos del cliente. Cada contacto debe contener los siguientes campos:
    • type — tipo de contacto. Valores posibles:
      • email_work — e-mail de trabajo
      • email_personal — e-mail personal
      • skype
      • telegram
      • viber
      • whatsapp
    • value — valor del contacto
  • labels — conjunto de etiquetas asignadas al cliente. Cada etiqueta contiene los siguientes campos:
    • id — identificador de la etiqueta
    • label — valor de la etiqueta

Devuelve al cliente por su ID

Parámetros de dirección

• c_id — identificador del cliente

Respuesta

                                    {
  "id": 65,
  "name": "Good Company",
  "status": "company",
  "type": "client",
  "responsible_user_id": 20,
  "employees_count": "50",
  "comment": "",
  "country": "GB",
  "city": "London",
  "address": "",
  "zip": "",
  "website": "",
  "created_at": "2020-04-28 05:47:47",
  "created_by": 20,
  "lead_source": "manual",
  "lead_created_at": null,
  "lead_created_by": null,
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "good_company@example.com"
    }
  ],
  "labels": [
    {
      "id": 12,
      "label": "Best clients"
    }
  ],
  "utms": [
    {
      "id": 19,
      "param": "utm_source",
      "value": "google",
      "display_value": "Google"
    }
  ],
  "custom_properties": [
    {
      "id": 18,
      "key": "loyalty",
      "title": "Loyalty",
      "value": "high"
    }
  ]
}

donde:

• name — nombre del cliente
• status — estado del cliente. Valores posibles:
  • individual — persona física
  • company — empresa
• type — tipo de cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — agente
  • partner — colaborador
• responsible_user_id — responsable (identificador del usuario)
• employees_count — cantidad de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción del cliente
• country — país del cliente. Código de dos letras (ES, US, etc.)
• city — ciudad del cliente
• address — domicilio del cliente
• zip — código postal
• website — página web del cliente
• lead_source — fuente. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• lead_created_at — fecha y hora de la creación del lead si el cliente ha sido creado a través del lead (en formato YYYY-MM-DD HH:mm:ss)
• lead_created_by — por quien ha sido creado el lead si el cliente ha sido creado a través del lead (identificador del usuario)
• phones — conjunto de números de teléfono del cliente. Cada número debe contener los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto debe contener los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor del contacto
• labels — conjunto de etiquetas vinculadas al cliente. Cada etiqueta contiene los siguientes campos:
  • id — identificador de la etiqueta
  • label — valor de la etiqueta
• custom_properties — conjunto de propiedades adicionales. Cada propiedad adicional contiene los siguientes campos:
  • id — identificador de la propiedad adicional o:
  • key — nombre único de la propiedad adicional
  • value — valor de la propiedad adicional

Crea un nuevo cliente con los datos indicados

Parámetros

• customer — datos de nuevo cliente. Estructura de cliente:

(Respuesta 1)

                                    Respuesta 1:
{
    "name": "Good Company",
    "status": "company",
    "type": "client",
    "responsible_user_id": 20,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "phones": [
      {
        "type": "work", 
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 12 },
      { "id": 13 }
    ],
    "utms": [
      { "id": 19 },
      { "id": 20 }
    ],
    "custom_properties": [
      {
        "id": 18,
        "value": "high"
      }
    ]
}

donde:

• name — nombre del cliente
• status — estado del cliente. Valores posibles:
  • individual — persona física
  • company — empresa
• type — tipo de cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — agente
  • partner — colaborador
• responsible_user_id — responsable (identificador del usuario)
• employees_count — cantidad de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción del cliente
• country — país del cliente. Código de dos letras (ES, US, etc.)
• city — ciudad del cliente
• address — domicilio del cliente
• zip — código postal
• website — página web del cliente
• lead_source — fuente. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• phones — conjunto de números de teléfono. Cada número debe contener los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto debe contener los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor del contacto
• labels — conjunto de etiquetas añadidas al clientes. Cada elemento debe contener:
  • id — identificador de la etiqueta existente
• custom_properties — conjunto de propiedades adicionales. Cada elemento debe contener:
  • id — identificador de la propiedad adicional o:
  • key — nombre único de la propiedad adicional
  • value — valor de la propiedad adicional

Respuesta:

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 65
}

donde:

• id — Identificador del cliente creado.

Actualiza al cliente existente con el ID indicado

Parámetros de dirección

• c_id — identificador del cliente

Parámetros

• customer — nuevos datos del cliente. Estructura del cliente:

                                    {
    "name": "Good Company",
    "status": "company",
    "type": "client",
    "responsible_user_id": 20,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 12 },
      { "id": 13 }
    ],
    "utms": [
      { "id": 19 },
      { "id": 20 }
    ],
    "custom_properties": [
      {
        "id": 18,
        "value": "high"
      }
    ]
}

donde:

• name — nombre del cliente
• status — estado del cliente. Valores posibles:
  • individual — persona física
  • company — empresa
• type — tipo del cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — agente
  • partner — colaborador
• responsible_user_id — responsable (identificador del usuario)
• employees_count — número de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción del cliente
• country — país del cliente. Código de dos letras (ES, US, etc.)
• city — ciudad del cliente
• address — domicilio del cliente
• zip — código postal
• website — página web del cliente
• lead_source — fuente. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• phones — conjunto de números de teléfono. Cada número debe contener los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto contiene los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor del contacto
• labels — conjunto de etiquetas añadidas al cliente. Cada elemento debe contener:
  • id — identificador de la etiqueta existente
• custom_properties — conjunto de parámetros adicionales. Cada elemento debe contener:
  • id — identificador de la propiedad adicional o:
  • key — nombre único de la propiedad adicional
  • value — valor de la propiedad adicional

Elimina el cliente por su ID

Parámetros de dirección

• c_id — identificador del cliente

Muestra el conjunto de todas las etiquetas de fuente y su estadística

Respuesta

                                    [
  {
    "id": 78,
    "param": "utm_source",
    "value": "google",
    "display_value": "Google",
    "count": 1267
  }
]

Donde cada etiqueta de analítica contiene los siguientes campos:

• id — identificador de etiqueta de fuente
• param — tipo de etiqueta de fuente. Valores posibles:
  • utm_source
  • utm_medium
  • utm_campaign
  • utm_content
  • phone — teléfono
  • custom — libre
• value — valor real de la etiqueta de fuente
• display_value — valor mostrado de la etiqueta de fuente
• count — número de clientes y clientes potenciales que utilizan esta etiqueta de fuente

Agrega una nuevo etiqueta de fuente

Parámetros

• utm — datos de la nueva etiqueta de fuente. Estructura de la etiqueta:

(Respuesta 1)

                                    Respuesta 1:
{
  "param": "utm_source",
  "value": "google",
  "display_value": "Google"
}

Donde:

• param — tipo de etiqueta de fuente. Valores posibles:
  • utm_source
  • utm_medium
  • utm_campaign
  • utm_content
  • phone — teléfono
  • custom — libre
• value — valor real de la etiqueta de fuente
• display_value (opcional) — valor mostrado de la etiqueta de fuente

Respuesta

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 78
}

Donde:

• id — identificador de etiqueta de fuente

Actualiza la etiqueta de fuente existente con el ID indicado

Parámetros de la dirección

• utm_id — identificador de etiqueta de fuente

Parámetros

• utm — nuevos datos de la etiqueta de fuente. Estructura de etiqueta de fuente:

                                    {
  "param": "utm_source",
  "value": "google",
  "display_value": "Google"
}

Donde:

• param — tipo de etiqueta de fuente. Valores posibles:
  • utm_source
  • utm_medium
  • utm_campaign
  • utm_content
  • phone — teléfono
  • custom — libre
• value — valor real de la etiqueta de fuente
• display_value — valor mostrado de la etiqueta de fuente

Elimina la etiqueta de calltracking por su ID

Parámetros de la dirección

• utm_id — identificador de la etiqueta de fuente

Devuelve el listado de todas las etiquetas y su estadística

Respuesta

                                    {
  "totalCount": 5,
  "labels": [
    {
      "id": 12,
      "label": "Best clients",
      "count": 14
    }
  ]
}

donde:

• totalCount — número total de etiquetas en el sistema
• labels — conjunto de etiquetas. Cada etiqueta contiene los siguientes campos:
  • id — identificador de la etiqueta
  • label — nombre de la etiqueta
  • count — número de clientes y leads que usan esta etiqueta

Crea una nueva etiqueta

Parámetros

• name — nombre de etiqueta nueva

Respuesta

                                    {
  "id": 13,
  "label": "Very best clients",
  "count": 0
}

donde:

• id — identificador de la etiqueta creada
• label — nombre de la etiqueta
• count — número de clientes y leads que usan esta etiqueta (siempre igual a 0)

Elimina la etiqueta del sistema por su ID

Parámetros de dirección

• l_id — identificador de la etiqueta

Devuelve todos los parámetros adicionales

Respuesta

                                    {
  "totalCount": 8,
  "customProperties": [
    {
      "id": 18,
      "key": "loyalty",
      "title": "Loyalty"
    }
  ]
}

donde:

• totalCount — cantidad de propiedades adicionales.
• customProperties — matriz de propiedades adicionales. Cada propiedad adicional contiene los siguientes parámetros:
  • id — identificador de la propiedad adicional
  • key — nombre único de la propiedad adicional
  • title — nombre visualizado de la propiedad adicional

Devuelve notas en el flujo de actividad del cliente

Parámetros de dirección

• c_id — identificador del cliente

Respuesta

                                    {
  "totalCount": 17,
  "items": [
    {
      "id": 37825,
      "type": "note",
      "content": "Call to the client",
      "time": "2020-06-08 06:55:02",
      "user_id": 20,
      "user_name": "John Beam",
      "call_id": null,
      "call_type": null,
      "call_status": null,
      "call_phone": null,
      "call_duration": null,
      "call_record": null,
      "call_contact_name": null,
      "attached_files": [
        {
          "file_id": 576,
          "original_filename": "document.doc"
        }
      ]
    }
  ]
}

donde:

• totalCount — cantidad total de las grabaciones
• items — conjunto de grabaciones. Cada grabación contiene los siguientes atributos:
  • id — identificador de la grabación
  • type — tipo de grabación. Valores posibles:
    • event — evento
    • note — nota de texto
    • call — llamada
  • content — contenido de la grabación. Si el tipo de la grabación es nota, este atributo contiene un contenido de nota de texto. Si el tipo de la grabación es evento, este atributo contiene el identificador, por ejemplo:
    • CUSTOMER_CREATED — evento de creación de cliente
    • LEAD_CREATED — evento de creación de lead
  • time — hora de grabación en formato YYYY-MM-DD hh:mm:ss
  • user_id — identificador del usuario creador de la grabación
  • user_name — nombre de usuario creador de la grabación
  • call_id — identificador de llamada (si el tipo de grabación es llamada)
  • call_type — tipo de llamada. Valores posibles:
    • incoming — llamada entrante
    • outgoing — llamada saliente
  • call_status — estado de llamada. Valores posibles:
    • answer — llamada de éxito
    • noanswer — sin respuesta
    • cancel — cancelada
    • busy — ocupado
    • failed — no se ha podido realizar
  • call_phone — número de teléfono de la llamada
  • call_duration — duración de la llamada en segundos
  • call_record — si está activada la grabación de llamadas
  • call_contact_name — nombre del contacto de la llamada
  • attached_files — conjunto de archivos adjuntados a la nota (si el tipo de la grabación es nota). Cada elemento del conjunto contiene los siguientes atributos:
    • file_id — identificador del archivo
    • original_filename — nombre original del archivo

Añade nota de texto en el flujo de actividad del cliente con capacidad de adjuntar archivos

Parámetros de dirección

• c_id — identificador del cliente

Parámetros

• content — contenido en texto de la nota
• files — matriz de los archivos adjuntos

Respuesta

                                    {
  "id": 37825,
  "type": "note",
  "content": "Call to the client",
  "time": "2020-06-08 06:55:02",
  "user_id": 20,
  "user_name": "John Beam",
  "attached_files": [
    {
      "file_id": 576,
      "original_filename": "document.doc"
    }
  ]
}

donde:

• id — identificador de la grabación
• type — tipo de grabación. En este caso es igual:
  • note — nota de texto
• content — contenido en texto de la nota
• time — hora de la grabación en formato YYYY-MM-DD hh:mm:ss
• user_id — identificador del usuario creador de la grabación
• user_name — nombre del usuario creador de la grabación
• attached_files — matriz de archivos adjuntos a una nota (si el tipo de grabación es una nota). Cada elemento de la matriz contiene los siguientes atributos:
  • file_id — identificador del archivo
  • original_filename — nombre original del archivo

Actualiza el contenido de la nota de texto existente por su ID

Parámetros de dirección

• c_id — identificador del cliente
• i_id — identificador de nota de texto

Parámetros

• content — nuevo texto de la nota

Elimina la nota en el flujo de actividad del cliente por su ID

Parámetros de dirección

• c_id — identificador del cliente
• i_id — identificador de nota

Devuelve el listado de empleados del cliente por su ID

Parámetros de dirección

• c_id — identificador del cliente

Respuesta

                                    {
  "totalCount": 5,
  "employees": [
    {
      "id": 23,
      "customer_id": 11,
      "name": "Steven Knight",
      "position": "manager",
      "position_title": "",
      "comment": "",
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "s.knight@example.com"
        }
      ]
    }
  ]
}

donde:

• totalCount — cantidad de empleados del cliente
• employees — matriz de empleados del cliente. Cada elemento contiene los siguientes atributos:
  • id — identificador del empleado
  • customer_id — identificador del cliente vinculado al empleado
  • name — nombre del empleado
  • position — cargo del empleado. Valores posibles:
    • ceo — director general
    • director — directir
    • manager — agente
    • sales_manager — comercial
    • hr — RRHH
    • support — soporte
    • custom — otro
  • position_title — nombre de otros cargos (paraposition = custom)
  • comment — descripción del empleado
  • phones — matriz de números de teléfono del empleado. Cada número contiene los siguientes campos:
    • type — tipo de número. Valores posibles:
      • work — de trabajo
      • personal — personal
    • phone — valor del número
  • contacts — matriz de contactos del empleado. Cada contacto contiene los siguientes campos:
    • type — tipo de contacto. Valores posibles:
      • email_work — e-mail de trabajo
      • email_personal — e-mail personal
      • skype
      • telegram
      • viber
      • whatsapp
    • value — valor del contacto

Devuelve al empleado del cliente por su ID

Parámetros de dirección

• c_id — identificador del cliente
• e_id — identificador del empleado

Respuesta

                                    {
  "id": 23,
  "customer_id": 11,
  "name": "Steven Knight",
  "position": "manager",
  "position_title": "",
  "comment": "",
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "s.knight@example.com"
    }
  ]
}

donde:

• id — identificador del empleado
• customer_id — identificador del cliente vinculado al empleado
• name — nombre del empleado
• position — cargo del empleado. Valores posibles:
  • ceo — director general
  • director — director
  • manager — agente
  • sales_manager — comercial
  • hr — RRHH
  • support — soporte
  • custom — otro
• position_title — nombre del cargo propio (para position = custom)
• comment — descripción del empleado
• phones — conjunto de números de teléfono del empleado. Cada número contiene los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto contiene los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valores de contacto

Crea y guarda a nuevo empleado para el cliente seleccionado

Parámetros de dirección

• c_id — identificador del cliente

Parámetros

• employee — datos del empleado nuevo. Estructura del empleado:

(Respuesta 1)

                                    Respuesta 1:
{
    "name": "Steven Knight",
    "position": "manager",
    "position_title": "",
    "comment": "",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "s.knight@example.com"
      }
    ]
}

donde:

• name — nombre del empleado
• position — cargo del empleado. Valores posibles:
  • ceo — director general
  • director — director
  • manager — agente
  • sales_manager — comercial
  • hr — RRHH
  • support — soporte
  • custom — otro
• position_title — nombre del cargo propio (para position = custom)
• comment — descripción del empleado
• phones — conjunto de números de teléfono del empleado. Cada número contiene los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto contiene los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto

Respuesta

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 23
}

donde:

• id — identificador de nuevo empleado

Actualiza al empleado existente con ID indicado

Parámetros de dirección

• c_id — identificador del cliente
• e_id — identificador del empleado

Parámetros

• employee — nuevos datos del empleado. Estructura:

                                    {
    "name": "Steven Knight",
    "position": "manager",
    "position_title": "",
    "comment": "",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "john@example.com"
      }
    ]
}

donde:

• name — nombre del empleado
• position — cargo del empleado. Valores posibles:
  • ceo — director general
  • director — director
  • manager — agente
  • sales_manager — comercial
  • hr — RRHH
  • support — soporte
  • custom — otro
• position_title — nombre del cargo propio (para position = custom)
• comment — descripción del empleado
• phones — conjunto de números de teléfono del empleado. Cada número contiene los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del cliente. Cada contacto contiene los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto

Elimina al empleado por su ID

Parámetros de dirección

• c_id — identificador del cliente
• e_id — identificador del empleado

Devuelve el listado de leads

Parámetros

• search (opcional) - barra de búsqueda. La búsqueda se realiza de forma combinada por:
  • nombre del lead
  • números de teléfono del lead
  • descripción del lead
  • domicilio y código postal
  • página web
  • e-mail
  • Messengets
• filter (opcional) - filtro de leads. Estructura del filtro:

(Respuesta 1)

                                    Respuesta 1:
{
    "source": "call_incoming",
    "responsible": 32,
    "label": 12,
    "utm": 19,
    "createdAfter": "2020-06-11 12:24:00",
    "createdBefore": "2020-06-26 12:24:00"
}

donde

• source — fuente del lead. Valores posibles:
  • manual — añadido manualmente
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma de contactar
• responsible — responsable (identificador de usuario). El parámetro permite símbolos especiales:
  • null — devuelve todos los leads asignados
  • –1 — devuelve leads no gestionados
  • –2 — devuelve todos los leads (y asignados y no gestionados)
• label — etiqueta (identificador)
• createdAfter — mostrar solo leads creados después del periodo seleccionado (formato: YYYY-MM-DD hh:mm:ss)
• createdBefore — mostrar solo leads creados hasta del periodo seleccionado (formato: YYYY-MM-DD hh:mm:ss)

Cualquiera de los parámetros del filtro se puede omitir, es decir, es opcional.

• sort (opcional) - clasificación de leads. Estructura del parámetro:

(Respuesta 2)

                                    Respuesta 2:
{
    "attr": "name",
    "desc": 0
}

donde

• attr — campo de clasificación. Valores posibles:
  • name — nombre de lead
  • lead_source — fuente de lead
  • lead_status — estado de lead
  • responsible_user_id — usuario responsable
  • lead_created_at — fecha creación del lead
• desc — sentido de clasificación. Valores posibles:
  • 0 — creciente
  • 1 — decreciente
  • take (para la muestra por página) - cuántos leads devolver (por defecto 20)
  • skip (para la muestra por página) - cuántos leads saltarse (por defecto 0)

Respuesta

(Respuesta 3)

                                    Respuesta 3:
{
  "totalCount": 100,
  "uncategorizedCount": 10,
  "leads": [
    {
      "id": 3486,
      "name": "Good Company",
      "responsible_user_id": 234,
      "employees_count": "50",
      "comment": "",
      "country": "GB",
      "city": "London",
      "address": "",
      "zip": "",
      "website": "",
      "lead_status": "not_processed",
      "lead_source": "manual",
      "lead_created_at": "2020-04-28 05:47:47",
      "lead_created_by": 234,
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "good_company@example.com"
        }
      ],
      "labels": [
        {
          "id": 22,
          "label": "Best clients"
        }
      ],
      "utms": [
        {
          "id": 19,
          "param": "utm_source",
          "value": "google",
          "display_value": "Google"
        }
      ]
    }
  ]
}

donde

• totalCount — total de leads encontrados (incluyendo los de barra de búsqueda y filtros)
• uncategorizedCount — total de leads no gestionados (teniendo en cuenta la barra de búsqueda y filtros)
• leads — conjunto de leads (teniendo en cuenta la muestra por página). Cada elemento de conjunto contiene los siguientes parámetros:
  • id — identificador de lead
  • name — nombre de lead
  • responsible_user_id — responsable (identificador de usuario)
  • employees_count — total de empleados. Valores posibles:
    • 50 — inferior a 50
    • 50_250 — 50 – 250
    • 250_500 — 250 – 500
  • comment — descripción del lead
  • country — país del lead. Código de dos letras (ES, US, etc.)
  • city — ciudad del lead
  • address — domicilio del lead
  • zip — código postal
  • website — página web del lead
  • lead_status — estado del lead. Valores posibes:
    • not_processed — no gestionado
    • in_progress — en proceso
    • finished — finalizado
  • lead_source — fuente del lead. Valores posibles:
    • manual — manual
    • call_incoming — llamada entrante
    • call_outgoing — llamada saliente
    • form — forma
  • lead_created_at — fecha y hora de creación del lead (en formato YYYY-MM-DD HH:mm:ss)
  • lead_created_by — creador del lead (identificador de usuario)
  • phones — conjunto de números de teléfono de lead. Cada número contiene los siguientes campos:
    • type — tipo de número. Valores posibles:
      • work — de trabajo
      • personal — personal
    • phone — valor del número
  • contacts — conjunto de contactos del lead. Cada contacto debe contener los siguientes campos:
    • type — tipo de contacto. Valores posibles:
      • email_work — e-mail de trabajo
      • email_personal — e-mail personal
      • skype
      • telegram
      • viber
      • whatsapp
    • value — valor de contacto
  • labels — conjunto de etiquetas asignadas al lead. Cada etiqueta contiene los siguientes campos:
    • id — identificador de la etiqueta
    • label — valor de la etiqueta

Devuelve el lead por su ID

Respuesta

                                    {
  "id": 3486,
  "name": "Good Company",
  "responsible_user_id": 234,
  "employees_count": "50",
  "comment": "",
  "country": "GB",
  "city": "London",
  "address": "",
  "zip": "",
  "website": "",
  "lead_status": "not_processed",
  "lead_source": "manual",
  "lead_created_at": "2020-04-28 05:47:47",
  "lead_created_by": 234,
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "good_company@example.com"
    }
  ],
  "labels": [
    {
      "id": 22,
      "label": "Лучшие клиенты"
    }
  ],
  "utms": [
    {
      "id": 19,
      "param": "utm_source",
      "value": "google",
      "display_value": "Google"
    }
  ],
  "custom_properties": [
    {
      "id": 12,
      "key": "loyalty",
      "title": "Лояльность",
      "value": "high"
    }
  ]
}

donde

• id — identificador del lead
• name — nombre de lead
• responsible_user_id — responsable (identificador de usuario)
• employees_count — número de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción de lead
• country — país del lead. Código de dos letras (ES, US, etc.)
• city — ciudad del lead
• address — domicilio del lead
• zip — código postal
• website — página web del lead
• lead_status — estado del lead. Valores posibles:
  • not_processed — no gestionado
  • in_progress — en proceso
  • finished — finalizado
• lead_source — fuente del lead. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• lead_created_at — fecha y hora de la creación del lead (en formato YYYY-MM-DD HH:mm:ss)
• lead_created_by — por quien ha sido creado el lead (identificador del usuario)
• phones — conjunto de números de teléfono del lead. Cada número debe contener los siguientes campos:
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del lead. Cada contacto debe contener los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto
• labels — conjunto de etiquetas asignadas al lead. Cada etiqueta contiene los siguientes campos:
  • id — identificador de etiqueta
  • label — valor de etiqueta

Crea un nuevo lead con los datos indicados

Parámetros

• convert — convertir lead en cliente. Valores posibles:
  • 0 — no convertir, crear lead
  • 1 — crear cliente
  • 2 — inadecuado (la operación será cancelada — no serán creados ni el lead ni el cliente)
• lead — datos del nuevo lead. Estructura del lead:

(Respuesta 1)

                                    Respuesta 1:
{
    "name": "Good Company",
    "responsible_user_id": 234,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "lead_status": "in_progress",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 22 },
      { "id": 23 }
    ],
    "utms": [
      { "id": 19 },
      { "id": 20 }
    ],
    "custom_properties": [
      {
        "id": 12,
        "value": "high"
      }
    ]
}

donde

• name — nombre de lead
• responsible_user_id — responsable (identificador de usuario)
• employees_count — cantidad de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción del lead
• country — país del lead. Código de dos letras (ES, US, etc.)
• city — ciudad del lead
• address — domicilio del lead
• zip — código postal
• website — página web del lead
• lead_source — fuente del lead. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• lead_status — estado del lead. Valores posibles:
  • not_processed — no gestionado
  • in_progress — en proceso
  • finished — finalizado
• phones — conjunto de números de teléfono. Cada contacto debe contener los siguientes campos:
  • type — tipo de números. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del lead. Cada contacto debe contener los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto
• labels — conjunto de etiquetas asignadas al lead. Cada etiqueta contiene los siguientes campos:
  • id — identificador de la etiqueta
  • custom_properties — conjunto de propiedades adicionales. Cada elemento debe contener:
    • id — identificador de la propiedad adicional o:
    • key — nombre único de la propiedad adicional
    • value — valor de la propiedad adicional

Respuesta

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 123
}

donde

• id — identificador del lead creado

Actualiza el lead existente con el ID indicado

Parámetros

• convert — convertir lead en cliente. Valores posibles:
  • 0 — no convertir
  • 1 — crear cliente
  • 2 — inadecuado (eliminar lead)
• lead — nuevos datos del lead. Estructura del lead:

                                    {
    "name": "Good Company",
    "responsible_user_id": 234,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "lead_status": "in_progress",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 22 },
      { "id": 23 }
    ],
    "utms": [
      { "id": 19 },
      { "id": 20 }
    ],
    "custom_properties": [
      {
        "id": 12,
        "value": "high"
      }
    ]
}

donde

• name — nombre de lead
• responsible_user_id — responsable (identificador de usuario)
• employees_count — cantidad de empleados. Valores posibles:
  • 50 — inferior a 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — descripción del lead
• country — país del lead. Código de dos letras (ES, US, etc.)
• city — ciudad del lead
• address — domicilio del lead
• zip — código postal
• website — página web del lead
• lead_source — fuente del lead. Valores posibles:
  • manual — manual
  • call_incoming — llamada entrante
  • call_outgoing — llamada saliente
  • form — forma
• lead_status — estado del lead. Valores posibles:
  • not_processed — no gestionado
  • in_progress — en proceso
  • finished — finalizado
• phones —conjunto de números de teléfono. Cada contacto debe contener los siguientes campos:
  • type — tipo de números. Valores posibles:
    • work — de trabajo
    • personal — personal
  • phone — valor del número
• contacts — conjunto de contactos del lead. Cada contacto debe contener los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto
• labels — conjunto de etiquetas asignadas al lead. Cada etiqueta contiene los siguientes campos:
  • id — identificador de la etiqueta
• custom_properties — conjunto de propiedades adicionales. Cada elemento debe contener:
  • id — identificador de la propiedad adicional o:
  • key — nombre único de la propiedad adicional
  • value — valor de la propiedad adicional

Elimina el lead por su ID

Devuelve el listado de usuarios

Respuesta)

                                    {
  "totalCount": 2,
  "users": [
    {
      "id": 234,
      "email": "john@example.com",
      "name": "John Beam",
      "group_id": 653,
      "is_superadmin": 1,
      "enabled": 1,
      "created_at": "2020-04-27 01:01:31",
      "avatar": 2457,
      "role": "",
      "status": "",
      "language": "en",
      "color": "220",
      "color_hex": "5678BD",
      "internal_number": "100",
      "timezone": "Europe/London",
      "first_day": 1,
      "device": "webphone",
      "phone_widget_location": "right",
      "phones": [
        {
          "phone": "+44123456789",
          "type": "work"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "ivanov@example.com"
        }
      ]
    }
  ]
}

donde

• totalCount — total de usuarios
• users — conjunto de usuarios. Cada elemento del conjunto contiene los siguientes parámetros:
  • id — identificador de usuario
  • email — e-mail de la cuenta de usuario
  • name — nombre de usuario
  • group_id — identificador de grupo de usuario
  • is_superadmin — muestra si el usuario es súper administrador (1 o 0)
  • enabled — si está desbloqueado el usuario (1 o 0)
  • created_at — fecha y hora de creación de usuario (en formato YYYY-MM-DD hh:mm:ss)
  • avatar — avatar de usuario (identificador de archivo)
  • role — cargo de usuario
  • status — estado de usuario
  • language — idioma de la interfaz de usuario. Alternativas posibles:
    • de — alemán
    • en — inglés
    • es — español
    • pl — polaco
    • ru — ruso
    • ua — ucraniano
  • color — color de usuario en la interfaz Teamsale CRM (solo valor hue — del 0 al 359)
  • color_hex — color de usuario en la interfaz de Teamsale CRM (hex-presentación)
  • internal_number — extensión de la centralita del usuario
  • timezone — huso horario de usuario
  • first_day — determina qué día es el inicio de la semana:
    • 0 — domingo
    • 1 — lunes
  • device — qué usa para las llamadas. Valores posibles:
    • webphone — teléfono web
    • softphone — softphone externo
  • phone_widget_location — ubicación del widget de teléfono web. Valores posibles:
    • left — ubicar el widget del teléfono a la izquierda
    • right — ubicar el widget del teléfono a la derecha
  • phones — conjunto de números de teléfono de usuario. Cada número contiene los siguientes campos:
    • phone — valor de número
    • type — tipo de número. Valores posibles:
      • work — de trabajo
      • personal — personal
  • contacts — conjunto de contactos de usuario. Cada contacto contiene los siguientes campos:
    • type — tipo de contacto. Valores posibles:
      • email_work — e-mail de trabajo
      • email_personal — e-mail personal
      • skype
      • telegram
      • viber
      • whatsapp
    • value — valor de contacto

Devuelve al usuario por su ID

Respuesta

                                    {
  "id": 234,
  "email": "john@example.com",
  "name": "John Beam",
  "group_id": 653,
  "is_superadmin": 1,
  "enabled": 1,
  "created_at": "2020-04-27 01:01:31",
  "avatar": 2457,
  "role": "",
  "status": "",
  "language": "en",
  "color": "220",
  "color_hex": "5678BD",
  "internal_number": "100",
  "timezone": "Europe/London",
  "first_day": 1,
  "device": "webphone",
  "phone_widget_location": "right",
  "phones": [
    {
      "phone": "+44123456789",
      "type": "work"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "simpson@example.com"
    }
  ],
  "pending_email_change_request": false
}

donde

• id — identificador de usuario
• email — e-mail de la cuenta de usuario
• name — nombre de usuario
• group_id — identificador de grupo de usuario
• is_superadmin — muestra si el usuario es súper administrador (1 o 0)
• enabled — si está desbloqueado el usuario (1 o 0)
• created_at — fecha y hora de creación de usuario (en formato YYYY-MM-DD hh:mm:ss)
• avatar — avatar de usuario (identificador de archivo)
• role — cargo de usuario
• status — estado de usuario
• language — idioma de la interfaz de usuario. Alternativas posibles:
  • de — alemán
  • en — inglés
  • es — español
  • pl — polaco
  • ru — ruso
  • ua — ucraniano
• color — color de usuario en la interfaz Teamsale CRM (solo valor hue — del 0 al 359)
• color_hex — color de usuario en la interfaz de Teamsale CRM (hex-presentación)
• internal_number — extensión de la centralita del usuario
• timezone — huso horario de usuario
• first_day — determina qué día es el inicio de la semana:
  • 0 — domingo
  • 1 — lunes
• device — qué usa para las llamadas. Valores posibles:
  • webphone — teléfono web
  • softphone — softphone externo
• phone_widget_location — ubicación del widget de teléfono web. Valores posibles:
  • left — ubicar el widget del teléfono a la izquierda
  • right — ubicar el widget del teléfono a la derecha
• phones — conjunto de números de teléfono de usuario. Cada número contiene los siguientes campos:
  • phone — valor de número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• contacts — conjunto de contactos de usuario. Cada contacto contiene los siguientes campos:
  • type — tipo de contacto. Valores posibles:
    • email_work — e-mail de trabajo
    • email_personal — e-mail personal
    • skype
    • telegram
    • viber
    • whatsapp
  • value — valor de contacto
• pending_email_change_request — si ha sido enviada la solicitud de cambio de email de la cuenta pero no ha sido confirmada aún, este parámetro será establecido como true

Devuelve horario laboral del usuario

Respuesta

                                    {
  "schedulePeriod": 7,
  "scheduleWorkingHours": [
    {
      "time_start": "2020-06-15 09:00:00",
      "time_end": "2020-06-15 18:00:00"
    }
  ],
  "scheduleFixes": [
    {
      "index": 2,
      "repeat_index": 1,
      "time_start": "2020-06-24 09:00:00",
      "time_end": "2020-06-24 13:00:00",
      "deleted": 0
    }
  ],
  "customWorkingHours": [
    {
      "time_start": "2020-06-27 11:00:00",
      "time_end": "2020-06-27 15:00:00"
    }
  ]
}

donde

• schedulePeriod — periodicidad del horario "cómo" se repite. Para la semana laboral ordinaria son 7 días, para horarios "día sí día no" son dos días y así sucesivamente.
• scheduleWorkingHours — conjunto de periodos laborales. Cada periodo laboral contiene los siguientes atributos:
  • time_start — inicio de jornada laboral en formato YYYY-MM-DD hh:mm:ss
  • time_end — fin de jornada laboral en formato YYYY-MM-DD hh:mm:ss
• scheduleFixes — conjunto de modificaciones introducidas en la jornada laboral determinado en el parámetro scheduleWorkingHours. Cada elemento del conjunto contiene los siguientes atributos:
  • index — índice del elemento en scheduleWorkingHours, es decir qué periodo ha sido modificado
  • repeat_index — índice de repetición de horario en el que se produce el cambio de jornada laboral
  • time_start — nuevo inicio de jornada laboral YYYY-MM-DD hh:mm:ss
  • time_end — nuevo fin de jornada laboral YYYY-MM-DD hh:mm:ss
  • deleted — si es igual a 1, el periodo laboral ha sido eliminado por completo
• customWorkingHours — conjunto de períodos de trabajo personalizados y únicos. Cada período de trabajo contiene los siguientes atributos:
  • time_start — inicio de jornada laboral YYYY-MM-DD hh:mm:ss
  • time_end — inicio de jornada laboral YYYY-MM-DD hh:mm:ss

Devuelve grupos y derechos de usuario de cada uno

Respuesta

                                    {
  "totalCount": 4,
  "groups": [
    {
      "id": 45,
      "type": "manager",
      "title": "",
      "permissions": {
        "customers_create": true,
        "customers_edit": true,
        "customers_delete": true,
        "customers_import_export": true,
        "customers_view_all": false,
        "calendar_other_users_access": false,
        "calls_other_users_access": false,
        "leads_view": false,
        "leads_edit": false,
        "leads_delete": false,
        "leads_import_export": false,
        "team_add": false,
        "team_edit": false
      }
    }
  ]
}

donde

• totalCount — número total de grupos
• groups — conjunto de grupos. Cada grupo contiene los siguientes atributos:
  • id — identificador de grupos
  • type — tipo de grupos. Valores posibles:
    • admin — administradores
    • manager — agentes
    • chat_operator — operadores
    • trainee — becarios
    • custom — personalizado
  • title — nombre del grupo personalizado (paratype = custom)
  • permissions — derechos de los usuarios del grupo. Los administradores tienen el acceso total, por lo que para los administradores este objeto permanecerá vacío. El resto de grupos contienen los siguientes atributos (cada uno de éstos puede ser igual a true o false):
    • customers_create — permitir creación de clientes
    • customers_edit — permitir editar clientes
    • customers_delete — permitir eliminar clientes
    • customers_import_export — permitir importación y exportación de clientes
    • customers_view_all — permitir ver a todos los clientes incluso los asignados a otros usuarios
    • calendar_other_users_access — permitir ver tareas de otros usuarios
    • calls_other_users_access — permitir acceso a llamadas de otros usuarios
    • leads_view — permitir ver leads de otros usuarios
    • leads_edit — permitir redactar leads de otros usuarios
    • leads_delete — permitir eliminar leads de otros usuarios
    • leads_import_export — permitir importación y exportación de leads
    • team_add — permitir invitar y agregar a otros usuarios al grupo
    • team_edit — permitir editar usuarios

Devuelve el listado de todos los contactos (clientes, empleados, leads, usuarios) con números de teléfono

Parámetros

• search (opcional) - barra de búsqueda. La búsqueda se realiza de forma combinada por:
  • a los nombres y números de clientes, leads, empleados y usuarios
  • a las extensiones de los usuarios de la centralita
• take (para la muestra por página) - cuántos contactos devolver (por defecto 20)
• skip (para la muestra por página) - cuántos contactos saltarse (por defecto 0)

Respuesta

(Respuesta 1)

                                    Respuesta 1:
{
  "totalCount": 128,
  "contacts": [
    {
      "contact_type": "customer",
    },
    {
      "contact_type": "employee",
    },
    {
      "contact_type": "lead",
    },
    {
      "contact_type": "user",
    }
  ]
}

donde

• totalCount — número total de contactos (incluyendo la barra de búsqueda)
• contacts — conjunto de contactos. Cada uno de los contactos depende de su tipo (cliente, empleado, lead, usuario) contendrá su propio conjunto de atributos.

Cliente

(Respuesta 2)

                                    Respuesta 2:
{
    "contact_type": "customer",
    "id": 3486,
    "name": "Good Company",
    "status": "company",
    "type": "client",
    "phone": {
      "phone": "+44123456789",
      "type": "work"
    },
    "responsible": {
      "id": 234,
      "name": "John Beam",
      "ext_num": "100"
    }
}

donde

• contact_type — tipo de contacto:
  • customer — cliente
• id — identificador de cliente
• name — nombre de cliente
• status — estado de cliente. Valores posibles:
  • individual — persona física/li>
  • company — empresa
• type — tipo de cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — agente
  • partner — colaborador
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• responsible — usuario responsable. Contiene los siguientes campos:
  • id — identificador de usuario
  • name — nombre de usuario
  • ext_num — extensión de la centralita virtual de usuario

Empleado del cliente

(Respuesta 3)

                                    Respuesta 3:
{
    "contact_type": "employee",
    "id": 8,
    "name": "Michael Simpson",
    "phone": {
      "phone": "+44123456789",
      "type": "work"
    },
    "position": {
      "position": "manager",
      "title": ""
    },
    "customer": {
      "id": 3486,
      "name": "Good Company"
    },
    "responsible": {
      "id": 234,
      "name": "John Beam",
      "ext_num": "100"
    }
}

donde

• contact_type — tipo de contacto:
  • employee — empleado
• id — identificador de empleado
• name — nombre de empleado
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• position — cargo del empleado. Contiene los siguientes campos:
  • position — valor del cargo. Valores posibles:
    • ceo — director general
    • director — director
    • manager — agente
    • sales_manager — comercial
    • hr — RRHH
    • support — soporte
    • custom — otro
  • title — nombre de otro cargo (paraposition = custom)
• customer — cliente asignado al empleado. Contiene los siguientes campos:
  • id — identificador de cliente
  • name — nombre de cliente
  • responsible — usuario responsable por el cliente matriz. Contiene los siguientes campos:
    • id — identificador de usuario
    • name — nombre de usuario
    • ext_num — extensión de la centralita del usuario

Lead

(Respuesta 4)

                                    Respuesta 4:
{
    "contact_type": "lead",
    "id": 3486,
    "name": "Good Company",
    "phone": {
      "phone": "+44123456789",
      "type": "work"
    },
    "responsible": {
      "id": 234,
      "name": "John Beam",
      "ext_num": "100"
    }
}

donde

• contact_type — tipo de contacto:
  • lead — lead
• id — identificador de lead
• name — nombre de lead
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• responsible — usuario responsable. Contiene los siguientes campos:
  • id — identificador de usuario
  • name — nombre de usuario
  • ext_num — extensión de la centralita del usuario

Usuario

(Respuesta 5)

                                    Respuesta 5:
{
    "contact_type": "user",
    "id": 234,
    "name": "John Beam",
    "avatar": 2457,
    "role": "",
    "status": "",
    "phone": {
      "phone": "100",
      "type": "internal"
    },
    "group": {
      "type": "admin",
      "title": ""
    }
}

donde

• contact_type — tipo de contacto:
  • user — usuario
• id — identificador de usuario
• name — nombre de usuario
• avatar — avatar de usuario (identificador de archivo)
• role — rol de usuario
• status — estado de usuario
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
    • internal — extensión de la centralita del usuario
• group — grupo del usuario. Contiene los siguientes campos:
  • type — tipo de grupo. Valores posibles:
    • admin — administradores
    • manager — agentes
    • chat_operator — operadores
    • trainee — becarios
    • custom — personalizado
  • title — nombre del grupo personalizado (para type = custom)

Identifica el contacto (cliente, empleado, lead, usuario) por número de teléfono

Parámetros

• phone — número de teléfono

Respuesta

La respuesta dependerá del tipo de contacto encontrado (cliente, empleado, lead, usuario).

Cliente

(Respuesta 1)

                                    Respuesta 1:
{
  "contact_type": "customer",
  "id": 3486,
  "name": "Good Company",
  "status": "company",
  "type": "client",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "responsible": {
    "id": 234,
    "name": "John Beam",
    "ext_num": "100"
  }
}

donde

• contact_type — tipo de contacto:
  • customer — cliente
• id — identificador de cliente
• name — nombre de cliente
• status — estado de cliente. Valores posibles:
  • individual — persona física
  • company — empresa
• type — tipo de cliente. Valores posibles:
  • potential — cliente potencial
  • client — cliente
  • reseller — agente
  • partner — colaborador
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• responsible — usuario responsable. Contiene los siguientes campos:
  • id — identificador de usuario
  • name — nombre de usuario
  • ext_num — extensión de la centralita de usuario

Empleado del cliente

(Respuesta 2)

                                    Respuesta 2:
{
  "contact_type": "employee",
  "id": 8,
  "name": "Michael Simpson",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "position": {
    "position": "manager",
    "title": ""
  },
  "customer": {
    "id": 3486,
    "name": "Good Company"
  },
  "responsible": {
    "id": 234,
    "name": "John Beam",
    "ext_num": "100"
  }
}

donde

• contact_type — tipo de contacto:
  • employee — empleado
• id — identificador de empleado
• name — nombre de empleado
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• position — cargo del empleado. Contiene los siguientes campos:
  • position — valor del cargo. Valores posibles:
    • ceo — director general
    • director — director
    • manager — agente
    • sales_manager — comercial
    • hr — RRHH
    • support — soporte
    • custom — otro
  • title — nombre del cargo propio (paraposition = custom)
• customer — cliente al que se ha vinculado el empleado. Contiene los siguientes campos:
  • id — identificador de cliente
  • name — nombre de cliente
• responsible — usuario responsable por el cliente matriz. Contiene los siguientes campos:
  • id — identificador de usuario
  • name — nombre de usuario
  • ext_num — extensión de la centralita del usuario

Lead

(Respuesta 3)

                                    Respuesta 3:
{
  "contact_type": "lead",
  "id": 3486,
  "name": "Good Company",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "responsible": {
    "id": 234,
    "name": "John Beam",
    "ext_num": "100"
  }
}

donde

• contact_type — tipo de contacto:
  • lead — lead
• id — identificador de lead
• name — nombre de lead
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
• responsible — usuario responsable. Contiene los siguientes campos:
  • id — identificador de usuario
  • name — nombre de usuario
  • ext_num — extensión de la centralita del usuario

Usuario

(Respuesta 4)

                                    Respuesta 4:
{
  "contact_type": "user",
  "id": 234,
  "name": "John Beam",
  "avatar": 2457,
  "role": "",
  "status": "",
  "phone": {
    "phone": "100",
    "type": "internal"
  },
  "group": {
    "type": "admin",
    "title": ""
  }
}

donde

• contact_type — tipo de contacto:
  • user — usuario
• id — identificador de usuario
• name — nombre de usuario
• avatar — avatar de usuario (identificador de archivo)
• role — rol de usuario
• status — estado de usuario
• phone — número de teléfono. Contiene los siguientes campos:
  • phone — solo número
  • type — tipo de número. Valores posibles:
    • work — de trabajo
    • personal — personal
    • internal — extensión de la centralita del usuario
• group — grupo de usuario. Contiene los siguientes campos:
  • type — tipo de grupo. Valores posibles:
    • admin — administradores
    • manager — agentes
    • chat_operator — operadores
    • trainee — becarios
    • custom — personalizado
  • title — nombre de grupo personalizado (para type = custom)

Muestra el listado de acuerdos

Parámetros

• search (opcional) — línea de búsqueda. La búsqueda de acuerdos se realiza por su nombre.

• filter (opcional) — filtro de acuerdos. Estructura del filtro:

(Respuesta 1)

                                    Respuesta 1:
{
  "currency": "USD",
  "responsible_user": 20,
  "status": "new"
}

Donde:

• currency — divisa de acuerdo. Código de 3 dígitos ISO 4217: EUR, USD, etc.
• responsible_user — responsable (identificador de usuario)

• status — estado de acuerdo. Valores posibles:

  • new — nuevo acuerdo
  • in_progress — en gestión
  • decision — a la espera de toma de decisión
  • payment — a la espera de pago
  • success — acuerdo con éxito
  • canceled — acuerdo cancelado

  Cualquiera de los parámetros de filtro puede omitirse, es decir, es opcional.

• sort (opcional) — filtro de acuerdos. Estructura de parámetro:

(Respuesta 2)

                                    Respuesta 2:
{
  "attr": "name",
  "desc": 0
}

Donde:

• attr — campo de filtro. Valores posibles:
  • title — nombre de acuerdo
  • budget — presupuesto del acuerdo
  • status — estado del acuerdo
  • created_at — fecha de creación de acuerdo
• desc — tipo de filtro. Valores posibles:
  • 0 — creciente
  • 1 — decreciente

• take (para la búsqueda por página) — resultado a mostrar (por defecto 20)

• skip (para la búsqueda por página) — resultado a ocultar (por defecto 0)

Respuesta

(Respuesta 3)

                                    Respuesta 3:
{
  "totalCount": 82,
  "deals": [
    {
      "id": 83,
      "title": "Good deal",
      "budget": 990.00,
      "currency": "USD",
      "status": "new",
      "responsible_user": 20,
      "created_at": "2021-10-05 12:40:10",
      "created_by": 20,
      "customer_id": 65,
      "customer_is_lead": 0,
      "customer_name": "Good company",
      "customer_responsible_user": 20
    }
  ]
}

Donde:

• totalCount — total de acuerdos (dada la barra de búsqueda y el filtro)
• deals — conjunto de acuerdos (teniendo en cuenta el resultado por página). Cada elemento del conjunto contiene los siguientes parámetros:
  • id — identificador del acuerdo
  • title — nombre del acuerdo
  • budget — presupuesto del acuerdo
  • currency — divisa del acuerdo. Código ISO 4217 de tres dígitos: EUR, USD, etc.
  • status — estado de acuerdo. Valores posibles:
    • new — nuevo acuerdo
    • in_progress — en gestión
    • decision — a la espera de la toma de decisión
    • payment — a la espera de pago
    • success — acuerdo con éxito
    • canceled — acuerdo cancelado
  • responsible_user — responsable (identificador de usuario)
  • created_at — fecha y hora del acuerdo (en formato YYYY-MM-DD HH:mm:ss)
  • created_by — creada por (identificador de usuario)
  • customer_id — identificador del cliente relacionado con el acuerdo
  • customer_is_lead — bandera que muestra si el cliente es un lead
  • customer_name — nombre del cliente relacionado con el acuerdo
  • customer_responsible_user — responsable del cliente (identificador de usuario)

Muestra el acuerdo por su ID

Parámetros de la dirección

• deal_id — identificador del acuerdo

Respuesta

                                    {
  "id": 83,
  "title": "Good deal",
  "budget": 990.00,
  "currency": "USD",
  "status": "new",
  "responsible_user": 20,
  "created_at": "2021-10-05 12:40:10",
  "created_by": 20,
  "customer_id": 65,
  "customer_is_lead": 0,
  "customer_name": "Good company",
  "customer_responsible_user": 20
}

Donde:

• id — identificador del acuerdo
• title — nombre del acuerdo
• budget — presupuesto del acuerdo
• currency — divisa de acuerdo. Código de 3 dígitos ISO 4217: EUR, USD, etc.
• status — estado de acuerdo. Valores posibles:
  • new — nuevo acuerdo
  • in_progress — en gestión
  • decision — a la espera de la toma de decisión
  • payment — a la espera de pago
  • success — acuerdo con éxito
  • canceled — acuerdo cancelado
• responsible_user — responsable (identificador de usuario)
• created_at — fecha y hora del acuerdo (en formato YYYY-MM-DD HH:mm:ss)
• created_by — creada por (identificador de usuario)
• customer_id — identificador del cliente relacionado con el acuerdo
• customer_is_lead — bandera que muestra si el cliente es un lead
• customer_name — nombre del cliente relacionado con el acuerdo
• customer_responsible_user — responsable del cliente (identificador de usuario)

Crea un nuevo acuerdo con los datos indicados

Parámetros

• deal — datos del nuevo acuerdo. Estructura de acuerdo:

(Respuesta 1)

                                    Respuesta 1:
{
  "title": "Good deal",
  "budget": 990.00,
  "currency": "USD",
  "status": "new",
  "responsible_user": 20,
  "customer_id": 65
}

Donde:

• title — nombre del acuerdo
• budget — presupuesto del acuerdo
• currency — divisa de acuerdo. Código de 3 dígitos ISO 4217: EUR, USD, etc.
• status — estado de acuerdo. Valores posibles:
• new — nuevo acuerdo
• in_progress — en gestión
• decision — a la espera de la toma de decisión
• payment — a la espera de pago
• success — acuerdo con éxito
  • canceled — acuerdo cancelado
• responsible_user — responsable (identificador de usuario)
• customer_id — identificador del cliente relacionado con el acuerdo

Respuesta

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 83
}

Donde:

• id — identificador del acuerdo creado

Actualiza el acuerdo existente con el ID indicado

Parámetros de la dirección

• deal_id — identificador del acuerdo

Parámetros

• deal — nuevos datos del acuerdo. Estructura del acuerdo:

                                    {
  "title": "Good deal",
  "budget": 990.00,
  "currency": "USD",
  "status": "new",
  "responsible_user": 20
}

Donde:

• title — nombre del acuerdo
• budget — presupuesto del acuerdo
• currency — divisa del acuerdo. Código ISO 4217 de tres dígitos: EUR, USD, etc.
• status — estado del acuerdo. Valores posibles:
  • new — nuevo acuerdo
  • in_progress — en gestión
  • decision — a la espera de toma de decisión
  • payment — a la espera de pago
  • success — acuerdo con éxito
  • canceled — acuerdo cancelado
• responsible_user — responsable (identificador de usuario)

Elimina el acuerdo por su ID

Parámetros de la dirección

• deal_id — identificador de acuerdo

Devuelve los registros en la ficha del acuerdo

Parámetros de la dirección

• deal_id — identificador del acuerdo

  Respuesta

                                    {
  "totalCount": 17,
  "items": [
    {
      "id": 37825,
      "type": "note",
      "content": "Call to the client",
      "time": "2020-06-08 06:55:02",
      "user_id": 20,
      "user_name": "John Beam",
      "attached_files": [
        {
          "file_id": 576,
          "original_filename": "document.doc"
        }
      ]
    }
  ]
}

Donde:

• totalCount — número total de registros
• items — conjunto de registros. Cada registro contiene los siguientes atributos:
  • id — identificador de registro
  • type — tipo de registro. Valores posibles:
    • event — evento
    • note — nota de texto
  • content — contenido del registro. Si el tipo de entrada es una nota, este atributo contiene el contenido de texto de la nota. Si el tipo de registro es un evento, este atributo contiene el identificador del evento, por ejemplo:
    • DEAL_CREATED — evento de creación de registro
    • DEAL_STATUS_CHANGED: success — evento de cambio de estado del acuerdo: el acuerdo de éxito
  • time — hora de registro en formato YYYY-MM-DD hh:mm:ss
  • user_id — id del usuario creador del registro
  • user_name — nombre del usuario creador del registro
  • attached_files — conjunto de archivos adjuntos a una nota (si el tipo de entrada es una nota). Cada elemento del conjunto contiene los siguientes atributos:
    • file_id — identificador del archivo
    • original_filename — nombre original del archivo

Agrega nota de texto en la ficha del acuerdo con posibilidad de adjuntar archivos

Параметры адреса

• deal_id — identificador del acuerdo

Parámetros

• content — contenido en texto de la nota
• files — conjunto de archivos adjuntos

Respuesta

                                    {
  "id": 37825,
  "type": "note",
  "content": "Call to the client",
  "time": "2020-06-08 06:55:02",
  "user_id": 20,
  "user_name": "John Beam",
  "attached_files": [
    {
      "file_id": 576,
      "original_filename": "document.doc"
    }
  ]
}

Donde:

• id — identificador de registro
• type — tipo de registro. En este caso igual:
  • note — nota de texto
• content — contenido en texto de la nota
• time — hora de registro en formato YYYY-MM-DD hh:mm:ss
• user_id — identificador de usuario creador del registro
• user_name — nombre de usuario creador del registro
• attached_files — conjunto de archivos adjuntos a una nota (si el tipo de entrada es una nota). Cada elemento del conjunto contiene los siguientes atributos:
  • file_id — identificador del archivo
  • original_filename — nombre original del archivo

Actualiza el contenido de una nota de texto existente por su ID

Parámetros de la dirección

• deal_id — identificador del acuerdo
• i_id — identificador de la nota

Parámetros

• content — nuevo texto de la nota

Actualiza la nota en la ficha del acuerdo por su ID

Parámetros de la dirección

• deal_id — identificador del acuerdo
• i_id — identificador de la nota

Devuelve el listado de tareas

Parámetros

• search (opcional) — barra de búsqueda. La búsqueda se realiza de forma combinada por:
  • nombre de tareas
  • descripción de tareas
  • comentarios de tareas finalizadas
• filter (opcional) - filtro de tareas. Estructura del filtro:

(Respuesta 1)

                                    Respuesta 1:
{
    "responsible": 456,
    "createdBy": 456,
    "start": "2020-06-03 02:56:00",
    "end": "2020-06-12 02:56:00",
    "completed": 1
}

donde:

• responsible — responsable (identificador de usuario)
• createdBy — creado por (identificador de usuario)
• start — mostrar tareas empezadas después del periodo seleccionado (en formato YYYY-MM-DD hh:mm:ss)
• end — mostrar tareas empezadas antes del periodo seleccionado (en formato YYYY-MM-DD hh:mm:ss)
• completed — seleccione en 1 para ver también las tareas finalizadas

• sort (opcional) - clasificación de tareas. Estructura del parámetro:

(Respuesta 2)

                                    Respuesta 2:
{
    "attr": "start",
    "desc": 0
}

donde:

• attr — campo de clasificación. Valores posibles:
  • responsible — usuario responsable
  • title — nombre de tarea
  • start — hora inicio de tarea
  • end — hora fin de tarea
• desc — sentido de clasificación. Valores posibles:
  • 0 — creciente
  • 1 — decreciente

Respuesta

(Respuesta 3)

                                    Respuesta 3:
{
  "totalCount": 4,
  "events": [
    {
      "id": 40,
      "type": "task",
      "title": "Create text for Good Company",
      "description": "",
      "start": "2020-05-26 09:00:00",
      "end": "2020-05-26 12:30:00",
      "allDay": false,
      "created_by": 234,
      "responsible_user": 234,
      "phone": "",
      "call_done": 0,
      "completed": 0,
      "completed_comment": "",
      "members": [234, 235],
      "customers": [
        {
          "id": 3486,
          "name": "Good Company",
          "status": "company",
          "type": "client",
          "lead_source": "manual",
          "lead_status": "not_processed",
          "contact_type": "customer"
        }
      ]
    }
  ]
}

donde

• totalCount — cantidad total de tareas
• events — conjunto de tareas. Cada tarea contiene los siguientes atributos:
  • id — identificador de tarea
  • type — tipo de tarea. Valores posibles:
    • task — tarea
    • call — llamada
  • title — nombre de tarea
  • description — descripción de tarea (en formato Quill Delta)
  • start — fecha y hora inicio de tarea (en formato YYYY-MM-DD hh:mm:ss)
  • end — fecha y hora fin de tarea (en formato YYYY-MM-DD hh:mm:ss)
  • allDay — tarea para todo el día (true o false) — la fecha se determina por el parámetro start
  • created_by — identificador de usuario creador de tarea
  • responsible_user — identificador de usuario responsable de tarea
  • phone — número de teléfono para llamada (si el tipo de tarea es llamada)
  • call_done — muestra si se ha realizado la llamada
  • completed — muestra que la tarea está marcada como finalizada
  • completed_comment — comentario para la tarea finalizada
  • members — conjunto de participantes de la tarea (solo identificadores de usuarios)
  • customers — conjunto de clientes y leads adjuntados a la tarea. Cada elemento de conjunto contiene los siguientes campos:
    • id — identificador de cliente / lead
    • name — nombre de cliente / lead
    • status — estado de cliente. Valores posibles:
      • individual — persona física
      • company — empresa
  • type — tipo de cliente. Valores posibles:
    • potential — cliente potencial
    • client — cliente
    • reseller — agente
    • partner — colaborador
  • lead_source — fuente del lead. Valores posibles:
    • manual — manual
    • call_incoming — llamada entrante
    • call_outgoing — llamada saliente
    • form — forma
  • lead_status — estado del lead. Valores posibles:
    • not_processed — no gestionado
    • in_progress — en proceso
    • finished — finalizado
  • contact_type — tipo de contacto. Valores posibles:
    • customer — cliente
    • lead — lead

Devuelve la tarea por su ID

Respuesta

                                    {
  "id": 40,
  "type": "task",
  "title": "Create text for Good Company",
  "description": "",
  "start": "2020-05-26 09:00:00",
  "end": "2020-05-26 12:30:00",
  "allDay": false,
  "created_by": 234,
  "responsible_user": 234,
  "phone": "",
  "call_done": 0,
  "completed": 0,
  "completed_comment": "",
  "members": [234, 235],
  "customers": [
    {
      "id": 3486,
      "name": "Good Company",
      "status": "company",
      "type": "client",
      "lead_source": "manual",
      "lead_status": "not_processed",
      "contact_type": "customer"
    }
  ]
}

donde

• id — identificador de tarea
• type — tipo de tarea. Valores posibles:
  • task — tarea
  • call — llamada
• title — nombre de tarea
• description — descripción de tarea (en formato Quill Delta)
• start — fecha y hora de inicio de tarea (en formato YYYY-MM-DD hh:mm:ss)
• end — fecha y hora de fin de tarea (en formato YYYY-MM-DD hh:mm:ss)
• allDay — tarea para todo el día (true o false)
• created_by — identificador de usuario creador de tarea
• responsible_user — identificador de usuario responsable de tarea
• phone — número de teléfono para llamada (si el tipo de tarea es llamada)
• call_done — muestra si se ha realizado la llamada
• completed — muestra que la tarea está marcada como finalizada
• completed_comment — comentario para la tarea finalizada
• members — conjunto de participantes de la tarea (identificadores de usuarios solo)
• customers — conjunto de clientes y leads adjuntados a la tarea. Cada elemento del conjunto contiene los siguientes campos:
  • id — identificador del lead / cliente
  • name — nombre del lead / cliente
  • status — estado del cliente. Valores posibles:
    • individual — persona física
    • company — empresa
  • type — tipo de cliente. Valores posibles:
    • potential — cliente potencial
    • client — cliente
    • reseller — agente
    • partner — colaborador
  • lead_source — fuente del lead. Valores posibles:
    • manual — manual
    • call_incoming — llamada entrante
    • call_outgoing — llamada saliente
    • form — forma
  • lead_status — estado del lead. Valores posibles:
    • not_processed — no gestionado
    • in_progress — en proceso
    • finished — finalizado
  • contact_type — tipo de contacto. Valores posibles:
    • customer — cliente
    • lead — lead

Crea una nueva tarea con los datos indicados

Parámetros

• event — datos de nueva tarea. Estructura:

(Respuesta 1)

                                    Respuesta 1:
{
    "type": "task",
    "title": "Create text for Good Company",
    "description": "",
    "start": "2020-05-26 09:00:00",
    "end": "2020-05-26 12:30:00",
    "allDay": false,
    "responsible_user": 234,
    "phone": "",
    "members": [234, 235],
    "customers": [3486, 3487]
}

donde

• type — tipo de tarea. Valores posibles:
  • task — tarea
  • call — llamada
• title — nombre de tarea
• description — descripción de tarea (en formato Quill Delta)
• start — fecha y hora de inicio de tarea (en formato YYYY-MM-DD hh:mm:ss)
• end — fecha y hora de fin de tarea (en formato YYYY-MM-DD hh:mm:ss)
• allDay — tarea para todo el día (true o false)
• responsible_user — identificador de usuario responsable de tarea
• phone — número de teléfono para llamada (si el tipo de tarea es llamada)
• members — conjunto de participantes de la tarea (identificadores de usuarios solo)
• customers — conjunto de clientes y leads adjuntados a la tarea (solo identificadores de clientes y leads)

Respuesta

(Respuesta 2)

                                    Respuesta 2:
{
  "id": 7216
}

donde

• id — identificador de tarea creada

Actualiza la tarea existente con el ID indicado

Parámetros

• event — nuevos datos de la tarea. Estructura:

                                    {
    "title": "Create text for Good Company",
    "description": "",
    "start": "2020-05-26 09:00:00",
    "end": "2020-05-26 12:30:00",
    "allDay": false,
    "created_by": 234,
    "responsible_user": 234,
    "phone": "",
    "members": [234, 235],
    "customers": [3486, 3487]
}

donde

• title — nombre de tarea
• description — descripción de tarea (en formato Quill Delta)
• start — fecha y hora de inicio de tarea (en formato YYYY-MM-DD hh:mm:ss)
• end — fecha y hora de fin de tarea (en formato YYYY-MM-DD hh:mm:ss)
• allDay — tarea para todo el día (true o false)
• responsible_user — identificador de usuario responsable de tarea
• phone — número de teléfono para llamada (si el tipo de tarea es llamada)
• members — conjunto de participantes de la tarea (identificadores de usuarios solo)
• customers — conjunto de clientes y leads adjuntados a la tarea (solo identificadores de clientes y leads)

Finaliza (cierra) la tarea

Parámetros

• comment (opcional) - comentario

Elimina la tarea por su ID

Devuelve el listado de llamadas

Parámetros

• search (opcional) — barra de búsqueda. La búsqueda se realiza de forma combinada por:
  • de número de teléfono
  • de números de contactos (clientes, empleados, leads o usuarios)
• filter (opcional) — filtro de llamadas. Estructura del filtro:
• take (para la muestra por página) - cuántas llamadas devolver (por defecto 20)
• skip (para la muestra por página) - cuántas llamadas saltarse (por defecto 0)

(Respuesta 1)

                                    Respuesta 1:
{
    "user": 23,
    "type": "incoming",
    "status": "answer",
    "dateFrom": "2020-06-03 14:56:00",
    "dateTo": "2020-06-26 14:56:00"
}

donde

• user — usuario (identificador)
• type — tipo de llamada. Valores posibles:
  • incoming — llamada entrante
  • outgoing — llamada saliente
• status — estado de la llamada. Valores posibles:
  • answer — llamada de éxito
  • noanswer — sin respuesta
  • cancel — cancelada
  • busy — ocupado
  • failed — no se ha podido realizar
• dateFrom — ver solo llamadas realizadas después de la hora seleccionada (formato: YYYY-MM-DD hh:mm:ss)
• dateTo — ver solo llamadas realizadas antes de la hora seleccionada (formato: YYYY-MM-DD hh:mm:ss)

Cualquiera de los parámetros del filtro se puede omitir, es decir, es opcional.

• sort (opcional) — filtro de llamadas. Estructura del parámetro:

(Respuesta 2)

                                    Respuesta 2:
{
    "attr": "time",
    "desc": 0
}

donde

• attr — campo de clasificación. Valores posibles:
  • phone — número de teléfono
  • status — estado de llamada
  • duration — duración de llamada
  • time — hora de llamada
• desc — sentido de clasificación. Valores posibles:
  • 0 — creciente
  • 1 — descreciente

Respuesta

(Respuesta 3)

                                    Respuesta 3:
{
  "totalCount": 233,
  "calls": [
    {
      "id": 127,
      "type": "outgoing",
      "status": "answer",
      "phone": "+44123456789",
      "user_id": 179,
      "time": "2019-07-31 17:58:40",
      "duration": 9,
      "pbx_call_id": "out_807ghh1h7f09fa7a188dbf8a6998b1c9ghg4ij06",
      "record": 1,
      "record_url_till": "2020-07-24 20:08:10",
      "contact_type": "customer",
      "contact_name": "Good Company",
      "contact_customer_id": 3486,
      "contact_employee_id": null,
      "employee_customer_id": null,
      "contact_user_id": null,
      "is_lead": 1,
      "record_urls": [
        {
          "url": "https ://api.zadarma.com/v1/pbx/record/download/[...]/[...]/[...].mp3"
        }
      ]
    }
  ]
}

donde

• totalCount — número total de llamadas (incluyendo la barra de búsqueda y el filtro)
• calls — conjunto de llamadas (teniendo en cuenta la muestra por página). Cada elemento del conjunto contiene los siguientes parámetros:
  • id — identificador de llamada
  • type — tipo de llamada. Valores posibles:
    • incoming — llamada entrante
    • outgoing — llamada saliente
  • status — estado de la llamada. Valores posibles:
    • answer — llamada de éxito
    • noanswer — sin respuesta
    • cancel — cancelada
    • busy — ocupado
    • failed — no se ha podido realizar
  • phone — número de teléfono
  • user_id — usuario realizador o receptor de la llamada
  • time — hora de la llamada en formato YYYY-MM-DD hh:mm:ss
  • duration — duración de la llamada en segundos
  • pbx_call_id — identificador de la llamada en la centralita Zadarma
  • record — si está activada la grabación de llamadas
  • record_url_till — tiempo durante el que funcionará el enlace enlace de grabación de llamada
  • contact_type — tipo de contacto. Valores posibles:
    • customer — cliente o lead (ver parámetro is_lead)
    • employee — empleado del cliente
    • user — usuario
  • contact_name — nombre del contacto
  • contact_customer_id — identificador del cliente o lead (si la llamada está vinculada al cliente)
  • contact_employee_id — identificador del empleado (si la llamada está vinculada al empleado)
  • employee_customer_id — identificador del cliente matriz (si la llamada está relacionada con el empleado)
  • contact_user_id — identificador del usuario (si la llamada está relacionada con el usuario)
  • is_lead — muestra si la llamada está relacionada con el lead
  • record_urls — conjunto de grabaciones de llamadas (puede faltar ya que se ha de solicitar expresamente). Cada elemento del conjunto - objeto que contiene el siguiente campo:
    • url — enlace a la grabación de llamada

Devuelve el archivo por su ID

inicio de llamada entrante a la centralita virtual

Parámetros que se envían al enlace para las notificaciones:

• event – evento (NOTIFY_START)
• call_start – hora inicio de llamada;
• pbx_call_id – id de la llamada;
• caller_id – número del llamante;
• called_did – número al que se ha llamado.

Redacción de la firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['caller_id'] . $_POST['called_did'] . 
        $_POST['call_start'], API_SECRET));

Para las solicitudes NOTIFY_START y NOTIFY_IVR se puede modificar "sobre la marcha" el escenario de la llamada en curso, enviando como respuesta una de las siguientes alternativas:

Reproducir el archivo:

(Respuesta 1)

                                    Respuesta 1:
{
    "redirect": ID,
    "return_timeout": TIMEOUT (необязательное)
}

donde,

• ivr_play – valor de la columna ID en el listado de archivos cargados/insertados del archivo requerido.

Reproducir una frase popular:

(Respuesta 2)

                                    Respuesta 2:
{
    "hangup": 1
}

donde,

• ivr_saypopular – número de la frase del listado;

Reproducir cifras:

(Respuesta 3)

                                    Respuesta 3:
{
    "caller_name": NAME
}

Reproducir el número (de acuerdo con las reglas numéricas complejas):

(Respuesta 4)

                                    Respuesta 4:
{
    "wait_dtmf": {
        "timeout": TIMEOUT,
        "attempts": ATTEMPTS,
        "maxdigits": MAXDIGITS,
        "name": NAME,
        "default": DEFAULT,
    }
}

donde,

• language puede tomar uno de los valores: ru, ua, en, es, pl;

Si se han indicado ivr_saydigits o ivr_saynumber, en el siguiente evento NOTIFY_IVR se añadirá el parámetro: "ivr_saydigits": "COMPLETE" o "ivr_saynumber": "COMPLETE"

En cada una de las solicitudes anteriores puede haber una solicitud de entrada de dígitos de la persona que llama:

(Respuesta 5)

                                    Respuesta 5:
{
    "ivr_play": "ID"
}

donde,

• timeout - tiempo de espera de entrada de dígitos en segundos;
• attempts - número de intento de entrada de dígitos de la persona que llama;
• maxdigits - número máximo de entrada de dígitos;
• name - el nombre que se devolverá en la respuesta;
• default - acción si no se ha escrito ningún dígito (toma nota que para que la reproducción de la acción se requiere previamente reproducir el archivo con el comando ivr_play de acuerdo al p.4 más abajo). Valores posibles:
  • id del escenario del desvío (en formato 0-1, donde 0 es el menú de voz, 1 es el número del escenario);
  • menú de la centralita virtual en formato 0-main, donde 0 es el id del menú;
  • extensión de la centralita virtual (número de 3 dígitos);
  • hangup - terminar la llamada.

En el siguiente evento NOTIFY_IVR se indicará el parámetro adicional:

(Respuesta 6)

                                    Respuesta 6:
{
    "ivr_saypopular": 1,
    "language": "en"
}

donde,

• name - nombre indicado en la anterior respuesta;
• digits - dígitos introducidos por la persona que llama;
• default_behaviour - indicado si el usuario no ha apretado ningún botón y ha funcionado el comportamiento por defecto;

Transferir la llamada:

(Respuesta 7)

                                    Respuesta 7:
{
    "ivr_saydigits": "12",
    "language": "en"
}

donde,

• redirect - id del escenario de desvío (en formato 0-1, donde 0 es el número del menú de voz, 1 es el número del escenario); o en formato 1 donde q es el escenario (número del menú de voz es 0 en este caso); o menú de la centralita virtual 0-main, donde 0 es el id del menú; o extensión de la centralita virtual (número de 3 dígitos); o "blacklist" - en este caso la llamada será rechazada con el tono de ocupado;
• return_timeout - Valores en segundos. Posibles valores:
  • 0, la llamada no será devuelta al menú;
  • >= 3 - duración de la llamada antes de ser devuelta al menú;
• rewrite_forward_number - desvío al número de teléfono. Parámetro opcional, disponible solo para el uso conjunto con el parámetro redirect. Imprescindible para el cambio en el momento del número del desvío indicado en los ajustes de la extensión de la centralita.

Finalizar la llamada:

(Respuesta 8)

                                    Respuesta 8:
{
    "ivr_saynumber": "123",
    "language": "en"
}

En cada respuesta se puede indicar adicionalmente:

Establecer un nombre para el número entrante:

(Respuesta 9)

                                    Respuesta 9:
{
    "wait_dtmf": {
        "name": NAME,
        "digits": DIGITS,
        "default_behaviour": "1"
    }
}

donde,

• caller_name - nombre del número.

Listado de frases populares:

• Buenos días
• Desvío de llamadas
• Llamada desde la web
• Bienvenidos
• Mensaje de prueba
• Permanezca en la línea
• Ha llamado en horario no laboral
• Todos nuestros operadores están ocupados. Le responderá el primer operador disponible.
• Introduzca el número de extensión del abonado
• Introduzca el número de extensión del operador
• Introduzca el número de extensión
• Por favor, permanezca a la espera
• Introduzca el número de extensión o espere a ser atendido por un operador
• Por favor, deje su mensaje
• Deje su mensaje después de la señal
• Por favor, vuelva a llamar en horario laboral
• Gracias por contactar con nosotros.
• Gracias por su llamada.
• Espere a ser atendido por un operador
• Su llamada es muy importante para nosotros
• La llamada está siendo grabada
• En estos momentos no estamos en la oficina
• le devolveremos la llamada a la mayor brevedad posible.
• Estamos de día de descanso.
• Hola!

inicio de llamada entrante a la extensión de la centralita virtual

Parámetros que se envían al enlace para la notificación:

• event – evento (NOTIFY_INTERNAL)
• call_start – duración del inicio de la llamada;
• pbx_call_id – id de la llamada;
• caller_id – número del llamante;
• called_did –número al que se realiza la llamada;
• internal – (opcional) extensión.
• transfer_from – (opcional) el iniciador de la transferencia, extensión.
• transfer_type – (opcional) tipo de transferencia.

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['caller_id'] . $_POST['called_did'] . 
        $_POST['call_start'], API_SECRET));

respuesta de llamada al número interno o externo

Parámetros que se envían al enlace para la notificación:

• event – evento (NOTIFY_ANSWER)
• caller_id – número del llamante;
• destination – número al que se realiza la llamada;
• call_start – hora del inicio de la llamada;
• pbx_call_id – id звонка;
• internal – (opcional) extensión.

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['caller_id'] . $_POST['destination'] . 
        $_POST['call_start'], API_SECRET));

fin de llamada entrante a la extensión de la centralita virtual

Parámetros que se envían al enlace para la notificación:

• event – evento (NOTIFY_END)
• call_start – hora del inicio de la llamada;
• pbx_call_id – id de la llamada;
• caller_id – número del llamante;
• called_did – número al que se realiza la llamada;
• internal – (opcional) extensión;
• duration – duración en segundos;
• disposition – estado de la llamada:
  • 'answered' – conversación,
  • 'busy' – ocupado,
  • 'cancel' - cancelado,
  • 'no answer' - sin respuesta,
  • 'failed' - no ha sido posible,
  • 'no money' - no hay saldo, se ha superado el límite,
  • 'unallocated number' - el número no existe,
  • 'no limit' - se ha superado el límite,
  • 'no day limit' - se ha superado el límite diario,
  • 'line limit' - se ha superado el límite de líneas,
  • 'no money, no limit' - se ha superado el límite;
• last_internal – extensión, último partícipe de la llamada (después de la transferencia o recogida de llamada);
• status_code – código del estado de la llamada Q.931;
• is_recorded – 1 - hay grabación de la llamada, 0 - no hay grabación;
• call_id_with_rec – id de la llamada con grabación (recomendamos cargar el archivo de la grabación no antes de 40 segundos puesto que se requiere tiempo para guardar el archivo).

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['caller_id'] . $_POST['called_did'] . 
        $_POST['call_start'], API_SECRET));

inicio de llamada saliente desde la centralita virtual

Parámetros que se envían al enlace para la notificación:

• event – evento (NOTIFY_OUT_START)
• call_start – hora del inicio de la llamada;
• pbx_call_id – id de la llamada;
• destination – número al que se realiza la llamada;
• caller_id – número establecido en la extensión de la centralita virtual o en la regla de determinación en función del destino. Si el número no está establecido se se transmite 0;
• internal – (opcional) número de extensión.

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['internal'] . $_POST['destination'] . 
        $_POST['call_start'], API_SECRET));

fin de llamada salientes desde la centralita virtual

Parámetros que se envían al enlace para la notificación:

• event – evento (NOTIFY_OUT_END)
• call_start – hora del inicio de la llamada;
• pbx_call_id – id de la llamada;
• caller_id – número establecido en la extensión de la centralita virtual o en la regla de determinación en función del destino. Si el número no está establecido se se transmite 0;
• destination – número al que se realiza la llamada;
• internal – (opcional) extensión;
• duration – duración en segundos;
• disposition – estado de la llamada:
  • 'answered' – conversación,
  • 'busy' – ocupadо,
  • 'cancel' - cancelado,
  • 'no answer' - sin respuesta,
  • 'failed' - no ha sido posible,
  • 'no money' - no hay saldo, se ha superado el límite,
  • 'unallocated number' - el número no existe,
  • 'no limit' - se ha superado el límite,
  • 'no day limit' - se ha superado el límite diario,
  • 'line limit' - se ha superado el límite de las líneas,
  • 'no money, no limit' - se ha superado el límite;
• status_code – código del estado de la llamada Q.931;
• is_recorded – 1 - hay grabación de la llamada, 0 - no hay grabación;
• call_id_with_rec – id de la llamada con grabación (recomendamos cargar el archivo de la grabación no antes de 40 segundos después de la notificación puesto que se requiere tiempo para guardar el archivo).

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['internal'] . $_POST['destination'] . 
        $_POST['call_start'], API_SECRET));

la grabación de la llamada está lista para descargarse

Parámetros que se envían al enlace para la notificación:

• event – evento(NOTIFY_RECORD)
• call_id_with_rec – id único de la llamada con grabación de la conversación;
• pbx_call_id – ID permanente de la llamada externa a la centralita virtual (no cambia al pasar de escenarios, menú de voz, transferencia, etc., se muestra en estadísticas y notificaciones).

Crear una firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['pbx_call_id'] . $_POST['call_id_with_rec'], API_SECRET));

respuesta de la persona que llama a la acción asignada

Parámetros que se envían al enlace de notificaciones:

• event – evento (NOTIFY_IVR)
• call_start – hora inicio de la llamada;
• pbx_call_id – id de la llamada;
• caller_id – número del llamante;
• called_did – número al que se ha llamado.

Redacción de la firma de verificación para la notificación de llamadas entrantes, ejemplo en PHP:

                                    $signatureTest = base64_encode(hash_hmac('sha1', 
        $_POST['caller_id'] . $_POST['called_did'] . 
        $_POST['call_start'], API_SECRET));

Las posibles respuestas enviadas son similares a las respuestas de las solicitudes NOTIFY_START

                                    <?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?>

Para aumentar la seguridad recomendamos permitir el acceso a tu enlace únicamente desde la dirección IP 185.45.152.42.

Además, si has solicitado la contraseña de acceso a API, en cada solicitud de tu enlace recibirás un encabezado adicional "Signature", mediante el cual también puedes verificar la integridad, así como la autenticidad de los datos.

Puedes ver un ejemplo de script en en nuestro repositorio en GitHub.

informe sobre verificación de números

Parámetros enviados al enlace para las notificaciones:

• event – evento (NUMBER_LOOKUP)
• success – indicador de éxito de validación;
• description – descripción del estado de finalización de la validación;
• result – datos del informe;
  • number – número comprobado;
  • mcc – prefijo móvil del país;
  • mnc – prefijo del operador móvil;
  • ported – indicador de transferencia a otro operador;
  • roaming – indicador de estar en roaming;
  • error – estado del error;
  • errorDescription – descripción del error;
  • mccName – nombre del país;
  • mncName – nombre del operado;

Redacción de la suscripción de verificación:

$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));

información sobre llamadas a los números conectados en call tracking

Se envía una vez cada 8 minutos si hay nuevas llamadas.

Parámetros que se envían al enlace de notificación:

• event – evento (CALL_TRACKING)
• result - área
  • tracker - ID del tracker (se puede averiguar en la página donde se inserta el código);
  • start - hora de inicio de la llamada;
  • duration - duración de la llamada en segundos;
  • caller_id - número del llamante;
  • caller_did - número al que se ha llamado;
  • country - (opcional) país desde el que se realiza la llamada;
  • ga_id - (opcional, si en los ajustes está indicado Id Google Analytics) id del visitante en Google Analytics;
  • url - dirección de la página desde la que se realizó la llamada;
  • utm_source, utm_medium, utm_campaign, utm_term, utm_content - (opcional, si al visitar el sitio web estaban indicadas las etiquetas utm) etiquetas utm a través de las cuales ha llegado el usuario a la web la última vez;
  • first_utm - (opcional, si al visitar por primera vez el sitio web estaban indicadas las etiquetas utm diferentes a las que se ha visitado por última vez) matriz con las etiquetas utm indicadas más arriba a través de las cuales el usuario ha visitado la web por primera vez;
  • pbx_call_id – id de la llamada (excepto los gratuitos);

Redacción de la suscripción de verificación:

$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));

información sobre SMS recibidos

Parámetros que se envían al enlace de notificación:

• event – evento (SMS)
• result – área;
  • caller_id – número del remitente;
  • caller_did – número del destinatario;
  • text – texto del mensasje.

Redacción de la suscripción de verificación:

$signatureTest = base64_encode(hash_hmac('sha1', $_POST['result'], API_SECRET));

resultado de reconocimiento de voz

Parámetros que se envían al enlace de notificaciones:

• event – evento (SPEECH_RECOGNITION)
• lang – idioma;
• call_id – id único de llamada, este id está indicado en el nombre del archivo con la grabación de la llamada;
• pbx_call_id – ID permanente de la llamada externa a la centralita virtual;
• result:
  • words - conjunto:
    • result - conjunto de palabras (conjunto):
      • s - hora inicio de palabra
      • e - hora fin de palabra
      • w - palabra
    • channel - número de canal
  • phrases - conjunto:
    • result - frase
    • channel - número de canal