AG ISDN Supplementary Services Developer's Reference Manual P/N 6502-13

Introduction

Appendix C: Constants

Introduction

The following sections describe constants used in fields in the extended data structure found in isdnacu.h.

ACT_DIVERT_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_act_divert_ret_error extended data structure.

Constant	Description/Notes
ACT_DIVERT_RETERR_NOT_SUBSCRIBED	The served user is not subscribed to the service.
ACT_DIVERT_RETERR_NOT_AVAILABLE	The network can not allocate the resources at this time.
ACT_DIVERT_RETERR_INVALID_SERVED_NB	The served number is unknown to the network.
ACT_DIVERT_RETERR_INTERAC_NOT_ALLOWED	Interaction with other supplementary service not allowed.
ACT_DIVERT_RETERR_SERVICE_NOT_PROVIDED	The user has not subscribed for the basic service which was applied.
ACT_DIVERT_RETERR_RESOURCE_UNAVAILABLE	The resources can not be acquired.
ACT_DIVERT_RETERR_INV_DIVERTED_TO_NB	The diverted-to number can not be routed through the network.
ACT_DIVERT_RETERR_DIV_SPECIAL_SERV_NB	Diversion to fire, emergency, etc. is prohibited.
ACT_DIVERT_RETERR_DIV_TO_SERVED_USER_NB	Diversion back to served user number is prohibited.
ACT_DIVERT_RETERR_UNSPECIFIED	Unspecified cause.

ACU_SS_AOC_BILLING_ID Constants

These constants specify the billing ID type in the billing_id fields of the following extended data structures:

tAcuSSAocDInform

tAcuSSAocEInform

These constants indicate the reason the served user is being charged.

Constant	Description/Notes
ACU_SS_AOC_BILLING_ID_NORMAL	Normal call setup.
ACU_SS_AOC_BILLING_ID_CREDIT_CARD	A credit card number is being charged.
ACU_SS_AOC_BILLING_ID_REVERSE	The incoming call has reversed charges.
ACU_SS_AOC_BILLING_ID_CFU	Call forwarding, unconditional, has been invoked.
ACU_SS_AOC_BILLING_ID_CFB	Call forwarding, busy, has been invoked.
ACU_SS_AOC_BILLING_ID_CFNR	Call forwarding, no response, has been invoked.
ACU_SS_AOC_BILLING_ID_CD	Call deflection has been invoked.
ACU_SS_AOC_BILLING_ID_TRF	Call transfer has been invoked.

ACU_SS_AOC_CHARGED_ITEM Constants

These constants specify the charged item method in the charged_item field of the tAcuSSAocSInform extended data structure.

Constant	Description/Notes
ACU_SS_AOC_CHARGED_ITEM_BASIC	This charged item indicates the rate to be applied for the connection to the called user.
ACU_SS_AOC_CHARGED_ITEM_ATTEMPT	The charge applied when the call has been routed to the called user, but the called user has not answered the call.
ACU_SS_AOC_CHARGED_ITEM_SETUP	The charge applied when the called user answers the call.
ACU_SS_AOC_CHARGED_ITEM_SPECIAL_ CHARGING	A special non-standard arrangement exists for calculating the cost of the call.
ACU_SS_AOC_CHARGED_ITEM_USER_TO_USER	User-to-user data is charged.
ACU_SS_AOC_CHARGED_ITEM_SUP_SERV	Invokation of a supplementary service is charged.

ACU_SS_AOC_CHARGING_RATE Constants

These constants specify the charging rate in the charging_rate field of the tAcuSSAocSInform extended data structure. They are used to indiate which sturcture to use in the union of AOC-S structures.

Constant	Description/Notes
ACU_SS_AOC_CHARGING_RATE_VOLUME	tAcuSSAocVolume is used in rate union.
ACU_SS_AOC_CHARGING_RATE_SPECIFIC	tAcuSSAocSpecific is used in rate union.
ACU_SS_AOC_CHARGING_RATE_DURATION	tAcuSSAocDuration is used in rate union.

ACU_SS_AOC_ERR Constants

These constants specify the error cause in the cause field of the acu_ss_aoc_request_ret_error extended data structure.

