For the best experience turn off the battery saving mode.

Документация REST API сервиса BSG

Интегрируйте возможности сервиса рассылок BSG в личный проект.
API предназначен для разработчиков и сопровождается детальной документацией.

Просмотр статуса

Получает информацию о существующем сообщении. Это сообщение может быть отправленным или полученным. Вам нужно только указать уникальный идентификатор сообщения, который был возвращен при создании или получении.

Параметры

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»
}

Rate this post