3.1.9 Получить статус пользователей (в интеграции)
POST /v1/users/state Header[X-Mango-API-Token]
Параметры запроса:
| Параметр | Тип | Обяза-тель-ность | Формат | Описание |
|---|---|---|---|---|
| User | object | Нет | ||
| Userext | string | Нет | \d | Внутренний номер сотрудника в ВАТС, в случае отсутствия параметра будет выводить полный список пользователей |
Пример запроса:
{
"ext": "8000"
}
Параметры ответа:
| Параметр | Тип | Описание |
|---|---|---|
| Result | object | |
| Resultcode | integer | |
| Resultmessage | string | |
| Data | object | |
| Dataregistred | boolean | зарегистрирован / не зарегистрирован вебсокет |
| DataState | object | состояние пользователя |
| DataState[ext] | string | Идентификатор пользователя |
| DataState[callid] | string | ID звонка |
| DataState[entryid] | string | |
| DataState[callType] | string | Входящий / Исходящий / Внутренний |
| DataState[phone] | string | Звонок на номер |
| DataState[caller] | string | Звонящий |
| DataState[state] | string | Состояние пользователя: APPEARED, CONNECTED, ON_HOLD, FREE |
Возможны следующие HTTP коды ответа:
- 200 - Resultcode=0
- 200 - статусов нет
- 401 - Ключ интеграции не прошел валидацию. Resultcode=103
- 400 - Userext не задан. Resultcode=103, Resultmessage="User not found"
- 400 - ошибка парсинга JSON запроса
- 500 - ошибка сервера
Пример ответа:
{
"result": {
"code": "0",
"message": "OK"
},
"data":
[{
"state": {
"ext": "8000",
"callId": "MToxMDAxMzAxOTozODE6NTY1NjQxNzEy",
"entryId": "MzE4MDc3NjgyMzozODE=",
"callType": "OUTBOUND",
"phone": "79269226127",
"caller": "8000",
"state": "CONNECTED"
},
"registred": true
}
]
}