CallsQr#

גרסת בטא

הפונקציונליות נמצאת בגרסת בטא. הפונקציות עשויות להשתנות ועלולות לפעול באופן לא יציב. ייתכן שבעתיד תיגבה תשלום נוסף עבור הפונקציונליות.
ניתן לבקש גישה לפונקציונליות דרך התמיכה הטכנית של GREEN-API

השיטה מיועדת לקבלת קוד ה-QR הנדרש להרשאת סשן השיחות.

קוד ה-QR מתעדכן כל 20 שניות, ולכן מומלץ לקרוא לשיטת קבלת קוד ה-QR במרווח של שנייה אחת.

בקשה#

כדי לקבל את קוד ה-QR, יש לבצע בקשה לכתובת:

GET

{{apiUrl}}/waInstance{{idInstance}}/callsQr/{{apiTokenInstance}}

הבקשה מתבצעת ללא פרמטרים.

לקבלת פרמטרי הבקשה apiUrl, idInstance ו-apiTokenInstance, עיינו בסעיף לפני שמתחילים.

תגובה#

שדות התגובה#

שדה	סוג	תיאור
`type`	string	סוג ההודעה, ערכים אפשריים: `qrCode`, `alreadyLogged`, `error`
`message`	string	תוכן ההודעה. הפורמט תלוי בערך השדה `type`

התקבלה תמונת קוד QR#

שדה	סוג	תיאור
`type`	string	`qrCode` — התקבלה תמונת קוד QR
`message`	string	תמונת קוד QR בגודל 256×256 בפורמט `PNG`, מקודדת ב-`base64`. זוהי תמונה מוכנה, ולא מחרוזת עם תוכן קוד ה-QR. להצגה בדפדפן יש להוסיף את המחרוזת `data:image/png;base64, {message}`

הסשן כבר מורשה#

שדה	סוג	תיאור
`type`	string	`alreadyLogged` — סשן השיחות כבר מורשה. כדי לקבל קוד QR חדש, יש לבצע תחילה logout לסשן באמצעות השיטה CallsLogout
`message`	string	מקבל את הערך `instance account already authorized`

אירעה שגיאה#

שדה	סוג	תיאור
`type`	string	`error` — אירעה שגיאה
`message`	string	תיאור השגיאה
		`Instance starting` — המופע נמצא בתהליך הפעלה
		`unexpected agent state: unknown` — סוכן השיחות נמצא במצב לא ידוע

שגיאות#

לרשימת השגיאות המשותפות לכל השיטות, עיינו בסעיף שגיאות נפוצות.

דוגמאות קוד#

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/callsQr/{{apiTokenInstance}}"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/callsQr/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsQr/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsQr/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);