startPhoneAudio
Applies to: Skype for Business 2015
Initiates a call-via-work.
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
startPhoneAudio allows a user to create a new peer-to-peer conversation with a contact using call-via-work.A call-via-work call is an outgoing call that is initiated from a user's phone, and that displays the user's Skype for Business work identity to the remote party.A phoneAudioInvitation will be started; its status can be tracked on the event channel.
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 |
|---|---|---|
| Conversations.Initiate | Initiate conversations and join meetings | Allows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user |
| Conversations.Receive | Receive conversation invites | Allows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user |
Operations
POST
Starts a phoneAudioInvitation and creates a new conversation with a contact.
Query parameters
| Name | Description | Required? |
|---|---|---|
| to | The target of this invitation. | No |
Request body
| Name | Description | Required? |
|---|---|---|
| operationId | The ID that the application supplies to correlate its request with the corresponding operation started in the event channel.The maximum length is 50 characters. String | No |
| phoneNumber | The user's own telephone number that she wants to ring when using startPhoneAudio.The input parameter is a digit string that can include "+" if the following digit string is an E.164 normalized number.This parameter is optional and defaults to the phone number supplied when the application was created.String | No |
| importance | The conversation's importance (Importance): Normal, Urgent, or Emergency.An application can use this as a hint to inform the user.(Importance)Normal, Urgent, or Emergency | No |
| subject | The conversation's subject.The property has a maximum length of 250 characters.The maximum length is 250 characters. String | No |
| threadId | The conversation's thread ID.An application can use this ID to continue an existing conversation.String | No |
| to | The contact that this invitation is to be sent to.String | Yes |
Response body
| Item | Description |
|---|---|
| phoneAudioInvitation | Represents an invitation to a conversation for the phoneAudio modality. |
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 |
|---|---|---|---|
| BadRequest | 400 | NormalizationFailed | The phone normalization failed. |
| Forbidden | 403 | None | Phone audio is not listed in the capabilities. |
| 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/communication/startPhoneAudio HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 210
{
"operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
"phoneNumber" : "tel : +14255551234",
"importance" : "Urgent",
"subject" : "SkypeforBusiness",
"threadId" : "292e0aaef36c426a97757f43dda19d06",
"to" : "sip : john@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 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/146
XML Request
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/startPhoneAudio HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 454
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
<property name="phoneNumber">tel:+14255551234</property>
<property name="importance">Normal</property>
<property name="subject">Skype for Business</property>
<property name="threadId">292e0aaef36c426a97757f43dda19d06</property>
<property name="to">sip:john@contoso.com</property>
</input>
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 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/146