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

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

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

Переслати повідомлення 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″
}
]
}

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

Отримує інформацію про існуючий повідомленні. Це може бути відправлене або отримане повідомлення. Вам необхідно вказати 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”
}