Rufnummern

Erkunden Sie detaillierte Dokumentationen zur Nutzung unserer Nummernverwaltungs-API für eine umfassende Kontrolle über die Suche, Buchung und Verwaltung der Rufnummern Ihres Accounts.


GET/api/numbers/available

Verfügbare Nummern

Dieser Endpunkt ermöglicht es Ihnen, nach verfügbaren Rufnummern zu suchen, basierend auf den bereitgestellten Suchkriterien. Die Suchkriterien können den Ländercode, die Vorwahl und die unterstützden Features umfassen. Die Antwort wird eine Liste von verfügbaren Telefonnummern enthalten, die den Suchkriterien entsprechen.

Parameter

  • Name
    country
    Type
    string
    Optional
    Optional
    Description

    Der ISO 3166-1 alpha-2 Ländercode des Landes, in dem nach verfügbaren Nummern gesucht werden soll.

  • Name
    features_sms
    Type
    boolean
    Optional
    Optional
    Description

    Wenn auf true gesetzt, werden nur Nummern zurückgegeben, die SMS unterstützen.

  • Name
    features_a2p_sms
    Type
    boolean
    Optional
    Optional
    Description

    Wenn auf true gesetzt, werden nur Nummern zurückgegeben, die A2P SMS unterstützen.

  • Name
    features_voice
    Type
    boolean
    Optional
    Optional
    Description

    Wenn auf true gesetzt, werden nur Nummern zurückgegeben, die Voice unterstützen.

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

Bestellen Sie eine Nummer

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

Parameter

  • Name
    number
    Type
    phonenumber
    Description

    Die Telefonnummer, die bestellt werden soll.

  • Name
    payment_interval
    Type
    enum
    Optional
    Optional
    Description

    Das Zahlungsintervall für die Nummer. Mögliche Werte sind monthly und annually (Standard).

POST
/api/numbers/available
curl -X POST "https://gateway.seven.io/api/numbers/order" \
    -H "x-api-key: YOUR_API_KEY" \
    -d 'number=4523854818'
{
    "success": true,
    "error": null,
}

GET/api/numbers/active

Aktive Nummern

Erhalten Sie eine Liste aller aktiven Nummern, die derzeit mit Ihrem Konto verknüpft sind.

GET
/api/numbers/active
curl -X GET "https://gateway.seven.io/api/numbers/active" \
    -H "x-api-key: YOUR_API_KEY"
{
    "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
                }
            },
            "expires": null,
            "created": "2024-01-31 17:06:27"
        },
        {
            // ...
        }
    ]
}

GET/api/numbers/active/:number

Nummer abrufen

Fragen Sie eine einzelne aktive Nummer ab, indem Sie die Telefonnummer angeben.

Pfadparameter

  • Name
    number
    Type
    phonenumber
    Description

    Die Telefonnummer, für die Details abgerufen werden sollen.

GET
/api/numbers/active/49176123456789
curl -X GET "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: YOUR_API_KEY"
{
    "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
        }
    },
    "expires": null,
    "created": "2024-01-31 17:06:27"
}

PATCH/api/numbers/active/:number

Nummer aktualisieren

Aktualisieren Sie die Details einer einzelnen aktiven Nummer, indem Sie die Telefonnummer angeben. Derzeit können Sie den einfachen Namen aktualisieren und festlegen, ob Sie eingehende SMS per SMS oder E-Mail weiterleiten möchten oder nicht. Als Antwort erhalten Sie die aktualisierten Nummerndetails.

Pfadparameter

  • Name
    number
    Type
    phonenumber
    Description

    Die Telefonnummer, für die Details aktualisiert werden sollen.

Parameter

  • Name
    friendly_name
    Type
    string
    Optional
    Optional
    Description

    Die einfache Name der Nummer.

  • Name
    sms_forward
    Type
    array
    Optional
    Optional
    Description

    Die Telefonnummer, an die eingehende SMS weitergeleitet werden sollen. Wenn leer, werden eingehende SMS nicht per SMS weitergeleitet.

  • Name
    email_forward
    Type
    array
    Optional
    Optional
    Description

    Die E-Mail-Adresse, an die eingehende SMS weitergeleitet werden sollen. Wenn leer, werden eingehende SMS nicht per E-Mail weitergeleitet.

PATCH
/api/numbers/active/49176123456789
curl -X PATCH "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: YOUR_API_KEY" \
    -d 'friendly_name=New Friendly Name'
{
        "country": "DE",
        "number": "49176123456789",
        "friendly_name": "New 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": [
                    "49176123456789"
                ],
                "enabled": true
            },
            "email": {
                "address": [
                    "j.doe@acme.inc",
                    "john@doe.com"
                ],
                "enabled": true
            }
        },
        "expires": null,
        "created": "2024-01-31 17:06:27"
    }

DELETE/api/numbers/active/:number

Nummer löschen

Löschen Sie eine einzelne aktive Nummer, indem Sie die Telefonnummer angeben.

Pfadparameter

  • Name
    number
    Type
    phonenumber
    Description

    Die zu löschende Telefonnummer.

Parameter

  • Name
    delete_immediately
    Type
    boolean
    Optional
    Optional
    Description

    Wenn auf true gesetzt, wird die Nummer sofort gelöscht. Wenn auf false gesetzt, wird die Nummer am Ende des aktuellen Abrechnungszeitraums gelöscht.

DELETE
/api/numbers/active/49176123456789
curl -X DELETE "https://gateway.seven.io/api/numbers/active/49176123456789" \
    -H "x-api-key: YOUR_API_KEY"
{
    "success": true
}
Zuletzt aktualisiert: Vor 5 Monaten