Transaksjons-SMS – spesifikasjon (Advanced API 1.0)

Vær oppmerksom

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

API-URL

URL for sending av HTTP-forespørsler:

https://portal.bulkgate.com/api/1.0/advanced/transactional

Merk

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

Støttede HTTP-metoder

POST - application/json

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

Parametertabell

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
application_id	Applikasjons-ID	Ja	-
application_token	Applikasjonstoken	Ja	-
number	Mottakerens nummer	Ja eller `admin`	-
admin	Nummeret til BulkGate-administratoren som mottar varselet. Mer informasjon	Ja eller `number`	-
text	Teksten i SMS-meldingen (maks. 612 tegn, eller 268 tegn hvis Unicode er aktivert), UTF-8-koding. Du kan legge til variabler i malen fra matrisen `variables` (en annen parameter) `Hei <first_name> <last_name> ....`	Ja	-
variables	Assosiativ matrise for å legge variabler til i teksten, f.eks.: `{"first_name": "Ola", "last_name": "Nordmann"}`	Nei	`[]`
unicode	`Yes`/`true`/`1` for Unicode-SMS, `no`/`false`/`0` for 7-bits SMS	Nei	`false`
sender_id	Avsender-ID, se Avsendertype	Nei	`gSystem`
sender_id_value	Avsenderverdi – `gOwn` (f.eks. «420 777 777 777»), `gText` (f.eks. «BulkGate»), `gProfile` (f.eks. «423»), `gMobile` eller `gPush` (NØKKEL)	Nei	`null`
country	Oppgi mottakernumrene i internasjonalt format (med landsprefiks, f.eks. `420`), eller legg til landskode (`777777777` + `CZ` = `420777777777`). Se eksempelet med krav om land. Hvis verdien er `null`, brukes tidssonen du har angitt, til å fylle ut informasjonen	Nei	`null`
schedule	Planlegg dato og klokkeslett for sendingen i Unix-tidsstempel eller ISO 8601.	Nei	Nå
duplicates_check	Velg `on` for å hindre at duplikatmeldinger sendes til samme telefonnummer. Meldinger med samme tekst sendt til samme nummer fjernes hvis tidsintervallet mellom dem er kortere enn 5 minutter. Med `off` fjernes ingen duplikater.	Nei	`off`
tag	Meldingsetikett som brukeren senere kan hente meldingene etter.	Nei	-

Avsendertype `sender_id`

VERDI	BETYDNING
`gSystem`	Systemnummer
`gShort`	Kortnummer (Short Code)
`gText`	Tekstavsender
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push – sender et varsel til Mobile Connect-appen
`gOwn`	Eget nummer (krever bekreftelse av nummeret)
`gProfile`	BulkGate-profil-ID
`<int>`	BulkGate-profil-ID

Eksempel på forespørsel

POST /api/1.0/advanced/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777", "unicode": true, "text": "Hei, <first_name> <last_name>", "variables": {"first_name": "Ola", "last_name": "Nordmann"}, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "cz", "schedule": "2018-05-14T18:30:00-01:00" }

Svar

Ved suksess:

{ "data": { "status": "accepted", "sms_id": "tmpde1bcd4b1d1", "part_id": [ "tmpde1bcd4b1d1_1", "tmpde1bcd4b1d1" ], "number": "420777777777" } }

Der:

part_ID er en matrise med ID-ene til delene av den opprinnelige lange meldingen, som ble delt opp fordi den overskred grensen på 160 tegn for én melding. Mer informasjon her.

Ved feil:

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "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

Se alle feiltyper for Simple API og Advanced API her.

Var denne siden nyttig?

Spør AI Kopiert