ms_genringCallerID( )

Description | Cautions | Examples

Name:	int ms_genringCallerID(devh, len, mode, cadid, OrigAddr, rfu)
Inputs:	int devh	station device handle
	unsigned short len	length in cycles for ring
	unsigned short mode	asynchronous/synchronous
	char* OrigAddr	call origination information
	void* rfu	reserved for future use
Returns:	0 if success for asynchronous >0 if success for synchronous -1 if failure
Includes:	dtilib.h srllib.h msilib.h
Category:	Station
Mode:	synchronous/asynchronous

Description

The ms_genringCallerID( ) function allows transmission of analog Caller ID data (Call Originator information) to telephones equipped with FSK Caller ID detectors.

Parameter	Description
Cadid	Either a CadenceID for Distinctive rings or the current default ring (MS_RNG_DEFAULT) may be specified.
OrigAddr	An ASCII character string that holds the information about the origination party. The maximum length is 127 characters. With this feature, OrigAddr can be divided into multiple sub-fields identified by field identifiers to hold analog caller identification (FSK) transmission data.

The sub fields used by the OrigAddr parameter include:

• Caller Name: identifies the name of the call originator if available.
• Caller Number: identifies the number of the call originator if available.
• Date Time: identifies the date and time at which the call is sent.
• Caller Number Absence Reason: identifies why call originator's number is not available. Possible reasons are Private (P) or Out of Area (O).
• Caller Name Absence Reason: identifies why call originator's name is not available. Possible reasons are Private (P) or Out of Area (O).

Sub-group identifiers with format 'X:' are used to specify sub-fields for caller ID transmission. Note that the user strings embed this character as part of sub-field identifiers. Thus this sub-group identifier is implicit by nature.

The following sub-group identifiers are supported:

• T: identifies beginning of Time and Date sub-field.
• N: identifies beginning of Caller Name sub-field.
• I: identifies beginning of Caller Number sub-field.
• A: identifies beginning of Caller Number Absence Reason sub-field.
• B: identifies beginning of Caller Name absence Reason sub-field.

NOTES:

1. Use the character '/' as an escape character to indicate that ':' is part of the string. For example, Next string "N:J/:NamathI:993-3000" uses escape character / to embed the name J:Namath.

2. The end of a sub-field is recognized by the character ':' or the end of string when a sub-field is located at the end of the string.

Cautions

• This function is supported on DM3 boards only.

Examples

Example 1--Application sends Caller Name and Date to a Caller ID phone connected to a station.

OriginationAddress[128] = "T:01310930N:John Doe" which is:

Caller Name = John Doe

Date Time = Jan 31, 9 30 am

Example 2--Application sends Caller Number absence reason (O: Out Of Area) and Date and Time to a Caller ID phone connected to a station.

OriginationAddress[128] = "T:01310930A:O" which is:

Caller Number Absence Reason : Out Of Area

Date Time = Jan 31, 9 30 am

Example 3--Application sends proprietary data to a Caller ID phone connected to a station.

OriginationAddress[128] = "R:xxxxxxxxxxx" which is:

xxxx  represents the proprietary data to be sent

See Also

• ms_SetMsgWaitInd( )

Click here to contact Dialogic Customer Engineering