Voice applications can use SIP tags to send and receive information including Universal Resource Indicators (URIs) to and from the SIP stack. Information on how to use each SIP tag supported by Blueworx Voice Response is provided here.
The tags take the form tag name: value. For example:
TO_HDR= sip: user@uk.ibm.com FROM_HDR= sip: wvr@uk.ibm.com
The value of the tag is always defined as a string and must follow the SIP standard for the header type that is used.
The tags can be used with MakeCall, AnswerCall, TransferCall, and TerminateCall state table actions. For more information on state table actions and system variables, see Blueworx Voice Response for AIX: Application Development using State Tables.
The system variables that are used are:
To ensure that these three System Variables contain the correct information, the Call Information Type parameter must be set to Signalling Process in the System Configuration GUI. See Call Information Type for more information.
SIP tag information contained in SV542 is also accessible from VoiceXML applications. For more information, see Using Blueworx Voice Response call tags.
SIP tag information contained in SV541 and SV542 is also accessible from CCXML applications. For more information, see Using Blueworx Voice Response call tags.
The following sections describe each SIP tag supported by Blueworx Voice Response and how to use it with the product:
A SIP 'To Header' tag. This is the address to which the request is sent. This corresponds to the called number in a traditional telephony system. The standard character format for a SIP URI is UTF-8.
When using a proxy:
sip:john@mydomain.com
When not using a proxy:
sip:john@mycomputer.mydomain.com:5060 (the port is optional, the default is 5060).
A SIP 'From Header' tag. This is the address from which the request is sent. This relates to the calling number in a traditional telephony system. The standard character format for a SIP URI is UTF-8.
"harry" <sip:tom@mycomputer.mydomain.com>;
A SIP 'P-Asserted-Identity' tag. Added by a SIP proxy when the SIP calling ID (in the From header) has been authenticated. For more information on the usage of 'P-Asserted-Identity', refer to SIP RFC3325.
P-Asserted-Identity: "fred"<sip:123456@anyhost.com>
In this example, 123456 would be extracted as the calling number passed in SV186, and everything following P-Asserted-Identity: would be passed in tagged string SV542.
A SIP 'Privacy' tag. Indicates whether presentation of the calling id (in the P-Asserted-Identity) header is to be suppressed or allowed.
Privacy: none
A SIP 'Request Header' tag. This is an actual address and defines the 'first hop' for an outbound request. This may be a proxy server or gateway which will then forward the request to the address defined in the TO_HDR. If a REQ_HDR tag is present it will override any routing information that has been configured on the system. The standard character format for a SIP URI is UTF-8.
sip:john@99.23.45.7
A SIP 'Remote-Party-ID' tag. Support provided for compatibility with existing gateways.
To determine Calling number (passed in SV186), Blueworx Voice Response looks for headers in the following order of priority:
Remote-Party-ID: "Bob"<sip:123456@anyhost.com>;party=calling;privacy=none
A SIP 'Subject Header'. This is used to send information on the TerminateCall state table action. This may be information required to complete the call (to connect the user to a directory lookup number), and can be used as an alternative to call transfer (REFER). The standard character format for a SIP URI is UTF-8.
"1,5551234,555678"
A SIP 'Diversion Header'. The diversion header tag can contain a URI and certain attributes that describe the parameters that may be received with it (for example, the reason for the diversion). The standard character format for a SIP URI is UTF-8. A SIP message can contain multiple diversion headers. Blueworx Voice Response extracts the first of these (top) into the DIV_HDR string, but also uses the first to extract the Original Called Number into SV187 and the last (bottom) to extract the Last Redirecting Number into SV188.
The reason code is added as an attribute.
A SIP 'Diversion Header' tag attribute.
"unknown"
"user-busy"
"no-answer"
"unavailable"
"unconditional"
"time-of-day"
"do-not-disturb"
"deflection"
"follow-me"
"out-of-source"
"away"
A SIP 'Diversion Header' tag attribute. The standard character format for a SIP URI is UTF-8.
"15"
A SIP 'Diversion Header' tag attribute. The standard character format for a SIP URI is UTF-8.
"20"
A SIP 'Diversion Header' tag attribute. The standard character format for a SIP URI is UTF-8.
"privacy=full"
"privacy=name"
"privacy=screen"
A SIP 'Diversion Header' tag attribute. The standard character format for a SIP URI is UTF-8.
"screen=yes"
"screen=no"
A SIP 'Diversion Header' tag attribute. The standard character format for a SIP URI is UTF-8.
"quoted_string"
A SIP 'Accept Language Header' tag. This is used in requests to indicate the preferred language or languages to be used for reason phrases, session descriptions, or status responses included in the response. If not present, all languages should be acceptable.
da
en-gb;q=0.8
en;q=0.7
A SIP 'Call-ID' tag. This is a unique identifier used to group together a series of messages.
f81d4fae-7dec-11d0-a765-00a0c91e6bf6@myco.com
A SIP 'Call-Info' tag. This provides additional information about the caller.
card - a business card, for example, in vCard or LDIF format
icon - designates a digital image of the caller.
<http://wwww.example.com/alice/photo.jpg>;purpose=icon
<http://www.example.com/alice/>;purpose=info