Transfer API

This API allows you to transfer interactions to specific users or campaigns, for telephony interactions it also allows transfers to external numbers.

Transfer endpoint

• Method: PUT
• URL: https://<domain>.ucontactcloud.com/api/inbox/id/<guid>/transfer

General description

The endpoint begins to transfer an interaction to a specified destination. The possible destinations are a specific user, a specific campaign, for a telephony interaction you can transfer to an external number, and specify if the transfer will be blind or attended.

Request body

• Content-Type: application/json
• Body: A JSON object containing:
  • a destinationType key. The value of destinationType is either: "agent" for user transfers, "campaign" for campaign transfer or "external" for external transfer (only valid for a telephony interaction).
  • a destination key. The value of destination depends on the destinationType, it should be a username for user transfers, a campaign name for campaign transfers, a phone number for external transfers.
  • a type key, only required for telephony. The value of type is either "blind" or "attended".

Body examples

Transfer a text interaction to a specific campaign:

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

Transfer a text interaction to a specific user:

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

Blind transfer a call to an external number:

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

Attended transfer a call to a specific user:

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