Author Topic: SipEndpoint SDK Dial function - data parameter  (Read 237 times)

Offline hynsey

  • Newbie
  • *
  • Posts: 14
  • Karma: 0
SipEndpoint SDK Dial function - data parameter
« on: January 28, 2019, 09:03:22 PM »
Hi folks,
Finding documentation on this is nigh on impossible:

Genesys SIP Endpoint 8.5.0 for .NET API Reference
Code: [Select]
Dial Method (connectionId, destination, video, data)
Namespaces ► Genesyslab.Sip.Endpoint.Provider ► ICallControl ► Dial(Int32, String, Boolean, String)C#Visual BasicVisual C++ Declaration Syntax
C# Visual Basic Visual C++


Code: [Select]
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
)

 Parameters
Code: [Select]
connectionId (Int32)
destination (String)
video (Boolean)
data (String)

I am looking for information on the expected syntax/structure of the data 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

Marked as best answer by hynsey on January 31, 2019, 01:46:17 AM

Offline hynsey

  • Newbie
  • *
  • Posts: 14
  • Karma: 0
Re: SipEndpoint SDK Dial function - data parameter
« Reply #1 on: January 30, 2019, 04:45:50 PM »
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: [Select]
key1=value1,key2=value2,key3=value3
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