API

Autentisering

När du gör API-förfrågningar måste du inkludera din API-nyckel i HTTP-huvudet. Rubrikformatet ska se ut så här:

X-TopMessage-Key: {API_KEY}

Hantera dina API-nycklar

här

Skicka meddelanden

Skicka enkelt ett eller flera meddelanden till dina kunder via deras föredragna kanaler, som SMS och WhatsApp, med ett enda, enhetligt API. Börja med ett enkelt textmeddelande genom att definiera destination och innehåll, eller använd avancerade funktioner för att förbättra din kommunikationsstrategi.

Användningsexempel

Följande är några exempel på användningsfall för TopMessage API:

Enkelt SMS
Personligt SMS
SMS med förkorta länk
SMS-verifiering
SMS med mall
WhatsApp med mall
WhatsApp i fritt format
Schemalagt meddelande
Massmeddelanden

Fullständiga förfrågningsparametrar

Namn	Slag	Beskrivning
data	`object`	Innehåller nedanstående information om meddelandet som skickas.

DataObject

Namn	Slag	Beskrivning
from	`string`	Visningsnamn som ditt meddelande kommer att skickas från. Du kan se tillgängliga namn eller skapa ett nytt på avsändarsidan.Gå till avsändarsidan.
to	`string[]`	Mottagarens mobiltelefonnummer i internationellt format.
text	`string`	Ditt textmeddelande ska skickas till mottagaren/mottagarna.
channel	`string`	Kommunikationskanalen skickar ditt budskap igenom. Möjliga värden: `SMS` och `WHATSAPP` Standard: `SMS`
template_id	`string`	Unik identifierare för din skickade mall. Du kan se tillgängliga mallar eller skapa en ny från mall-sidan i ditt konto.Gå till mallsidan.
parameters	`string[]`	Dessa värden används för att ersätta platshållarna i din meddelandemall, så att du kan anpassa meddelandet för varje mottagare. Standard: Tömma
shorten_URLs	`boolean`	Anger om HTTPS URL:er i texten ska ersättas med förkortade URL:er. Möjliga värden: `TRUE` och `FALSE` Standard: `FALSE`
request_id	`string`	Unik identifierare för begäran som genererats av dig för att spåra förfrågningar. Standard: `NULL`
schedule	`string`	Anger den tidpunkt när meddelandet ska skickas. Tiden måste vara i UTC och följa ISO-8601-formatet ("2024-12-01T18:00:00Z"). Den schemalagda tiden får inte ställas in mer än 1 år i förväg. Standard: Nu

Fullständiga svarsparametrar

Svarsparametrar

Svaret inkluderar alla parametrar från begäran, tillsammans med de ytterligare parametrarna som anges nedan.

DataObject

Namn	Slag	Beskrivning
account_id	`string`	Unik identifierare för ditt konto.
id	`string`	Unik identifierare för ditt meddelande.
status	`string`	Initial status för ditt meddelande. Möjliga värden: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
create_date	`string`	Tidpunkt då meddelandet initierades
update_date	`string`	Senaste statusuppdateringsdatum för ditt meddelande.
segment_count	`integer`	Antalet segment ditt meddelande bestod av.
encoding	`string`	Kodning av ditt meddelande. Möjliga värden: `STANDARD` och `UNICODE`

POST

https://api.topmessage.se/v1/messages

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Begär prov

Payload

cURL

Java

Python

{
    "data": {
        "from": "TopMessage",
        "to": [
            "48727516980",
            "48727516981"
        ],
        "parameters": {
            "48727516980": ["John"],
            "48727516981": ["Ann"]
        },
        "text": "Hi {first_name}! Just testing out this cool SMS feature.https://topmessage.com",
        "shorten_URLs": true,
        "request_id": "9190cda0-70d8-4127-ac8f-787c083efa1b",
        "schedule": "2024-12-01T00:00:01Z"
    }
}

curl -X POST "https://api.topmessage.com/v1/messages" -H "Content-Type: application/json" -H "X-TopMessage-Key: {API_KEY}" -d '{
    "data": {
        "from": "TopMessage",
        "to": [
            "48727516980",
            "48727516981"
        ],
        "parameters": {
            "48727516980": ["John"],
            "48727516981": ["Ann"]
        },
        "text": "Hi {first_name}! Just testing out this cool SMS feature.https://topmessage.com",
        "request_id": "9190cda0-70d8-4127-ac8f-787c083efa1b",
        "shorten_URLs": true,
        "schedule": "2024-12-01T00:00:01Z"
     }
  }'

String response = HttpClient.newHttpClient().send(
    HttpRequest.newBuilder()
        .uri(URI.create("https://api.topmessage.com/v1/messages"))
        .header("Content-Type", "application/json")
        .header("X-TopMessage-Key", "{API_KEY}")
        .POST(HttpRequest.BodyPublishers.ofString("""
            {
                "data": {
                    "from": "TopMessage",
                    "to": [
                        "48727516980",
                        "48727516981"
                    ],
                    "parameters": {
                        "48727516980": ["John"],
                        "48727516981": ["Ann"]
                    },
                    "text": "Hi {first_name}! Just testing out this cool SMS feature. https://topmessage.com",
                    "request_id": "9190cda0-70d8-4127-ac8f-787c083efa1b",
                    "shorten_URLs": true,
                    "schedule": "2024-12-01T00:00:01Z"
                }
            }
            """))
        .build(),
    HttpResponse.BodyHandlers.ofString()
).body();

response = requests.post(
    "https://api.topmessage.com/v1/messages",
    headers={
        "Content-Type": "application/json",
        "X-TopMessage-Key": "{API_KEY}"
    },
    json={
       "data": {
            "from": "TopMessage",
            "to": ["48727516980", "48727516981"],
            "parameters": {
                "48727516980": ["John"],
                "48727516981": ["Ann"]
            },
            "text": "Hi {first_name}! Just testing out this cool SMS feature.https://topmessage.com",
            "request_id": "9190cda0-70d8-4127-ac8f-787c083efa1b",
            "shorten_URLs": true,
            "schedule": "2024-12-01T00:00:01Z"
        }
    }
)

Svarsprov

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "template_id": "7c3f35bc-491e-4580-a8b8-602efae1ccd1",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "48727516980",
            "text": "Hi {first_name}! Just testing out this cool SMS feature. https://topmessage.com",
            "parameters": [
                "John"
            ],
            "channel": "SMS",
            "segment_count": 1,
            "encoding": "STANDARD",
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T06:58:22Z",
            "update_date": "2024-11-25T06:58:22Z"
        },
        {
            "id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "template_id": "7c3f35bc-491e-4580-a8b8-602efae1ccd1",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "48727516981",
            "text": "Hi {first_name}! Just testing out this cool SMS feature.",
            "parameters": [
                "Ann"
            ],
            "channel": "SMS",
            "segment_count": 1,
            "encoding": "STANDARD",
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T06:58:22Z",
            "update_date": "2024-11-25T06:58:22Z"
        }
    ]
}