Api Integration - SMSGATEZ

API Integration is found on the SMSGATEZ Cloud

SMSGATEZ SEND API

API Key: c3zPm7E20npMUS4d (Your account will have a unique API Key)

Send API URL: https://api.smsgatez.com/index.php/SendApi

Params (method GET/POST):

apiKey: c3zPm7E20npMUS4d(required)
from: Your SMSGatez phone number or ‘rotatePhoneNumbers’ to use smart rotator (required)
to: receiver phone number (required)
message: the body (required)
showInbox: {true|false} default is false

Examples:
https://api.smsgatez.com/index.php/SendApi?apiKey=c3zPm7E20npMUS4d&from=%2B12223334444&to=%2B15556667777&message=Hello%20How%20are%20you
https://api.smsgatez.com/index.php/SendApi?apiKey=c3zPm7E20npMUS4d&from=rotatePhoneNumbers&to=%2B19513487859message=Hello%20How%20are%20you

The response is in JSON format: {“status”:”success|fail”,”reason”:”ERROR_DETAILS”,”from”:”FROM_PHONE”,”to”:”TO_PHONE”,”message”:”MESSAGE”}

To Test Your API: Use the API example and replace the ” apiKey= ” with Your_API_Key from your account, an active ” from= ” with %2B preceding the phone number, an active ” to= ” with %2B preceding the phone number and a ” message = ” We use ” Hello%20How%20are%20you ” Add all of your PARAMs together and paste into your favorite browser.

*Just a note: Scripting languages use encode the message by removing spaces so as to transfer information from one computer to another, across networks.

When I pasted the above example with my active phone number I got the following response:

{“status”:”fail”,”reason”:”Please check log!”,”to”:”+19513487859″,”from”:”+18333321414″}

As you can see the status is “fail” and the reason is that the from number is not an active number on this account.

Post back delivery receipt URL will be entered in the field provided.

You will need to choose GET or POST allowing SMSGatez to post back the URL you have input with these params: from, to, and status={DELIVERED, SENT, FAILED, DELIVERABLE, UNDELIVERED, REJECTED, QUEUED}

Don’t forget to click on UPDATE to save your changes.

SMSGATEZ CONTACT API

Add Contact API URL: https://api.smsgatez.com/index.php/ContactController/createContact

Params (method GET/POST):

apiKey: Your_API_Key (required)
group: group name (required)
phone: phone number of the contact
email: email of the contact
firstname: first name
lastname: last name
address: address
city: city
state: state
zip: zip code
country: country (default US)
optedIn: true|false (default false)

Example:
https://api.smsgatez.com/index.php/ContactController/createContact?apiKey=Your_API_Key&phone=%2B12223334444&group=Test_Group&optedIn=true

The response is in JSON format: {“status”:”success|fail”,”reason”:”ERROR_DETAILS”}

WEBHOOKS

INCOMING WEBHOOKS

Incoming Webhooks can be found under Automatic>Replies in the WebApp

Syntax:
<your_url.com><?|&><EXT_PHONE_NUMBER_PARAM_NAME>=[SG_PHONE_NUMBER]&<EXT_VIRTUAL_NUMBER_PARAM_NAME>=[SG_VIRTUAL_NUMBER]&<EXT_FIRST_NAME_PARAM_NAME>=[SG_FIRST_NAME]&<EXT_LAST_NAME_PARAM_NAME>=[SG_LAST_NAME]&<EXT_MESSAGE_PARAM_NAME>=[SG_MESSAGE]&<EXT_TIMESTAMP_PARAM_NAME>=[SG_TIMESTAMP]&<EXT_ADDRESS_PARAM_NAME>=[SG_ADDRESS]&<EXT_CITY_PARAM_NAME>=[SG_CITY]&<EXT_STATE_PARAM_NAME>=[SG_STATE]&<EXT_ZIP_PARAM_NAME>=[SG_ZIP]&<EXT_CARRIER_PARAM_NAME>=[SG_CARRIER]&<EXT_EMAIL_PARAM_NAME>=[SG_EMAIL]

Replace <EXT_…> with your API params/info, update <?|&>, don’t change [SG_…] params.
SG_PHONE_NUMBER: the recipient phone number(don’t change).
SG_VIRTUAL_NUMBER: the virtual number that receives the incoming message.
First name, last name, EXT_VIRTUAL_NUMBER and message are optional.

Important: Global webhook will be overwritten by auto reply webhook!