Wix Answers Help Center
Call Center APIs
The call center API enables you to get information about the lines and the queues of your call center.
Also see Add a Phone Callback Ticket Request.
Get Call Center Lines
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines
Gets a list of all call center phone lines.
- Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Line objects
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines
Request Example Using curl:
1
curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'
Get Current Status of Call Center Line
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines/{line GUID}/schedule/openState
Get whether a line is operating, according to its schedule. The line ID is specified in the URL.
Note: This works only for lines configured with a schedule based on a Schedule object. See Line object for details.
- Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: A structure, see below
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/schedule/openState
Response Example:
The response is a structure that contains the following parameters.
Response Params | Description | Type |
---|---|---|
isOpen | Whether the line is currently available, according to the schedule | Boolean |
nextStatusChangeDateUTC | The next time that the current status of isOpen is scheduled to change Note that the schedule could change after you make this request. Therefore, for accurate information, you should send this request periodically. If the status will not change in the next 7 days, this field is not returned. | The time is relative to UTC. |
isDefaultFallback | When false, the schedule id was found. When true, the schedule id was not found and the above information came from the default schedule (which defaults to open 24/7). | Boolean |
1 2 3 4 5
{ "isOpen": true, "nextStatusChangeDateUTC": 1568193387000, "isDefaultFallback": false }
Get Call Center Queues
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues
Get a list of all call center queues.
- Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Queue objects
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues
Request Example Using curl:
1
curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'
Get Current Status of Call Center Queue
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues/{queue GUID}/schedule/openState
Get whether a queue is operating, according to its schedule. The queue ID is specified in the URL.
Note: This works only for queues configured with a schedule based on a Schedule object. See Queue object for details.
- Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: A structure, see below
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/schedule/openState
Response Example:
The response is a structure that contains the following parameters.
Response Params | Description | Type |
---|---|---|
isOpen | Whether the queue is currently available, according to the schedule | Boolean |
nextStatusChangeDateUTC | The next time that the current status of isOpen is scheduled to change Note that the schedule could change after you make this request. Therefore, for accurate information, you should send this request periodically. If the status will not change in the next 7 days, this field is not returned. | The time is relative to UTC. |
isDefaultFallback | When false, the schedule id was found. When true, the schedule id was not found and the above information came from the default schedule (which defaults to open 24/7). | Boolean |
1 2 3 4 5
{ "isOpen": true, "nextStatusChangeDateUTC": 1568193387000, "isDefaultFallback": false }
Was this article helpful?