Constant	Description/Notes
ACU_SS_AOC_ERR_UNSPECIFIED	An error occured, but the cause is not specified.
ACU_SS_AOC_ERR_NO_CH_INF_AVAIL	The network is unable to acquire the information for this call.

ACU_SS_AOC_MULTIPLIER Constants

These constants specify the multiplier in the multiplier field of the tAcuSSAocSpecific extended data structure.

The multiplier is used to adjust the currency value decimal position. For example, to specify a charge of $17.76, the amount could be set to 1776, the currency id to $, and the multiplier to AOC_SS_AOC_MULTIPLIER_HUNDREDTH.

Constant	Description/Notes
ACU_SS_AOC_MULTIPLIER_THOUSANDTH	0.001 * amount.
ACU_SS_AOC_MULTIPLIER_HUNDREDTH	0.01 * amount.
ACU_SS_AOC_MULTIPLIER_TENTH	0.1 * amount.
ACU_SS_AOC_MULTIPLIER_ONE	1 * amount.
ACU_SS_AOC_MULTIPLIER_TEN	10 * amount.
ACU_SS_AOC_MULTIPLIER_HUNDRED	100 * amount.
ACU_SS_AOC_MULTIPLIER_THOUSAND	1000 * amount.

acu_SS_AOC_RATE_TYPE Constants

These constants specify the rate type in the rate_type field of the tAcuSSAocSpecific extended data structure.

Constant	Description/Notes
ACU_SS_AOC_RATE_TYPE_FREE_OF_CHARGE	No charge incurred for specified service.
ACU_SS_AOC_RATE_TYPE_FREE_OF_CHARGE_ FROM_BEGINNING	No charge incurred for entire call.
ACU_SS_AOC_RATE_TYPE_FLAT_RATE	A flat rate applies to the billed service.
ACU_SS_AOC_RATE_TYPE_SPECIAL_CHARGING	A special charging arrangement applies to the billed service.
ACU_SS_AOC_RATE_TYPE_NOT_AVAIL	No rate infomation is currently available for the billed service.

ACU_SS_AOC_RECORDED_CHARGES Constants

These constants specify the recorded charges unit type in the recorded_charges fields of the following extended data structures:

tAcuSSAocDInform

tAcuSSAocEInform

Constant	Description/Notes
ACU_SS_AOC_RECORDED_CHARGES_CHARGING_UNITS	Indicates that charge information contains a metered charging unit count.
ACU_SS_AOC_RECORDED_CHARGES_CURRENCY_UNITS	Indicates that charge information contains an absolute currency amount.
ACU_SS_AOC_RECORDED_CHARGES_FREE_OF_ CHARGE	Indicates that there is no charge applied to the specified service.

ACU_SS_AOC_S_TYPE_OF_CHARGE Constants

These constants specify the charging type in the type_of_charging field of the tAcuSSAocDuration extended data structure.

Constant	Description/Notes
ACU_SS_AOC_S_TYPE_OF_CHARGE_CONTINUOUS	The charge is applied evenly throughout the call.
ACU_SS_AOC_S_TYPE_OF_CHARGE_STEP	The charge is applied at the beginning of the specified time unit.

ACU_SS_AOC_SCALE Constants

These constants specify the time scale in the time_scale field of the tAcuSSAocDuration extended data structure.

The scale constant is used in conjuction with an integer (i.e. granularity or time fields) to specify the time unit applied for the calculation of charges by the network.

For example, one way to indicate the network will charge on each 6 second interval would be to set the time field to 6, and the time_scale field to ACU_SS_AOC_SCALE_ONE_SEC.

Constant	Description/Notes
ACU_SS_AOC_SCALE_HUNDREDTH_SEC	0.01 seconds.
ACU_SS_AOC_SCALE_TENTH_SEC	0.1 seconds.
ACU_SS_AOC_SCALE_ONE_SEC	1 second.
ACU_SS_AOC_SCALE_TEN_SEC	10 seconds.
ACU_SS_AOC_SCALE_ONE_MIN	1 minute.
ACU_SS_AOC_SCALE_ONE_HOUR	1 hour.
ACU_SS_AOC_SCALE_24_HOURS	24 hours.

