Números de teléfono

Explore documentación detallada sobre el uso de nuestra API de gestión de números para un control completo sobre la búsqueda, reserva y gestión de los números de teléfono de su cuenta.

GET/api/numbers/available

Números disponibles

Este punto final le permite buscar números de teléfono disponibles, basándose en los criterios de búsqueda proporcionados. Los criterios de búsqueda pueden incluir el código de país, el prefijo y las características compatibles. La respuesta incluirá una lista de números de teléfono disponibles que coincidan con los criterios de búsqueda.

Parámetros

Name
country
Type
string
Optional
Optional
Description
El código de país ISO 3166-1 alpha-2 del país en el que se desea buscar números disponibles.
Name
features_sms
Type
boolean
Optional
Optional
Description
Si se establece en true, solo se devolverán números que soporten SMS.
Name
features_a2p_sms
Type
boolean
Optional
Optional
Description
Si se establece en true, solo se devolverán números que soporten A2P SMS.
Name
features_voice
Type
boolean
Optional
Optional
Description
Si se establece en true, solo se devolverán números que soporten voz.

GET

/api/numbers/available

curl -X GET "https://gateway.seven.io/api/numbers/available?country=DK" \
    -H "x-api-key: SU_CLAVE_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

Ordenar un número

Ordene un número de teléfono especificando el número deseado. La respuesta contendrá los detalles del número ordenado.

Parámetros

Name
number
Type
phonenumber
Description
El número de teléfono que se va a ordenar.
Name
payment_interval
Type
enum
Optional
Optional
Description
El intervalo de pago para el número. Los valores posibles son monthly y annually (por defecto).

POST

/api/numbers/order

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

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

GET/api/numbers/active

Números activos

Obtenga una lista de todos los números activos que están actualmente vinculados a su cuenta.

GET

/api/numbers/active

curl -X GET "https://gateway.seven.io/api/numbers/active" \
    -H "x-api-key: SU_CLAVE_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

Obtener número

Consulte un único número activo especificando el número de teléfono.

Parámetros de ruta

Name
number
Type
phonenumber
Description
El número de teléfono para el cual se deben obtener los detalles.

GET

/api/numbers/active/49176123456789

curl -X GET "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: SU_CLAVE_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

Actualizar número

Actualice los detalles de un único número activo especificando el número de teléfono. Actualmente, puede actualizar el nombre simple y establecer si desea reenviar SMS entrantes por SMS o correo electrónico. Como respuesta, recibirá los detalles del número actualizado.

Parámetros de ruta

Name
number
Type
phonenumber
Description
El número de teléfono para el cual se deben actualizar los detalles.

Parámetros

Name
friendly_name
Type
string
Optional
Optional
Description
El nombre sencillo del número.
Name
sms_forward
Type
array
Optional
Optional
Description
El número de teléfono al que se deben reenviar los SMS entrantes. Si está vacío, los SMS entrantes no se reenviarán por SMS.
Name
email_forward
Type
array
Optional
Optional
Description
La dirección de correo electrónico a la que se deben reenviar los SMS entrantes. Si está vacío, los SMS entrantes no se reenviarán por correo electrónico.
Name
slack_forward
Type
url
Optional
Optional
Description
La URI del Webhook de Slack a la que se deben reenviar los SMS entrantes. Si está vacío, los SMS entrantes no se reenviarán por Slack.

PATCH

/api/numbers/active/49176123456789

curl -X PATCH "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: SU_CLAVE_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

Eliminar número

Elimine un número activo individual especificando el número de teléfono.

Parámetros de ruta

Name
number
Type
phonenumber
Description
El número de teléfono a eliminar.

Parámetros

Name
delete_immediately
Type
boolean
Optional
Optional
Description
Si se establece en true, el número se eliminará inmediatamente. Si se establece en false, el número se eliminará al final del período de facturación actual.

DELETE

/api/numbers/active/49176123456789

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

{
    "success": true
}