SMS GET · SMS · 1SPOC API Reference

infoOverview

About this API

SMS GET

MethodGET

Versionv1.0

Base URLhttps://api.example.com/sms

Content TypeNo request body

keySecurity

Authentication

This endpoint does not require authentication.

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

msgstringNot specifiedRequest value for msg.

deststringNot specifiedRequest value for dest.

typestringNot specifiedRequest value for type.

headerstringNot specifiedRequest value for header.

versionstringNot specifiedRequest value for version.

accesskeystringNot specifiedRequest value for accesskey.

dlt_entity_idstringNot specifiedRequest value for dlt entity id.

dlt_template_idstringNot specifiedRequest value for dlt template id.

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request GET 'https://api.example.com/sms/genericapi/QSGenericReceiver'

const response = await fetch('https://api.example.com/sms/genericapi/QSGenericReceiver', {
  method: 'GET',
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://api.example.com/sms/genericapi/QSGenericReceiver', {
  method: 'GET',
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://api.example.com/sms/genericapi/QSGenericReceiver'
headers = {}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://api.example.com/sms/genericapi/QSGenericReceiver"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.example.com/sms/genericapi/QSGenericReceiver',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
var response = await client.GetAsync("https://api.example.com/sms/genericapi/QSGenericReceiver");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://api.example.com/sms/genericapi/QSGenericReceiver", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}

{}

ruleHTTP Responses

Status Codes

200Successful response