sendDTMF()

sendDTMF(params)

Compatibility:
Prebuilt
Custom

Parameters

  • sessionId participantId of the dialOut Session.
  • tones combined string of the dtmf tone to send (example 1234#).
  • method (optional) the method to use for sending DTMF. Can be 'sip-info', 'telephone-event', or 'auto'. Defaults to 'auto', which selects the best method based on the SIP endpoint's capabilities.
  • digitDurationMs (optional) duration in milliseconds, between each DTMF digit. Must be an integer between 50 and 2000. The default duration is 500ms.

Return Value

Errors

Below are the possible errors that the caller of sendDTMF() can expect to be thrown:

  • sessionId and tones are mandatory parameters of type string
  • tones string must be upto 20 characters
  • {character} is not valid DTMF tone - valid DTMF tones are 0-9, A-D, #, *
  • digitDurationMs must be a finite integer number
  • digitDurationMs must be between 50ms and 2000ms, the default value is 500ms