View a status
Retrieves the information of an existing message. This message can be a sent or a received message. You only need to supply the unique message id that was returned upon creation or receiving.
PARAMETERS
| Parameter |
Type |
Description |
| id |
int |
An unique random ID which is created on the BSG.
platform and is returned upon creation of the object. Required |
| reference |
string |
A client reference. Required |
| task_id |
int |
An unique random ID which is created for multiple request. Required |
ATTRIBUTES
| Attribute |
Type |
Description |
| id |
int |
An unique random ID which is created on the BSG platform and is returned upon creation of the object. |
| msisdn |
string |
The telephone number. |
| reference |
string |
A client reference. |
| validity |
int |
The amount of seconds that the message is valid. |
| time_in |
datetime |
The date and time of the creation of the message . |
| time_sent |
datetime |
The scheduled date and time of the message. |
| time_dr |
datetime |
The date and time of the creation of the message. |
| status |
string |
The date and time of the last status of the message.
Possible values: scheduled, sent, delivered, expired, undeliverable, rejected, unknown. |
REQUEST MESSAGE STATUS BY ID
DEFINITION
GET https://app.bsg.hk/rest/sms/{id}
EXAMPLE RESPONSE
{
"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"
}
REQUEST MESSAGE STATUS BY REFERENCE
DEFINITION
GET https://app.bsg.hk/rest/sms/{reference}
EXAMPLE RESPONSE
{
"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"
}
EXAMPLE ERROR RESPONSE FOR MESSAGE STATUS
{
"error": 20,
"errorDescription":"SMS not found"
}
REQUEST TASK INFO BY TASK_ID
DEFINITION
GET https://app.bsg.hk/rest/sms/task/{task_id}
EXAMPLE RESPONSE
{
"originator":"alpha_name",
"body":"message text",
"validity":72,
"totalprice":0.23,
"currency":"EUR",
"sent":1,
"delivered":1,
"expired":0,
"undeliverable":0,
"unknown":0
}
EXAMPLE ERROR RESPONSE FOR TASK INFO
{
"error": 30,
"errorDescription":"Task not found"
}
