Genesys CTI User Forum

Genesys CTI User Forum => Genesys CTI Technical Discussion => Topic started by: hynsey on January 28, 2019, 12:03:22 PM

Title: SipEndpoint SDK Dial function - data parameter
Post by: hynsey on January 28, 2019, 12:03:22 PM

Hi folks,
Finding documentation on this is nigh on impossible:

[b]Genesys SIP Endpoint 8.5.0 for .NET API Reference[/b]
[code]Dial Method (connectionId, destination, video, data)[/code]

[i]Namespaces ► Genesyslab.Sip.Endpoint.Provider ► ICallControl ► Dial(Int32, String, Boolean, String)C#Visual BasicVisual C++ Declaration Syntax
C# Visual Basic Visual C++ [/i]

[code]GsStatus Dial(
int connectionId,
string destination,
bool video,
string data
)
Function Dial ( _
connectionId As Integer, _
destination As String, _
video As Boolean, _
data As String _
) As GsStatus
GsStatus Dial(
int connectionId,
String^ destination,
bool video,
String^ data
)[/code]

[b]Parameters[/b]
[code]connectionId (Int32)
destination (String)
video (Boolean)
data (String)[/code]

I am looking for information on the expected syntax/structure of the [font=courier]data [/font]parameter. I'm hoping this will allow me to set SIP Headers that can be translated by SIP Server into attached data for the dial. But I'm not certain.
Does anyone have any ideas?

Thanks,
Mick

Title: Re: SipEndpoint SDK Dial function - data parameter
Post by: hynsey on January 30, 2019, 07:45:50 AM

Ok, figured this out with trial and error.

For anyone else who encounters this, the data string expects a KVP structured string in this format:

[code]key1=value1,key2=value2,key3=value3[/code]

These KVPs get included in the SIP INVITE message as SIP Headers. Therefore if you name them properly "X-Genesys-...." they will be attached by SIP Server if you dial a route point.

Cheers,
Mick