SMS

Utilize esta API para enviar SMS com várias funcionalidades para um ou mais destinatários simultaneamente.

POST/api/sms

Enviar SMS

Envie um SMS para um ou mais destinatários.

Name
to
Type
string
Description
Número do destinatário do SMS. Isso também pode ser o nome de um contato ou de um grupo. Nossa API aceita todos os formatos comuns como 0049171999999999, 49171999999999, +49171999999999. Vários destinatários são passados separados por vírgula. Idealmente, forneça o número de telefone no formato internacional de acordo com E.164.
Name
text
Type
string
Description
Texto da mensagem SMS.

Name
from
Type
string
Optional
Optional
Description
Remetente do SMS. Este pode conter no máximo 11 caracteres alfanuméricos ou 16 caracteres numéricos.
Name
delay
Type
timestamp
Optional
Optional
Description
Data/hora para envio programado. Opcionalmente, Unix-Timestamp ou um carimbo de data/hora no formato AAAA-MM-DD hh:mm:ss.
Name
flash
Type
boolean
Optional
Optional
Description
Enviar SMS como Flash SMS. Estes são exibidos diretamente na tela do destinatário. Na maioria dos dispositivos, o remetente não é exibido em Flash-SMS, exceto em alguns modelos mais antigos.
Name
udh
Type
string
Optional
Optional
Description
Cabeçalho de Dados do Usuário (UDH) personalizado do SMS. Se especificado e a variável text contiver código hexadecimal, a mensagem será enviada como SMS binário de 8 bits. 050003CC0201 (Mensagem concatenada: número de referência 204, parte 1 de 2)
Name
ttl
Type
integer
Optional
Optional
Description
Indica o Período de Validade do SMS em minutos. O padrão é 2880, ou seja, 48 horas. Observe que nem todas as redes permitem uma configuração diferente.
Name
label
Type
integer
Optional
Optional
Description
Opcionalmente, defina um rótulo para cada SMS para poder identificá-lo em suas estatísticas. Máx. 100 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
performance_tracking
Type
boolean
Optional
Optional
Description
Ativar rastreamento de cliques e desempenho para URLs encontradas no texto do SMS. Isso também ativa o encurtador de URL.
Name
foreign_id
Type
string
Optional
Optional
Description
Forneça seu próprio ID para esta mensagem. Você receberá o foreign_id de volta em callbacks para relatórios de status, etc. Máx. 64 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
Name
is_binary
Type
boolean
Optional
Optional
Description
Se true, o SMS será enviado como dados binários.
Name
unicode
Type
string
Deprecated
Deprecated
Description
Envio como SMS Unicode (caracteres cirílicos, árabes, etc.). O comprimento da SMS é reduzido para 70 caracteres. Por favor, note que nosso gateway detecta automaticamente a codificação. Portanto, este parâmetro não é necessário. No entanto, você pode forçar um método de envio específico com ele.
Name
utf8
Type
string
Deprecated
Deprecated
Description
Força o reconhecimento como conjunto de caracteres UTF8 e sobrescreve a detecção automática da API.
Name
return_msg_id
Type
string
Deprecated
Deprecated
Description
Se este parâmetro estiver definido, o ID do SMS será exibido na segunda linha após o código de status. Não tem efeito se o parâmetro json estiver definido como 1.
Name
details
Type
string
Deprecated
Deprecated
Description
Mostra vários detalhes sobre o SMS enviado. Prático para depuração. Não tem efeito se o parâmetro json estiver definido como 1.
Name
json
Type
string
Deprecated
Deprecated
Description
A saída é mais detalhada no formato JSON. Por favor, use Accept: application/json no cabeçalho em vez disso.
Name
no_reload
Type
string
Deprecated
Deprecated
Description
Desativa o bloqueio de recarga. Este bloqueio impede o envio de SMS iguais (mesmo texto e destinatário) dentro de 180 segundos. Você também pode desativar permanentemente este bloqueio em seu login em Configurações > SMS.

Anfrage

POST

/api/sms

curl -X POST https://gateway.seven.io/api/sms \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Accept: application/json" \
    -d "to=49176123456789" \
    -d "from=AcmeInc" \
    -d "text=hello world"

Antwort

{
    "success": "100",
    "total_price": 0.075,
    "balance": 593.994,
    "debug": "false",
    "sms_type": "direct",
    "messages": [
        {
            "id": "77229318510",
            "sender": "sender",
            "recipient": "49123456789",
            "text": "Hello World",
            "encoding": "gsm",
            "label": null,
            "parts": 1,
            "udh": null,
            "is_binary": false,
            "price": 0.075,
            "success": true,
            "error": null,
            "error_text": null
        },
        {
            "id": "77229318511",
            // ....
        }
    ]
}

