Dial-Out to Phone and SIP End Point from Video Room: Android SDK – Video API

The EnxRoom.makeOutboundCall() method allows you to initiate an Outbound Call to PSTN Number or SIP URI while being in the session, thus inviting the called participant to join the session on accepting the call.

Class: EnxRoom

• public void makeOutboundCall(String dialout_number, String cli_number, JSONObject dialOptions) – To dial Single Phone Number
• public void makeOutboundCalls(List<String> numberList, String cli_number, JSONObject dialOptions) – To dial multiple Phone Numbers (Maximum 5)

Parameters:

• dialout_number – String. It can be either a PSTN Number or a SIP URI to dial out.
• numberList – List of Strings. Multiple PSTN or SIP URL to dial out.
• cli_number – Calling Line Identification Number to be added as the originator of the Call. In the case of PSTN Phone Numbers, this will be validated against your purchased number or opted Shared Number. In case if the CLI does not match, the call will fail with an error “CLI mismatch”
• options – Availability: Android SDK v2.1.3+
  • name – String. Name of the dialled participant. If the name is omitted, the dialled Phone Number is used as the name.
  • early_media – Boolean. Default false. If set to true, the ringer is played in the Room when dial-out is initiated. On the other hand, if set to false, the ringer will not be placed in the Room when dial-out is in progress.
  • silent_join – Boolean. Default true. If set to true, the dialled participant is not put into the Room until he answers the call. On the other hand, when it is set to false, he will be put into the Room as soon as dial-out is in progress and ringer will be played.

Note: early_media and silent_join may not be used together.

Callback:

• onDialStateEvents -Notification to the call initiator about the status of the dial-out process as received from Gateway. The JSON Response returns status codes as: initiated, calling, connecting, connected, and terminated.
• onDTMFCollected – Notification when DTMF input is collected. It gets the String of digits collected.

room.makeOutbound("00999999999", "00999999999", dialOptions);

Public void onDialStateEvents(JSONObject jsonobject){
	// event JSON contains status of dial-out process 
	/*
	{	"number": "9999999999",	/* Dialed Phone Number of SIP URI */
		"status": "connected", 	/* Status of dialout Process */
		"description": "Detailed description"
	} 

	status may be initiated, calling, connecting, 
	connected & terminated
	*/     
} 

Public void onDTMFCollected(String DTMFInput){
	// DTMFINput - A String of digits collected through DTMF
} 

Error Codes / Exceptions:

Code	Description
1141	Dial out request already in process.
1142	CLI doesn’t match with the configured phone number.
5095	Invalid phone number.

Cancel Outbound Call

Availability: Android SDK v2.1.3+

The EnxRoom.cancelOutboundCall() method allows you to cancel an ongoing Outbound Call to PSTN Number or SIP URI thus disconnects the participant from the session on passing the number.

Class: EnxRoom

Method: public void cancelOutboundCall(String number)

Parameters:

• number – String. A PSTN Number or a SIP URI to disconnect from the session.

Callback

• onOutBoundCallCancel: Notification to the call initiator when the participant gets disconnected.

enxRoom.cancelOutboundCall("9999999999");	// Cancel a Call
 
public void onOutBoundCallCancel(JSONObject jsonObject);{
	// Acknowledge that the Call has been cancelled
	{	number: "9999999999",	/* Phone Number of SIP URI */

	} 
}

Send DTMF Response

Availability: v2.3.16

The EnxRoom.sendDTMF() method allows send DTMF response to pass through an IVR if dialed out PSTN Call is connected to IVR. This method can be executed repeatedly to pass single digit or multiple digits in a single call.

An outbound PSTN Call must have been answered first to make use of sendDTMF() method to pass DTMF digits on the same PSTN channel.

Class: EnxRoom

Method: public void sendDTMF(String number, String digits)

Parameters:

• number – String. It’s the same dialout_number used with makeOutboundCall() method. It can be either a PSTN Number or a SIP URI to dial out. For Phone Number, use country code without “00” or “+”.
• digits – String. Digit(s) to pass on to Voice Service as DTMF digits.

Callback:

• onOutBoundCallSendDtmf – Success and failure notifications are given with error codes.

enxRoom.sendDTMF("919999988888", "1");	// Send DTMF 1

Public void onOutBoundCallSendDtmf(JSONObject jsonobject){
 	// event JSON contains status of sendDTMF 
}

Error Codes / Exceptions

Code	Description
1155	Invalid options/parameters/values.
1201	Invalid Dial-State.
1202	Outbound Dial Request not found.

---