Making a call
Call feature is essential for the modern day communication. Call sdk allows users to make a audio/video call with the another sdk users.
warning
Before making the call, make sure you have implemented the helper object.
#
Make a voice callInitiate a call by providing the callee’s user JID into the makeVoiceCall method. Once the call initiated successfully, a callStatusListener callback will be triggered and callee user call status will be received here.
caution
If One to one call feature is unavailable for your plan, then it will throw 403 exception
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
[USER_JID ] | User JID | Array | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
note
To receive the user track, a userTrackListener callback should already be registered in the caller's client app. Whenever you make the call to a user, you will receive your own track and the callee's track in the same callback method. To differentiate the user, You can use the 'localUser' and 'userJid' param. You will receive both Audio and Video track in the same callback method.
#
Sample Javascript code to play the trackYou need to supply the track object which was received in the callback method to the audio element based on the track type that you have received.
warning
You shouldn't play your own Audio track.
#
Make a video callInitiate a call by providing the callee’s user JID into the makeVideoCall method. Once the call initiated successfully, a callback callStatusListener will be triggered and callee user call status will be received here.
caution
If One to one call feature is unavailable for your plan, then it will throw 403 exception
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
[USER_JID ] | User JID | Array | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
note
To receive the user track, a userTrackListener callback should already be registered in the caller's client app. Whenever you make the call to a user, you will receive your own track and the callee's track in the same callback method. To differentiate the user, You can use the 'localUser' and 'userJid' param. You will receive both Audio and Video track in the same callback method.
#
Sample Javascript code to play the trackYou need to supply the track object which was received in the callback method to the audio element based on the track type that you have received.
warning
You shouldn't play your own Audio track.
#
Make a group voice callInitiate a call by providing the callee’s user JID & Group ID into the makeVoiceCall method. Once the call initiated successfully, a callStatusListener callback will be triggered and callee user call status will be received here.
caution
If GroupCall feature is unavailable for your plan, then it will throw 403 exception
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
[USER_JID ] | Pass User JID in array format | String | true |
GROUP_ID | Group ID | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
note
To receive the user track, a userTrackListener callback should already be registered in the caller's client app. You will receive all users Audio track in the same callback method. To differentiate the user, You can use the 'localUser' and 'userJid' param.
note
You need to have multiple Audio tag element to play all user's audio.
#
Make a group video callInitiate a call by providing the callee’s user JID & Group ID into the makeVideoCall method. Once the call initiated successfully, a callback callStatusListener will be triggered and callee user call status will be received here.
caution
If GroupCall feature is unavailable for your plan, then it will throw 403 exception
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
[USER_JID ] | Pass User JID in array format | String | true |
GROUP_ID | Group ID | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
note
To receive the user track, a userTrackListener callback should already be registered in the caller's client app. You will receive all users Audio/Video track in the same callback method. To differentiate the user, You can use the 'localUser' and 'userJid' param.
note
You need to have multiple Audio and Video tag element to play all user's audio and video.
#
Receive incoming callTo receive an incoming call, a incomingCallListener callback should already be registered in the callee’s client app. Whenever a user make call to a user, the callee user will receive the calling data in this callback.
#
Response ParamsArguments | Description |
---|---|
callTime | Call intiated time in timestamp format. |
callType | Describe the audio or video call. |
groupId | Contain the group ID If the call is group call. Otherwise, the value will be NULL. |
roomId | Call room ID. |
status | Status of the call(calling, ringing, connecting, connected). |
toUsers | Array of User JID of callee users. |
userJid | User JID who intiated the call |
#
Answer a callTo answer a call use the answerCall method.
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
End a callTo end a call use the endCall method.
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
Decline a callTo decline a call use the declineCall method.
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |