Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_session_channel_invite_user

Learn about session and session group management.
Read time 1 minuteLast updated 20 hours ago

This command sends an invitation to a specified user to join the channel that corresponds to the provided session handle. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEsession_handle
The handle returned from a successful [vx_req_sessiongroup_add_session] request.
char *participant_uri
The SIP URI of the participant to invite.

Detailed Description

struct vx_req_session_channel_invite_user;
This command sends an invitation to a specified user to join the channel that corresponds to the provided session handle. See: vx_resp_session_channel_invite_user The user who sends the invite does not receive any feedback after the invite call is made, and does not know if the other user received the invitation, if they are online, or if they rejected or ignored the invitation. The user who sends the invitation can only determine whether an invitation was accepted if they see the user who received the invitation enter the channel. Sending an invite to a user is not the same as making a P2P call, because you do not get the events that you would receive when a P2P call is made. Invites work well for inviting PSTN callers into a channel.

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable session_handle

VX_HANDLE session_handle;
The handle returned from a successful [vx_req_sessiongroup_add_session] request.

variable participant_uri

char * participant_uri;
The SIP URI of the participant to invite.