Transaksjonelle massemeldinger – spesifikasjon

API-URL

URL som brukes til å sende HTTP-forespørsler:

https://portal.bulkgate.com/api/1.0/integration/transactional-bulk

Merk

Hvis forespørselen ikke kommer frem, gjentar du den på reserveserveren backup1.bulkgate.com.

POST /api/1.0/integration/transactional-bulk HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Vær oppmerksom

Det er strengt forbudt å bruke transaksjons-SMS til promotering eller markedsføring. De skal kun brukes til varsling – som SMS-varsler.

Merk

Hvis du vil bruke en transaksjonsrute til å sende varsler som massemeldinger, kontakter du kundestøtten vår. Vi kan tillate dette når det er god grunn til det.

Advarsel

Mottakere som har meldt seg av, vil motta meldingen (avmelding gjelder bare markedsføringsmeldinger).

Parametertabell

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
application_id	Application ID	Ja	-
application_token	Applikasjonens autentiseringstoken	Ja	-
tag	Personlig identifikasjonsetikett	Nei	-
messages	Matrise med meldinger	Ja	Meldingsobjekt

Meldingsobjekt

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
primary_channel	Den primære kanalen som brukes først i kaskaden	Nei	`sms`
phone_number	Mottakerens telefonnummer	Ja	-
country	Oppgi mottakernumrene i internasjonalt format (med landsprefiks, f.eks. `420`), eller legg til landskode (`775123456` + `CZ` = `420775123456`). Se et eksempel på kravene for et land. Hvis verdien er `null`, brukes tidssonen du har angitt, til å fullføre informasjonen	Nei	`null`
schedule	Planlegg dato og klokkeslett for sendingen i Unix-tidsstempel. Se eksemplene nedenfor.	Nei	`null`
channels	Assosiativ matrise med kanalobjekter	Ja	Kanalobjekt

Viber-kanalobjekt

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
sender	Avsendernavn	Nei	-
expiration	Tid før meldingen utløper	Nei	`3600`
text	Meldingstekst. Du kan legge til variabler i malen fra matrisen `variables` (en annen parameter) `Hello <first_name> <last_name> ....`	Ja	-
variables	Assosiativ matrise for å legge variabler til i teksten, f.eks. `{"first_name": "John", "last_name": "Doe"}`	Nei	`[]`

SMS-kanalobjekt

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
sender_id	Avsender-ID, se Avsender-ID-type	Nei	`gSystem`
sender_id_value	Avsenderverdi - `gOwn` (f.eks. «420 777 777 777»), `gText` (f.eks. «BulkGate»), `gProfile` (f.eks. «423»), `gMobile` eller `gPush` (KEY)	Nei	`''`
unicode	`Yes`/`true`/`1` for Unicode-SMS, `no`/`false`/`0` for 7-bits SMS	Nei	`false`
text	SMS-tekst (maks. 612 tegn, eller 268 tegn hvis Unicode er aktivert), UTF-8-koding. Du kan legge til variabler i malen fra matrisen `variables` (en ekstra parameter) `Hello <first_name> <last_name> ....`	Ja	-
variables	Assosiativ matrise for å legge variabler til i teksten, f.eks.: `{"first_name": "John", "last_name": "Doe"}`	Nei	`[]`

Avsender-ID-type `sender_id`

VERDI	BESKRIVELSE
`gSystem`	Systemnummer
`gShort`	Kortnummer (short code)
`gText`	Tekstavsender
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push - sender et varsel til Mobile Connect-appen din
`gOwn`	Eget nummer (krever bekreftelse av nummeret)
`gProfile`	ID for avsenderprofil
`<int>`	ID for avsenderprofil

Eksempel på en fullstendig forespørsel:

POST /api/1.0/integration/transactional-bulk HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "tag": "", "messages": [ { "primary_channel": "sms", "phone_number": "420777777777", "country": "cz", "schedule": 1683101313, "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "text": "test <variable_1>", "variables": { "variable_1": "name" } }, "sms": { "sender_id": "gSystem", "sender_id_value": "BulkGate", "unicode": false, "text": "test <variable_1>", "variables": { "variable_1": "name" } } } }, { "primary_channel": "sms", "phone_number": "420777777778", "country": "cz", "schedule": 1683101313, "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "text": "test <variable_1>", "variables": { "variable_1": "name" } }, "sms": { "sender_id": "gSystem", "sender_id_value": "BulkGate", "unicode": false, "text": "test <variable_1>", "variables": { "variable_1": "name" } } } } ] }

Svaret på denne kommandoen kan være:

Ved suksess

{ "data": { "total": { "status": { "sent": 0, "accepted": 0, "scheduled": 2, "error": 0, "blacklisted": 0, "invalid_number": 0, "invalid_sender": 0 } }, "response": [ { "status": "scheduled", "message_id": "#############-0", "part_id": [ "#############-0" ], "number": "420777777777", "channel": "sms" }, { "status": "scheduled", "message_id": "#############-1", "part_id": [ "#############-1" ], "number": "420777777778", "channel": "sms" } ] } }

Ved feil:

{ "data": { "total": { "status": { "sent": 0, "accepted": 0, "scheduled": 0, "error": 0, "blacklisted": 0, "invalid_number": 0, "invalid_sender": 0 } }, "response": [] } }

{ "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null }

Der:

type og error (beskrivelse av feilen) finner du i tabellen over feiltyper
code er HTTP-feilkoden
detail er tilleggsinformasjon om feilen

Alle feiltyper for Simple API og Advanced API finner du her.

Var denne siden nyttig?

Spør AI Kopiert