Complex Objects 


AuthenticationDetails Object

Contains the credentials of the registered user performing the request. Must be sent with every request.

Property

Type

Description

username
String The sender’s username (login).
password
String The sender’s password.
class
String always “telemessage.web.services.AuthenticationDetails”

 


Message Object

Contains the message data. This includes the recipients’ information, message content, scheduling data and other
information.

Property

Type

Description

subject
String Zero or one text subject strings.
textMessage
String Zero or one text message string
properties
Array of Property objects Reserved for future use.
recipients
Array of Recipient objects One or more Recipient objects.
schedule
Schedule Zero or one Schedule objects.
fileMessages
Array of FileMessage objects Zero or more FileMessage objects.
class
string always “telemessage.web.services.Message”

 


Recipient Object

Contains the data of a specific message recipient.

Property

Type

Description

type
string

The recipient device type.Possible values are:

  • SMS
  • MMS
  • MOBILE
  • HOME_PHONE
  • BUSINESS_PHONE
  • FAX
  • EMAIL
value
string

Indicates a device value (phone number or email address).

addresType
integer

Indicates whether the recipient should be in the TO, CC or BCC list (only relevant to email
recipients). Must contain one of the following values:

  • 0 – TO
  • 1 – CC
  • 2 – BCC
description
string

An optional text description for this recipient (used for display purposes instead of the value
property in various circumstance).

class
string

always “telemessage.web.services.Recipient”

 


Schedule Object

Indicates when to start and stop trying to send the message.

Property

Type

Description

sendAt
long Used for scheduling a message to a later time for a postponed message delivery (in standard
timestamp format – number of milliseconds since 1.1.1900).
expiredAt
long Indicates when the system should stop trying to deliver the message (in standard timestamp
format – number of milliseconds since 1.1.1900).
class
string always “telemessage.web.services.Schedule”

 


FileMessage Object

Used to attach a file to a message.Containsthe name of the file, the file type and the file data contents.

Property

Type

Description

filename
string The name of the file that will be presented to the end user (only the name itself, without the full path to
the file).
mimeType
String The mime type of the file. If absent the mime type is automatically determined according to the file name
extension (for common file types).
type
int Indicates the format and location of the file data. Must contain one of the following values:

  • 0 – the value object contains the file encoded using the Base64 encoding format. The actual file
    content is provided here in the Base64 format. More information on Base64 can be obtained from http://www.ietf.org/rfc/rfc1521.txt.
value
string The file data encoded using the Base64 encoding format. Find more here.
preview
string Reserved for future use.
class
string always “telemessage.web.services.FileMessage”

 


RecipientStatus Object

The status of a message recipient according to device.

Property

Type

Description

recipient
Recipient The details of the recipient.
status
integer The status value of the recipient device (see Appendix B).
description
string The status description as (see Appendix B).
statusDate
long The time the status was given (in standard timestamp format – number of milliseconds since
1.1.1900).
class
string always “telemessage.web.services.RecipientStatus”

Deprecated. See MultiValueUserField

UserField Object

Contains specific user field information

Property

Type

Description

name
string The field name.
value
string The field value.
date
long The time of last the update (in standard timestamp format – number of milliseconds since
1.1.1900).
options
Array of Option Array of possible options for the current field. 
class
string always “telemessage.web.services.UserField”

MultiValueUserField Object

Contains specific user field information

Property

Type

Description

name
string The field name.
values
array of string The field values.
value
string For backward compatibility with UserField. Leave empty.
date
long The time of last the update (in standard timestamp format – number of milliseconds since
1.1.1900).
options
Array of Option Array of possible options for the current field. 
class
string always “telemessage.web.services.MultiValueUserField”

Option Object

Contains specific option information

Property

Type

Description

name
string The option name.
value
array of string The option value.
class
string always “telemessage.web.services.Option”