Метод: POST
Authorization: Bearer Token (Метод для получения токена по логину и паролю)
URL: https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel?autoCallId=897f97a4-4bb5-4b8d-ae8b-703193934cc0&force=false&clientExternalId=ce0dc96c-5b5a-4245-a7f8-cfa42922c589 |
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/cancel?autoCallId=897f97a4-4bb5-4b8d-ae8b-703193934cc0&force=true |
Описание параметров метода:
| Параметр | Тип параметра | Обязательность | Описание |
|---|---|---|---|
| autoCallId | string | да | Указывается UUID задания на обзвон в котором требуется удалить номер |
| phone | int | да, если значение force=false | Указывается номер телефона(ов), который требуется удалить. |
| clientExternalId | string | да, если значение force=false | uuid кандидата(ов), по которому производится отмена |
| force | bool | да | В случае если передается значение true, все звонки в задании на обзовн будут отменены |
При успешном выполнении метода придет ответ с кодом 200 без тела.
В случае если вы попытались удалить номер, который уже удален из задания прейдет ответ с кодом 200 и телом:
| Блок кода | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
[
{
"candidateId": "1503c740-c7ff-490c-ba86-ba9f07f9ed4b",
"status": 422,
"content": "Candidate can not be canceled"
}
]
|