UUI data formats

To avoid unexpected truncation of UUI data in Genesys Cloud, take note of the headers third parties use to send UUI data. Genesys Cloud adheres to the IETF UUI specification for UUI data.

Warning: In some cases, sending UUI data using HEX encoding to Genesys Cloud causes problems. More specifically, if the decoded HEX data results in ASCII characters that exist in the extended ASCII character set, the SIP service cannot properly decode the HEX data. So, if your UUI data must use characters from the extended ASCII character set (character 128-255), encode your UUI data using ASCII format.

UUI header	Description	Genesys Cloud removes first octet?
User-to-User	In this case, the first octet, called the “protocol discriminator,” describes the payload’s contents. For example, if you want to use “12345” as UUI data in Architect, then the far end needs to send “xx12345” because Genesys Cloud removes “xx.” If the far end does not send a protocol discriminator, then your data will be truncated because Genesys Cloud always removes the first octet. Example `User-to-User: XXhexdata;encoding=hex;purpose=isdn-uui;content=isdn-uui` where XX is the protocol discriminator.	Yes
User-to-User with pd parameter	Some gateways specify the protocol discriminator separately in a parameter. In this case the pd parameter contains the protocol discriminator, so Genesys Cloud does not remove the first octet. Example `User-to-User: hexdata;pd=XX;encoding=hex;purpose=isdn-uui;content=isdn-uui` where XX is the protocol discriminator.	No
x-User-To-User	This is the Audiocodes proprietary header, which only includes the data. It does not use the protocol discriminator nor any of the other standard parameters and depending on the encoding you select, is in the following format. Example `x-User-to-User:hexdata;encoding=hex` `x-User-to-User:asciidata;encoding=ascii`	No

Note: If you are formatting a UUI header for a REFER, the data should be in the following format, where XX is the protocol discriminator. Refer-To: <sip:address@ip?User-to-User=XXhexdata%3Bencoding%3Dhex>