asnCtiMakeCall

Initiates a new call on a line.

In most cases the operation is simple. Just provide the line number (e.g. '+49815136856177') to dial from and the number to dial to, let the server format the dialing number.
This is it.

It will get a bit more complex, if you want to use additional features like project/pin rules, hide caller id, provide the contact data and so on.
In this cases you have to add AsnCtiNewCallParams to your arguments. See AsnCtiNewCallParams for more details.

Remark: The result of this operation does not necessarily reflect, that a call has been dialed successfully. It just confirms the successful execution of the operation.
The corresponding result of the dial command itself (to the PBX for example) will be sent as an asnCtiNotifyMakeCallResult event.

ArgumentType: AsnCtiMakeCallArgument

AsnCtiMakeCallArgument is an Object

Name Type Optional Comment
u8sPhoneNumberFrom string Phone number (supercanonic notation, starts with '+', e.g. '+49815136856177') or line URI of the line where the call will be initiated.

u8sPhoneNumberTo string Number to dial.

iNumberFormat number The u8sPhoneNumberTo is the number to dial and normally the server would reformat the number into a dialable form. This behavior can be altered:

  • 0: Server should not format the number for dialing, it shall use it like it is.
  • Other values: Server should format the number before dialing (set prefix and area code etc.).
    Hint: If you are not sure, the number should always be formatted (-> use '1')
(Linked Type: AsnETAPIDialNumberFormat)
newCallParams AsnCtiNewCallParams yes Allows to set additional information (Project/Pin rules, hide caller id, set remote contact details etc.). These information are completely optional and in the most cases you can omit this parameter.

optionalParams AsnOptionalParameters yes

ResultType: AsnCtiMakeCallResult

AsnCtiMakeCallResult is an Object

Name Type Optional Comment
u8sConnectionID string Connection identifier of the call

optionalParams AsnOptionalParameters yes Additional parameters for asnCtiSetCallData added here for backward compatibility.

  • Key "WasProjectFound", Value bool, optional. Only initiate the call if the project (parameter in newCallParams of AsnCtiMakeCallArgument) was found.

ErrorType: AsnCtiMakeCallError

AsnCtiMakeCallError is an Object

Name Type Optional Comment
iErrorDetail number
u8sErrorString string
optionalParams AsnOptionalParameters yes

Version 6.1