Xsip.generate - Revision history

Monica at 09:02, 4 November 2013

2013-11-04T09:02:45Z

Monica at 09:02, 4 November 2013

2013-11-04T09:02:24Z

Dana at 13:13, 11 June 2013

2013-06-11T13:13:37Z

Dana at 13:11, 30 May 2013

2013-05-30T13:11:42Z

Dana at 15:54, 8 November 2012

2012-11-08T15:54:11Z

Dana: Created page with " '''xsip.generate''' is a message sent by a module requesting the transmission of a SIP request. The ysipchan module handles this message. ===Parameters=== '''method''' :::M..."

2012-10-08T14:24:43Z

Created page with " '''xsip.generate''' is a message sent by a module requesting the transmission of a SIP request. The ysipchan module handles this message. ===Parameters=== '''method''' :::M..."

New page

'''xsip.generate''' is a message sent by a module requesting the transmission of a SIP request. The ysipchan module handles this message.

===Parameters===

'''method'''
:::Mandatory - The name of the SIP method to use in the request (e.g. NOTIFY)
'''uri'''
:::The Request URI of the SIP request to generate
'''id'''
:::The channel ID if the request must be generated in an existing dialog, overrides uri
'''line'''
:::The account name if the request must be generated on a registered line, overrides domain
'''domain'''
:::The domain used to fill the From and Call-ID headers if needed
'''xsip_type'''
:::The content type header
'''xsip_body'''
:::The content header
'''xsip_body_encoding'''
:::The local body encoding for binary bodies, can be base64, hex (with no spaces) or hexs (separated with spaces). By default an UTF-8 text encoding is assumed
'''sip_headername'''
:::Where headername is the name of the header to be sent with the request. This parameter is repeated for each header in the request (e.g. sip_From, sip_To, etc)
'''wait'''
:::Boolean value indicating that the sender should wait for the response to the request, default false

'''Note:''' A request URI must be present in a way or another - either specified explicitely or taken from the dialog of a channel ID - else the handler will silently return false.

===Return===

The receiving module will:

'''wait=false'''
:::Return without waiting for the request transaction to terminate, discard information from received answers
'''wait=true'''
:::Wait for the request transaction to terminate and set the code parameter of the message to the received SIP code

← Older revision		Revision as of 09:02, 4 November 2013
Line 42:		Line 42:
	* [[Telephony]]		* [[Telephony]]

−	[[Category:SIP]]	+	[[Category:SIP]] [[Category:Messages]]

← Older revision		Revision as of 09:02, 4 November 2013
Line 41:		Line 41:
	* [[Messages]]		* [[Messages]]
	* [[Telephony]]		* [[Telephony]]
		+
		+	[[Category:SIP]]

← Older revision		Revision as of 13:11, 30 May 2013
Line 35:		Line 35:
	'''wait=true'''		'''wait=true'''
	:::Wait for the request transaction to terminate and set the code parameter of the message to the received SIP code		:::Wait for the request transaction to terminate and set the code parameter of the message to the received SIP code
		+
		+
		+	'''See also'''
		+
		+	* [[Messages]]
		+	* [[Telephony]]

← Older revision		Revision as of 15:54, 8 November 2012
Line 1:		Line 1:

−	'''xsip.generate''' is a message sent by a module requesting the transmission of a SIP request. The ysipchan module handles this message.	+	'''xsip.generate''' is a message sent by a module requesting the transmission of a SIP request. The [[SIP Configuration File\|ysipchan]] module handles this message.

	===Parameters===		===Parameters===

@@ Line 25: / Line 25: @@
 :::Boolean value indicating that the sender should wait for the response to the request, default false
-'''Note:''' A request URI must be present in a way or another - either specified explicitely or taken from the dialog of a channel ID - else the handler will silently return false.
+'''Note:''' A request URI must be present in a way or another - either specified explicitly or taken from the dialog of a channel ID - else the handler will silently return false.
 ===Return===