Sending SMS, Viber, Flash SMS, WAP-Push

POST http://lk.mysmpp.ru/xml

Headers

Name Type Description

Name	Type	Description
Content-type*	String	`text/xml; charset=utf-8;`

Content-type*

String

text/xml; charset=utf-8;

Request Body

Name Type Description

Name	Type	Description
login.value*	String	Your login in the system
message.address.region	String	Area for vCard
message.address.city	String	City for vCard
message.address.street	String	Street for vCard
message.address.post_office_box	Int	PO Box for vCard
message.organization	String	Organization for vCard
message.position	String	Contact's position for vCard
message.email	String	E-mail for vCard
message.phone.fax	Int	Fax number for vCard
message.phone.work	Int	Work phone number for vCard
message.phone.cell	Int	Phone number for vCard
message.name	String	Name for vCard
message.url	String	Link for WAP Push or vCard
message.abonent.time_send	date	The date and time of the shipment in the format: YYYY-MM-DD HH:MM where, YYYY-year, MM-month, DD-day, HH-hours, MM-minutes If not set, Viber message has maximum lifetime (one day).
message.abonent.client_id_sms	String	The number assigned by the client Optional parameter, allows to avoid resending. If SMS with this number has already been sent from this account earlier, then it will not be sent again, but the number of the previously sent SMS will be returned.
message.abonent.number_sms	Int	Message number within the XML document being sent
message.image_viber	String	Address of the picture for Viber message
message.action_viber	String	Link for Viber message button
message.button_viber	String	Viber message button text
message.text_viber*	String	Viber message text
message.sender_viber*	String	Viber message sender
message.type	String	SMS message type: - flashsms - Flash SMS - silence - invisible SMS (to check subscriber status) - sms - regular SMS - wappush - WAP-Push - vcard - business card (vCard)
message.type_send_2	String	Type of message to be delivered, in case the message to be sent is not delivered (`viber` or `sms`)
message.type_send_1*	String	Type of message to be sent (`viber` or `sms`)
token.value*	String	You can use a secret key instead of login and password. To obtain it, please contact your manager
password.value*	String	Your password in the system
message.sender*	String	Sender of SMS message This is the value that will be displayed on the subscriber's phone in the SMS From field.
message.text*	String	SMS text
abonent.phone*	Int	Number of the subscriber to whom the SMS is addressed
message.additional	String	Additional information for vCard
message.address.country	String	Country for vCard
message.address.postal_code	Int	Index for vCard

String

Your login in the system

message.address.region

String

Area for vCard

message.address.city

String

City for vCard

message.address.street

String

Street for vCard

message.address.post_office_box

Int

PO Box for vCard

message.organization

String

Organization for vCard

message.position

String

Contact's position for vCard

message.email

String

E-mail for vCard

message.phone.fax

Int

Fax number for vCard

message.phone.work

Int

Work phone number for vCard

message.phone.cell

Int

Phone number for vCard

message.name

String

Name for vCard

message.url

String

Link for WAP Push or vCard

message.abonent.time_send

date

The date and time of the shipment in the format:

YYYY-MM-DD HH:MM

where, YYYY-year, MM-month, DD-day, HH-hours,

MM-minutes

If not set, Viber message has maximum lifetime (one day).

message.abonent.client_id_sms

String

The number assigned by the client

Optional parameter, allows to avoid resending. If SMS with this number has already been sent from this account earlier, then it will not be sent again, but the number of the previously sent SMS will be returned.

message.abonent.number_sms

Int

Message number within the XML document being sent

message.image_viber

String

Address of the picture for Viber message

message.action_viber

String

Link for Viber message button

message.button_viber

String

Viber message button text

message.text_viber*

String

Viber message text

message.sender_viber*

String

Viber message sender

message.type

String

SMS message type:

- flashsms - Flash SMS

- silence - invisible SMS (to check subscriber status)

- sms - regular SMS

- wappush - WAP-Push

- vcard - business card (vCard)

message.type_send_2

String

Type of message to be delivered, in case the message to be sent is not delivered (viber or sms)

message.type_send_1*

String

Type of message to be sent (viber or sms)

token.value*

String

You can use a secret key instead of login and password. To obtain it, please contact your manager

password.value*

String

Your password in the system

message.sender*

String

Sender of SMS message

