TopMessage API-dokumentation | Skicka meddelanden

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:

Skicka ett enda SMS-meddelande – perfekt för direkt, en-till-en-kommunikation som varningar eller bekräftelser.

Fullständiga förfrågningsparametrar

Namn	Slag	Beskrivning
data	`object`	Innehåller meddelandeinformation.

Data Object

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 TopMessage
to	`string[]`	Mottagarens mobiltelefonnummer i internationellt format. 46701123456
text	`string`	Ditt textmeddelande ska skickas till mottagaren/mottagarna. Hej! Testar den här coola SMS-funktionen. https://topmessage.se

Fullständiga svarsparametrar

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

Namn	Slag	Beskrivning
data	`object`	Innehåller meddelandeinformation.

Data Object

Namn	Slag	Beskrivning
id	`string`	Unik identifierare för ditt meddelande.
account_id	`string`	Unik identifierare för ditt konto.
status	`string`	Initial status för ditt meddelande. Möjliga värden: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
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`
segment_count	`integer`	Antalet segment ditt meddelande bestod av.
encoding	`string`	Kodning av ditt meddelande. Möjliga värden: `STANDARD` och `UNICODE`
direction	`string`	Anger meddelandeflödet – om det skickades av ditt system eller mottogs från en användare. Möjliga värden: `OUTBOUND`, `INBOUND`
country	`string`	Anger mottagarens land för utgående meddelanden och avsändarens land för inkommande meddelanden. Värdet anges i ISO 3166-1 alpha-2-format.
type	`string`	Anger vilken typ av meddelandeinnehåll som skickas eller tas emot. Hjälper till att identifiera om det är vanlig text, mallbaserat eller meddelande med media (t.ex. bilder eller videor), inklusive interaktivt innehåll för WhatsApp.
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
create_date	`string`	Tidpunkt då meddelandet initierades
update_date	`string`	Senaste statusuppdateringsdatum för ditt meddelande.

POST

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

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

Begär prov

Payload

cURL

Java

Python

PHP

Node.js

{
    "data": {
        "from": "TopMessage",
        "to": [
            "46701123456"
        ],
        "text": "Hej! Testar den här coola SMS-funktionen. https://topmessage.se"
    }
}

Svarsprov

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "46701123456",
            "text": "Hej! Testar den här coola SMS-funktionen. https://topmessage.se",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "SE",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}