Skip to content

API de Transferencia

Esta API permite transferir interacciones a usuarios o campañas específicas. Para interacciones de telefonía, también permite transferencias a números externos.

Endpoint de transferencia

  • Método: PUT
  • URL: https://<dominio>.ucontactcloud.com/api/inbox/id/<guid>/transfer

Descripción general

El endpoint inicia la transferencia de una interacción a un destino especificado. Los destinos posibles son un usuario específico, una campaña específica o, para interacciones de telefonía, un número externo. También permite especificar si la transferencia será ciega (blind) o asistida (attended).

Cuerpo de la solicitud (Request body)

  • Content-Type: application/json
  • Body: Un objeto JSON que contiene:
    • Una clave destinationType. El valor de destinationType puede ser: "agent" para transferencias a usuarios, "campaign" para transferencias a campañas o "external" para transferencias externas (válido solo para interacciones de telefonía).
    • Una clave destination. El valor de destination depende del destinationType: debe ser un nombre de usuario para transferencias a agentes, el nombre de una campaña para transferencias a campañas, o un número de teléfono para transferencias externas.
    • Una clave type, requerida únicamente para telefonía. El valor de type puede ser "blind" o "attended".

Ejemplos del cuerpo (Body)

Transferir una interacción de texto a una campaña específica:

json
    {
        "destinationType":"campaign",
        "destination":"sales_team"
    }

Transferir una interacción de texto a un usuario específico:

json
    {
        "destinationType":"agent",
        "destination":"jon_smith"
    }

Transferencia ciega de una llamada a un número externo:

json
    {
        "type":"blind",
        "destinationType":"external",
        "destination":"1-533-445"
    }

Transferencia atendida de una llamada a un usuario específico:

json
    {
        "type":"attended",
        "destinationType":"agent",
        "destination":"jane_doe"
    }

uContact by net2phone