Anexos

Você pode enviar anexos diretamente em suas SMS via API. Para isso, o parâmetro files deve ser passado como um array associativo com os respectivos arquivos.

Propriedades

Name
name
Type
string
Description
Nome do arquivo. Este deve ser inserido exatamente como um espaço reservado no texto do SMS. Aqui seria [[dokument.pdf]]
Name
contents
Type
string
Description
Conteúdo do arquivo codificado em base64.

Propriedades Opcionais

Name
validity
Type
integer
Description
Validade em dias. Após o período de validade, o arquivo será automaticamente excluído. Padrão: 3
Name
password
Type
string
Description
Senha de acesso desejada para o arquivo. Sem senha, o arquivo estará visível para qualquer pessoa com o link.

Requisição

POST

/api/sms

curl -X POST https://gateway.seven.io/api/sms \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Accept: application/json" \
    -d "to=49176123456789" \
    -d "from=AcmeInc" \
    -d "text=Hallo, hier das Dokument: [[dokument.pdf]]" \
    -d "files[0][name]=dokument.pdf" \
    -d "files[0][contents]=iVBORw0KGgoAAAANSUhEUgAAAdoAAACWCAYAAAB5CUk..."

Códigos de Retorno

Para cada SMS, você receberá um código de retorno na resposta, que fornece informações detalhadas sobre o envio ou o erro no envio da SMS.

Name
100
Description
SMS foi aceita pelo gateway e será enviada.
Name
101
Description
Falha no envio para pelo menos um destinatário.
Name
201
Description
Remetente inválido. São permitidos no máximo 11 caracteres alfanuméricos ou 16 caracteres numéricos.
Name
202
Description
O número do destinatário é inválido.
Name
301
Description
Parâmetro to não definido.
Name
305
Description
Parâmetro text é inválido.
Name
401
Description
Parâmetro text é muito longo.
Name
402
Description
Este SMS já foi enviado nos últimos 180 segundos. Você pode desativar este bloqueio nas configurações da sua conta.
Name
403
Description
Limite máximo por dia para este número de destinatário atingido.
Name
500
Description
Conta com saldo insuficiente para o envio deste SMS.
Name
600
Description
Ocorreu um erro durante o envio.
Name
802
Description
O label especificado é inválido.
Name
900
Description
Falha na autenticação. Por favor, verifique a chave API usada na Autenticação.
Name
901
Description
Falha na verificação do hash de assinatura.
Name
902
Description
A chave API não tem permissão de acesso a este endpoint.
Name
903
Description
O IP de onde a solicitação foi feita não está na lista de IPs permitidos.

DELETE/api/sms

Excluir SMS

Exclua uma ou mais SMS antes que sejam enviadas para impedir o envio.

Name
ids
Type
array
Description
Uma lista de SMS a serem excluídas. Indique aqui os respectivos ´id´s das SMS que devem ser excluídas.

Anfrage

DELETE

/api/sms

curl -X DELETE "https://gateway.seven.io/api/sms" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Content-type: application/json" \
    -d "{ \"ids\": [ 77150850625, 77150850626 ] }"

Antwort

{
    "success": true,
    "deleted": [
        "77150850625",
        "77150850626"
    ]
}

Por razões de compatibilidade, métodos de acesso mais antigos continuam a ser suportados de forma mais simples. Por favor, note que novos recursos são lançados principalmente para a API atual. Além disso, o uso a seguir pode causar problemas com solicitações maiores e problemas de segurança.

Exemplos

A seguinte solicitação para a URL a seguir envia uma SMS com o conteúdo meine erste nachricht como SMS com o remetente seven.io para o número de telefone 49160999999999:

Anfrage

GET

/api/sms

curl "https://gateway.seven.io/api/sms?p=SUA_CHAVE_API&to=49160999999999&text=meine%20erste%20nachricht&from=seven.io&return_msg_id=1"

Antwort

100
123456789

Esta solicitação mostra vários detalhes sobre a mensagem, cada um separado por uma quebra de linha:

Anfrage

GET

/api/sms

curl "http://gateway.seven.io/api/sms?p=SUA_CHAVE_API&to=Gruppe1&text=Test+SMS&from=SMS&flash=0&details=1"

Antwort

100
Verbucht: 0.075
Preis: 0.075
Guthaben: 27.38
Text: Test SMS
SMS-Typ: direct
Flash SMS: off
Encoding: ASCII
GSM0338: true
Debug: false

SMS

Enviar SMS

Anfrage

Antwort

Anexos

Propriedades

Propriedades Opcionais

Requisição

Códigos de Retorno

Excluir SMS

Anfrage

Antwort

Legado

Exemplos

Anfrage

Antwort

Anfrage

Antwort