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ă.
Vizualizați o stare
Preluează informațiile unui mesaj existent. Acest mesaj poate fi un mesaj trimis sau primit. Trebuie doar să furnizați ID-ul mesajului unic care a fost returnat la crearea sau primirea.
PARAMETRI
An unique random ID which is created on the BSG. platform and is returned upon creation of the object. Required
A client reference. Required
An unique random ID which is created for multiple request. Required
ATRIBUȚII
An unique random ID which is created on the BSG platform and is returned upon creation of the object.
The telephone number.
A client reference.
The amount of seconds that the message is valid.
The date and time of the creation of the message .
The scheduled date and time of the message.
The date and time of the creation of the message.
The date and time of the last status of the message. Possible values: scheduled, sent, delivered, expired, undeliverable, rejected, unknown.
SOLICITAȚI STATUTUL MESAJULUI PRIN ID
DEFINITION
GET https://app.bsg.hk/rest/sms/{id}
EXEMPLU DE RĂSPUNS
{ „error”:0,
„errorDescription”:”No errors”,
„id”:”211″,
„msisdn”:”380972000001″,
„reference”:”ext_id_19″,
„time_in”:”2017-01-17 09:11:41″,
„time_sent”:”2017-01-17 09:11:41″,
„time_dr”:”2017-01-17 09:11:41″,
„status”:”delivered”,
„price”:0.23,
„currency”:”EUR”
}
SOLICITAȚI STATUTUL MESAJULUI DE REFERINȚĂ
DEFINITION
GET https://app.bsg.hk/rest/sms/{reference}
EXEMPLU DE RĂSPUNS
{ „error”:0,
„errorDescription”:”No errors”,
„id”:”211″,
„msisdn”:”380972000001″,
„reference”:”ext_id_19″,
„time_in”:”2017-01-17 09:11:41″,
„time_sent”:”2017-01-17 09:11:41″,
„time_dr”:”2017-01-17 09:11:41″,
„status”:”delivered”,
„price”:0.23,
„currency”:”EUR”
}
EXEMPLU DE RĂSPUNS DE EROARE PENTRU STAREA MESAJULUI
{ „error”: 20,
„errorDescription”:”SMS not found”
}
CERIȚI INFORMAȚII PRIVIND TASCURILE PRIN TASK_ID
DEFINITION
GET https://app.bsg.hk/rest/sms/task/{task_id}
EXEMPLU DE RĂSPUNS
{ „originator”:”alpha_name”,
„body”:”message text”,
„validity”:72,
„totalprice”:0.23,
„currency”:”EUR”,
„sent”:1,
„delivered”:1,
„expired”:0,
„undeliverable”:0,
„unknown”:0
}
EXEMPLU DE RĂSPUNS DE EROARE PENTRU INFORMAȚII DE SARCINĂ
{ „error”: 30,
„errorDescription”:”Task not found”
}