Skip to content

Commit 4dac81e

Browse files
authored
Updates to SIP pages and TOC
1 parent 9ba2788 commit 4dac81e

File tree

4 files changed

+47
-20
lines changed

4 files changed

+47
-20
lines changed

articles/communication-services/how-tos/calling-sdk/call-context.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,34 @@
22
title: How to pass contextual data between calls
33
titleSuffix: An Azure Communication Services how-to guide
44
description: Use Azure Communication Services SDKs to pass contextual data between calls.
5-
author: aakanmu
6-
ms.author: aakanmu
5+
author: sloanster
6+
ms.author: micahvivion
77
ms.service: azure-communication-services
88
ms.subservice: calling
99
ms.topic: how-to
10-
ms.date: 05/14/2024
10+
ms.date: 09/13/2024
1111
ms.custom: template-how-to
1212
---
1313

14-
# Passing Contextual Information
14+
# Using the ACS calling SDK to pass contextual User-to-User Information (UUI) data between calls
1515

1616
In this article, you learn how to pass along custom contextual information when routing calls with Azure Communication Services Calling SDKs. This capability allows users to pass metadata about the call, callee, or any other information that is relevant to their application or business logic.
1717

18+
The Azure Communication Services (ACS) WebJS SDK provides developers to include custom contextual data (included as a header on the calling object) when directing and routing calls from one person to another. This information, also known as User-to-User Information (UUI) data or call control UUI data, is a small piece of data inserted by an application initiating the call. The UUI data is opaque to end users making a call.
19+
1820
Contextual information supported includes both freeform custom headers and the standard User-to-User Information (UUI) SIP header. Also when you receive an inbound call, the custom headers and UUI are included in the incomingCall payload.
1921

2022
All custom context data is opaque to Calling SDK or SIP protocols and its content is unrelated to any basic functions.
2123

22-
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
24+
Developers can pass this context by using custom headers, which consist of optional key-value pairs. These pairs can be included in the 'AddParticipant' or 'Transfer' actions within the calling SDK. Once added, you can read the data payload as the call moves between endpoints. By efficiently looking up this metadata and associating it with the call, developers can avoid external database lookups and have the content information readily available within the call object.
25+
26+
The custom call context can be transmitted to SIP endpoints using the SIP protocol. This transmission includes both the custom headers and the standard User-to-User Information (UUI) SIP header. When an inbound call is routed from your telephony network, the data from your Session Border Controller (SBC) in the custom headers and UUI is also included in the IncomingCall event payload.
27+
28+
It’s important to note that all custom context data remains transparent to the calling SDK and isn't related to any of the SDK’s fundamental functions when used in SIP protocols. Here's a tutorial to assist you in adding custom context headers when using the WebJS SDK.
29+
30+
31+
> [!IMPORTANT]
32+
> To use the ability to pass User-to-User Information (UUI) data using the calling SDK you must use the calling WebJS SDK GA or public preview version `1.29.1` or later.
2333
2434
## Prerequisites
2535

articles/communication-services/how-tos/calling-sdk/includes/call-context/call-context-web.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
---
2-
author: aakanmu
2+
author: sloanster
33
ms.service: azure-communication-services
44
ms.topic: include
5-
ms.date: 05/14/2024
6-
ms.author: aakanmu
5+
ms.date: 09/13/2024
6+
ms.author: micahvivion
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
99

