TopMessage API-documentatie |Statuscodes

API

Beveiliging

Bij het instellen van webhook-eindpunten kunt u uw applicatie beveiligen tegen ongewenste verzoeken door webhook-geheim te configureren. Elke verzoekhandtekening wordt gemaakt met behulp van het HMAC_SHA256 hash-algoritme. Het algoritme ondertekent de webhook-payload met het geheim dat u heeft opgegeven. De resulterende hash wordt opgenomen in de handtekeningheader van het verzoek in de volgende indeling:

X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}

Beheer uw webhookeindpunten

hier

Ontvang een leveringsrapport

Het afleveringsrapport van uitgaande berichten wordt naar uw webhookeindpunt verzonden, waarin wordt aangegeven of elk bericht is afgeleverd of mislukt.

Naam	Vriendelijk	Beschrijving
data	`object`	Bevat de onderstaande details van het bericht dat wordt verzonden.

GegevensObject

Naam	Vriendelijk	Beschrijving
id	`string`	Unieke identificatie van uw bericht.
status	`string`	Initiële status van uw bericht. Mogelijke waarden: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Het communicatiekanaal stuurt uw boodschap door. Mogelijke waarden: `SMS` En `WHATSAPP` Standaard: `SMS`

Ontvang een inkomend bericht

Inkomende berichten die op uw SMS- of WhatsApp-telefoonnummer worden ontvangen, worden in realtime doorgestuurd naar het opgegeven webhook-eindpunt.

Naam	Vriendelijk	Beschrijving
data	`object`	Bevat de onderstaande details van het bericht dat wordt verzonden.

GegevensObject

Naam	Vriendelijk	Beschrijving
account_id	`string`	Unieke identificatie van uw account.
from	`string`	Het mobiele telefoonnummer(s) van de afzender in internationaal formaat.
sender_code	`string`	Uw TopMessage SMS- of WhatsApp-telefoonnummer.
text	`string`	Uw sms-bericht dat naar de ontvanger(s) wordt verzonden.
channel	`string`	Het communicatiekanaal stuurt uw boodschap door. Mogelijke waarden: `SMS` En `WHATSAPP` Standaard: `SMS`
to	`string`	Je TopMessage-afzendernaam voor SMS of WhatsApp. Je kunt de beschikbare namen bekijken of een nieuwe aanmaken op de afzenderspagina.Ga naar de afzenderspagina.
request_id	`string`	Unieke identificatie van het verzoek dat door u wordt gegenereerd om verzoeken te traceren. Standaard: NULL

POST

https://{yourDomain}/your/webhook/path

X-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/json

Monster aanvragen (afleverrapport)

Payload

Java

Python

{
    "data":
        {
            "id":"b04fc4d3-f232-46b7-b66b-538c0d4b3404",
            "channel":"SMS",
            "status":"DELIVERED"
        }
    }

public class TopMessageDeliveryReport {
    private String id;
    private String requestId;
    private String channel;
    private String status;
}

class TopMessageDeliveryReport:
    id: str
    request_id: str
    channel: str
    status: str

Monster aanvragen (binnenkomend bericht)

Payload

Java

Python

{
    "data": {
        "id":"e3fc3b55-807f-41cf-93cf-cd365fef8515",
        "channel":"WHATSAPP",
        "account_id":"0d1f7f1c-27df-41bf-8bdc-5666608a4285",
        "sender_details":
        {
            "sender_id":"476c7381-ca60-4e98-9657-a4af98ec032b",
            "sender_name":"TopMessage",
            "sender_code":"19134216816"},
            "Number":"491511234567",
            "text":"Received"
        }
    }
}

public class TopMessageIncomingMessage {
    private String id;
    private String channel;
    private String accountId;
    private SenderDetails senderDetails;
    private String number;
    private String referenceMessageId;
    private String text;
    private String mediaId;
    private Location location;

    public static class SenderDetails {
        private String id;
        private String name;
        private String code;
    }

    public static class Location {
        private String name;
        private String address;
        private String latitude;
        private String longitude;
    }
}

class SenderDetails:
    id: str
    name: str
    code: str

class Location:
    name: str
    address: str
    latitude: str
    longitude: str

class TopMessageIncomingMessage:
    id: str
    channel: str
    account_id: str
    sender_details: SenderDetails
    number: str
    reference_message_id: str
    text: str
    media_id: str
    location: Location

Webhaken