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. |
| reference |
string |
A client reference |
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. |
| 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, read, expired, undeliverable, rejected, unknown. |
REQUEST MESSAGE STATUS BY ID
DEFINITION
GET https://app.bsg.hk/rest/viber/{id}
EXAMPLE RESPONSE
{
"error":0,
"errorDescription":"No errors",
"id":"380972920000",
"msisdn":"380972920000",
"reference":"ext_id_19",
"time_in":"2017-01-17 09:20:02",
"time_sent":"2017-01-17 09:20:02",
"time_dr":"2017-01-17 09:20:02",
"status":"read",
"price":0.23,
"currency":"EUR"
}
REQUEST MESSAGE STATUS BY REFERENCE
DEFINITION
GET https://app.bsg.hk/rest/viber/{reference}
EXAMPLE RESPONSE
{
"error":0,
"errorDescription":"No errors",
"id":"380972920000",
"msisdn":"380972920000",
"reference":"ext_id_19",
"time_in":"2017-01-17 09:20:02",
"time_sent":"2017-01-17 09:20:02",
"time_dr":"2017-01-17 09:20:02",
"status":"read",
"price":0.23,
"currency":"EUR"
}
IN ERROR CASE
{
"error": 40,
"errorDescription":"Message not found"
}
