VendorCallsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| endVendorCall | POST /vendors/{vendor_id}/calls/{session_id}/end | End a call session |
| getVendorCall | GET /vendors/{vendor_id}/calls/{call_id} | Get call session details |
| initiateVendorCall | POST /vendors/{vendor_id}/calls | Initiate a call to a customer |
| listVendorCalls | GET /vendors/{vendor_id}/calls | List vendor call sessions |
| notifyVendorCall | POST /vendors/{vendor_id}/calls/{session_id}/notify | Notify customer of incoming call |
endVendorCall
MessageResponse endVendorCall(vendor_id, session_id)
End a call session
Terminates an active call session and updates its status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | String | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorCall
VendorCallWithUserResponse getVendorCall(vendor_id, call_id)
Get call session details
Retrieves details of a specific call session for the vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| call_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
initiateVendorCall
VendorInitiateCallResponse initiateVendorCall(vendor_id, VendorInitiateCallRequest)
Initiate a call to a customer
Creates a new call session to contact a customer. The vendor staff member initiating the call will be the caller, and the specified user will be the receiver.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| VendorInitiateCallRequest | VendorInitiateCallRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
listVendorCalls
PaginatedResponse_VendorCallWithUserResponse listVendorCalls(vendor_id, page, per_page, status, call_type, user_id)
List vendor call sessions
Retrieves a paginated list of call sessions for the specified vendor. Includes customer details for each call.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] | |
| status | String | [optional] [default to null] | |
| call_type | String | [optional] [default to null] | |
| user_id | Long | [optional] [default to null] |
Return type
PaginatedResponse_VendorCallWithUserResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
notifyVendorCall
MessageResponse notifyVendorCall(vendor_id, session_id)
Notify customer of incoming call
Sends a push notification to the customer about the incoming call. Should be called after initiating a call session.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | String | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8