Wipple CPaaS
メニュー
Function リファレンス / Enqueue

Enqueue

{
    "verb": "enqueue",
    "name": "support",
    "actionHook": "/queue-action",
    "waitHook": "/queue-wait"
}

パラメータ

actionHookstring

操作が完了したときに呼び出される Webhook。

  • 通話が leave Function によってキューから取り出された場合、Webhook は直ちに呼び出されます。
  • 通話が dequeue Function によって相手側にブリッジされた場合、Webhook は双方が切断した後に呼び出されます。
  • Webhook が指定されていない場合、現在のアプリケーションの次の Function から実行が続行されます。
    指定されるリクエストパラメータについては後述を参照してください。

namestring必須

キューの名前。


prioritynumber

(0.8.3-4 で追加)0 から 999 までの任意の優先度の値。
通話は優先度の低い順から高い順にキューから取り出されます。
デフォルト: 999。


waitHookstring

発信者がキューにいる間に呼び出される Webhook。
この Webhook から返されるアプリケーションで許可される Function は say、play、pause、leave のみです。
追加のリクエストパラメータについては後述を参照してください。


actionHook のプロパティ

  • queueSid: キューの一意の識別子
  • queueResult: 完了理由:
  • 'hangup' - キューにいる間に通話が放棄された
  • 'leave' - leave Function により通話がキューから出た
  • 'bridged' - dequeue Function により通話が別の通話にブリッジされた
  • 'error' - 何らかのシステムエラーが発生した
  • queueTime - 通話がキューで過ごした秒数
  • queueSize - キューに残っている通話数
  • queuePosition - 削除される前のキュー内での通話の位置(0 始まり)
  • callSid - 通話の一意の識別子
  • callId - 通話の SIP Call-ID

waitHook のプロパティ

  • queueSid: キューの一意の識別子
  • queuePosition: キュー内での現在の位置(0 始まり)
  • queueTime: 通話がこれまでにキューで過ごした秒数
  • queueSize: キュー内の現在の通話数