WORKSECTION

Учасники

Отриманная списку користувачів через API: get_users

Приклад get_users запиту

?action=get_users
Повертає дані користувачів акаунту
Повертаються наступні дані:
  • id — ID користувача
  • first_name — ім'я користувача
  • last_name — прізвище користувача
  • name — ім'я та прізвище користувача
  • title — посада користувача
  • url — url адреса користувача
  • services — об'єкт з двох інших вкладених об'єктів: chats (месенджери) та socials (соцмережі)
  • contacts — інфо з поля "Інші контакти"
    *не повертається, якщо пусте
  • data_added — дата та час надсилання запрошення користувачеві
    *повертається при використанні адмінського токену
  • rate — ставка користувача (якщо вказано)
  • avatar — посилання на зображення аватарки користувача
  • group — назва команди
  • department — назва відділу
  • role — роль користувача:
    • owner — власник
    account admin — адміністратор акаунту
    team admin — адміністратор команди
    department admin — адміністратор відділу
    user — користувач
    guest — гість
    reader — читач
  • email — email користувача
  • phone — основний номер телефону (якщо вказано)
  • phone2 — робочий номер телефону (якщо вказано)
  • phone3 — мобільний номер телефону (якщо вказано)
  • phone4 — домашній номер телефону (якщо вказано)
  • address — адреса (якщо вказано)
  • address2 — додаткова адреса (якщо вказано)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "USER_ID",
            "first_name": "USER_FIRST_NAME_1",
            "last_name": "USER_LAST_NAME_1",
            "name": "USER_NAME",
            "title": "USER_POSITION",
            "url": "USER_URL",
            "services": {
                "chats": {
                    "WhatsApp": "...",
                    ... ... ...
                },
                "socials": {
                    "LinkedIn": "...",
                    ... ... ...
                }
            },
            "contacts": "USER_OTHER_CONTACTS",
            "date_added": "YYYY-MM-DD HH:MM",
            "rate": USER_RATE,

            "avatar": "URL",
            "group": "USER_GROUP",
            "department": "USER_DEPARTMENT",
            "role": "USER_ROLE",
            "email": "USER_EMAIL",
            "phone": "USER_PHONE",
            "phone2": "USER_PHONE_2",
            "phone3": "USER_PHONE_3",
            "address": "USER_ADDRESS",
            "address2": "USER_ADDRESS_2"
        },
        {
            "id": "USER_ID",
            "first_name": "USER_FIRST_NAME_2",
            "last_name": "USER_LAST_NAME_2",
            ... ... ...
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Запрошення користувача до акаунту через API: add_user

Приклад add_user запиту

?action=add_user&email=USER_EMAIL
Запрошення до акаунту нового користувача
*до вашої команди, якщо не вказано параметр group

Обов'язкові параметри:
  • email — email користувача

Необов'язкові параметри:
  • first_name — ім'я користувача
  • last_name — прізвище користувача
  • title — посада користувача
  • group — назва команди
  • department — назва відділу
  • role — роль користувача. Доступні варіанти:
user — користувач
guest — гість
reader — читач
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "USER_ID",
        "first_name": "USER_FIRST_NAME",
        "last_name": "USER_LAST_NAME",
        "name": "USER_NAME",
        "title": "USER_POSITION",
        "avatar": "URL",
        "group": "GROUP_NAME",
        "department": "USER_DEPARTMENT",
        "role": "USER_ROLE",
        "email": "USER_EMAIL"
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Отримання списку команд учасників через API: get_user_groups

Приклад get_user_groups запиту

?action=get_user_groups
Повертає список команд учасників акаунту
Повертаються наступні дані:
  • id — ID команди
  • title — назва команди
  • client — тип команди:
0 — внутрішня команда компанії
1 — клієнтська команда

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 0
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 1
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Створення команди для учасників акаунту через API: add_user_group

Приклад add_user_group запиту 

?action=add_user_group&title=USER_GROUP
Створює команду
*при відсутності команди з аналогічною назвою

Обов'язкові параметри:
  • title — назва команди

Необов'язкові параметри:
  • client — 1 для клієнтської команди та 0 для команди компанії
Приклад JSON відповіді
При успішному виконанні, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "GROUP_ID",
        "title": "USER_GROUP_NAME",
        "type": "company",
        "client": 1
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Отриманная списку контактів через API: get_contacts

Приклад get_contacts запиту

?action=get_contacts 
Повертає дані по контактах акаунту
Повертаються наступні дані:
  • id — ID контакту
  • first_name — ім'я контакту
  • last_name — прізвище контакту
  • name — ім'я та прізвище контакту
  • title — посада контакту
  • url — url адреса контакту
  • services — об'єкт з двох інших вкладених об'єктів: chats (месенджери) та socials (соцмережі)
  • contacts — інфо з поля "Інші контакти"
    *не повертається, якщо пусте
  • data_added — дата та час додавання контакту
    *повертається при використанні адмінського токену
  • group — назва папки контактів
  • email — email контакту
  • phone — основний номер телефону (якщо вказано)
  • phone2 — робочий номер телефону (якщо вказано)
  • phone3 — мобільний номер телефону (якщо вказано)
  • phone4 — домашній номер телефону (якщо вказано)
  • address — адреса (якщо вказано)
  • address2 — додаткова адреса (якщо вказано)

Приклад JSON відповіді
При успішному виконанні, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "CONTACT_ID",
            "first_name": "CONTACT_FIRST_NAME",
            "last_name": "CONTACT_LAST_NAME",
            "name": "CONTACT_NAME",
            "title": "CONTACT_POSITION",
            "url": "CONTACT_URL",
            "services": {
                "chats": {
                    "WhatsApp": "...",
                    ... ... ...
                },
                "socials": {
                    "LinkedIn": "...",
                    ... ... ...
                }
            },
            "contacts": "CONTACT_OTHER_CONTACTS",
            "date_added": "YYYY-MM-DD HH:MM",
            "group": "CONTACT_GROUP",
            "email": "CONTACT_EMAIL",
            "phone": "CONTACT_PHONE",
            "phone2": "CONTACT_PHONE_2",
            "phone3": "CONTACT_PHONE_3",
            "phone4": "CONTACT_PHONE_4",
            "address": "CONTACT_ADDRESS",
            "address2": "CONTACT_ADDRESS_2"
        },
        {
            "id": "CONTACT_ID",
            "first_name": "CONTACT_FIRST_NAME",
            "last_name": "CONTACT_LAST_NAME",
            ... ... ...
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Створення контакту через API: add_contact

Приклад add_contact запиту

?action=add_contact&name=CONTACT_NAME&email=CONTACT_EMAIL
Створює контакт
*не має доступу до акаунту

Обов'язкові параметри:
  • email — email контакту
  • name — ім'я та прізвище контакту

Необов'язкові параметри:
  • title — посада контакту
  • group — назва папки контактів
  • phone — основний номер телефону контакту
  • phone2 — робочий номер телефону
  • phone3 — мобільний номер телефону
  • phone4 — домашній номер телефону
  • address — адреса контакту
  • address2 — додаткова адреса контакту
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "CONTACT_ID",
        "first_name": "CONTACT_FIRST_NAME",
        "last_name": "CONTACT_LAST_NAME",
        "name": "CONTACT_NAME",
        "title": "CONTACT_POSITION",
        "group": "GROUP_NAME",
        "email": "CONTACT_EMAIL",
        "phone": "CONTACT_PHONE",
        "phone2": "CONTACT_PHONE_2",
        "phone3": "CONTACT_PHONE_3",
        "phone4": "CONTACT_PHONE_4",
        "address": "CONTACT_ADDRESS",
        "address2": "CONTACT_ADDRESS_2"
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Отримання списку папок для контактів через API: get_contact_groups

Приклад get_contact_groups запиту

?action=get_contact_groups
Повертає дані по папках для контактів акаунту
Повертаються наступні дані:
  • id — ID папки
  • title — назва папки
  • type — тип папки:
preset — папка для контактів, створена за замовчуванням
folder — папка для контактів, створена учасником акаунту

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "preset"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "folder"
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Створення папки для контактів через API: add_contact_group

Приклад add_contact_group запиту

?action=add_contact_group&title=CONTACT_GROUP
Створює папку для контактів
*при відсутності папки з аналогічною назвою

Обов'язкові параметри:
  • title — назва папки для контактів
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "CONTACT_GROUP_ID",
        "title": "CONTACT_GROUP",
        "type": "folder"
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Підписати користувача на задачу через API: subscribe

Приклад subscribe запиту

?action=subscribe&id_task=TASK_ID&email_user=USER_EMAIL
Підписує користувача на зазначене завдання
*список підписників завдання можна отримати через метод get_task при зазначенні параметра extra=subscribers

Обов'язкові параметри:
  • id_task — ID завдання
  • email_user — email користувача
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Ця стаття була вам корисною? Так, дякую! Ні

Відписати користувача від задачі через API: unsubscribe

Приклад unsubscribe запиту

?action=unsubscribe&id_task=TASK_ID&email_user=USER_EMAIL
Відписує користувача від зазначеного завдання
*список підписників завдання можна отримати через метод get_task при зазначенні параметра extra=subscribers

Обов'язкові параметри:
  • id_task — ID завдання
  • email_user — email користувача
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Ця стаття була вам корисною? Так, дякую! Ні

Отримання інформації про авторизованого користувача через API: me

Приклад me запиту

?action=me
Повертає інформацію про авторизованого користувача (oauth2)

метод доступний тільки при використанні токена доступу
Повертаються наступні дані:
  • id — ID користувача
  • first_name — ім'я користувача
  • last_name — прізвище користувача
  • name — ім'я та прізвище користувача
  • title — посада користувача
  • avatar — посилання на зображення аватарки користувача
  • group — назва команди
  • department — назва відділу
  • role — роль користувача:
    • owner — власник
    account admin — адміністратор акаунту
    team admin — адміністратор команди
    department admin — адміністратор відділу
    user — користувач
    guest — гість
    reader — читач
  • email — email користувача
  • phone — основний номер телефону (якщо вказано)
  • phone2 — робочий номер телефону (якщо вказано)
  • phone3 — мобільний номер телефону (якщо вказано)
  • phone4 — домашній номер телефону (якщо вказано)
  • address — адреса (якщо вказано)
  • address2 — додаткова адреса (якщо вказано)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "USER_ID",
            "first_name": "USER_FIRST_NAME_1",
            "last_name": "USER_LAST_NAME_1",
            "name": "USER_NAME",
            "title": "USER_POSITION",
            "rate": USER_RATE,
            "avatar": "URL",
            "group": "USER_GROUP",
            "department": "USER_DEPARTMENT",
            "role": "USER_ROLE",
            "email": "USER_EMAIL",
            "phone": "USER_PHONE",
            "phone2": "USER_PHONE_2",
            "phone3": "USER_PHONE_3",
            "address": "USER_ADDRESS",
            "address2": "USER_ADDRESS_2"
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні
esc
или
Роздрукувати