TopMessage API-dokumentation | Hämta meddelanden och verifiera koder

Hämta meddelande

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

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

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

Få detaljerad information om alla dina skickade meddelanden för att övervaka leverans, spåra prestanda och optimera din meddelandestrategi.

Fullständiga förfrågningsparametrar

Inga förfrågningsparametrar krävs.

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.
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.

GET

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

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

Svarsprov

'X-Total-Count': 1

{
    "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"
        },
        {
            "id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "46701123457",
            "text": "Testar bara snabbt den här SMS-funktionen.",
            "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"
        }
    ]
}