Contacts

L'API Contacts vous permet de sauvegarder une liste de contacts de votre entreprise pour les réutiliser lors du passage de commande ou de la création de tickets.

Elle vous permet de lister, créer, modifier et supprimer ces contacts.

Champs de l'objet

Nom du champ	Type	Description
contact_uuid	string	Identifiant technique du contact (attribué automatiquement)
first_name	string	Prénom
last_name	string	Nom de famille
phone_number	dictionnaire	Numéro de téléphone fixe
cell_phone_number	dictionnaire	Numéro de téléphone mobile
email	list d'endpoint	Adresse email

Récupérer un contact

Pour récupérer un contact, vous pouvez faire un GET sur l'url /api/contacts/{contact_uuid}/.

Exemple:

Requête :

GET /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "Shallan",
    "last_name": "Davar",
    "phone_number": "0172841403",
    "cell_phone_number": "0692417906",
    "email": "s.davar@soulcast.com"
}

Supprimer un contact

Pour supprimer un contact, vous pouvez faire un DELETE sur l'url /api/contacts/{contact_uuid}/.

Requête :

DELETE /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Créer un contact

Pour créer un contact, vous pouvez faire un POST sur l'url /api/contacts/.

Requête :

POST /api/contacts/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Note

L'intégralité des informations doivent être envoyées au serveur.

Modifier un contact

Pour modifier un contact, vous pouvez faire un PUT sur l'url /api/contacts/{contact_uuid}/.

Requête :

PUT /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Note

L'intégralité des informations doivent être envoyées au serveur.

Lister les contacts

Pour récupérer la liste de vos contacts, vous pouvez faire un GET sur l'url /api/contacts/.

Requête :

GET /api/contacts/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "contact_uuid": "i9usbs1j",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "0142845403",
        "cell_phone_number": "0692417900",
        "email": "john@doe.com"
    },
    {
        "contact_uuid": "28ur020o",
        "first_name": "Jane",
        "last_name": "Dale",
        "phone_number": "0432244493",
        "cell_phone_number": "0674830292",
        "email": "jane@dale.com"
    },
]