Page tree
Skip to end of metadata
Go to start of metadata

Информация о текущем клиенте

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/me
ЗапросПустой
ОтветClient

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Id": 11,
    "ProjectId": 1,
    "CompanyId": 2,
    "Type": "crm",
    "Name": "Дмитрий Менделеев",
    "Online": true,
    "CustomerId": 5,
    "ChannelId": null,
    "TelegramId": null,
    "FacebookId": null,
    "VKId": null,
    "TotalTickets": 2,
    "TotalOpenTickets": 1,
    "CreatedAt": 1498085866873,
    "UpdatedAt": 1518167008390,
    "SeenAt": 1518167008390,
    "MessagedAt": null,
    "IntegrationId": "10"
  },
  "Rels": {}
}


Авторизация пользователя по сессии

ПараметрЗначениеКомментарии
МетодPOST
Путь/public/api/v1/clients/auth
Запрос
ПолеТипОбязательноеКомментарий
TokenstringДаТокен внутренний сессии на сервере чата

ОтветClientAuth

Пример запроса:

{"Token": "e71539abc4e000626c34bf981892b9acf84b84ed.f23e085bdd5d2b46e87b36fd79654727"}

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Client": {
      "Id": 11,
      "ProjectId": 1,
      "CompanyId": 2,
      "Type": "crm",
      "Name": "Дмитрий Менделеев",
      "Online": true,
      "CustomerId": 5,
      "ChannelId": null,
      "TelegramId": null,
      "FacebookId": null,
      "VKId": null,
      "TotalTickets": 2,
      "TotalOpenTickets": 1,
      "CreatedAt": 1498085866873,
      "UpdatedAt": 1518167109406,
      "SeenAt": 1518167109406,
      "MessagedAt": null,
      "IntegrationId": "10"
    },
    "Session": {
      "Id": 92,
      "ClientId": 11,
      "Token": "e71539abc4e000626c34bf981892b9acf84b84ed.f23e085bdd5d2b46e87b36fd79654727",
      "CreatedAt": 1518164878551,
      "Integration": false,
      "IntegrationHash": null,
      "IntegrationCredentials": null
    }
  },
  "Rels": {}
}

Регистрация анонимного пользователя

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/signup
Запрос
ПолеТипОбязательноеКомментарий
NamestringДаИмя клиента

ОтветClientAuth

Пример запроса:

{"Name": "John Doe"}

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Client": {
      "Id": 18,
      "ProjectId": 1,
      "CompanyId": null,
      "Type": "internal",
      "Name": "John Doe",
      "Online": false,
      "CustomerId": null,
      "ChannelId": null,
      "TelegramId": null,
      "FacebookId": null,
      "VKId": null,
      "TotalTickets": 0,
      "TotalOpenTickets": 0,
      "CreatedAt": 1518167345813,
      "UpdatedAt": 1518167345813,
      "SeenAt": null,
      "MessagedAt": null,
      "IntegrationId": null
    },
    "Session": {
      "Id": 94,
      "ClientId": 18,
      "Token": "9f0ccd578394c9ef56c660de0f6c4614cbfe9a35.a07b3b3359e0d3943e074656dcda5d28",
      "CreatedAt": 1518167345815,
      "Integration": false,
      "IntegrationHash": null,
      "IntegrationCredentials": null
    }
  },
  "Rels": {}
}

Регистрация анонимного пользователя в проекте

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/signup_in_project
Запрос
ПолеТипОбязательноеКомментарий
NamestringДаИмя клиента
ProjectstringДаНазвание проекта на английском

ОтветClientAuth

Пример запроса:

{"Name": "John Doe", "Project": "retail"}

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Client": {
      "Id": 18,
      "ProjectId": 1,
      "CompanyId": null,
      "Type": "internal",
      "Name": "John Doe",
      "Online": false,
      "CustomerId": null,
      "ChannelId": null,
      "TelegramId": null,
      "FacebookId": null,
      "VKId": null,
      "TotalTickets": 0,
      "TotalOpenTickets": 0,
      "CreatedAt": 1518167345813,
      "UpdatedAt": 1518167345813,
      "SeenAt": null,
      "MessagedAt": null,
      "IntegrationId": null
    },
    "Session": {
      "Id": 94,
      "ClientId": 18,
      "Token": "9f0ccd578394c9ef56c660de0f6c4614cbfe9a35.a07b3b3359e0d3943e074656dcda5d28",
      "CreatedAt": 1518167345815,
      "Integration": false,
      "IntegrationHash": null,
      "IntegrationCredentials": null
    }
  },
  "Rels": {}
}

Авторизация клиента через внешнюю систему

Например, авторизация клиента, информация о котором есть в ДБО или CRM.

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/integration_auth
Запрос
ПолеТипОбязательноеКомментарий
CredentialsstringДаЛюбая безопасная строка, по которой внешняя система сможет авторизовать пользователя.
ChannelstringДаНазвание канала на английском языке, например, support.

ОтветClientAuth

Пример запроса:

{"Credentials": "super-secure-token"}

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Client": {
      "Id": 1,
      "ProjectId": 1,
      "CompanyId": null,
      "Type": "crm",
      "Name": "Мартин Лютер Кинг",
      "Online": false,
      "CustomerId": 7,
      "ChannelId": null,
      "TelegramId": null,
      "FacebookId": null,
      "VKId": null,
      "TotalTickets": 15,
      "TotalOpenTickets": 0,
      "CreatedAt": 1491678852327,
      "UpdatedAt": 1517989811064,
      "SeenAt": 1516117515977,
      "MessagedAt": null,
      "IntegrationId": "1"
    },
    "Session": {
      "Id": 95,
      "ClientId": 1,
      "Token": "cd0f8d5b81358ec76db6aa50ec0424d7fd4fccc7.da3df153848575972de2e8b3ca187f2f",
      "CreatedAt": 1518167539961,
      "Integration": false,
      "IntegrationHash": null,
      "IntegrationCredentials": null
    }
  },
  "Rels": {}
}

Авторизация клиента через внешнюю систему в проекте

Например, авторизация клиента, информация о котором есть в ДБО или CRM.

ПараметрЗначениеКомментарий
МетодPOST
Путь/public/api/v1/clients/integration_auth_in_project
Запрос
ПолеТипОбязательноеКомментарий
CredentialsstringДаЛюбая безопасная строка, по которой внешняя система сможет авторизовать пользователя.
ProjectstringДаНазвание проекта на английском языке.

ОтветClientAuth

Пример запроса:

{
  "Credentials": "super-secure-token",
  "Project": "retail"
}

Пример ответа:

{
  "OK": true,
  "Error": null,
  "Result": {
    "Client": {
      "Id": 1,
      "ProjectId": 1,
      "CompanyId": null,
      "Type": "crm",
      "Name": "Мартин Лютер Кинг",
      "Online": false,
      "CustomerId": 7,
      "ChannelId": null,
      "TelegramId": null,
      "FacebookId": null,
      "VKId": null,
      "TotalTickets": 15,
      "TotalOpenTickets": 0,
      "CreatedAt": 1491678852327,
      "UpdatedAt": 1517989811064,
      "SeenAt": 1516117515977,
      "MessagedAt": null,
      "IntegrationId": "1"
    },
    "Session": {
      "Id": 95,
      "ClientId": 1,
      "Token": "cd0f8d5b81358ec76db6aa50ec0424d7fd4fccc7.da3df153848575972de2e8b3ca187f2f",
      "CreatedAt": 1518167539961,
      "Integration": false,
      "IntegrationHash": null,
      "IntegrationCredentials": null
    }
  },
  "Rels": {}
}
  • No labels