ENVIO DE SMS SIMPLES VIA HTTP

Segue abaixo o link utilizado para realizar um envio via HTTP:

Link para envio método POST:

http://sms.sophiatelecom.com/api/unitario.php?token=[]&destino=[]&msg=[]  

A url deve receber 3 parâmetros obrigatórios e pode receber um quarto parâmetro opcional conforme a seguir.

- Token (Obrigatório)  

Senha de usuário para envios API.

- Destino (Obrigatório)  

Número do telefone celular (destinatário).

- Msg (Obrigatório)  

Texto a ser enviado para o telefone celular (destinatário).

- Id (Opcional)  

Id de controle de cada mensagem, caso este parâmetro não seja enviado o sistema irá gerar um id aleatório para a mensagem. OBS: este id deve ser único para cada mensagem enviada.

 RETORNO DA REQUISIÇÃO

Parâmetros de retorno do envio (envio unitário) 

Status = 0 (erro no recebimento da mensagem) 

Status = 200 (O sistema incluiu a mensagem na fila com sucesso)

 Parâmetros de retorno:

- destino: (número de destino enviado) 

- status: (código de status do envio)

 - messageID: (ID da mensagem enviada) 

- data: (data e hora de envio) 

- detailDescription (descrição detalhada do envio)  

Exemplo de retorno:

{ 

            "envio": [{ 

                "destino": "11999999999",

                 "status": 200, "mesageID": "5b678259ef213", 

                "data": "20XX-XX-XX XX:XX:XX",

                "detailDescription": "OK"

                             }] 

}

ENVIO EM LOTE

Segue abaixo o link utilizado para realizar envio em lote via HTTP:

A URL a seguir está disponível para requisições em lote de SMS. Podem ser enviadas até 1.000 (um mil) mensagens em cada requisição.  

Link para envio método POST:

http://sms.sophiatelecom.com/api/envio.php  

A url deve receber 3 parâmetros obrigatórios e pode receber um quarto parâmetro opcional conforme a seguir.

- Token (Obrigatório)  

Senha de usuário para envios API.

- Destino (Obrigatório)  

Número do telefone celular (destinatário).

- Msg (Obrigatório)  

Texto a ser enviado para o telefone celular (destinatário).

- Id (Opcional) 

Id de controle de cada mensagem, caso este parâmetro não seja enviado o sistema irá gerar um id aleatório para a mensagem. OBS: este id deve ser único para cada mensagem enviada.

Exemplo de envio: 

[{ "token": "XXXXXXXXXXXXXXXXXX", 

"mensagens": [{ "destino": "11999999999",

 "msg": "mensagem 1",

 "id": 1234 

},

 { 

"destino": "41999999999", 

"msg": "mensagem 2",

 "id": 12345

 }] 

}]

RETORNO DA REQUISIÇÃO

Parâmetros de retorno do envio (envio em lote)

Status = 0 (erro no recebimento da mensagem)

Status = 200 (O sistema incluiu a mensagem na fila com sucesso)  

Parâmetros de retorno:

- destino: (número de destino enviado)  

- status: (código de status do envio)

- messageID: (ID da mensagem enviada)  

- data: (data e hora de envio)

- detailDescription (descrição detalhada do envio ) 

Exemplo de retorno:

"detalhes": [  

     { 

         "destino": "11999999999", 

         "status": 200,

          "mesageID": "1234",

         "data": "20XX-XX-XX XX:XX:XX", 

         "detailDescription": "OK"

     },  

     {

         "destino": "41999999999", 

         "status": 200,

         "mesageID": "12345",

         "data": "20XX-XX-XX XX:XX:XX",     

         "detailDescription": "OK" 

     } 

     ] 

}

CONSULTA DE STATUS (DLR)

Segue abaixo o link utilizado para realizar a consulta de status da mensagem enviada:  

Link para envio método POST

a envio método POST: http://sms.sophiatelecom.com/api/dlr.php?token=[]&id=[]  

- Token (Obrigatório)

Senha de usuário para envios API.

- Id (Obrigatório)

Id da mensagem gerado na requisição de envio da mensagem

RETORNO DA REQUISIÇÃO

Parâmetros de retorno de consulta de status

Parâmetros de retorno:

- data: (data e hora da postagem da mensagem) 

- enviado: (data e hora de envio para a operadora) 

- entregue: (data e hora de confirmação de entrega da operadora)

- status: (código de status de entrega)

- destino: (número de destino enviado) 

- mensagem: (texto da mensagem enviada)

- id: (ID da mensagem enviada)

Exemplo de retorno:

{ 

                "dlr": [{ 

                        "data": "20XX-XX-XX XX:XX:XX",

                         "enviado": "20XX-XX-XX XX:XX:XX ",

                         "entregue": "20XX-XX-XX XX:XX:XX ",

                         "status": "2",

                         "numero": "11999999999",

                         "mensagem": "Mensagem de teste",

                         "id": "5b6457cc6003b"

                 }]

 }

DESCRIÇÃO DO STATUS DA CONSULTA

CONSULTA MO (Caixa de Entrada)

Método para consulta das respostas obtidas na caixa de entrada via POST, segue abaixo os parâmetros e URL de exemplo:

Link para envio método POST:

http://sms.sophiatelecom.com/api/mo.php?token=[]

- Token (Obrigatório)

Senha de usuário para envios API.

Parâmetros de retorno:

- destino: (número de destino enviado) 

- data: (data e hora da postagem da mensagem) 

- mensagem: (texto da mensagem enviada) 

- id: (ID da mensagem enviada)

Exemplo de retorno:

{

                        "mo": [{ 

                                "destino": "11999999999",

                                "data": "20XX-XX-XX XX:XX:XX", 

                                "mensagem": "Mensagem de teste", 

                                "id": "5b6457cc6003b" 

                        }] 

}

Observações:

Para a consulta de MO a resposta de confirmação de entrega da mensagem deve ser 200. Se o seu link não responder 200 o sistema vai entender que não foi enviada corretamente, então vai enviar novamente. Isso provocará repetições de mensagens em sua Caixa de Entrada.

CALLBACK AUTOMÁTICO (DLR)

Neste método o sistema irá enviar os status de cada mensagem via GET, segue abaixo os parâmetros e URL a serem enviados para a URL cadastrada:

Link para envio método GET:

http://url/status=[]&id=[]&destino=[]&entrega=[20XX-XX-XX XX:XX:XX]

- Status

Código de status a ser consultado:

        Status = 2 (entregue) 

        Status = 3 ou 4 (erro)

- Destino

Número do telefone celular (destinatário).

- Entrega

Texto a ser enviado para o telefone celular (destinatário).  

- Id

Id de controle de cada mensagem.

Para configurar a sua URL para que o sistema envie os status em tempo real vá até MEU PERFIL > CONFIGURAÇÕES > call-back DLR

Veja abaixo:  

CALLBACK AUTOMÁTICO (MO – Caixa de Entrada)

Neste método o sistema irá enviar em tempo real as mensagens recebidas na caixa de entrada (MO) via GET, segue abaixo os parâmetros e URL a serem enviados para a URL cadastrada:

Link para envio método GET

http://url/data=[XXXX-XX-XX XX:XX:XX]5&numero=[11999999999]&mensagem=[XXX]&id=[XXX]

- Data

Data e hora da resposta.

- Numero

Número do telefone celular (destinatário).

- Mensagem

Texto da mensagem.

- Id

Id de controle de cada mensagem.

Para cadastrar a URL de MO no sistema, vá até MEU PERFIL > CONFIGURAÇÕES > callback MO.

Veja abaixo: