Numéros

Explorez des documentations détaillées sur l'utilisation de notre API de gestion des numéros pour un contrôle complet sur la recherche, la réservation et la gestion des numéros de votre compte.

GET/api/numbers/available

Numéros disponibles

Ce point de terminaison vous permet de rechercher des numéros disponibles, basés sur les critères de recherche fournis. Les critères de recherche peuvent inclure le code pays, l'indicatif régional et les fonctionnalités prises en charge. La réponse contiendra une liste de numéros de téléphone disponibles correspondant aux critères de recherche.

Paramètres

Name
country
Type
string
Optional
Optional
Description
Le code pays ISO 3166-1 alpha-2 du pays dans lequel rechercher des numéros disponibles.
Name
features_sms
Type
boolean
Optional
Optional
Description
Si défini sur true, seuls les numéros prenant en charge les SMS seront retournés.
Name
features_a2p_sms
Type
boolean
Optional
Optional
Description
Si défini sur true, seuls les numéros prenant en charge les SMS A2P seront retournés.
Name
features_voice
Type
boolean
Optional
Optional
Description
Si défini sur true, seuls les numéros prenant en charge la voix seront retournés.

GET

/api/numbers/available

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

{
    "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

Commander un numéro

Commandez un numéro de téléphone en spécifiant le numéro souhaité. La réponse contiendra les détails du numéro commandé.

Paramètres

Name
number
Type
phonenumber
Description
Le numéro de téléphone à commander.
Name
payment_interval
Type
enum
Optional
Optional
Description
L'intervalle de paiement pour le numéro. Les valeurs possibles sont monthly et annually (par défaut).

POST

/api/numbers/order

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

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

GET/api/numbers/active

Numéros actifs

Obtenez une liste de tous les numéros actifs actuellement associés à votre compte.

GET

/api/numbers/active

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

{
    "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

Récupérer un numéro

Interrogez un seul numéro actif en spécifiant le numéro de téléphone.

Paramètres de chemin

Name
number
Type
phonenumber
Description
Le numéro de téléphone pour lequel récupérer les détails.

GET

/api/numbers/active/49176123456789

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

{
    "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

Mettre à jour un numéro

Mettez à jour les détails d'un seul numéro actif en spécifiant le numéro de téléphone. Actuellement, vous pouvez mettre à jour le nom simple et définir si vous souhaitez ou non rediriger les SMS entrants par SMS ou par e-mail. En réponse, vous recevrez les détails mis à jour du numéro.

Paramètres de chemin

Name
number
Type
phonenumber
Description
Le numéro de téléphone pour lequel les détails doivent être mis à jour.

Paramètres

Name
friendly_name
Type
string
Optional
Optional
Description
Le nom simple du numéro.
Name
sms_forward
Type
array
Optional
Optional
Description
Le numéro de téléphone vers lequel les SMS entrants doivent être transférés. Si vide, les SMS entrants ne seront pas transférés par SMS.
Name
email_forward
Type
array
Optional
Optional
Description
L'adresse e-mail vers laquelle les SMS entrants doivent être transférés. Si vide, les SMS entrants ne seront pas transférés par e-mail.
Name
slack_forward
Type
url
Optional
Optional
Description
L'URI du webhook Slack vers lequel les SMS entrants doivent être transférés. Si vide, les SMS entrants ne seront pas transférés par Slack.

PATCH

/api/numbers/active/49176123456789

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

Supprimer un numéro

Supprimez un numéro actif unique en spécifiant le numéro de téléphone.

Paramètres de chemin

Name
number
Type
phonenumber
Description
Le numéro de téléphone à supprimer.

Paramètres

Name
delete_immediately
Type
boolean
Optional
Optional
Description
Si défini sur true, le numéro sera supprimé immédiatement. Si défini sur false, le numéro sera supprimé à la fin de la période de facturation en cours.

DELETE

/api/numbers/active/49176123456789

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

{
    "success": true
}