This is the value that will be displayed on the subscriber's phone in the SMS From field.

message.text*

String

SMS text

abonent.phone*

Int

Number of the subscriber to whom the SMS is addressed

message.additional

String

Additional information for vCard

message.address.country

String

Country for vCard

message.address.postal_code

Int

Index for vCard

<?xml  version="1.0" encoding="utf-8" ?>
<response>
     <information number_sms="1" id_sms="SMS ID in the system to check the status" parts="2">Status/error message</information>
     <information number_sms="2" id_sms="SMS ID in the system to check the status" parts="2">Status/error message</information>
     <information number_sms="3" id_sms="SMS ID in the system to check the status" parts="2">Status/error message</information>
…
</response>

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>Error message</error>
</response>

Deciphering parameters in query responses

Parameter	Data type	Description
information.number_sms	Int	The message number specified when sending the XML document
information.id_sms	Int	SMS message number. It is used to check the status of SMS. If an error occurred while sending SMS, id_sms is not transmitted
information.parts	Int	Number of SMS parts
information	String	Message status ("send") if SMS has been sent, or an error message if an error occurred while sending SMS: We have run out of SMS. Please contact your manager to resolve the problem Out of SMS Account blocked Specify phone number Phone number is on the stop list This destination is closed for you This destination is closed SMS text rejected by moderator No sender The sender must not exceed 15 characters for numeric numbers and 11 characters for alphanumeric numbers Phone number must be less than 15 characters No message text No link Provide the contact name and at least one parameter for a business card There is no such sender The sender has not been moderated
error	String	The error text can take the following values: Incorrect XML document format Incorrect login or password POST data is missing

Parameter

Data type

Description

information.number_sms

Int

The message number specified when sending the XML document

information.id_sms

Int

SMS message number. It is used to check the status of SMS.

If an error occurred while sending SMS, id_sms is not transmitted

information.parts

Int

Number of SMS parts

information

String

Message status ("send") if SMS has been sent, or an error message if an error occurred while sending SMS:

We have run out of SMS. Please contact your manager to resolve the problem
Out of SMS
Account blocked
Specify phone number
Phone number is on the stop list
This destination is closed for you
This destination is closed
SMS text rejected by moderator
No sender
The sender must not exceed 15 characters for numeric numbers and 11 characters for alphanumeric numbers
Phone number must be less than 15 characters
No message text
No link
Provide the contact name and at least one parameter for a business card
There is no such sender
The sender has not been moderated

error

String

The error text can take the following values:

Incorrect XML document format
Incorrect login or password
POST data is missing

Example XML request

<?xml version="1.0" encoding="utf-8" ?>
<request>
  <message type_send_1="viber or sms" type_send_2="viber or sms" type="flashsms or silence or sms or wappush or vcard">
   <sender_viber>Sender of Viber message</sender_viber>
   <text_viber>Message text</text_viber>
   <button_viber>Button text</button_viber>
   <action_viber>Link for button</action_viber>
   <image_viber>Address of image</image_viber>
   <sender>Sender 1</sender>
   <text>Message text 1</text>
   <url>Address for WAP Push or vCard</url>
   <name>Name for vCard</name>
   <phone cell="79033256699" work="79033256699" fax="79033256699"/>
   <email>E-mail vCard</email>
   <position>Job vCard</position>
   <organization>Organization vCard</organization>
   <address post_office_box="P.O. Box" street="Street" city="City" region="Region" postal_code="Index" country="Country" />
   <additional>Additional vCard information</additional>
   <abonent phone="79033256699" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34:54" validity_period="2001-12-31 15:34:54" validity_period_viber="2001-12-31 15:34:54" />
   <abonent phone="79033256699" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35:54" />
     ...
   <abonent phone="79033256699" number_sms="10" client_id_sms="110" time_send="" />
 </message>
 <message>
   <sender>Sender 2</sender>
   <text>Message Text 2</text>
   <abonent phone="79033256699" number_sms="11" client_id_sms="111" />
   <abonent phone="79033256699" number_sms="12" client_id_sms="112" />.
   ...
   <abonent phone="79033256699" number_sms="20" client_id_sms="120" />
</сообщение
 ...
<security>
   <login value="login" />
   <password value="password" />
</security>
</request>

Last updated 11 months ago