You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Using the ACS calling SDK to pass contextual User-to-User Information (UUI) data between calls
14
14
15
-
The Azure Communication Services (ACS) WebJS SDK provide the ability to allow developers to include custom contextual data (included as a header on the calllin object) when directing and routing calls from one person to another. This informaiton, 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 This UUI data is opaque to SIP and its
15
+
The Azure Communication Services (ACS) WebJS SDK provides developers to include custom contextual data (included as a header on the callling 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.
16
16
17
17
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.
18
18
19
-
Moreover, the custom call context can also also transmitted to to SIP endpoints using 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.
19
+
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.
20
20
21
-
It’s important to note that all custom context data remains transparent to the calling SDK and is not related to any of the SDK’s fundamental functions when used in SIP protocols. Here is a tutorial to assist you in adding custom context headers when using the WebJS SDK.
21
+
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.
22
22
23
23
24
24
> [!IMPORTANT]
@@ -27,15 +27,15 @@ It’s important to note that all custom context data remains transparent to the
27
27
## Technical parameters
28
28
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.
29
29
30
-
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 ‘X-MS-Custom-’ prefix (which can be seeing if you insspect the SIP header with packet inspector).
30
+
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).
31
31
32
32
The SIP header key may consist of alphanumeric characters and a few selected symbols which includes `.`, `!`, `%`, `*`, `_`, `+`, `~`, `-`. 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 includes `=`, `;`, `.`, `!`, `%`, `*`, `_`, `+`, `~`, `-`.
33
33
34
34
The maximum length of a VOIP header key is 64 chars. The maximum length of VOIP header value is 1024 chars.
35
35
36
36
When adding these custom headers as a developer you can choose to add only SIP headers, only VoIP headers or both can be included.
37
37
38
-
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. To support adding these headers, you must begin with a 1:1 call where the additional headers are available at the start of the initiation process.
38
+
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.
39
39
40
40
## Adding custom context when inviting a participant
41
41
@@ -84,8 +84,8 @@ Currently, adding custom User-to-User Information headers is only supported when
84
84
85
85
```
86
86
87
-
## Additional resources
87
+
## More resources
88
88
89
-
- For more details on how to pass contextual data using ACS Call automation see this [guide](../../../how-tos/call-automation/custom-context.md).
89
+
- For more details on how to pass contextual data using Azure Communication Services Call automation, see this [guide](../../../how-tos/call-automation/custom-context.md).
90
90
91
91
- Learn more about [SIP protocol details for direct routing](../../../concepts/telephony/direct-routing-sip-specification.md).
0 commit comments