16 Dec Send SMS

 

Overview

Go4clients bases its functionality on campaigns. A campaign is a set of events (Calls, SMS, Landing pages, and many more) with the same characteristics that allows your organization to categorize your customers according to your needs and contact them evenly. You can find the interactions that your customers have with it in the “1-Way analytics” section.

This API allows you to send a personalized SMS to a unique destination at the time no matter what programming language your organization uses since Go4clients APIs use standard REST services that are easily integrated with any application. You can use this API when you need to send a personalized SMS to a single destination. Although the API responds immediately, the Delivery receipt of each message is asynchronous (see Delivery Receipt of a Message).

Features:

• Assign a campaign name to your petition. If you don’t specify one, the service creates a general campaign called “General 1-way Campaign”.

• Put a sender (parameter “from”) into your petition only if you have acquired a shared or dedicated code. If the body’s petition omits this parameter, we will assume that the sender can be “Random”.

• Send an SMS with a Landing Page service included!

 

1. HTTP Methods

To send an SMS campaign you need to call a POST HTTP. The following URLs are used to publish the SMS service:

HTTPS (Recommended):

HTTP (non-SSL):

The following HTTP request will create and add a SMS to the new SMS campaign “My first campaign” if it is the first SMS you send, the system will automatically create this campaign for you. This petition will send the “message” to the destination “to“.

2. Authentication

All requests require API Key and API Secret authentication credentials. The “apiKey” path parameter refers to the API key of your organization. You will also need to send the Apisecret as a header. Your Account Administrator can this information under “My Profile > Settings > API” section.

The security information goes in the POST Headers:

Parameters
Apikey
String (Required)

The account’s Api key username (key), a 32 character random generated string.
Example:

“Apikey”: “5bf54d157a214f748eede4e4131b874d”

Apisecret
String (Required)

The account’s API password (secret). It’s a numeric random string with a random length between 10 and 15 characters.
Example:

“Apisecret” : “712968662797”

Please be advised that the header also have to include a parameter “Content-Type” with value “application/json”.

REQUEST PARAMETERS

Parameters
from
String – (Not mandatory)

A number of origin of the SMS. It only works when the client has bought a code.

to
String (Required)

Destination number of the message. Only receives numbers.

message
String (Required)

Message content. Supports a maximum length of 160 characters.

campaing
String (Not mandatory)

Identifier of the campaign. If the campaign already exists the SMS will be added to it. If it doesn’t exist the system will automatically create a new campaign with this identifier and add the SMS to it. If the parameter is not present, the SMS will be added to the generic “1-Way generic campaign” in your account.;

sendDate
String (Not mandatory)

The delivery date of the SMS. Format: yyyy-MM-dd HH:mm

landindId
String (Not mandatory)

It is the ID of Landing Page which will be used into the SMS. The Landing Page have to belong to user/organization who wants to send a message, otherwise, the plat-form will give an error.

 

SMS + LANDING PAGE

For this service, you only have to add the “landingId” parameter into your petition and, into the message body, include the following identifier: #Landing_Preview#

The following HTTP request will create and add an SMS to the new SMS campaign “My first campaign with Landing Page” if it is the first SMS you send. This petition will send the “message” with a Landing Page to the destination “to“.

If you want to know how to integrate your application with the events triggered by the Go4Clients Landing Page platform, please see de section LANDING PAGE INTEGRATION

 

LANDING PAGE ID

You will need to go to the section “Create Landing Page” on the platform web. There you will find the Landing Pages and its IDs created by you.

3. RESPONSE PARAMETERS

Below, you will find a success response example of the SMS service and parameters descriptions.

 

Response Parameters
code
String

Code of the result.

description
String (Required)

Brief description of the result.

succes
Boolean

Indicates if the service response is successful or not.

cost
Double (Not mandatory)

Value debited for the sent message.

 

EXAMPLES

PHP Example SMS

 

PHP Example SMS+LANGIND PAGE: