Documentação da API de Notificações
Esses pontos de extremidade permitem que você enviar notificações móveis internas e Recuperar histórico de notificações A partir da SMSMobileAPI. As notificações podem ser enviadas para um dispositivo móvel específico e, em seguida, rastreadas por meio do endpoint de lista.
O notificação/lista O endpoint retorna o tempo de envio e o tempo de distribuição da notificação em GMT, incluindo strings completas de data e hora e Carimbos de data/hora Unix.
Início rápido
URL base
Exemplos
Autenticação
Os endpoints de notificação autenticam-se usando o apikey parâmetro.
Conceitos comuns
Target mobile
As notificações são enviadas para um dispositivo móvel específico usando ladoO endpoint de listagem pode filtrar o mesmo alvo usando sidentifiante ou lado.
Status distribuído
- distribuído=1 Significa que a notificação foi distribuída.
- distribuído=0 significa não distribuído.
- status_distribuído retornos distribuído ou não_distribuído.
Datas e fusos horários
- enviado_* Os campos representam a data/hora de envio da notificação em GMT.
- distribuído_* Os campos representam a data/hora de distribuição em GMT.
- *_no_unix Os campos são timestamps Unix.
Comportamento do ponto final da lista
- O endpoint da lista sempre retorna um máximo de 200 linhas.
- Os resultados são ordenados do mais recente para o mais antigo, utilizando a data e hora de envio.
- Os filtros de data usam dataAdicionar internamente e são expostos como data_de / data_para.
Erros
| HTTP | Exemplo de erro | Significado |
|---|---|---|
| 400 | {"success":false,"message":"Parâmetro obrigatório ausente: apikey."} | Ausente ou vazio apikey. |
| 400 | {"success":false,"message":"Parâmetros obrigatórios ausentes: apikey e sid são obrigatórios."} | Ausente lado sobre notificação/enviar. |
| 400 | {"success":false,"message":"Parâmetro obrigatório ausente: message."} | Ausente mensagem sobre notificação/enviar. |
| 400 | {"success":false,"message":"Formato date_from inválido. Esperava-se o formato AAAA-MM-DD."} | Inválido data_de formato em notificação/lista. |
| 400 | {"success":false,"message":"Valor distribuído inválido. Valores permitidos: 0 ou 1."} | Inválido distribuído valor do filtro. |
| 500 | {"success":false,"message":"Falha na conexão com o banco de dados."} | Problema de conexão com o banco de dados. |
| 500 | {"success":false,"message":"Falha na consulta: ..."} | Erro de execução SQL. |
Notificação – Enviar
Criar uma nova notificação para um dispositivo móvel específico.
Ponto final
Parâmetros de consulta/corpo
| Parâmetro | Tipo | Descrição |
|---|---|---|
| apikey | corda | Obrigatório Sua chave de API. |
| lado | corda | Obrigatório Antissocial móvel alvo. |
| título | corda | Opcional Título da notificação. Padrão: Notificação. |
| mensagem | corda | Obrigatório Conteúdo da mensagem de notificação. |
| tipo | corda | Opcional Tipo de notificação. Padrão: notificação. |
Exemplo de resposta bem-sucedida
{ "success": true, "message": "Notificação criada.", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }
Notificação – Lista
Recupere as notificações mais recentes para uma chave de API, com filtragem opcional.
Ponto final
Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| apikey | corda | Obrigatório Sua chave de API. |
| sidentifiante | corda | Opcional Filtrar notificações por dispositivo móvel alvo. |
| lado | corda | Opcional Alias de sidentifiante. |
| distribuído | 0 | 1 | Opcional 1 = distribuído apenas, 0 = não distribuído apenas. |
| data_de | AAAA-MM-DD | Opcional Filtrar data de envio a partir deste dia. |
| data_para | AAAA-MM-DD | Opcional Filtrar por data de envio até hoje. |
Exemplo de resposta bem-sucedida
{ "success": true, "message": "Notificações recuperadas com sucesso.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Notificação", "message": "vers miano", "distribued": "1", "distribued_status": "distribuído", "distribued_date_gmt": "2026-03-18", "distribued_time_gmt": "10:18:30", "distribued_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Enviar campos de resposta
| Campo | Tipo | Descrição |
|---|---|---|
| sucesso | booleano | Status da solicitação. |
| mensagem | corda | Mensagem de resultado legível para humanos. |
| eu ia | inteiro | ID de notificação criado no banco de dados. |
| apikey | corda | Chave de API repetida. |
| lado | corda | Antissidentifiant móvel alvo usado durante a criação. |
Listar campos de resposta
| Campo | Tipo | Descrição |
|---|---|---|
| sucesso | booleano | Status da solicitação. |
| mensagem | corda | Mensagem de resultado legível para humanos. |
| filtros | objeto | Filtros repetidos utilizados pela solicitação. |
| contar | inteiro | Número de notificações devolvidas. |
| dados | variedade | Lista de notificações. |
| dados[].sidentifiant | corda | Identificador móvel alvo. |
| data[].título | corda | Título da notificação. |
| dados[].mensagem | corda | Mensagem de notificação. |
| dados[].distribuídos | corda | Bandeira distribuída bruta. |
| dados[].status_distribuído | corda | distribuído ou não_distribuído. |
| data[].data_distribuída_gmt | corda | Data de distribuição em GMT. |
| dados[].tempo_distribuído_gmt | corda | Horário de distribuição em GMT. |
| dados[].distribuídos_em_gmt | corda | Data e hora de distribuição completas em GMT. |
| dados[].distribuídos_no_unix | int|nulo | Data e hora de distribuição em formato de timestamp Unix. |
| data[].distributed_timezone | corda | Sempre GMT. |
| data[].data_enviada_gmt | corda | Enviar data em GMT. |
| data[].sent_time_gmt | corda | Enviar a hora em GMT. |
| dados[].enviados_às_gmt | corda | Enviar data e hora completas em GMT. |
| dados[].enviados_no_unix | int|nulo | Enviar data e hora como um timestamp Unix. |
| data[].sent_timezone | corda | Sempre GMT. |
