GupShup Enterprise provides certain advanced functions to the users. You can use GupShup API's, customized messages, mobile access to name a few. We will see each of these functions here.

Enterprise GupShup API

Gateway API app resides at http://enterprise.smsgupshup.com/GatewayAPI/rest. You can send different types messages such as text, Unicode, vCard, and binary using gateway API.

For using API you need:

1.   User name & password. If you don’t have an account you can create one at http://enterprise.smsgupshup.com.

2.   URL encoding of your message, password etc.

3.    Current version of API is 1.1 but we still support 1.0.

Sending a Single Message with version 1.1

Try and send message using below URL. Just replace the highlighted sections with your details.

http://enterprise.smsgupshup.com/GatewayAPI/rest?method=SendMessage&send_to=9199xxxxxxxx&msg=Welcome%20to%20SMS%20GupShup%20API&msg_type=TEXT&userid=20000xxxxx&auth_scheme=plain&password=password&v=1.1&format=text

Just replace

·       9199xxxxxxxx – with mobile no. of the receiver

·       Welcome%20to%20SMS%20GupShup%20API. – with your URL encoded message

·       20000xxxx – with your user id

·       password – with your password

You can add more parameters in this URL.

Parameters

List of parameters apart from default parameters.

Parameter	Value	Description
method	sendMessage	Specification to send a single message
send_to	Phone no. of the receiver	The number must be in pure numeric format with no special characters.
msg	UrlEncoded string of UTF-8 characters	The message that needs to be sent. It can contain alphanumeric & special characters.
msg_type	Text, Unicode_text, or flash, VCARD, binary	Indicates the type of the message to be sent. Use VCARD for sending a business card.

Optional parameter

Parameter	Value	Description
port	Port Number	It is a pure number and needs to be specified if the message is being sent to a port.
timestamp	URL encoded timestamp in the given format	Sender can specify a particular time for sending the message. Accepted timestamp formats are: 1.   yyyy-MM-dd HH:mm:ss (2008-11-21 23:12:32 or 2008-3-4 2:44:23) 2.   MM/dd/yy HH:mm:ss (11/21/08 23:12:32 or 3/4/08 2:44:33) 3.   MM/dd/yy hh:mm:ss a(11/21/08 11:12:32 PM or 3/4/08 2:44:33 AM) 4.    MM/dd/yy hh:mm a(11/21/08 11:12 PM or 3/4/08 2:44 AM)

Sending a Single Message with version 1.0

GupShup Enterprise also supports backward compatibility for our older version of API, 1.0.

Here’s a sample URL for sending message using version 1.0

http://enterprise.smsgupshup.com/GatewayAPI/rest?method=SendMessage&

send_to=9199xxxxxxxx,91998xxxxxxx,91997xxxxxxx&msg=Welcome%20to%20SMS%20

GupShup%20API&userid=20000xxxxx&auth_scheme=plain&password=password

&v=1.0&format=text

Just replace

·       9199xxxxxxxx – with mobile no. of the receiver.

·       Welcome%20to%20SMS%20GupShup%20API. – with your URL encoded message

·       20000xxxx – with your user id

·       password – with your password

You can add more parameters in this URL.

Parameters

List of parameters apart from default parameters.

Parameter	Value	Description
method	sendMessage	Specification to send a single message
send_to	Phone no. of the receiver	The number must be in pure numeric format with no special characters.
msg	UrlEncoded string of UTF-8 characters	The message that needs to be sent. It can contain alphanumeric & special characters.

Optional parameter

Parameter	Value	Description
port	Port Number	It is a pure number and needs to be specified if the message is being sent to a port.

With version 1.0,

·       You can send messages to multiple numbers in a single API call by separating numbers using “,” or “|”

·       Only text messages are allowed. This means you must exclude the “msg_type” parameter

·       Scheduling of messages (i.e. the parameter *timestamp*) is not supported

·       File uploads are not supported via API v1.0

Please refer to our API document to know more about API functions, and see more examples.

Mobile Access

Mobile access will allow you to access your groups through the specified mobile phone(s). You can create new groups too through the specified mobile phone(s).

To enable mobile access through website:

1.   Click Groups tab on the menu bar.

2.   Click Group Settings tab for the group for which you want to enable mobile access.

3.   Select the Enable Mobile Access option.

: After enabling mobile access, a successful message is displayed at the top.

4.   Enter the mobile number to which you need to provide access to the group(s). Click Add button.

5.   Repeat above step to add more numbers. You can up to 7 different mobile numbers.

6.    Click Save.

To enable mobile access for group creation:

1.   Click Settings on menu bar.

2.   Select Enable Group Creation by SMS in the Advanced Account Settings section.

3.   Enter the mobile number on which you want to provide this feature. Click Add button.

4.   Repeat above step to add more numbers. You can up to 7 different mobile numbers.

5.    View this document to in details what kind of actions can be performed via mobile access.

Keyword Response Campaign

You can collect response data for all your set-up keywords. For this GupShup provides you two options. Default response and Response URL.

Response URL: Whenever a request is received on the defined keyword, it will be forwarded to the given Response URL, such as www.example.com.

To respond to the keyword, the GupShup server calls the following URL:

http://www.example.com/getresponse.php?phonecode=%pcode&keyword=%kw&location=%loc&carrier=%car&content=%con&msisdn=%ph&timestamp=%time

The response URL consists details of response such as the sender’s phone number, the time when request was received, the keyword on which request was received, the additional message with the request, and so on. Thus, for the keyword Test, phone code 9220092200, and message Test Nagpur, the server calls the following URL:

http://www.example.com?phonecode=9220092200&keyword=Test&location=Mumbai&carrier=Vodafone&content=TestNagpur&msisdn=9812348765&timestamp=13082098000

: If you wish to generate a response through the callback URL, you must ensure that the response conforms to a specified XML format. If the remote server returns an invalid XML message or does not return an XML message at all, the first 160 characters of server response are used to compose the message.

Default Response: Default Response is a response that is delivered to the sender’s number on receiving the keyword instruction. You can set a default string as a response to a keyword.