Call Update

POST /telephony/calls/@channelKey/

---

URL Example

https://system_domain/api/v2/telephony/calls/@channelKey/

---

Request Body Parameters (form-data)

Parameter	Type	Required	Description
action	string	Yes	update_call - this value must be used to update a call
сall_id	number	Yes	Call ID in the system
call_status	string	Yes	Call status, see description below
pbx_call_id	string number	No	Call ID from the PBX
pbx_user_id	string number	No	User ID from the PBX
user_id	number	No	Employee ID in the system
audio_record	file (mp3/mp4/wav/ogg)	No	Call recording
сomment	string	No	Comment for the ticket

Description of the call_status Parameter

Available values:

1. ringing
2. in-progress
3. canceled
4. missed
5. failed
6. answered
7. busy

The ringing and in-progress statuses are active call statuses, meaning the user will be shown the call card. The remaining statuses are final call statuses and hide the call card.

---

Request Body Example (form-data)

Request to update a call

Key	Value
action	update_call
call_id	345
call_status	ringing
user_id	1
comment	Very important call!

info

Only one of the following parameter pairs can be passed at a time:

call_id or pbx_call_id

user_id or pbx_user_id – these parameters link the call to a specific user and assign them as the assignee/performer in the ticket.

---

Response Example

{
    "data": {
        "call_id": 123,
        "pbx_call_id": null,
        "user_id": 0,
        "pbx_user_id": null,
        "call_status": "ringing",
        "audio_record": null,
        "ticket_id": 4567
    }
}