immediateForwardToContact
Applies to: Skype for Business 2015
Immediately forward all incoming calls to a user-provided number or contact.
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. |
Resource description
The presence of this resource indicates that the user can forward her incoming calls to the number or contact of her choosing.The calls will ring only at the target.
Properties
None
Links
None
Azure Active Directory scopes for online applications
The user must have at least one of these scopes for operations on the resource to be allowed.
| Scope | Permission | Description |
|---|---|---|
| User.ReadWrite | Read/write Skype user information | Allows the app to read and update presence, photo, location, note, call forwarding settings of the signed-in user |
Operations
POST
Immediately forward all incoming audio calls to a user-provided number or contact.
Query parameters
| Name | Description | Required? |
|---|---|---|
| target | The number or contact that the user wants to immediately forward her calls to.If the target is a number, the application should provide a tel URI, which is provided by the contact.If the target is a contact, the application should provide a sip URI, which is provided by the contact.The maximum length is 80 characters. | Yes |
Request body
| Name | Description | Required? |
|---|---|---|
| target | The number or contact that the user wants to immediately forward her calls to.If the target is a number, the application should provide a tel URI, which is provided by the contact.If the target is a contact, the application should provide a sip URI, which is provided by the contact.The maximum length is 80 characters. String | Yes |
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 |
|---|---|---|---|
| Forbidden | 403 | None | Indicates that the user is not enabled for enterprise voice, the user is anonymous, or the administrator has disabled call forwarding to custom numbers. |
| ServiceFailure | 500 | CallbackChannelError | The remote event channel is not reachable |
| Conflict | 409 | AlreadyExists | The already exists error. |
| Conflict | 409 | TooManyGroups | The too many groups error. |
| Conflict | 409 | None | Un-supported Service/Resource/API error. |
| Gone | 410 | CannotRedirect | Cannot redirect since there is no back up pool configured. |
Examples
Only server-supplied query parameters, if any, are shown in the request sample.
JSON Request
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/me/callForwardingSettings/immediateForwardSettings/immediateForwardToContact HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
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.
HTTP/1.1 204 No Content
XML Request
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/me/callForwardingSettings/immediateForwardSettings/immediateForwardToContact HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
XML Response
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 204 No Content