Para obter a melhor experiência, desligue o modo de economia de bateria.

Bem vindo à
BSG Desenvolvedores Docs.

Se você deseja usar nossas APIs REST, receba
notificações com webhooks ou crie um aplicativo para o
Intercom Messenger, você veio ao lugar certo.

Reenviar uma mensagem VIBER por SMS se não for entregue

Cria um novo objeto de mensagem. BSG retorna o objeto de mensagem criado com cada solicitação. Por solicitação, no máximo 50 telefones podem ser inseridos.

NOTA: O corpo do SMS deve ser adicionado ao hash de opções do Viber.

PARÂMETROS

Parameter
Type
Description
originator
type: string

The sender of the SMS message.

text
type: string

The body of the SMS message.

DEFINITION

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

RETORNOS
Retorna um objeto de mensagem se a solicitação foi bem-sucedida. Se a solicitação falhar, um objeto de erro será retornado.

EXAMPLE REQUEST

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

EXAMPLE RESPONSE

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

IN ERROR CASE

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

View a status

Recupera as informações de uma mensagem existente. Esta mensagem pode ser enviada ou recebida. Você só precisa fornecer o ID de mensagem exclusivo que foi retornado na criação ou recebimento.

PARAMETERS

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.

reference
type: string

A client reference

ATTRIBUTES

Attribute
Type
Description
id
type: int

Um ID aleatório único que é criado na plataforma BSG e é retornado na criação do objeto.

msisdn
type: string

O número de telefone.

reference
type: string

Uma referência de cliente.

time_in
type: datetime

A data e hora da criação da mensagem

time_sent
type: datetime

A data e hora agendadas da mensagem.

time_dr
type: datetime

A data e hora da criação da mensagem.

status
type: string

Valores possíveis: programado, enviado, entregue, lido, expirado, não entregue, rejeitado, desconhecido.

alt_route
type: hash

Um hash com informações de mensagem SMS

channel
type: string

Sempre SMS

id
type: int

Um ID aleatório único que é criado na plataforma BSG e é retornado na criação do objeto.

status
type: string

Valores possíveis: programado, enviado, entregue, lido, expirado, não entregue, rejeitado, desconhecido.

DEFINITION

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

EXAMPLE RESPONSE

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

IN ERROR CASE

{ “error”: 40,
“errorDescription”:”Message not found”
}