Метод: POST
Authorization: Bearer Token (Метод для получения токена по логину и паролю)
URL: https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel
Пример запроса удаления кандидата по номеру телефона
https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel?autoCallId=bce7d22e-dde6-4427-b391-ebbdfda44de6&phone=74992868344
Пример запроса удаление всех телефонов из задания
https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel?autoCallId=bce7d22e-dde6-4427-b391-ebbdfda44de6&force=true
Описание параметров метода:
| Параметр | Тип параметра | Обязательность | Описание |
|---|---|---|---|
| autoCallId | string | да | Указывается ID задания на обзвон в котором требуется удалить номер |
| phone | int | да, если force не передается в запросе | Указывается номер телефона(ов), который требуется удалить. Например: Если в запросе force=false |
| clientExternalId | string | да, если force не передается в запросе | ID кандидата(ов), по которому производится отмена. Например: Если в запросе force=false |
| force | bool | нет | В случае если передается значение true, все звонки в задании на обзвон будут отменены |
При успешном выполнении метода придет ответ с кодом 200 без тела.
В случае если вы попытались удалить номер, который уже удален из задания прейдет ответ с кодом 200 и телом:
Пример ответа при попытки удалить ранее удаленный номер
[
{
"candidateId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"status": 422,
"content": "Candidate can not be canceled"
}
]