ACU_SS_AOC_TYPE Constants

These constants specify the Advice of Charge service type in the aoc_type field of the acu_ss_aoc_inform_invoke extended data structure.

Constant	Description/Notes
ACU_SS_AOC_TYPE_AOC_S_INFORM	The aoc_data union contains a tAcuSSAocSInform structure.
ACU_SS_AOC_TYPE_AOC_E_INFORM	The aoc_data union contains a tAcuSSAocEInform structure.
ACU_SS_AOC_TYPE_AOC_D_INFORM	The aoc_data union contains a tAcuSSAocDInform structure.

ACU_SS_AOC_TYPE_OF_CHARGE Constants

These constants specify the type of charge in the type_of_charging fields of the following extended data structures:

tAcuSSAocDInform

tAcuSSAocEInform

Constant	Description/Notes
ACU_SS_AOC_TYPE_OF_CHARGE_SUBTOTAL	The charge is only a subtotal of the charges to be attributed to the call.
ACU_SS_AOC_TYPE_OF_CHARGE_TOTAL	The charge is a total of the charges to be attributed to the call.
ACU_SS_AOC_TYPE_OF_CHARGE_NOT_AVAILABLE	No infomation is available.

ACU_SS_AOC_TYPE_OF_INFO Constants

These constants specify the information type in the type_of_info field of the tAcuSSAocSInform extended data structure.

Constant	Description/Notes
ACU_SS_AOC_TYPE_OF_INFO_CHARGE_RATE	The charge rate information is included.
ACU_SS_AOC_TYPE_OF_INFO_NOT_AVAILABLE	No further information is available.

ACU_SS_AOC_VOLUME Constants

These constants specify the volume type in the volume_type field of the tAcuSSAocVolume extended data structure.

Constant	Description/Notes
ACU_SS_AOC_VOLUME_TYPE_OCTET	User-to-User charged on an octet basis.
ACU_SS_AOC_VOLUME_TYPE_SEGMENT	User-to-User charged on a segment basis.
ACU_SS_AOC_VOLUME_TYPE_MESSAGE	User-to-User charged on a per-message basis.

ACU_SS_BASIC_SERVICE Constants

These constants specify the basic service type in the basic_service fields of the following extended data structures:

acu_ss_notify_diversion_invoke

acu_ss_divert_ret_result

acu_ss_act_divert_invoke

acu_ss_deact_divert_invoke

acu_ss_enquire_divert_invoke

acu_ss_enquire_divert_ret_result

Constant	Description/Notes
ACU_SS_BASIC_SERVICE_ALL_SERVICES	All services.
ACU_SS_BASIC_SERVICE_SPEECH	Speech.
ACU_SS_BASIC_SERVICE_UNRESTR_DIG_INFO	Unrestricted digital information.
ACU_SS_BASIC_SERVICE_AUDIO_3K1HZ	Audio 3k1Hz.
ACU_SS_BASIC_SERVICE_UNR_D_INFO_TONE_AN	Unrestricted digital information with tones and announcements.
ACU_SS_BASIC_SERVICE_TELEPHONY_3K1HZ	Telephony 3k1Hz.
ACU_SS_BASIC_SERVICE_TELETEX	Teletex.
ACU_SS_BASIC_SERVICE_TELEFAX_GROUP4_CL1	Telefax Group4 class1.
ACU_SS_BASIC_SERVICE_VIDEOTEX_SYNT_BASE	Videotex syntax based.
ACU_SS_BASIC_SERVICE_VIDEO_TELEPHONY	Video telephony.
ACU_SS_BASIC_SERVICE_TELEFAX_GROUP2_3	Telefax Group2-3.
ACU_SS_BASIC_SERVICE_TELEPHONY_7KHZ	Telephony 7khz.

ACU_SS_CALL_STATUS Constants

These constants specify the status of the call in the call_status fields in the following extended data structures:

acu_ss_transfer_invoke

acu_ss_notify_transfer_invoke

