Для найкращого досвіду вимкніть режим економії заряду.

Ласкаво просимо в розділ документації для розробників BSG.

Якщо ви хочете використовувати наші REST API, отримувати повідомлення від перехоплювачів або створити додаток для Intercom Messenger, ви опинилися в потрібному місці.

Перегляд статусу

Отримує інформацію про існуючий повідомленні. Це повідомлення може бути відправленим або отриманим. Вам потрібно лише вказати унікальний ідентифікатор повідомлення, який був повернутий при створенні або отриманні.

Параметри

Parameter
Type
Description
id
type: int

An unique random ID which is created on the BSG. platform and is returned upon creation of the object. Required

reference
type: string

A client reference. Required

task_id
type: int

An unique random ID which is created for multiple request. Required

Атрибути

Attribute
Type
Description
id
type: int

An unique random ID which is created on the BSG platform and is returned upon creation of the object.

msisdn
type: string

The telephone number.

reference
type: string

A client reference.

validity
type: int

The amount of seconds that the message is valid.

time_in
type: datetime

The date and time of the creation of the message .

time_sent
type: datetime

The scheduled date and time of the message.

time_dr
type: datetime

The date and time of the creation of the message.

status
type: string

The date and time of the last status of the message. Possible values: scheduledsentdeliveredexpiredundeliverablerejectedunknown.

ЗАПИТ СТАТУСУ ПОВІДОМЛЕННЯ ЧЕРЕЗ ID

ЗНАЧЕННЯ

GET https://app.bsg.hk/rest/sms/{id}

ПРИКЛАД ВІДПОВІДІ

{ “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”
}

ЗАПИТ СТАТУСУ ПОВІДОМЛЕННЯ ЧЕРЕЗ ЗАСЛАННЯ

ЗНАЧЕННЯ

GET https://app.bsg.hk/rest/sms/{reference}

ПРИКЛАД ВІДПОВІДІ

{ “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”
}

ПРИКЛАД ПОМИЛКИ ВІДПОВІДІ ДЛЯ СТАТУСУ ПОВІДОМЛЕННЯ

{ “error”: 20,
“errorDescription”:”SMS not found”
}

ЗАПИТ ІНФОРМАЦІЇ ПРО ЗАВДАННЯ ЧЕРЕЗ TASK_ID

ЗНАЧЕННЯ

GET https://app.bsg.hk/rest/sms/task/{task_id}

ПРИКЛАД ВІДПОВІДІ

{ “originator”:”alpha_name”,
“body”:”message text”,
“validity”:72,
“totalprice”:0.23,
“currency”:”EUR”,
“sent”:1,
“delivered”:1,
“expired”:0,
“undeliverable”:0,
“unknown”:0
}

ПРИКЛАД ПОМИЛКИ ВІДПОВІДІ ДЛЯ ІНФОРМАЦІЇ ПРО ЗАДАЧІ

{ “error”: 30,
“errorDescription”:”Task not found”
}