To effectively manage call requests in Venddor IO, it's essential to be familiar with the API endpoints and associated functionalities. This guide provides an overview of managing customer call-back requests through the Venddor IO API.
Call requests are a valuable tool for improving customer engagement and satisfaction. They allow customers to request a call from your support team at a convenient time.
URL: http://example.com/api/2.0/call_requests/
Purpose: Reference all call requests
Supported Methods: GET, POST
URL: http://example.com/api/2.0/call_requests/:id
Purpose: Address a specific call request
Supported Methods: GET, PUT, DELETE
Venddor IO facilitates efficient retrieval of call requests with tailored attributes via specific parameters:
| Parameter | Default | Description |
|---|---|---|
| page | 1 | The page number of the results |
| items_per_page | 10 | Number of items to display per page |
| sort_by | date | Field to sort results by |
| sort_order | desc | Sorting order (asc or desc) |
| order_exists | — | Filter by calls with (Y) or without (N) associated orders |
Examples:
Retrieve 20 call requests from the 1st page:
http://example.com/api/2.0/call_requests?items_per_page=20
Fetch 20 call requests from the 5th page, excluding associated orders:
http://example.com/api/2.0/call_requests?page=5&items_per_page=20&order_exists=N
Venddor IO call requests encompass various properties. Mandatory fields are marked with an asterisk (*).
The email field becomes mandatory when no phone number is provided. Conversely, the phone field is required in the absence of an email. Each field has unique attributes and valid methods, ensuring data integrity and relevance.
curl -X GET 'http://example.com/api/2.0/call_requests/'
curl -X GET 'http://example.com/api/2.0/call_requests/1'
curl -H "Content-Type: application/json" -X POST http://example.com/api/2.0/call_requests -d '{"phone":"+7(999)111-22-33", "name":"John Doe", "time_from":"9:00", "time_to":"10:00"}'
curl -H "Content-Type: application/json" -X PUT http://example.com/api/2.0/call_requests/5 -d '{"status":"no_answer", "notes":"John didn't answer the call"}'
curl -X DELETE 'http://example.com/api/2.0/call_requests/5'
Venddor IO's module-based structure provides a comprehensive platform for managing call requests. Developers and administrators can seamlessly navigate, create, update, and delete call requests using the provided API endpoints and parameters, ensuring efficient call request management.
Remember to handle customer data in compliance with relevant privacy regulations when working with call requests, as they often contain personal information like names and phone numbers.