Constant	Description/Notes
ACU_SS_CALL_STATUS_NOT_SPECIFIED	The information is not available.
ACU_SS_CALL_STATUS_ALERTING	The connection has not progressed to the active state.
ACU_SS_CALL_STATUS_ANSWERED	The connection has progressed to the active state.

ACU_SS_DIVERSION Constants

These constants specify the reason for diversion in the reason fields of the following extended data structures:

acu_ss_notify_diversion_invoke

acu_ss_divert_ret_result

These constants specify the diversion procedure in the procedure fields of the following extended data structures:

acu_ss_enquire_divert_invoke

acu_ss_enquire_divert_ret_result

Constant	Description/Notes
ACU_SS_DIVERSION_UNKNOWN	The call was diverted for unknown reasons.
ACU_SS_DIVERSION_CFU	The network immediately diverted the call.
ACU_SS_DIVERSION_CFB	The network diverted the call after it determined the user was busy.
ACU_SS_DIVERSION_CFNR	The network diverted the call after the served user did not answer.
ACU_SS_DIVERSION_CD_ALERTING	The served user has deflected the call after the alerting state was entered.
ACU_SS_DIVERSION_CD_IMMEDIATE	The served user has deflected the call immediately.
ACU_SS_DIVERSION_CD	Used when unknown call deflection cause.

ACU_SS_END_DESIGNATION Constants

These constants specify the end designation in the end_designation fields in the acu_ss_notify_transfer_invoke extended data structure.

Constant	Description/Notes
ACU_SS_END_DESIGNATION_NOT_SPECIFIED	For use in some variants (ETS 300).
ACU_SS_END_DESIGNATION_PRIMARY	Indicates the party associated with the connection is the primary party in the new connection. Only valid if the connection is in the active state.
ACU_SS_END_DESIGNATION_SECONDARY	Indicates the party associated with the connection is the secondary party in the new connection.

ACU_SS_NAME Constants

These constants specify the name presentation in the pres field of the acu_party_name extended data structure.

Constant	Description/Notes
ACU_SS_NAME_ALLOWED_ISO8859	Name can be presented to user, and is encoded in ISO-8859 format.
ACU_SS_NAME_ALLOWED_T61	Name can be presented to user, and is encoded in T-61 format.
ACU_SS_NAME_RESTRICTED_ISO8859	Name can not be presented to user, and is encoded in ISO-8859 format.
ACU_SS_NAME_RESTRICTED_T61	Name can not be presented to user, and is encoded in T-61 format.
ACU_SS_NAME_NOT_AVAILABLE	Name is not available.

ACU_SS_NUMBER_PLAN Constants

These constants specify the numbering plan in the number_plan field of the acu_party_num extended data structure.

This set of constants is a combination of the "type of number" and "numbering plan identification" fields included in the underlying protocol party number information elements. If the application wishes to access these fields directly, or if no macro corresponds to the desired/received value, then the following formula can be utilized:

ACU_SS_NUMBER_PLAN_X_Y = (t_of_num << 4) + num_plan_id

where the t_of_num and num_plan_id fields are defined in the relevent specifications (e.g. Q.931).

Constant	Description/Notes
ACU_SS_NUMBER_PLAN_UNKNOWN	No information about the number.
ACU_SS_NUMBER_PLAN_PUBLIC_UNKNOWN	Public number plan.
ACU_SS_NUMBER_PLAN_PUBLIC_INTERNATIONAL	Public number plan, international number.
ACU_SS_NUMBER_PLAN_PUBLIC_NATIONAL	Public number plan, national number.
ACU_SS_NUMBER_PLAN_PUBLIC_NETWORK_ SPECIFIC	Public number plan, network specific number.
ACU_SS_NUMBER_PLAN_PUBLIC_SUBSCRIBER	Public number plan, subscriber number.
ACU_SS_NUMBER_PLAN_PUBLIC_ABBREVIATED	Public number plan, abbreviated number.
ACU_SS_NUMBER_PLAN_PRIVATE_UNKNOWN	Private number plan.
ACU_SS_NUMBER_PLAN_PRIVATE_LEVEL_1_ REGIONAL	Private number plan, level 1 region formatted number.
ACU_SS_NUMBER_PLAN_PRIVATE_LEVEL_2_ REGIONAL	Private number plan, level 2 region formatted number.
ACU_SS_NUMBER_PLAN_PRIVATE_PTN_SPECIFIC	Private number plan, PTN specific formatted number.
ACU_SS_NUMBER_PLAN_PRIVATE_LOCAL	Private number plan, local formatted number.

