Back to API references

SOAP API method ProcessedSmsMailing_snapshot

Description

The snapshot of this mailing.

Parameters

Name Type Description
id * int Unique identifier (id) of the object ProcessedSmsMailing. The method only applies to the processedsmsmailing with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
pdfdocumentsnapshot Structure of type 'pdfdocumentsnapshot'
emailingdocumentsnapshot Structure of type 'emailingdocumentsnapshot'
smsdocumentsnapshot Structure of type 'smsdocumentsnapshot'

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 'pdfdocumentsnapshot'

Name Type Description
id int The ID of the snapshot.
source string The source of the snapshot.
pagecount int The number of pages in the snapshot.
name string The name of the snapshot.
faxheader string The headerline above the fax.
language string The language in which this snapshot is displayed.

Structure 'emailingdocumentsnapshot'

Name Type Description
id int The ID of the emailingdocumentsnapshot.
name string The name of the emailingdocumentsnapshot.
headers string The additional headers of the emailingdocumentsnapshot.
source string The source of the emailingdocumentsnapshot.
textversion string The textversion of the emailingdocumentsnapshot.
subject string The subject of the emailingdocumentsnapshot.
timestamp timestamp The timestamp of the emailingdocumentsnapshot.
charset string The charset of the emailingdocumentsnapshot.
language string The language of the emailingdocumentsnapshot.
priority_indicator string Getting the priority header for emails who use this document snapshot.
unsubscribe_header string Should the list-unsubscribe header be sent with the mailing.
htmlEscaping string Check if the webform is escaping HTML code
smartyVersion integer What smarty version is used to render this snapshot

Structure 'smsdocumentsnapshot'

Name Type Description
id int The unique identifier of the sms document snapshot in the environment.
name string The name of the sms document snapshot.
timestamp timestamp The timestamp when the sms document snapshot was created.
message string The message that was sent.
from string The from address of the sms document snapshot.
language string The language of the sms document snapshot.
smartyVersion integer What smarty version is used to render this SmsDocumentSnapshot