Gurulize API Dökümantasyonu

Kayıt (Register)

Kayıt talebi sadece POST metodu ile yapılmalıdır.

Talepte bulunulacak URL müşteri ile paylaşılacaktır.

Parametreler

username: müşteriye verilen kullanıcı adı
    password: müşteriye verilen parola
    caller: arayan telefon numarası. Nümerik ve 5xxyyyzztt seklinde olmalı
    callee: aranan telefon numarası. Nümerik ve 5xxyyyzztt seklinde olmalı
    duration: konuşma için istenen saniye olarak maksimum süre. Konuşma bu süreye
ulaştığında kesilir. Numerik olmalıdır
    lang: (en, tr) hata mesajlarının hangi dilde alınacağı. Sadece Türkçe ve İngilizce var,
varsayılan İngilizce

Yanıt (Response)

Cevaplar JSON formatında döner. "success" alanında boolean olarak isteğin kaydının yapılıp yapılamadığı kontrol edilebilir. İşlem sonucu ile ilgili bir açıklama "message" alanından görülebilir.

İstek alınırken bir problem oluşursa şunlara benzer bir cevap döner;

{
    "success": false,
    "message": "Eksik Parametre (username)"
}

{
    "success": false,
    "message": "Geçersiz Parametre (caller): Telefon numarası değil"
}

{
    "success": false,
    "message": "Kullanıcı Bilgileri Geçersiz"
}

İstek başarılı bir şekilde kaydedilmişse. Cevapta ayrıca, daha sonra isteğin durumu ile ilgili bilgilerin paylaşılmasında kullanılacak bir istek tanımlayıcı, "id" alanında döner.

{
    "success": true,
    "message": "Talep Alındı",
    "id": 2
}