ACU_SS_REJECT_LOCAL Constants

These constants specify the reason for rejection in the local_cause field of the acu_ss_reject extended data structure.

Constant	Description/Notes
ACU_SS_REJECT_LOCAL_UNUSED_FIELD	This field does not apply (reject originated from network).
ACU_SS_REJECT_LOCAL_UNSPECIFIED	Unknown reject cause.
ACU_SS_REJECT_LOCAL_INVALID_STATE	The local stack is not in a state to accept the service request.
ACU_SS_REJECT_LOCAL_NOT_IMPLEMENTED	The local stack has not implemented the service for this variant.
ACU_SS_REJECT_LOCAL_NO_RESPONSE	The network has not responded to the service request.
ACU_SS_REJECT_LOCAL_INVALID_CHAN	The channel specified is not acceptable.
ACU_SS_REJECT_LOCAL_INVALID_CONN_ID	The associated connection is not acceptable.
ACU_SS_REJECT_LOCAL_TEMP_BUSY	The service can not be provided due to current allocations of the necessary resources.
ACU_SS_REJECT_LOCAL_MISSING_PARAMETER	The necessary information was not provided.

ACU_SS_REJECT_NETWORK Constants

These constants specify the reason for rejection in the network_cause field of the acu_ss_reject extended data structure.

Constant	Description/Notes
ACU_SS_REJECT_NETWORK_UNUSED_FIELD	The local stack rejected the service request.
ACU_SS_REJECT_NETWORK_UNSPECIFIED	The cause is not known.
ACU_SS_REJECT_NETWORK_NOT_SUBSCRIBED	The served user is not subscribed to the service invoked.
ACU_SS_REJECT_NETWORK_NOT_IMPLEMENTED	The network has not implemented the requested service.
ACU_SS_REJECT_NETWORK_INVALID_STATE	The network can not process the request in the current connection state.
ACU_SS_REJECT_NETWORK_BEARER_CAP_ ERROR	There is an incompatibility in the bearer channel.

ACU_SS_SCREEN Constants

These constants specify the in the screen_ind field of the acu_party_num extended data structure.

Constant	Description/Notes
ACU_SS_SCREEN_UNUSED_FIELD	The field is not used or applicable.
ACU_SS_SCREEN_USER_PROV_NOT_SCREENED	The user provided the party information, and it has not been verified.
ACU_SS_SCREEN_USER_PROV_VERIFIED	The user provided the party information, and it has been validated by the network.
ACU_SS_SCREEN_USER_PROV_FAILED_ VERIFICATION	The user provided the party information, and the network verification failed.
ACU_SS_SCREEN_NETWORK_PROV	The network provided the party information.

ACU_SS_SUBSCRIPTION Constants

These constants specify the subscription in the subscription field of the acu_ss_divert_invoke extended data structure.

Constant	Description/Notes
ACU_SS_SUBSCRIPTION_NO_NOTIFY	The diverted party should not be notified of the diversion.
ACU_SS_SUBSCRIPTION_NOTIFY_WITHOUT_NB	The diverted party should not be given the new number, but can be notified of the diversion.
ACU_SS_SUBSCRIPTION_NOTIFY_WITH_NB	All diversion information can be shared with the diverted party.

DEACT_DIVERT_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_deact_divert_ret_error extended data structure.

Constant	Description/Notes
DEACT_DIVERT_RETERR_NOT_SUBSCRIBED	The served user is not subscribed to this service.
DEACT_DIVERT_RETERR_NOT_AVAILABLE	The supplementary service is not available for the indicated basic service.
DEACT_DIVERT_RETERR_INVALID_SERVED_NB	The served user number could not be found.
DEACT_DIVERT_RETERR_NOT_ACTIVATED	The activation step never completed.
DEACT_DIVERT_RETERR_UNSPECIFIED	Unspecified cause.

