Team Transfer (Blind)
Send the customer to a team (queue) of the organisation. The same endpoint as Start a Transfer, with team instead of to. Inbound, softphone outbound and click-to-call calls all work.
The transfer is blind: there is no consult, the switch moves the customer into the team and hangs up the agent's leg right away, and the API replies when that is done. The customer then goes through the team exactly like a new call to that team: its welcome and waiting music, its ring rule, its sticky agent, its voicemail and missed-call handling.
- Endpoint
POST /v2/user/transfer - Base URL
https://rest.telecmi.com - Content-Type
application/jsonorapplication/x-www-form-urlencoded
Sample Request
{
"cmiuuid": "d3c4a9f0-7b21-4e0a-9f6e-1c2b3a4d5e6f",
"team": "support_2224257"
}
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| token | string | No | Agent login token, when not sent in the x-access-token header (or as a token query parameter). |
| *cmiuuid | string | Yes | The call id, see Overview. |
| *team | string | Yes | The team's full name, for example support_2224257, or its short name support; the platform adds the organisation suffix. Letters, digits, _, - and ., at most 128. Only teams of the agent's own organisation are found. When team is present, to and type are ignored. |
curl -s -X POST https://rest.telecmi.com/v2/user/transfer \
-H "Content-Type: application/json" -H "x-access-token: <jwt>" \
-d '{ "cmiuuid": "d3c4a9f0-7b21-4e0a-9f6e-1c2b3a4d5e6f", "team": "support_2224257" }'
Sample Response
The transfer is already done when this reply arrives: the customer is in the team and the agent's call has ended.
{
"code": 202,
"msg": "team transfer done",
"transfer_id": "5a0e8f2c-3b7d-4c1e-9f6a-8d2b4e6c1a37",
"team": "support_2224257"
}
team is the team's full name as found. There is nothing to merge or cancel afterwards; /v2/user/transfer/control replies 409 no active transfer on this leg.
Error Codes
code | msg | Meaning | What to do |
|---|---|---|---|
400 | cmiuuid param missing | No call id given. | Fix the request. |
400 | team must be a team name | team has characters other than letters, digits, _, - and ., or is longer than 128. | Fix the request. |
407 | Failed to authenticate token. (field message, with error: true) | Missing or invalid token. | Log in again. |
404 | team not found in org <org> | No team with that name in the agent's organisation. | Check the name. |
404 | cmiuuid not found for agent <id> in org <org> (is the token for the agent who answered?) | No live call with this id belongs to the agent in the token. | See Why a lookup can fail. |
404 | channel not found | The agent's channel is gone: the call just ended. | Treat the call as over. |
409 | transfer already in progress | An attended transfer is running on this call (consult or merge). | cancel it first, or wait for its terminal event. |
409 | no customer on this call to transfer | The agent's leg has no live customer leg (for example the customer hung up a moment ago). | Treat the call as over. |
503 | call store unavailable, retry in a moment | The live-call store did not answer. | Retry after a second. |
503 | switch unreachable | The switch did not answer within 5 s. | Retry once. |
503 | switch error | Includes the switch failing to move the customer; the call is then left as it was, with the agent still talking to the customer. | Retry once. |
Transfer Events
Two transfer events, both with transfer_type: "blind" and to = the team's full name:
| State | When |
|---|---|
initiated | The switch started moving the customer. |
completed | The customer is in the team. Terminal. The agent's leg hangs up half a second later. |
failed | Instead of completed, with reason: "switch_error", when the switch could not move the customer. Terminal; the agent and the customer stay connected. |
There is no ringing or answered: the team rings its agents the way it does for any call. Socket example for the transferring agent:
{"state":"initiated","code":100,"transfer_id":"5a0e8f2c-3b7d-4c1e-9f6a-8d2b4e6c1a37","to":"support_2224257","type":"blind","reason":"","cmiuuid":"46c81098-4b17-4295-9172-397a4c0d2b11"}
{"state":"completed","code":202,"transfer_id":"5a0e8f2c-3b7d-4c1e-9f6a-8d2b4e6c1a37","to":"support_2224257","type":"blind","reason":"","cmiuuid":"46c81098-4b17-4295-9172-397a4c0d2b11"}
Webhook example (inbound call, agent 5159_2224257):
{"type":"event","status":"transfer_initiated","transfer_id":"5a0e8f2c-3b7d-4c1e-9f6a-8d2b4e6c1a37","transfer_type":"blind","user":"5159_2224257","team":"okok_2224257","to":"support_2224257","cmiuuid":"46c81098-4b17-4295-9172-397a4c0d2b11","conversation_uuid":"9def3ef9-b9bf-4903-80bf-dbb4d6013bb9","from":"919894396168","app_id":2224257,"time":1789636527000,"custom":"none"}
{"type":"event","status":"transfer_completed","transfer_id":"5a0e8f2c-3b7d-4c1e-9f6a-8d2b4e6c1a37","transfer_type":"blind","user":"5159_2224257","team":"okok_2224257","to":"support_2224257","cmiuuid":"46c81098-4b17-4295-9172-397a4c0d2b11","conversation_uuid":"9def3ef9-b9bf-4903-80bf-dbb4d6013bb9","from":"919894396168","app_id":2224257,"time":1789636527600,"custom":"none"}
In the webhook payload team is still the team the call came in on (or the agent's outbound team), and to is the team the customer was sent to. The ordinary call events continue as usual: the transferring agent's leg ends with its hangup event, and the new team's agents get ringing, answered and hangup events as for any call to that team. See Transfer Events.
Team agents' and call records' view
The agents of the team see an ordinary incoming team call: the caller shown is the customer's number, on outbound and click-to-call calls too. It is not marked as a transfer (the SDK's inComingCall.transfer is false), unlike an attended transfer to an agent (see Scenarios).
Call records. The transfer does not merge or rewrite records:
- Inbound: the transferring agent's record ends when the agent's leg hangs up, and the team agent who answers gets a new inbound record with the customer's number as
from. - Softphone outbound and click-to-call: the outbound record keeps
from= the organisation's number andto= the customer, although the team's agents are shown the customer's number while it rings.