ms:rtc:saas:transfer

JSON

Represents an operation resource for transferring call. The presence of this resource indicates a pending transfer operation.

Web link

For more on web links, see Web Links.

Name	Description
rel	The resource that this link points to. In JSON, this is the outer container.
href	The location of this resource on the server, and the target of an HTTP operation.

Properties

Name	Description
operationId	Gets the operation identifier.

Links

This resource can have the following relationships.

Link	Description
ms:rtc:saas:audioVideo	Represents the audio/video modality in the corresponding ms:rtc:saas:conversation.

Events

started
completed

Resource	Priority	Sender	Reason
ms:rtc:saas:transfer	High	ms:rtc:saas:conversation	Delivered when the transfer operation is started.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=67"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=67"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:transfer",
            "href" : "communication/conversations/948/audioVideo/transfer"
          },
          "type" : "started"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:transfer	High	ms:rtc:saas:conversation	Delivered when the transfer operation completes.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=66"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=66"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:transfer",
            "href" : "communication/conversations/948/audioVideo/transfer"
          },
          "type" : "completed"
        }
      ]
    }
  ]
}

Asynchronous reason codes

The completed event is sent on the event channel when the operation is finished. A status value of "success" indicates that the operation completed successfully.A status value of "failure" indicates that the operation failed. In case of failure, the error code and subcode are sent on the event channel.The following table shows the errors that are possible for this resource.

It is recommended that applications handle the error codes shown here. Applications can optionally display subcodes and messages in their user interface.

Conflict

Subcode	Reason
AlreadyExists
None
TooManyGroups

Gone

Subcode	Reason
CannotRedirect

NotFound

Subcode	Reason
None	The transfer target does not exist

RemoteFailure

Subcode	Reason
None	Non specific transfer failure, the exact reason is unknown.
None	The call to be replaced is gone.
TransferDeclined	The transferee declines the transfer request
TransferTargetDeclined	The transfer target decline incoming call.

ServiceFailure

Subcode	Reason
CallbackChannelError
InvalidExchangeServerVersion

Operations

POST

Starts transferring an audio video call to a designated destination. Creates ms:rtc:saas:transfer in event channel.

Request body

Click here to see the input values.

Name	Description	Required?
operationId	Gets the operation identifier. The maximum length is 50 characters.	Yes
preferredLanguage	Preferred language The maximum length is 4096 characters.	No
replacesCallContext	Replaces information	No
to	The transferee that the audioVideo is transferred to	No

Response body

None

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error	Code	Subcode	Description
RemoteFailure	720	TransferDeclined	The transferee declines the transfer request
NotFound	404	None	The transfer target does not exist
RemoteFailure	720	TransferTargetDeclined	The transfer target decline incoming call.
RemoteFailure	720	None	Non specific transfer failure, the exact reason is unknown.
Conflict	409	None	The transferring state prevents processing the HTTP request.
Forbidden	403	None	The conversation state prevents processing the HTTP request.
RemoteFailure	720	None	The call to be replaced is gone.
ServiceFailure	500	CallbackChannelError
Conflict	409	AlreadyExists
Conflict	409	TooManyGroups
Conflict	409	None
Gone	410	CannotRedirect

Examples

Request

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.