1.8.4 SMS API

SMS API is part of the VSServices application.

The page SendSms.aspx from the VSServices is used to send messages (chats or SMS). The table below contains the list of supported parameters.

Parameter	Mandatory	Description
to	?	message destination number
from	?	sender phone number or name
login	?	client login, used for authentication
pass	?	client password (web access password or SIP password, depending on the global system settings)
text	?	message text
forward		By default forward=0; the messages are routed according to the SMS routing plan. When the forward is set to 1, the API will first look for a client account with login matching the destination address, sent in to parameter. If there is no matching client in the system the messages is routed as an SMS using the SMS routing plan.
client_type		when the client_type is specified the login and password for authentication are checked only for the accounts with the specified client type. If the client_type is not provided, the login and password are checked against all the client accounts regardless of the type. The client_type 0 is for the wholesale type, 32 for the retail type.
db		reseller database name, used only with reseller multi-portal setup
id_cc		optional, generated by system for SMS always ends with 99

Sample URL for sending text SMS message is:

http://callto.net/VSServices/SendSms.ashx?login=CLIENT_LOGIN&pass=CLIENT_PASSWORD&from=Paulx&to=442081368002&&text=Hello

One text message length limit is 160 characters. SMS API is able to accept longer messages but those are divided into 160 characters.

HTTP interface description for sending binary messages

A binary SMS message needs two additional fields:

udh	(User Data Header) should include a string of hexadecimal digits which form the binary user data header for the message
data	should include a string of hexadecimal digits which form the binary data content for the message
binary=1	required to identify the message as binary

When sending binary messages you have to provide the correct UDH parameter. Messages with the wrong UDH will be delivered but might not be read correctly by recipient. The client will be charged for those messages as for normal SMS and as such they will be shown in the CDR.

Sample URL for sending binary message:

http://callto.net/vsservices/sendsms.ashx?login=TEST_LOGIN&pass=TEST_PASS&from=TESTING&to=48600123123&binary=1&udh=06050415811581&data=024A3A51D195CDD004001B20550590610560558550548540820849900000

HTTP interface description for VCard standard messages

special=vcard	Allows sending a VCard
binary=1	required to identify the message as binary
vcard fieds	Description
vname	VCard Name
vmobile	VCard Mobile
vphone	VCard Phone
vemail	VCard Email
vfax	VCardFax

A sample URL for sending VCard:

http://callto.net/vsservices/sendsms.ashx?login=TEST_LOGIN&pass=TEST_PASS&from=Paulx&to=48600123456&binary=1&special=vcard&vname=BenTen&vmobile=44123456789&vphone=44123456789&vemail=benten%40gmail%2Ecom&vfax=44123456789

API responses

The SMS API returns the status after sending a message. The response is in XML format.

<?xml version="1.0" encoding="utf-8" ?>

<response>

<sms_response_code>200</sms_response_code>

<sms_response_text>Success</sms_response_text>

</response>

Response codes

public enum SmsResponseCode

{

OK = 200,

FORWARD_SIP_SERVER = 201,

SIP_MESSAGE_SEND = 202,

AUTHORIZATION_FAILED = 400,

NOT_ENOUGH_FUNDS= 401,

NOT_ENOUGH_FUNDS_FOR_ALL_RECIVERS= 402,

CLIENT_IP_BLOCKED = 403,

WRONG_PARAMETERS= 404,

ERROR = 405,

NO_TARIFF = 500,

NO_DIALPLAN_ENTRY = 501 ,

NO_TARIFF_PROVIDER = 502,

SMS_PROVIDER_IS_OFFLINE = 600,

SMS_PROVIDER_CANNOT_PROCESS_THE_MESSAGE = 601,

RESLLER_LEVEL_I_HAS_NO_FUNDS = 701,

RESLLER_LEVEL_II_HAS_NO_FUNDS = 702,

RESLLER_LEVEL_III_HAS_NO_FUNDS = 703,

RESLLER_LEVEL_I_NO_TARIFF = 704,

RESLLER_LEVEL_II_NO_TARIFF = 705,

RESLLER_LEVEL_III_NO_TARIFF = 706,

RESLLER_LEVEL_I_NOT_ACTIVE= 710,

RESLLER_LEVEL_II_NOT_ACTIVE = 711,

RESLLER_LEVEL_III_NOT_ACTIVE = 712,

MULTIPLE_RESPONSE = 800

}

Voipswitch

1.8.4 SMS API

HTTP interface description for sending binary messages

HTTP interface description for VCard standard messages

API responses

Related content