GENIQ REST API Reference

// All requests are made via HTTPS.
// Data is passed as URL-encoded form parameters or query strings.
// Responses are returned standardly in JSON.
{
  "responseCode": "0",
  "responseMessage": "Success"
}

// Step 1: Request Access Token
POST /rest/v1/token HTTP/1.1
Authorization: Basic Base64(API_KEY:SECRET)

// Step 2: Use Access Token for API Requests
POST /rest/v1/sms HTTP/1.1
Authorization: Bearer [TOKEN]

curl -X POST https://api.geniq.io/rest/v1/token \
  -H 'Authorization: Basic YW55LWtleTpzZWNyZXQ='`

const axios = require('axios');
const key = 'YOUR_API_KEY';
const secret = 'YOUR_API_SECRET';
const basicAuth = Buffer.from(`${key}:${secret}`).toString('base64');

axios.post('https://api.geniq.io/rest/v1/token', {}, {
  headers: { 'Authorization': `Basic ${basicAuth}` }
})
.then(res => console.log(res.data));

import requests
key = "YOUR_API_KEY"
secret = "YOUR_API_SECRET"

response = requests.post(
    'https://api.geniq.io/rest/v1/token',
    auth=(key, secret)
)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
)
func main() {
	req, _ := http.NewRequest("POST", "https://api.geniq.io/rest/v1/token", nil)
	req.SetBasicAuth("YOUR_API_KEY", "YOUR_SECRET")
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl -X POST https://api.geniq.io/rest/v1/sms \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -d "recipient=6591234567" \
  -d "originator=Hello" \
  -d "message=Test message from GENIQ" \
  -d "reference=12345"

const axios = require('axios');
const qs = require('qs');

axios.post('https://api.geniq.io/rest/v1/sms', qs.stringify({
  recipient: '6591234567',
  originator: 'Hello',
  message: 'Test message from GENIQ',
  reference: '12345'
}), {
  headers: { 
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
  }
})
.then(res => console.log(res.data));

import requests
url = 'https://api.geniq.io/rest/v1/sms'
payload = {
    'recipient': '6591234567',
    'originator': 'Hello',
    'message': 'Test message from GENIQ',
    'reference': '12345'
}
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.post(url, data=payload, headers=headers)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
	"net/url"
	"strings"
)
func main() {
	data := url.Values{}
	data.Set("recipient", "6591234567")
	data.Set("originator", "Hello")
	data.Set("message", "Test message from GENIQ")
	data.Set("reference", "12345")

	req, _ := http.NewRequest("POST", "https://api.geniq.io/rest/v1/sms", strings.NewReader(data.Encode()))
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl -X POST https://api.geniq.io/rest/v1/batch_sms \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -d "recipients=6591234567,6581234567" \
  -d "originator=Hello" \
  -d "message=Test batch message from GENIQ" \
  -d "reference=12345"

const axios = require('axios');
const qs = require('qs');

axios.post('https://api.geniq.io/rest/v1/batch_sms', qs.stringify({
  recipients: '6591234567,6581234567',
  originator: 'Hello',
  message: 'Test batch message from GENIQ',
  reference: '12345'
}), {
  headers: { 
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
  }
})
.then(res => console.log(res.data));

import requests
url = 'https://api.geniq.io/rest/v1/batch_sms'
payload = {
    'recipients': '6591234567,6581234567',
    'originator': 'Hello',
    'message': 'Test batch message from GENIQ',
    'reference': '12345'
}
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.post(url, data=payload, headers=headers)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
	"net/url"
	"strings"
)
func main() {
	data := url.Values{}
	data.Set("recipients", "6591234567,6581234567")
	data.Set("originator", "Hello")
	data.Set("message", "Test batch message from GENIQ")
	data.Set("reference", "12345")

	req, _ := http.NewRequest("POST", "https://api.geniq.io/rest/v1/batch_sms", strings.NewReader(data.Encode()))
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl https://api.geniq.io/rest/v1/balance \
  -H 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

axios.get('https://api.geniq.io/rest/v1/balance', {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN' }
})
.then(res => console.log(res.data));

import requests

response = requests.get(
    'https://api.geniq.io/rest/v1/balance',
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
)
func main() {
	req, _ := http.NewRequest("GET", "https://api.geniq.io/rest/v1/balance", nil)
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl -X POST https://api.geniq.io/rest/v1/verify \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -d "recipient=6591234567" \
  -d "originator=Hello" \
  -d "reference=12345" \
  -d "expiry=300"

const axios = require('axios');
const qs = require('qs');

axios.post('https://api.geniq.io/rest/v1/verify', qs.stringify({
  recipient: '6591234567',
  originator: 'Hello',
  reference: '12345',
  expiry: 300
}), {
  headers: { 
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
  }
})
.then(res => console.log(res.data));

import requests
url = 'https://api.geniq.io/rest/v1/verify'
payload = {
    'recipient': '6591234567',
    'originator': 'Hello',
    'reference': '12345',
    'expiry': 300
}
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.post(url, data=payload, headers=headers)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
	"net/url"
	"strings"
)
func main() {
	data := url.Values{}
	data.Set("recipient", "6591234567")
	data.Set("originator", "Hello")
	data.Set("reference", "12345")
	data.Set("expiry", "300")

	req, _ := http.NewRequest("POST", "https://api.geniq.io/rest/v1/verify", strings.NewReader(data.Encode()))
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl -X POST "https://api.geniq.io/rest/v1/verify/otp_session_id?code=123456" \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -d "reference=12345"

const axios = require('axios');
const qs = require('qs');

axios.post('https://api.geniq.io/rest/v1/verify/otp_session_id?code=123456', qs.stringify({
  reference: '12345'
}), {
  headers: { 
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
  }
})
.then(res => console.log(res.data));

import requests
url = 'https://api.geniq.io/rest/v1/verify/otp_session_id?code=123456'
payload = {
    'reference': '12345'
}
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.post(url, data=payload, headers=headers)
print(response.json())

package main
import (
	"fmt"
	"io"
	"net/http"
	"net/url"
	"strings"
)
func main() {
	data := url.Values{}
	data.Set("reference", "12345")

	req, _ := http.NewRequest(
		"POST",
		"https://api.geniq.io/rest/v1/verify/otp_session_id?code=123456",
		strings.NewReader(data.Encode()),
	)
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

curl -X POST https://api.geniq.io/rest/v1/whatsapp/message_templates \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "sample_template",
    "language": "en",
    "category": "MARKETING",
    "header": "Welcome {{1}}",
    "headerFormat": "text",
    "headerExample": ["User"],
    "body": "Nice to meet you. Welcome to GENIQ {{1}}!",
    "bodyExample": ["Ali"],
    "footer": "Thanks"
  }'

curl -X GET "https://api.geniq.io/rest/v1/whatsapp/message_templates\
?limit=5&category=MARKETING" \
  -H 'Authorization: Bearer [TOKEN]'

curl -X DELETE "https://api.geniq.io/rest/v1/whatsapp/message_templates\
?name=sample_template" \
  -H 'Authorization: Bearer [TOKEN]'

curl -X POST https://api.geniq.io/rest/v1/voice \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipient": "6591234567",
    "message": "Hi, this is a test text-to-speech callout from GENIQ. Your verification code is 5 5 2 1.",
    "locale": "en-US",
    "originator": "6531596518",
    "reference": "call_123"
  }'

const axios = require('axios');
axios.post('https://api.geniq.io/rest/v1/voice', {
  recipient: "6591234567",
  message: "Hi, this is a test text-to-speech callout from GENIQ. Your verification code is 5 5 2 1.",
  locale: "en-US",
  originator: "6531596518",
  reference: "call_123"
}, {
  headers: { 'Authorization': 'Bearer [TOKEN]' }
}).then(res => console.log(res.data));

import requests
headers = { 'Authorization': 'Bearer [TOKEN]' }
data = {
    "recipient": "6591234567",
    "message": "Hi, this is a test text-to-speech callout from GENIQ. Your verification code is 5 5 2 1.",
    "locale": "en-US",
    "originator": "6531596518",
    "reference": "call_123"
}
response = requests.post('https://api.geniq.io/rest/v1/voice', json=data, headers=headers)
print(response.json())

package main
import (
	"bytes"
	"encoding/json"
	"net/http"
)
func main() {
	payload := map[string]interface{}{
		"recipient": "6591234567",
		"message": "Hi, this is a test text-to-speech callout from GENIQ. Your verification code is 5 5 2 1.",
		"locale": "en-US",
		"originator": "6531596518",
		"reference": "call_123",
	}
	body, _ := json.Marshal(payload)
	req, _ := http.NewRequest("POST", "https://api.geniq.io/rest/v1/voice", bytes.NewBuffer(body))
	req.Header.Set("Authorization", "Bearer [TOKEN]")
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

curl -X POST https://api.geniq.io/rest/v1/voice \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipient": "6591234567",
    "originator": "6531596518",
    "reference": "survey_1",
    "maxDuration": 30,
    "barge": true,
    "locale": "en-US",
    "menus": [
      {
        "menuId": "main",
        "message": "Press 1 for Support, or press 2 to speak to Sales.",
        "options": [
          { "dtmf": "1", "action": "return", "returnValue": "Support" },
          { "dtmf": "2", "action": "return", "returnValue": "Sales" }
        ]
      }
    ]
  }'

curl -X POST https://api.geniq.io/rest/v1/voice \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipient": "6591234567",
    "originator": "6531596518",
    "reference": "nest_1",
    "maxDuration": 45,
    "barge": true,
    "locale": "en-US",
    "menus": [
      {
        "menuId": "main",
        "message": "Press 1 for Billing, or press 2 for general support menu.",
        "options": [
          { "dtmf": "1", "action": "return", "returnValue": "Billing" },
          { "dtmf": "2", "action": "menus", "targetMenu": "sub_support" }
        ]
      },
      {
        "menuId": "sub_support",
        "message": "Press 1 for technical help, or press 2 to return to main menu.",
        "options": [
          { "dtmf": "1", "action": "return", "returnValue": "TechHelp" },
          { "dtmf": "2", "action": "menus", "targetMenu": "main" }
        ]
      }
    ]
  }'

// Set the "locale" variable inside voice JSON
{
  "recipient": "6591234567",
  "message": "Welcome to GENIQ Technologies",
  "locale": "en-US" // or cmn-CN, ms-MY, etc.
}

POST /your_webhook_endpoint HTTP/1.1
Host: your_domain.com
Content-Type: application/x-www-form-urlencoded

messageId=msg123\
&recipient=88888\
&originator=6591234567\
&message=hello\
&messageTimestamp=2017-01-03T14%3A31%3A28%2B08%3A00

POST /your_webhook_endpoint HTTP/1.1
Host: your_domain.com
Content-Type: application/x-www-form-urlencoded

messageId=msg123\
&channel=sms\
&recipient=6591234567\
&status=delivered\
&reasonCode=0\
&messageTimestamp=2017-01-03T14%3A31%3A28%2B08%3A00\
&operatorTimestamp=2017-01-03T14%3A31%3A00%2B08%3A00

{
  "messageId": "a662179e-ba00-492f-a0b7-06b3fa002502",
  "type": "text",
  "originator": "6588880000",
  "originatorName": "Mark Gold",
  "recipient": "6598989898",
  "body": "Hi, this is a test message",
  "messageTimestamp": "2025-02-20T14:45:42+08:00"
}

{
  "messageId": "45fd72c3-3495-4313-ba5d-be2d0acff3ca",
  "type": "image",
  "originator": "6588880000",
  "originatorName": "Mark Gold",
  "recipient": "6598989898",
  "url": "https://geniq.io/media/callback.jpg",
  "messageTimestamp": "2025-02-20T14:57:43+08:00"
}

{
  "messageId": "0c5b63cf-b41e-449c-a077-9124de0b87dc",
  "recipient": "6588880000",
  "status": "delivered",
  "reasonCode": "0",
  "channel": "whatsapp",
  "messageTimestamp": "2025-02-20T15:23:56+08:00",
  "providerTimestamp": "2025-02-20T15:23:55+08:00"
}

// SMPP v3.4 binds can be initiated via TCP socket to smpp.geniq.io:2775.
// IP authentication is required prior to binding.
// Ensure transmitter or transceiver bind requests contain system_id and password.
// Periodic enquire_link PDUs must be sent every 30 seconds to avoid connection drop.