Documentação da api

Documentação | SmsGateway24.com

v.1.0

1. Obtendo um token:

Descrição: Após a execução desta consulta bem sucedida, você receberá um token. Subsequentemente, você pode usar este token para acessar o servidor e fazer solicitações adicionais.
Ponto: https://smsgateway24.com/getdata/gettoken
Método:: GET
Parâmetros da solicitação:
Variável tipo Descrição:
email string [Obrigatório] Your login in the system. Usually email
pass string [Obrigatório] Your password in the system

Resposta JSON-formatada::
Variável tipo Descrição:
token string Seu token é adquirido através do método de recuperação do token:
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Enviar um SMS usando TOKEN:

Descrição: Gera mensagens SMS no servidor a serem enviadas coletivamente em um único lote. Habilita a criação de múltiplas mensagens SMS simultaneamente através de uma única solicitação.
Ponto: https://smsgateway24.com/getdata/addsms
Método:: GET, POST ( Usar %2B em vez do sinal de mais '+' na requisição GET )
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
sendto string [Obrigatório]Número de telefone do assinante. Todos os caracteres são permitidos. Por exemplo: +4915752982212, +4917642111111, +1 17642031984. Alternativamente, vários números podem ser especificados por vírgulas
body string [Obrigatório] Corpo da mensagem
device_id string [Obrigatório] ID do dispositivo
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Tempo designado para enviar uma mensagem. Por exemplo, 2024-04-15 02:10:31
sim int, default = 0 [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de ID do seu cliente. Campo opcional.
urgent int [opcional] SMS marcado como urgente. Este campo é opcional. O SMS será enviado com prioridade, e pode ser benéfico ao enviar senhas de uso único (OTPs).

Resposta JSON-formatada::
Variável tipo Descrição:
token string Seu token é adquirido através do método de recuperação do token:
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

2.1 Enviar SMS único usando login e senha:

Descrição: Gera mensagens SMS no servidor a serem enviadas coletivamente em um único lote. Habilita a criação de múltiplas mensagens SMS simultaneamente através de uma única solicitação.
Ponto: https://smsgateway24.com/getdata/smstosend
Método:: GET, POST ( Usar %2B em vez do sinal de mais '+' na requisição GET )
Parâmetros da solicitação:
Variável tipo Descrição:
email string [Obrigatório] Seu e-mail
pass string [Obrigatório] Sua senha
sendto string [Obrigatório]Número de telefone do assinante. Todos os caracteres são permitidos. Por exemplo: +4915752982212, +4917642111111, +1 17642031984. Alternativamente, vários números podem ser especificados por vírgulas
body string [Obrigatório] Corpo da mensagem
device_id string [Obrigatório] ID do dispositivo
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Tempo designado para enviar uma mensagem. Por exemplo, 2024-04-15 02:10:31
sim int, default = 0 [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de ID do seu cliente. Campo opcional.
urgent int [opcional] SMS marcado como urgente. Este campo é opcional. O SMS será enviado com prioridade, e pode ser benéfico ao enviar senhas de uso único (OTPs).

Resposta JSON-formatada::
Variável tipo Descrição:
token string Seu token é adquirido através do método de recuperação do token:
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

3. Enviando SMS em massa usando JSON

Descrição: Cria SMS no servidor para enviar. Depois disso, o telefone com o aplicativo Smsgateway24 chama o servidor e toma o SMS e envia-o a partir do cartão SIM Baixar o aplicativo no link
Ponto: https://smsgateway24.com/getdata/addalotofsms
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
datajson string [Obrigatório] {"token":"df427bfcf113c9a21c67718035076b5b","smsdata":[{"sendto":"015752982212","body":"Test message","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260},{"sendto":"+4915752982212","body":"Test message 2","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260,"urgent":1}]}

Resposta JSON-formatada::
Variável tipo Descrição:
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Request example:
{ "token":"df427bfcf113c9a21c6771803501", "smsdata":[ { "sendto":"015752982212", "body":"Your password is 12345", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":1 }, { "sendto":"015752982212", "body":"Regular SMS. Not urgnet", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":0 } ] }

4. Receber todos os SMS (incluindo SMS recebidos):

Descrição:: Este pedido permite que você recupere todas as mensagens associadas à sua conta, incluindo mensagens recebidas por SMS dos clientes. Todas as variáveis de entrada são obrigatórias neste método, e mensagens SMS podem variar em status.
Endpoint: https://smsgateway24.com/getdata/getallsms
Método: GET, POST (Usar %2B em vez do sinal de mais "+" na requisição GET)
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
device_id string [opcional] ID do dispositivo
status int [opcional]
  • 1 - Pendente por SMS
  • 2 - SMS usado pelo telefone
  • 3 - Enfileirado para envio. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS de entrada
  • 6 - SMS enviado por telefone
  • 7 - O SMS foi entregue
  • 8 - O SMS NÃO foi entregue
  • 9 - O SMS não foi enviado - Falha genérica. (Leia o que fazer com esse erro Aqui)
  • Outros erros menos comuns:
  • 10 - SMS não enviado - No Service
  • 11 - SMS não enviado - Null PDU
  • 12 - SMS não enviado - Radio Off
  • 100, 101 - SMS não enviado - NOT ALLOWED. (As permissões para o envio de SMS no aplicativo não foram concedidas)
begindate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] Begin Date Time
enddate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[opcional] End Date Time
sim int [opcional] SIM slot # 0 or 1
customerid int [opcional] Número de ID do seu cliente. Campo opcional
onlycount int [opcional] 0 | 1 contador apenas
phone string [opcional] 0 | 1 Filtro de números de telefone
orderbydesc int [opcional] 0 | 1 Order by any field
timezone int [opcional] Especifique o seu fuso horário local, como configurá-lo para a Austrália/Sydney, por exemplo.

Resposta JSON-formatada::
Variável tipo Descrição:
token string Seu token é adquirido através do método de recuperação do token:
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazio se tudo estiver em ordem
count int SMS amount
smss int JSON object
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta ... :
{ "smss": { "62050971": { "id": 62050971, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 2, "statustitle": "sending", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:44:43.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null }, "62051117": { "id": 62051117, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 7, "statustitle": "delivered", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:46:09.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null } } }

5. Adicionar uma nova lista de contatos

Descrição: A tag é necessária para gerar uma newsletter direcionada a um grupo de números. Por exemplo, use a tag Empregados
Ponto: https://smsgateway24.com/getdata/savetag
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
title string [Obrigatório] Nome da Tag

Resposta JSON-formatada::
Variável tipo Descrição:
tag_id int Tag ID
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Adicionar contatos na lista de contatos:

Descrição: Adicione contatos para qualquer tag. Por exemplo, para a tag * Colaboradores * seus colegas vão perfeitamente se adequar.
Ponto: https://smsgateway24.com/getdata/savecontact
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
phone string [Obrigatório] phone number
ctag_id int [Obrigatório] Tag ID
fullname string [Obrigatório] Nome do seu cliente

Resposta JSON-formatada::
Variável tipo Descrição:
contact_id int Contact Id
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Criar boletim informativo

Descrição:Depois de criar a etiqueta, você pode fazer a correspondência nos telefones de tag.
Ponto: https://smsgateway24.com/getdata/savepaket
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
title string [Obrigatório] Título da Newsletter
device_id string [Obrigatório] ID do dispositivo
body string [Obrigatório] Corpo da mensagem alvo
tags string [Obrigatório] ID da tag. Pode ser várias, separadas por vírgulas. Por exemplo: 12,13,14
sim int, default = 0 [Obrigatório]Número de SIM no telefone: 0 or 1
time_to_send int, default = 0 [Obrigatório]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

Resposta JSON-formatada::
Variável tipo Descrição:
contact_id int Id do Contato
error int 0 + 1 - indica se há um erro no processamento da solicitação
message string Mensagem de erro, vazia se tudo estiver em ordem.
paket_id int Package ID
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Obter lista de dispositivos

Descrição: Você pode descobrir tudo sobre seus dispositivos.
Ponto: https://smsgateway24.com/getdata/getalldevices
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.

Resposta JSON-formatada::
Variável tipo Descrição:
count int Número de dispositivos:
device json
  • id - ID do dispositivo
  • title - Nome do dispositivo
  • created - Data de criação do dispositivo
  • createdhumanformat - Data de criação do dispositivo em formato regular
  • lastseen - A data em que o dispositivo foi visto pela última vez
  • lastseenhumanformat - A data em que o dispositivo foi visto pela última vez
  • serialnumber - Número de série do dispositivo
  • siminfo - Informações sobre cartões SIM no JSON
  • appversion - A versão do aplicativo instalado no dispositivo
  • subscription - Há uma assinatura no dispositivo
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
    {
    "count": 2,
    "device": {
        "1576": {
            "id": 1576,
            "title": "AOSP_on_IA_Emulator",
            "number": null,
            "imei": "358240051111110",
            "created": {
                "date": "2020-03-28 20:10:29.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "28.03.2020 20:10:29",
            "lastseen": {
                "date": "2020-04-23 17:02:21.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "23.04.2020 17:02:21",
            "serialnumber": "EMULATOR30X0X5X0",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "89014103211118510720",
                    "Number": " 15555215554",
                    "Roaming": "0",
                    "CountryIso": "us",
                    "CarrierName": "Android (T-Mobile)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": null,
            "delaybetweenrequest": 1,
            "subscription": true
        },
        "1297": {
            "id": 1297,
            "title": "Android_SDK_built_for_x86",
            "number": null,
            "imei": "null",
            "created": {
                "date": "2020-01-20 14:01:05.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "20.01.2020 14:01:05",
            "lastseen": {
                "date": "2020-04-20 20:51:34.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "20.04.2020 20:51:34",
            "serialnumber": "unknown",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "8949226172233934327",
                    "Number": "+4915752982212",
                    "Roaming": "1",
                    "CountryIso": "de",
                    "CarrierName": "Drillisch (o2)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": 5,
            "delaybetweenrequest": 10,
            "subscription": false
        }
    }
}

9. Obter o Status de Entrega de um único SMS

Descrição: Você pode descobrir o status de entrega de cada SMS usando este método
Ponto: https://smsgateway24.com/getdata/getsmsstatus
Método:: GET, POST
Parâmetros da solicitação:
Variável tipo Descrição:
token string [Obrigatório] Seu token foi adquirido através do método de recuperação de token.
sms_id int [Obrigatório] Sms Id

Resposta JSON-formatada::
Variável tipo Descrição:
sms_id int SMS ID
status int SMS Status
  • 1 - Pendente por SMS
  • 2 - SMS usado pelo telefone
  • 3 - Enfileirado para envio. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - SMS de entrada
  • 6 - SMS enviado por telefone
  • 7 - O SMS foi entregue
  • 8 - O SMS NÃO foi entregue
  • 9 - O SMS não foi enviado - Falha genérica. (Leia o que fazer com esse erro Aqui)
  • Outros erros menos comuns:
  • 10 - SMS não enviado - No Service
  • 11 - SMS não enviado - Null PDU
  • 12 - SMS não enviado - Radio Off
  • 100, 101 - SMS não enviado - NOT ALLOWED. (As permissões para o envio de SMS no aplicativo não foram concedidas)
status_description string Nome do Status
error int 0 | 1 - ocorreu um erro ao processar o pedido
message string Mensagem de erro, vazia se tudo estiver em ordem.
Link para o exemplo Curl de código
Link para o exemplo de código Guzzle
Exemplo de resposta:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}