SIP Refer

{
  "verb": "sip:refer",
  "referTo": +815099990007,
  "actionHook": "/action"
}

パラメータ

referTostring必須

SIP URI、または電話番号/ユーザー識別子。

actionHookstring

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

eventHookstring

後続通話のステータスを通知する NOTIFY メッセージを受信したときに呼び出される Webhook。

headersobject

レスポンスに含める追加の SIP ヘッダー。

referredBystring

SIP URI、または電話番号/ユーザー識別子。
指定しない場合、デフォルトは転送される側の識別情報になります。

sip:refer Function は、次のいずれかの条件が満たされたときに完了します。

REFER に対して失敗レスポンスを受信した
REFER に対するレスポンスとして 202 Accepted を受信し、最終的な通話ステータスを含む後続通話ステータスの NOTIFY を受信した。

sip:refer には、最終結果の詳細を提供するアクションフックと、 REFER が成功した後に受信したすべての NOTIFY に対して呼び出されるイベントフックがあります。

actionHook のプロパティ

actionHook の Webhook には、次の追加パラメータが含まれます。

referStatus: REFER リクエストに対する SIP ステータスレスポンス
final_referred_call_status - 転送先への後続通話の最終的な SIP ステータス。これは、REFER が受け入れられ、相手側から NOTIFY リクエストを受信した場合にのみ提供されます。

eventHook のプロパティ

eventHook の Webhook には event と call_status の 2 つのパラメータが含まれます。event パラメータは常に transfer-status であり、call-status には REFER が成功した後に NOTIFY で受信した SIP ステータスが含まれます。例:

{
    "event": "transfer-status",
    "call_status": "180"
}