10+
## Technical parameters
11+
The calling SDK supports adding up to 5 custom SIP headers and 1000 custom VOIP headers. Additionally, developers can include a dedicated User-To-User header as part of SIP headers list.
12+
13+
The maximum length of a SIP header key is 64 chars, including the X-MS-Custom prefix. Due note that when the SIP header is added the calling SDK will automatically add the ‘X-MS-Custom-’ prefix (which can be seeing if you inspect the SIP header with packet inspector).
14+
15+
The SIP header key may consist of alphanumeric characters and a few selected symbols which include `.`, `!`, `%`, `*`, `_`, `+`, `~`, `-`. The maximum length of SIP header value is 256 chars. The same limitations apply when configuring the SIP headers on your SBC. The SIP header value may consist of alphanumeric characters and a few selected symbols which include `=`, `;`, `.`, `!`, `%`, `*`, `_`, `+`, `~`, `-`.
16+
17+
The maximum length of a VOIP header key is 64 chars. The maximum length of VOIP header value is 1024 chars.
18+
19+
When adding these custom headers as a developer you can choose to add only SIP headers, only VoIP headers or both can be included.
20+
21+
Currently, adding custom User-to-User Information headers is only supported when initiating a 1:1 call. After starting the 1:1 call, you can include additional participants while maintaining the User-to-User Information within the calls.
22+
1023
## Place a call with contextual Information
1124

1225
```js

articles/communication-services/toc.yml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -287,17 +287,6 @@ items:
287287
href: tutorials/building-app-start.md
288288
- name: Build an authentication service using Azure Functions
289289
href: tutorials/trusted-service-tutorial.md
290-
- name: Add video calling to your Android WebView client app
291-
href: quickstarts/voice-video-calling/get-started-android-webview.md
292-
- name: Using Event Grid to send calling push notifications
293-
href: tutorials/add-voip-push-notifications-event-grid.md
294-
- name: Proxy your calling traffic
295-
href: tutorials/proxy-calling-support-tutorial.md
296-
- name: Survey users
297-
href: tutorials/end-of-call-survey-tutorial.md
298-
displayName: diagnostics, Survey, feedback, quality, reliability, users, end, call, quick
299-
- name: Collecting user feedback with the mobile UI Library
300-
href: tutorials/collecting-user-feedback/collecting-user-feedback.md
301290
- name: Audio quality enhancements
302291
items:
303292
- name: Enabling audio effects
@@ -415,6 +404,13 @@ items:
415404
- name: 3. Microphone and camera setup before a call
416405
href: tutorials/call-readiness/call-readiness-tutorial-part-3-camera-microphone-setup.md
417406
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
407+
- name: Add end of call survey
408+
items:
409+
- name: Using the survey users API
410+
- href: tutorials/end-of-call-survey-tutorial.md
411+
- displayName: diagnostics, Survey, feedback, quality, reliability, users, end, call, quick
412+
- name: Collecting user feedback with the mobile UI Library
413+
- href: tutorials/collecting-user-feedback/collecting-user-feedback.md
418414
- name: Migrating to Azure Communication Services
419415
items:
420416
- name: Migrate from Twilio Video to Azure Communication Services
@@ -465,6 +461,8 @@ items:
465461
href: how-tos/ui-library-sdk/troubleshooting.md
466462
- name: Events
467463
items:
464+
- name: Using Event Grid to send calling push notifications
465+
- href: tutorials/add-voip-push-notifications-event-grid.md
468466
- name: View calling events
469467
href: quickstarts/voice-video-calling/handle-calling-events.md
470468
- name: Analytics
@@ -489,6 +487,12 @@ items:
489487
href: how-tos/calling-sdk/breakoutrooms.md
490488
- name: Together Mode
491489
href: how-tos/calling-sdk/together-mode.md
490+
- name: Configuring to proxy traffic
491+
- name: Proxy your calling traffic
492+
href: tutorials/proxy-calling-support-tutorial.md
493+
- name: Build a Webview based client
494+
- name: Add video calling to your Android WebView client app
495+
- href: quickstarts/voice-video-calling/get-started-android-webview.md
492496
- name: Chat
493497
items:
494498
- name: Build an authentication service using Azure Functions

articles/communication-services/tutorials/calling-sdk/tutorials/pass-contextual-data-header.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Provide a tutorial on how to pass contextual User-to-User Informati
55
author: sloanster
66
ms.topic: tutorial
77
ms.service: azure-communication-services
8-
ms.date: 09/12/2024
8+
ms.date: 09/13/2024
99
ms.author: micahvivion
1010
services: azure-communication-services
1111
---

0 commit comments

Comments
 (0)