DEFLECT_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_deflect_ret_error extended data structure.

Constant	Description/Notes
DEFLECT_RETERR_NOT_SUBSCRIBED	The served user is not subscribed to this service.
DEFLECT_RETERR_NOT_AVAILABLE	The supplementary service is not available for the indicated basic service.
DEFLECT_RETERR_SS_INTERACTION_NOT_ ALLOWED	Interaction with other supplementary service not allowed.
DEFLECT_RETERR_INVALID_DIVERTED_TO_NB	The diverted-to number could not be routed through the network.
DEFLECT_RETERR_SPECIAL_SERVICE_NB	Deflection to fire, emergency, etc. is prohibited.
DEFLECT_RETERR_DIVERSION_TO_SERVED_ USER_NB	Deflection back to served user number is prohibited.
DEFLECT_RETERR_NUMBER_OF_DIVERSIONS_ EXCEEDED	The network has reached the maximum number of diversions for a call.
DEFLECT_RETERR_INCOMING_CALL_ACCEPTED	The basic call control signals have overrulled the invokation of the deflect service.
DEFLECT_RETERR_REQUEST_ALREADY_ ACCEPTED	The call has progressed to far in the basic call state model.
DEFLECT_RETERR_UNSPECIFIED	Unspecified cause.

DIVERT_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_divert_ret_error extended data structure.

Constant	Description/Notes
DIVERT_RETERR_NOT_SUBSCRIBED	The served user is not subscribed to the service.
DIVERT_RETERR_NOT_AVAILABLE	The basic service is not available.
DIVERT_RETERR_RESOURCE_UNAVAILABLE	There are no resources available to invoke the service.
DIVERT_RETERR_INVALID_DIVERTED_TO_NB	The diverted-to number could not be routed.
DIVERT_RETERR_SPECIAL_SERVICE_NB	Diversion to special number (e.g. fire) is prohibited.
DIVERT_RETERR_DIVERSION_TO_SERVED_USER _NB	Diversion to served user is prohibited.
DIVERT_RETERR_NUMBER_OF_DIVERSIONS_ EXCEEDED	The call has reached the maximum number of diversions.
DIVERT_RETERR_SS_INTERACTION_NOT _ALLOWED	Interaction with other supplementary service not allowed.
DIVERT_RETERR_UNSPECIFIED	Unspecified cause.
DIVERT_RETERR_NO_RESPONSE	The diverted-to party failed to respond to the call
DIVERT_RETERR_DIVERTED_LEG_FAILED	The diverted-to party failed to answer the call.

ENQUIRE_DIVERT_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_enquire_divert_ret_error extended data structure.

Constant	Description/Notes
ENQUIRE_DIVERT_RETERR_NOT_SUBSCRIBED	The served user is not subscribed to the service.
ENQUIRE_DIVERT_RETERR_NOT_AVAILABLE	The information is not available.
ENQUIRE_DIVERT_RETERR_INVALID_SERVED_NB	The served user number is not recognized.
ENQUIRE_DIVERT_RETERR_UNSPECIFIED	Unspecified cause.

TRANSFER_RETERR Constants

These constants specify the error cause in the err_id field of the acu_ss_transfer_ret_err extended data structure.

Constant	Description/Notes
TRANSFER_RETERR_UNSPECIFIED	Unspecified cause.
TRANSFER_RETERR_RESOURCE_UNAVAILABLE	The network does not have the resources to invoke the service.
TRANSFER_RETERR_NOT_SUBSCRIBED	The served user has not subscribed to this service.
TRANSFER_RETERR_NOT_AVAILABLE	The transfer service is not available for the basic service of the call.
TRANSFER_RETERR_INVALID_CALL_STATE	The network call state does not support a transfer (e.g. prior to alerting or after clearing has started).
TRANSFER_RETERR_INTERAC_NOT_ALLOWED	Interaction with another supplementary service is not allowed.

Natural MicroSystems, Inc.
100 Crossing Boulevard
Framingham, MA 01702

Contact Developer Support