For the best experience turn off the battery saving mode.

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

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

Переслать сообщение VIBER через SMS, если оно не доставлено

Создает новый объект сообщения. BSG пересылает созданные объекты сообщений с каждым запросом. По запросу может быть введено до 50 телефонов.

ПРИМЕЧАНИЕ: тело SMS должно быть добавлено в хэш опций Viber.

Параметры

Параметр
Вид
Описание
originator
type: string

The sender of the SMS message.

text
type: string

The body of the SMS message.

ЗНАЧЕНИЯ

PUT (POST) https://app.bsg.hk/rest/viber/create

ВОЗВРАТ
Возвращает объект сообщения, если запрос был успешным. Если запрос не удался, возвращется отчет об ошибке.

Пример запроса

{ «tariff»:»0″,
«validity»:»1″,
«messages»:[
{
«to»:[
{
«msisdn»:»380972920000″,
«reference»:»ext_id_19″
}
],
«text»:»My Viber messages is shinier than your SMS messages»,
«alpha_name»:»BSG»,
«is_promotional»:false,
«options»:{
«viber»:{
«img»:»http://mysite.com/logo.png»,
«caption»:»See Details»,
«action»:»http://mysite.com/»,
«alt_route»: {
«originator»:»BSG»,
«text»: «SMS message will be received if you not a VIBER user.»
}
}
}
}
]
}

Пример ответа

{ «result»:[
{
«error»:0,
«errorDescription»:»No errors»,
«reference»:»ext_id_19″,
«id»:»217″,
«price»:0.23,
«currency»:»EUR»
}
],
«currency»:»EUR»,
«total_price»:0.23
}

В случае ошибки

{ «result»:[
{
«error»:43,
«errorDescription»:»External ID already exists»,
«reference»:»ext_id_19″
}
]
}

View a status

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

Параметры

Параметр
Вид
Описание
id
type: int

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

reference
type: string

A client reference

Аттрибуты

Аттрибут
Вид
Описание
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.

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

Possible values: scheduledsentdeliveredreadexpiredundeliverablerejectedunknown.

alt_route
type: hash

A hash with SMS message info

channel
type: string

Allways SMS

id
type: int

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

status
type: string

Possible values: scheduledsentdeliveredreadexpiredundeliverablerejectedunknown.

Значение

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

Пример ответа

{ «error»:0,
«errorDescription»:»No errors»,
«id»:»470093225″,
«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»:»undeliverable»,
«price»:0.00,
«currency»:»EUR»,
«alt_route»:[{
«channel»: «sms»,
«id»: «470094225»,
«status»: «delivered»,
«price»=>»0.023»
}]
}

В случае ошибки:

{ «error»: 40,
«errorDescription»:»Message not found»
}

Rate this post