Back to API references

SOAP API method User_sendSms

Description

Use this method to send a text message to this user. The sent message will be added to the statistics. Note: SMS longer than 160 characters will be split and logged seperately. So sending a SMS of 200 characters will show up in the statistics as 2 messages.

Parameters

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

Return values

Name Type Description
value boolean

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