API

Get Message

Hämta detaljer för både inkommande och utgående meddelanden och verifiera autentiseringskoder som skickas till dina kunder. Få tillgång till en lista över alla meddelanden eller hitta information om ett specifikt meddelande med det unika meddelande-ID som angavs när det skapades eller togs emot.

Användningsexempel

Hämta lista över meddelanden
Hämta ett specifikt meddelande
Verifiera koden

Användarverifieringen lyckades om rubriken X-Total-Count har fått värde 1 eller om dataobjektlistan som svar inte är tom.

Fullständiga förfrågningsparametrar

Inga förfrågningsparametrar krävs.

Fullständiga svarsparametrar

Svarsparametrar

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

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

DataObject

Namn	Slag	Beskrivning
account_id	`string`	Unik identifierare för ditt konto.
id	`string`	Unik identifierare för ditt meddelande.
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.
status	`string`	Initial status för ditt meddelande. Möjliga värden: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Kommunikationskanalen skickar ditt budskap igenom. Möjliga värden: `SMS` och `WHATSAPP` Standard: `SMS`
text	`string`	Ditt textmeddelande ska skickas till mottagaren/mottagarna.
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
segment_count	`integer`	Antalet segment ditt meddelande bestod av.
encoding	`string`	Kodning av ditt meddelande. Möjliga värden: `STANDARD` och `UNICODE`
country	`string`	Destinationsland för din meddelandemottagare.
direction	`string`	Anger om meddelandet tas emot av ditt system eller skickas från ditt system till mottagaren. Möjliga värden: `OUTBOUND`, `INBOUND`
type	`string`	Bestämmer strukturen för meddelandeinnehållet. Möjliga värden: `TEXT`, `TEMPLATE`
create_date	`string`	Tidpunkt då meddelandet initierades
update_date	`string`	Senaste statusuppdateringsdatum för ditt meddelande.
code	`string`	Användaren tillhandahållen kod, 4-6 siffror
expired	`boolean`	Indikerar om koden har gått ut. Möjliga värden: `TRUE`, `FALSE` Standard: `FALSE`

Hämta lista över meddelanden

GET

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

Hämta ett specifikt meddelande

GET

https://api.topmessage.se/v1/messages/{Id}

Verifiera koden

GET

https://api.topmessage.se/v1/messages?to={receipnet_number}&code={code}&expired=false

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

Svarsprov

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}