Zoiper COM API
1.1
|
Account interface. More...
Public Member Functions | |
void | Apply () |
Apply changes. More... | |
void | Register () |
Register the account. More... | |
void | Unregister () |
Unregister the account. More... | |
void | AddCodec ([in] BSTR codec) |
Add a codec to the account codec list. More... | |
void | ClearCodec () |
Disable the custom codec list for the account. More... | |
void | SipHeaderDump ([in] VARIANT_BOOL enable) |
Enables the SIP header dump for this account. More... | |
void | SipHeaderAdd ([in] BSTR name, [in] BSTR value) |
Add a new SIP header value. More... | |
void | SipHeaderClear ([in] BSTR name) |
Clear all custom SIP headers. More... | |
Properties | |
BSTR | Name [get] |
Specifies the account name. More... | |
EAccountType | Type [get] |
Specifies the account protocol type. More... | |
EAccountRegistrationState | State [get] |
Specifies the account registration state. More... | |
BSTR | Phone [set] |
Specifies the caller identification phone number for the account. More... | |
BSTR | Host [set] |
Specifies the IAX2 or XMPP host address. More... | |
BSTR | Domain [set] |
Specifies the SIP domain. More... | |
BSTR | Context [set] |
Specifies the IAX2 context. More... | |
BSTR | OutboundProxy [set] |
Specifies the SIP outbound proxy address. More... | |
BSTR | JabberID [set] |
Specifies the user identification for XMPP accounts. More... | |
BSTR | UserName [set] |
Specifies the user name used by VoIP service to identify the account. More... | |
BSTR | Password [set] |
Specifies the password used by the VoIP service to authenticate the account. More... | |
BSTR | CallerID [set] |
Specifies the caller identification name (CID) for the account. More... | |
BSTR | AuthenticationUserName [set] |
Specifies the username used by the VoIP service for the account authentication. More... | |
BSTR | STUNHost [set] |
Specifies the host address of the SIP STUN server for the account. More... | |
LONG | STUNPort [set] |
Specifies the port for the SIP STUN server. More... | |
LONG | RegistrationExpiry [set] |
Specifies the registration expiration time for the account in seconds. More... | |
VARIANT_BOOL | DisableRingbackTones [set] |
Enables the playback of ringback tones. More... | |
VARIANT_BOOL | UseRPort [set] |
Enable the use of RPort for the account. More... | |
VARIANT_BOOL | UseRPortMedia [set] |
Enable the use of media RPort for the account. More... | |
VARIANT_BOOL | ForceRFC3264 [get] |
Enables the forced use of RFC-3264 for the account. More... | |
EPresenceModel | PresenceModel [set] |
Specifies the presence model used by the account. More... | |
EDTMFType | DTMFType [set] |
Specifies the DTMF type to be used by the account. More... | |
EProtocolTransport | SIPTransportType [set] |
Specifies the transport type used by the SIP protocol. More... | |
ESRTPNegotiation | RTPEncryption [set] |
Specifies the RTP encryption method. More... | |
VARIANT_BOOL | UseRoster [set] |
Enables the XMPP contact roster to be downloaded from the server. More... | |
VARIANT_BOOL | UseLegacyTLS [set] |
Enable the usage of legacy TLS mode in XMPP. More... | |
ESubscribeMWI | SubscribeForMWI [set] |
Specifies when the account is going to subscribe for its Message Waiting Indication (MWI). More... | |
VARIANT_BOOL | SubscribePresence [set] |
Enables the SIP account subscription for presence messages. More... | |
VARIANT_BOOL | PublishPresence [set] |
Enables the SIP account to publish its presence information. More... | |
BSTR | VoiceMailCheckExtension [set] |
Specifies the phone number which will reach the accounts voice mail check IVR. More... | |
BSTR | VoiceMailForwardExtension [set] |
Specifies the phone number to which calls must be forwarded to leave a voice message for that account. More... | |
Account interface.
The account interface represents a connection to a given VoIP service. The phone can't make calls without an account interface instance.
void IZoiperAccount::AddCodec | ( | [in] BSTR | codec | ) |
Add a codec to the account codec list.
The first call to this method will enable the custom codec list for the account. If the method is not called, the account will use the global codec list, which by default has all the available codecs enabled.
[in] | codec | a string with the codec to add. It can have the following values: "GSM", "a-law", "u-law", "Speex", "iLBC 30" and "iLBC 20". It is not case sensitive. |
void IZoiperAccount::Apply | ( | ) |
Apply changes.
Apply any changes made to the properties of the account object.
void IZoiperAccount::ClearCodec | ( | ) |
Disable the custom codec list for the account.
void IZoiperAccount::Register | ( | ) |
void IZoiperAccount::SipHeaderAdd | ( | [in] BSTR | name, |
[in] BSTR | value | ||
) |
Add a new SIP header value.
Add a new header value for the calls associated with this account.
[in] | name | the parameter takes the name of the desired header. |
[in] | value | the parameter the desired value for that header. |
void IZoiperAccount::SipHeaderClear | ( | [in] BSTR | name | ) |
Clear all custom SIP headers.
Use to clear all of the custom headers added by using the IZoiperAccount::SipHeaderAdd method.
[in] | name | a string with the name of the header. |
void IZoiperAccount::SipHeaderDump | ( | [in] VARIANT_BOOL | enable | ) |
Enables the SIP header dump for this account.
When enabled this will cause the IZoiperEvent::OnZoiperCallSipHeader to be invoked when there is a SIP header availabale for this account.
[in] | enable | enables the SIP header dump. |
void IZoiperAccount::Unregister | ( | ) |
|
set |
Specifies the username used by the VoIP service for the account authentication.
In most cases IZoiperAccount::UserName and IZoiperAccount::AuthenticationUserName properties are one and the same parameter. In these cases you can just set the IZoiperAccount::UserName property.
|
set |
Specifies the caller identification name (CID) for the account.
|
set |
Specifies the IAX2 context.
|
set |
Enables the playback of ringback tones.
Enable or disable the playback of ringback tones, while the phone is waiting for the remote peer to answer.
|
set |
Specifies the SIP domain.
Set the SIP domain and port for the account. To set the port use the form <domain:port>.
|
set |
Specifies the DTMF type to be used by the account.
|
get |
Enables the forced use of RFC-3264 for the account.
|
set |
Specifies the IAX2 or XMPP host address.
Set the IAX2 or XMPP host and port for the account. To set the port use the form <domain:port>.
|
set |
Specifies the user identification for XMPP accounts.
It is used along with the IZoiperAccount::Host, IZoiperAccount::Password and IZoiperAccount::CallerID properties to define the XMPP connection parameters.
|
get |
Specifies the account name.
Used to read the account name. It acts as unique identifier for the account. The account name is set when the account is created.
|
set |
Specifies the SIP outbound proxy address.
Set the SIP outbound proxy address and port for the account. To set the port use the form <domain:port>.
|
set |
Specifies the password used by the VoIP service to authenticate the account.
|
set |
Specifies the caller identification phone number for the account.
This applies to IAX2 accounts only.
|
set |
Specifies the presence model used by the account.
|
set |
Enables the SIP account to publish its presence information.
|
set |
Specifies the registration expiration time for the account in seconds.
For SIP accounts the default value is 3600 seconds. For IAX2 accounts it is 60 seconds. The value set by this property will be suggested by the phone to the VoIP service but it can be overridden by it.
|
set |
Specifies the RTP encryption method.
|
set |
Specifies the transport type used by the SIP protocol.
|
get |
Specifies the account registration state.
|
set |
Specifies the host address of the SIP STUN server for the account.
Set an empty string if you want to disable the STUN usage for the account. The STUN usage is disabled by default.
|
set |
Specifies the port for the SIP STUN server.
Possible values are between 1 and 65500.
|
set |
Specifies when the account is going to subscribe for its Message Waiting Indication (MWI).
This property must be set before invoking IZoiperAccount::Apply and IZoiperAccount::ApplyRegister methods.
|
set |
Enables the SIP account subscription for presence messages.
|
get |
Specifies the account protocol type.
|
set |
Enable the usage of legacy TLS mode in XMPP.
|
set |
Specifies the user name used by VoIP service to identify the account.
|
set |
Enables the XMPP contact roster to be downloaded from the server.
Set the contact roster to be downloaded from the server and new contacts to be added (if there are any).
|
set |
Enable the use of RPort for the account.
|
set |
Enable the use of media RPort for the account.
|
set |
Specifies the phone number which will reach the accounts voice mail check IVR.
|
set |
Specifies the phone number to which calls must be forwarded to leave a voice message for that account.