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