vx_req_session_create

Reference the Vivox Core SDK API.

Read time 3 minutes

Last updated a day ago

#include <VxcRequests.h>

Public Attributes

	Name
vx_req_base_t	base The common properties for all requests.
VX_HANDLE	account_handle The handle returned from a successful vx_req_account_anonymous_login request.
char *	name The display name of the entity being called (user or channel).
char *	uri The URI of the terminating point of the session (who or what is being called).
char *	password The password that is used if the user is joining a password-protected channel.
int	connect_audio Determine whether the session will join audio.
int	join_audio
int	join_text
vx_password_hash_algorithm_t	password_hash_algorithm Indicates the hashing algorithm used on the password that is passed in to the SDK.
int	connect_text Determine whether the session is going to join text.
int	session_font_id The ID of the voice font to apply to the session.
int	jitter_compensation The jitter buffer compensation for the SIP session.
char *	alias_username
char *	sessiongroup_handle The preferred session group handle.
char *	session_handle The preferred session handle.
char *	access_token A Vivox Access Token to authorize the operation.

Detailed Description


struct vx_req_session_create;

Note: Creating a session automatically connects to the audio media, and you do not need to call Session.Connect. This request can be used as a shortcut to creating a session group and then adding a session to the session group. This request creates a new session group, creates a new session, and then returns the handles to both in the response.

Public Attributes Documentation

variable base


vx_req_base_t base;

The common properties for all requests.

variable account_handle


VX_HANDLE account_handle;

The handle returned from a successful vx_req_account_anonymous_login request.

variable name


char * name;

The display name of the entity being called (user or channel).

variable uri


char * uri;

The URI of the terminating point of the session (who or what is being called). URIs must be valid, and URI length cannot exceed MAX_CHANNEL_URI_LENGTH. Characters must use the following criteria:

Valid alphanumeric characters: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
Valid non-alphanumeric characters: -_.!~*'()&=+$,;?/
Escape sequence: Percent (%) followed by two hex characters (0-9 or A-F), which represent the ASCII value of the character that is being encoded. For example:
- 1. space - %20
- 1. @ - %40
- 1. : - %3A

variable password


char * password;

The password that is used if the user is joining a password-protected channel.

variable connect_audio


int connect_audio;

Determine whether the session will join audio.

1 indicates that the session will join audio.
0 indicates that the session will not join audio. The default value is 1.

variable join_audio


int join_audio;

Deprecated: Replaced with connect_audio. Determine whether the session will join audio.

1 indicates that audio will be joined.
0 indicates that audio will not be joined. The default value is 1.

variable join_text


int join_text;

Deprecated: Replaced with connect_text. Text is now enabled at the account level and the default is to have text enabled. Determine whether the session is going to join text.

1 indicates that text will be joined
0 indicates that text will not be joined. The default value is 0.

variable password_hash_algorithm


vx_password_hash_algorithm_t password_hash_algorithm;

Indicates the hashing algorithm used on the password that is passed in to the SDK. This can be password_hash_algorithm_cleartext or password_hash_algorithm_sha1_username_hash.

For password_hash_algorithm_cleartext, the password that is passed in is in cleartext.
For password_hash_algorithm_sha1_username_hash, the password that is passed in is the SHA1 hash of the password and the SIP URI of the user, Base64-encoded, with any trailing '=' characters stripped off.

variable connect_text


int connect_text;

Determine whether the session is going to join text.

1 indicates that text will be joined
0 indicates that text will not be joined. The default value is 1.

variable session_font_id


int session_font_id;

The ID of the voice font to apply to the session. You can obtain a list of available voice font IDs with vx_req_account_get_session_fonts. Set to 0 for none.

variable jitter_compensation


int jitter_compensation;

The jitter buffer compensation for the SIP session. This integer value represents the amount of compensation in milliseconds (ms) to apply to counteract network jitter. Valid values are 1-150 ms. If this field is not initialized, or if it is set to 1, then the SDK applies the default values for the given type of session.

variable alias_username


char * alias_username;

Deprecated: This is deprecated and should not be used.

variable sessiongroup_handle


char * sessiongroup_handle;

The preferred session group handle. Attention: This cannot match any existing handle (for example, account_handle or session_handle), but can be an existing sessiongroup_handle. This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.

variable session_handle


char * session_handle;

The preferred session handle. Attention: This cannot match any existing handle (for example, account_handle or session_handle). This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.

variable access_token


char * access_token;

A Vivox Access Token to authorize the operation.

Documentation

Development

User Acquisition

Monetization

Industry