...
...
...
Method parameters
Performs a single sending of a text message (SMS), already existing or created as the request is executed.
- string SendSingleSMS(string accessKey, int listID, string subject, string type, string content, string numero, Option[] options)
- accessKey:
...
- access key obtained using the LoginFromId method
- listID: list identifier. Lists and corresponding IDs can be obtained calling the GetLists Method
- subject: subject of the text message
- type: type of message text source (TEXT, ID)
- content:
...
- message text source, depending on the type:
- type = TEXT,
- content is the text of the message
- type = ID,
- content is the identifier of the text message to be sent
- options:
- message text source, depending on the type:
...
- an array
...
- of key/value
...
- pairs for options setting. Only the following options are available for this method:
- note
- *: a string containing notes about the message
- dyn_fld
- *: boolean value to enable/disable the use of dynamic fields in the message (dyn_fld=true, dyn_fld=false)
- from
Il codice di errore vale 0 se la chiamata al metodo è andata a buon fine e nel risultato sono restituiti i dettagli sull'invio (vedi esempio).Il numero di messaggi che possono essere inviati in un'ora è dell'ordine di qualche migliaio se si utilizza l'opzione type=ID, mentre con l'utilizzo dell'opzione type=TEXT ci si deve limitare a qualche decina di messaggi al giorno. Ne consegue che l'opzione type=TEXT è in genere consigliata solo se l'invio di SMS è occasionale.
Esempio di messaggio SendSingleSMSResult:
<SendSingleSMSResult>
<errorCode>0</errorCode>
<errorDescription>Message sent +393401111111</errorDescription>
</SendSingleSMSResult>- : sender of the text message (note: restrictions may apply in some countries and the sender may be overwritten, please contact us for country specific information)
- isUnicode: boolean value indicating whether to use Western alphabets only (false), or Eastern alphabets as well, such as Arabic, Russian, Chinese, and so on (true).
- pairs for options setting. Only the following options are available for this method:
*can be used only when type=TEXT
Note |
---|
The option type=ID allows to send a few thousand messages per hour, whereas the option type=TEXT only allows to send a few dozens a day. As a consequence, we recommend not to use the option type=TEXT for massive deliveries. |
If error code=0, the call to the method was successful and the method returns the details of the sending
SOAP Examples
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ws="http://services.mailupnet.it/WS">
<soap:Header/>
<soap:Body>
<ws:SendSingleSMS>
<!--Use accessKey value that is returned by LoginFromId method-->
<ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
<ws:listID>1</ws:listID>
<ws:subject>Single sending using TEXT option</ws:subject>
<ws:type>TEXT</ws:type>
<ws:content>Text message for [FirstName] [LastName]</ws:content>
<ws:numero>+393401111111</ws:numero>
<ws:options>
<!--'note' and 'dyn_fld' options can be used only when type=TEXT-->
<ws:Option><ws:Key>note</ws:Key><ws:Value>this note is for internal use only</ws:Value></ws:Option>
<ws:Option><ws:Key>dyn_fld</ws:Key><ws:Value>true</ws:Value></ws:Option>
<ws:Option><ws:Key>from</ws:Key><ws:Value>+391234567890</ws:Value></ws:Option>
<ws:Option><ws:Key>campo1</ws:Key><ws:Value>Mike</ws:Value></ws:Option>
</ws:options>
</ws:SendSingleSMS>
</soap:Body>
</soap:Envelope> |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<SendSingleSMSResult>
<errorCode>0</errorCode>
<errorDescription>Message sent +393401111111</errorDescription>
</SendSingleSMSResult> |