Back to API references

SOAP API method Account_smsDocument

Description

A smsdocument is for sending a sms message to a mobile phone. This method will return a specific smsdocument in this account.

Parameters

Name Type Description
identifier * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
smsdocument Structure of type 'smsdocument'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'smsdocument'

Name Type Description
from string The from address of the sms document.
message string The message of the sms.
temporary boolean Is this document set as a temporary document. The document will be removed when there are no
size int Get the size of the document.
smartyVersion integer What smarty version is used to render this document
id int The ID of the document.
templateID int The template ID of the document
name string The name of the document.
description string The description of the document.
archived boolean Is this an archived document?.
created timestamp The date and time when the document was created.
modified timestamp The date and time when the document was last modified.
language string The language of the document.
timezone string Get the time zone of the document. If the timezone is not set, it returns