For the best experience turn off the battery saving mode.

Documentația REST API a serviciului BSG

Integrați capabilitățile serviciului de expediere al BSG într-un proiect personal.
API este destinat dezvoltatorilor și este însoțit de o documentație detaliată.

Trimiteți mesajul

Creează un nou obiect de mesaj. BSG trimite ID-urile mesajelor trimise după fiecare solicitare trimisă. La fiecare solicitare se procesează maximum 50 de numere.

PARAMETRI OBLIGATORII

Parametri
Tip
Descriere
destination
type: string

The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters. Required

body
type: string

The body of the SMS message. Required

msisdn
type: string

The telephone number. Required

reference
type: string

A client reference. Required

phones
type: array

The array of recipients msisdn’s & reference’s. Required Set only for multiple message request („destination”: „phones”).

PARAMETRI SUPLIMENTARI

Parametri
Tip
Descrire
validity
type: int

The amount of seconds that the message is valid.

tariff
type: int

Tariff code of a price grid.

SEMNIFICAȚII

PUT (POST) https://app.bsg.hk/rest/sms/create

REVINE

Returnează un obiect de mesaj dacă cererea a avut succes. Dacă cererea a eșuat, un obiect de eroare va fi returnat.

EXEMPLU DE SOLICITARE (MESAJ MONOCOMPONENT)

{ „destination”:”phone”,
„originator”:”alpha name”,
„body”:”message text”,
„msisdn”:”380972000000″,
„reference”:”ext_id_16″,
„validity”:”1″,
„tariff”:”0″
}

EXEMPLU DE RĂSPUNS (MESAJ MONOCOMPONENT)

{ „result”:{
„error”:0,
„errorDescription”:”No errors”,
„reference”:”ext_id_16″,
„id”:”213″,
„price”:0.23,
„currency”:”EUR”
}
}

EXEMPLU DE SOLICITARE (MESAJ MULTIPARTIER)

{ „validity”:”1″,
„tariff”:”0″,
„destination”:”phones”,
„originator”:”alpha_name”,
„body”:”message text”,
„phones”:[
{
„msisdn”:”380972000000″,
„reference”:”ext_id_17″
},
{
„msisdn”:”380972000001″,
„reference”:”ext_id_18″
}
]
}

ATRIBUTE

Attribute
Tip
Descrire
task_id
type: int

An unique random ID which is created for multiple request.

EXEMPLU DE SOLICITARE (MESAJ MULTIPARTIER)

{ „task_id”:”6″,
„result”:[
{
„error”:0,
„errorDescription”:”No errors”,
„reference”:”ext_id_17″,
„id”:”214″,
„price”:0.23,
„currency”:”EUR”
},
{
„error”:0,
„errorDescription”:”No errors”,
„reference”:”ext_id_18″,
„id”:”215″,
„price”:0.23,
„currency”:”EUR”
}
],
„total_price”:0.46,
„currency”:”EUR”
}