Skip to content

RemoveFromQueueNotificationWebhook.md

Latest commit

 

History

History
36 lines (24 loc) · 2.14 KB

RemoveFromQueueNotificationWebhook.md

File metadata and controls

36 lines (24 loc) · 2.14 KB

RemoveFromQueueNotificationWebhook

A call has been removed from a queue and the Enqueue command’s actionUrl is being invoked. A PerCL response is expected except if reason is hangup.

Properties

Name Type Description Notes
requestType String Context or reason why this request is being made. Will be removeFromQueueNotification - A Call has been removed from a Queue and the Enqueue command’s actionUrl is being invoked. [optional]
accountId String Account ID associated with your account. [optional]
callId String Unique identifier for this Call, generated by FreeClimb [optional]
from String Phone number of the party that initiated the Call (in E.164 format). [optional]
to String Phone number provisioned to the customer and to which this Call is directed (in E.164 format). [optional]
callStatus CallStatus [optional]
direction CallDirection [optional]
conferenceId String This is only populated if request pertains to a conference. Otherwise, it is set to null. [optional]
queueId String This is only populated if the request pertains to a queue. Otherwise, it is set to null. [optional]
queueResult QueueResultStatus [optional]
queueTime Integer Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued. [optional]

Example

import com.github.freeclimbapi.JSON;
import com.github.freeclimbapi.models.RemoveFromQueueNotificationWebhook;

String json = "{\"requestType\":\"removeFromQueueNotification\",\"accountId\":\"string\",\"callId\":\"string\",\"from\":\"string\",\"to\":\"string\",\"callStatus\":\"queued\",\"direction\":\"inbound\",\"conferenceId\":\"string\",\"queueId\":\"string\",\"queueResult\":\"queueFull\",\"queueTime\":0}";

// create an instance of RemoveFromQueueNotificationWebhook from a JSON string
RemoveFromQueueNotificationWebhook removeFromQueueNotificationWebhook = new JSON().getGson().fromJson(json, RemoveFromQueueNotificationWebhook.class);