Números de Telefone

Explore documentações detalhadas sobre o uso de nossa API de gerenciamento de números para um controle abrangente sobre a busca, reserva e gestão dos números de telefone da sua conta.

GET/api/numbers/available

Números Disponíveis

Este endpoint permite que você busque números de telefone disponíveis, com base nos critérios de busca fornecidos. Os critérios de busca podem incluir o código do país, o prefixo e os recursos suportados. A resposta incluirá uma lista de números de telefone disponíveis que correspondem aos critérios de busca.

Parâmetros

Name
country
Type
string
Optional
Optional
Description
O código do país ISO 3166-1 alpha-2 do país em que se deseja buscar números disponíveis.
Name
features_sms
Type
boolean
Optional
Optional
Description
Se definido como true, apenas números que suportam SMS serão retornados.
Name
features_a2p_sms
Type
boolean
Optional
Optional
Description
Se definido como true, apenas números que suportam A2P SMS serão retornados.
Name
features_voice
Type
boolean
Optional
Optional
Description
Se definido como true, apenas números que suportam Voz serão retornados.

GET

/api/numbers/available

curl -X GET "https://gateway.seven.io/api/numbers/available?country=DK" \
    -H "x-api-key: SUA_CHAVE_API"

{
    "availableNumbers": [
        {
            "country": "DK",
            "number": "4523854818",
            "number_parsed": "+45 23 85 48 18",
            "fees": {
                "monthly": {
                    "basic_charge": 29.9,
                    "setup": 19.9
                },
                "annually": {
                    "basic_charge": 238.8,
                    "setup": 9.9
                },
                "sms_mo": 0,
                "voice_mo": 0.01
            },
            "features": {
                "sms": true,
                "a2p_sms": true,
                "voice": true
            }
        }
    ]
}

POST/api/numbers/order

Peça um Número

Bestelle um um eine Telefonnummer, indem Sie die gewünschte Nummer angeben. Die Antwort wird die Details der bestellten Nummer enthalten.

Parâmetros

Name
number
Type
phonenumber
Description
O número de telefone que deve ser encomendado.
Name
payment_interval
Type
enum
Optional
Optional
Description
O intervalo de pagamento para o número. Os valores possíveis são monthly e annually (padrão).

POST

/api/numbers/order

curl -X POST "https://gateway.seven.io/api/numbers/order" \
    -H "x-api-key: SUA_CHAVE_API" \
    -d 'number=4523854818'

{
    "success": true,
    "error": null,
}

GET/api/numbers/active

Números Ativos

Obtenha uma lista de todos os números ativos atualmente associados à sua conta.

GET

/api/numbers/active

curl -X GET "https://gateway.seven.io/api/numbers/active" \
    -H "x-api-key: SUA_CHAVE_API"

{
    "activeNumbers": [
       {
            "country": "DE",
            "number": "4915170264838",
            "friendly_name": "",
            "billing": {
                "fees": {
                    "setup": 19.9,
                    "basic_charge": 238.8,
                    "sms_mo": 0,
                    "voice_mo": 0
                },
                "payment_interval": "annually"
            },
            "features": {
                "sms": true,
                "a2p_sms": false,
                "voice": true
            },
            "forward_sms_mo": {
                "sms": {
                    "number": [
                        "4917612345678"
                    ],
                    "enabled": true
                },
                "email": {
                    "address": [
                        "j.doe@acme.inc",
                        "john@doe.com"
                    ],
                    "enabled": true
                },
                "slack": {
                    "uri": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXX",
                    "enabled": true
                }
            },
            "expires": null,
            "created": "2024-01-31 17:06:27"
        }
    ]
}

GET/api/numbers/active/:number

Obter Número

Consulte um único número ativo especificando o número de telefone.

Parâmetros de Caminho

Name
number
Type
phonenumber
Description
O número de telefone para o qual os detalhes devem ser recuperados.

GET

/api/numbers/active/49176123456789

curl -X GET "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: SUA_CHAVE_API"

{
    "country": "DE",
    "number": "49176123456789",
    "friendly_name": "",
    "billing": {
        "fees": {
            "setup": 19.9,
            "basic_charge": 238.8,
            "sms_mo": 0,
            "voice_mo": 0
        },
        "payment_interval": "annually"
    },
    "features": {
        "sms": true,
        "a2p_sms": false,
        "voice": true
    },
    "forward_sms_mo": {
        "sms": {
            "number": [
                "4917612345678"
            ],
            "enabled": true
        },
        "email": {
            "address": [
                "j.doe@acme.inc",
                "john@doe.com"
            ],
            "enabled": true
        },
        "slack": {
            "uri": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXX",
            "enabled": true
        }
    },
    "expires": null,
    "created": "2024-01-31 17:06:27"
}

PATCH/api/numbers/active/:number

Atualizar Número

Atualize os detalhes de um único número ativo especificando o número de telefone. Atualmente, você pode atualizar o nome simples e definir se deseja ou não encaminhar SMS recebidos por SMS ou e-mail. Como resposta, você receberá os detalhes do número atualizado.

Parâmetros de Caminho

Name
number
Type
phonenumber
Description
O número de telefone para o qual os detalhes devem ser atualizados.

Parâmetros

Name
friendly_name
Type
string
Optional
Optional
Description
O nome amigável do número.
Name
sms_forward
Type
array
Optional
Optional
Description
O número de telefone para o qual as SMS recebidas devem ser encaminhadas. Se vazio, as SMS recebidas não serão encaminhadas por SMS.
Name
email_forward
Type
array
Optional
Optional
Description
O endereço de e-mail para o qual as SMS recebidas devem ser encaminhadas. Se vazio, as SMS recebidas não serão encaminhadas por e-mail.
Name
slack_forward
Type
url
Optional
Optional
Description
O URI do Webhook do Slack para o qual as SMS recebidas devem ser encaminhadas. Se vazio, as SMS recebidas não serão encaminhadas pelo Slack.

PATCH

/api/numbers/active/49176123456789

curl -X PATCH "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: SUA_CHAVE_API" \
    -d 'friendly_name=Neuer freundlicher Name'

{
    "country": "DE",
    "number": "49176123456789",
    "friendly_name": "Neuer freundlicher Name",
    "billing": {
        "fees": {
            "setup": 19.9,
            "basic_charge": 238.8,
            "sms_mo": 0,
            "voice_mo": 0
        },
        "payment_interval": "annually"
    },
    "features": {
    "sms": true,
    "a2p_sms": false,
    "voice": true
},
    "forward_sms_mo": {
        "sms": {
            "number": [
                "49176123456789"
            ],
            "enabled": true
        },
        "email": {
            "address": [
                "j.doe@acme.inc",
                "john@doe.com"
            ],
            "enabled": true
        },
        "slack": {
            "uri": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXX",
            "enabled": true
        } 
    },
    "expires": null,
    "created": "2024-01-31 17:06:27"
}

DELETE/api/numbers/active/:number

Excluir número

Exclua um único número ativo especificando o número de telefone.

Parâmetros de Caminho

Name
number
Type
phonenumber
Description
O número de telefone a ser excluído.

Parâmetros

Name
delete_immediately
Type
boolean
Optional
Optional
Description
Se definido como true, o número será excluído imediatamente. Se definido como false, o número será excluído no final do período de faturamento atual.

DELETE

/api/numbers/active/49176123456789

curl -X DELETE "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: SUA_CHAVE_API"

{
    "success": true
}