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.

Ver um 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.

PARÂMETROS

Parameter
Type
Description
id
type: int

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

reference
type: string

Uma referência de cliente. Requeridos

task_id
type: int

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

ATRIBUTOS

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.

validity
type: int

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

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

A data e hora do último status da mensagem. Valores possíveis: programado, enviado, entregue, expirado, não entregue, rejeitado, desconhecido.

PEDIR ESTADO DA MENSAGEM POR ID

DEFINIÇÃO

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

EXEMPLO DE RESPOSTA

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

PEDIR ESTADO DA MENSAGEM POR REFERÊNCIA

DEFINIÇÃO

GET https://app.bsg.hk/rest/sms/{reference}

EXEMPLO DE RESPOSTA

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

EXEMPLO DE RESPOSTA DE ERRO PARA O STATUS DA MENSAGEM

{ “error”: 20,
“errorDescription”:”SMS not found”
}

SOLICITAR INFORMAÇÕES SOBRE A TAREFA POR TASK_ID

DEFINIÇÃO

GET https://app.bsg.hk/rest/sms/task/{task_id}

EXEMPLO DE RESPOSTA

{ “originator”:”alpha_name”,
“body”:”message text”,
“validity”:72,
“totalprice”:0.23,
“currency”:”EUR”,
“sent”:1,
“delivered”:1,
“expired”:0,
“undeliverable”:0,
“unknown”:0
}

EXEMPLO DE RESPOSTA A ERRO PARA INFORMAÇÕES DE TAREFA

{ “error”: 30,
“errorDescription”:”Task not found”
}