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.

Envie uma mensagem

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.

PARÂMETROS REQUERIDOS

Parameter
Type
Description
destination
type: string

O remetente da mensagem. Pode ser um número de telefone (incluindo o código do país) ou uma string alfanumérica. No caso de uma string alfanumérica, o comprimento máximo é de 11 caracteres. Requeridos

body
type: string

O corpo da mensagem SMS. Requeridos

msisdn
type: string

O número de telefone. Requeridos

reference
type: string

Uma referência de cliente. Requeridos

phones
type: array

A matriz de msisdns e referências de destinatários. Requerido Definido apenas para solicitação de várias mensagens (“destino”: “telefones”).

PARÂMETROS OPCIONAIS

Parameter
Type
Description
validity
type: int

A quantidade de segundos que a mensagem é válida.

tariff
type: int

Código tarifário de uma grade de preços.

DEFINIÇÃO

PUT (POST) https://app.bsg.hk/rest/sms/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.

EXEMPLO DE PEDIDO (ÚNICA MENSAGEM)

{ “destination”:”phone”,
“originator”:”alpha name”,
“body”:”message text”,
“msisdn”:”380972000000″,
“reference”:”ext_id_16″,
“validity”:”1″,
“tariff”:”0″
}

EXEMPLO DE RESPOSTA (ÚNICA MENSAGEM)

{ “result”:{
“error”:0,
“errorDescription”:”No errors”,
“reference”:”ext_id_16″,
“id”:”213″,
“price”:0.23,
“currency”:”EUR”
}
}

EXEMPLO DE PEDIDO (MÚLTIPLAS MENSAGENS)

{ “validity”:”1″,
“tariff”:”0″,
“destination”:”phones”,
“originator”:”alpha_name”,
“body”:”message text”,
“phones”:[
{
“msisdn”:”380972000000″,
“reference”:”ext_id_17″
},
{
“msisdn”:”380972000001″,
“reference”:”ext_id_18″
}
]
}

ATRIBUTOS

Attribute
Type
Description
task_id
type: int

Um ID aleatório único que é criado para vários pedidos.

EXEMPLO DE RESPOSTA (MÚLTIPLAS MENSAGENS)

{ “task_id”:”6″,
“result”:[
{
“error”:0,
“errorDescription”:”No errors”,
“reference”:”ext_id_17″,
“id”:”214″,
“price”:0.23,
“currency”:”EUR”
},
{
“error”:0,
“errorDescription”:”No errors”,
“reference”:”ext_id_18″,
“id”:”215″,
“price”:0.23,
“currency”:”EUR”
}
],
“total_price”:0.46,
“currency”:”EUR”
}