Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_account_send_message

Learn about messaging in Vivox Core.
Read time 1 minuteLast updated 20 hours ago

Send a message to a specific user. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEaccount_handle
The handle returned from a successful login request.
char *user_uri
The destination URI.
char *message_header
The HTTP content type of the message.
char *message_body
The contents of the message.
char *alias_username
char *language
The language to use.
char *application_stanza_namespace
A custom application stanza namespace.
char *application_stanza_body
A custom application stanza body.

Detailed Description

struct vx_req_account_send_message;
Send a message to a specific user. See: vx_resp_account_send_message

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 login request.

variable user_uri

char * user_uri;
The destination URI.

variable message_header

char * message_header;
The HTTP content type of the message. Note: This field will be validated, so it must use a valid format. See the IETF documentation on RFC 2046. If an empty string is passed in, then this field defaults to "text/plain".

variable message_body

char * message_body;
The contents of the message. Note: The message body cannot exceed the length that is specified by the server in its pre-login configuration. The default maximum message length is 320 bytes (320 characters in UTF-8 formatting).

variable alias_username

char * alias_username;
Deprecated: This is deprecated and should not be used.

variable language

char * language;
The language to use. Note: V5 only. This is ignored by V4. The default setting is NULL, which implies "en".

variable application_stanza_namespace

char * application_stanza_namespace;
A custom application stanza namespace. Note: V5 only. This is ignored by V4. This is optional. The default setting is NULL.

variable application_stanza_body

char * application_stanza_body;
A custom application stanza body. Note: V5 only. This is ignored by V4. This is optional. The default setting is NULL.