{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"outline":{"value":"false"},"style":{"value":"none"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"63827eff-3952-4358-b8bc-29fbe61885a5"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"3ce4e76a-ca44-4a82-9079-7921138d6bcf"}},{"type":"paragraph","content":[{"text":"Event Triggers let you set up Switchvox to interact with external web-based applications. When certain events occur in Switchvox, it can do an HTTP POST that includes information about the event, and then respond to XML that is returned. Click ","type":"text"},{"text":"Save Event Triggers","type":"text","marks":[{"type":"strong"}]},{"text":" when finished.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"System Default URL","type":"text"}]},{"type":"paragraph","content":[{"text":"You can enter a ","type":"text"},{"text":"Default URL","type":"text","marks":[{"type":"strong"}]},{"text":" so that you do not have to enter a full URL for each event. But, you can choose to use the default URL or not, so you still have flexibility on each event.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Event Specific URLs","type":"text"}]},{"type":"paragraph","content":[{"text":"There are some Switchvox events that trigger an HTTP POST. You can choose to ","type":"text"},{"text":"Append ","type":"text","marks":[{"type":"strong"}]},{"text":"URL variables and to use the Default URL (YES/NO).","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Incoming Call Event URL. ","type":"text","marks":[{"type":"strong"}]},{"text":"Triggered at the beginning of an incoming call. This event applies to calls received from VOIP providers, any channel groups, as well as calls between extensions. It is common for requests of this type to return XML for routing the call or altering the Caller ID.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Route to Extension Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a call hits an extension. This event can occur multiple times for each call. For example, a call may hit an IVR, a queue, and then a phone extension. XML can be returned to route calls differently.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"WARNING","type":"text","marks":[{"type":"strong"}]},{"text":": Do not create routing loops. For example, if a call to extension 333 results in a request that sets transfer_extension to 333, then Switchvox loops endlessly. Do not set transfer_extension in the response to this event unless it is absolutely necessary.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Call Answered Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a call is answered. This event applies to calls from external numbers, and from all Switchvox extensions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On New Voicemail Event URL.","type":"text","marks":[{"type":"strong"}]},{"text":" Triggered when a voicemail message is left for an extension (including a message forwarded from another extension). This event requests the voicemail URL.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Setting XML values in the response to this request results in undefined behavior. Return empty XML for this request.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Checked Voicemail Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when an extension checks its voicemail. This event could be used in conjunction with the On New Voicemail Event to track new voicemail messages and implement an escalation policy.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"NOTE","type":"text","marks":[{"type":"strong"}]},{"text":": Setting XML values in the response to this request results in undefined behavior. Return empty XML for this request.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Agent Logged In Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a queue member logs into a queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Agent Logged Out Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a queue member logs out of a queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Call Hangup Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a call is hung up. This event can be used in conjunction with the JOB_ID variable to record the completion of calls that invoked previous URL events. Note: Setting XML values in the response to this request results in undefined behavior. Return empty XML for this request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On Outgoing Call Event URL","type":"text","marks":[{"type":"strong"}]},{"text":". Triggered when a call is created. This event applies to calls to external numbers and all Switchvox extensions.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"URL Variables","type":"text"}]},{"type":"paragraph","content":[{"text":"Switchvox events can submit various information about calls. To do this, you use variables in the URL. Not every variable is available in every event (check the Acceptable Variables dropdown on each event), so be prepared to handle an empty variable. Here is the complete list of all of the variables for all event types:","type":"text"}]},{"type":"paragraph","content":[{"text":"CALLER_ID_NUMBER","type":"text","marks":[{"type":"strong"}]},{"text":". Phone number from caller ID, including area code.","type":"text"}]},{"type":"paragraph","content":[{"text":"CALLER_ID_NAME","type":"text","marks":[{"type":"strong"}]},{"text":". Name from caller ID.","type":"text"}]},{"type":"paragraph","content":[{"text":"EXTENSION","type":"text","marks":[{"type":"strong"}]},{"text":". Internal extension associated with the event.","type":"text"}]},{"type":"paragraph","content":[{"text":"EXTENSION_TYPE","type":"text","marks":[{"type":"strong"}]},{"text":". The type of the extension associated with the event. For the list of extension types, see ","type":"text"},{"text":"Extension Types","type":"text","marks":[{"type":"link","attrs":{"href":"https://sangoma.lightning.force.com/articles/Knowledge/SETUP-EXTENSIONS-Manage-Create-Extension-Type"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"FEATURE_DATA","type":"text","marks":[{"type":"strong"}]},{"text":". The data entered after a feature code. For example, in *62204, you have an EXTENSION of 62, an EXTENSION_TYPE of feature_monitor, and a FEATURE_DATA of 204.","type":"text"}]},{"type":"paragraph","content":[{"text":"INCOMING_DID","type":"text","marks":[{"type":"strong"}]},{"text":". Phone number dialed by an external caller. May be empty for internal calls, or calls over certain analog lines that do not provide the DID.","type":"text"}]},{"type":"paragraph","content":[{"text":"VM_DUR","type":"text","marks":[{"type":"strong"}]},{"text":". The duration of the voicemail message, in seconds.","type":"text"}]},{"type":"paragraph","content":[{"text":"VM_MSGNUM","type":"text","marks":[{"type":"strong"}]},{"text":". The unique message number for this voicemail message.","type":"text"}]},{"type":"paragraph","content":[{"text":"VM_MAILBOX","type":"text","marks":[{"type":"strong"}]},{"text":". Extension associated with the event’s voicemail box.","type":"text"}]},{"type":"paragraph","content":[{"text":"VM_DATE","type":"text","marks":[{"type":"strong"}]},{"text":". The date and time of the voicemail message.","type":"text"}]},{"type":"paragraph","content":[{"text":"QUEUES","type":"text","marks":[{"type":"strong"}]},{"text":". A comma separated list of the queue account_ids being logged in to or logged out of. In the case where the user is being logged out of all queues, the list will only contain the list of queues the user is a member of.","type":"text"}]},{"type":"paragraph","content":[{"text":"EVENT_TYPE","type":"text","marks":[{"type":"strong"}]},{"text":". Event type that has been triggered. This is useful for the Default URL, which receives POSTs from any of the event types.","type":"text"}]},{"type":"paragraph","content":[{"text":"JOB_ID","type":"text","marks":[{"type":"strong"}]},{"text":". Unique ID of the call. Note: This string of digits is not a numerical value: 99.100 is not equal to 99.1. This variable is useful for correlating multiple events (and also certain IVR requests).","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"XML Response","type":"text"}]},{"type":"paragraph","content":[{"text":"For some events, the remote web application can return XML that instructs Switchvox to perform operations on the call. Here is a sample of an XML response:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n8585551212\nJohn Doe\n850\nhttp://intranet.example.com/crm.cgi?custid=2\n1\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"All of the tags inside the call_info block are optional. The following XML tags can be used:","type":"text"}]},{"type":"paragraph","content":[{"text":"callerid_num","type":"text","marks":[{"type":"strong"}]},{"text":". Set Caller ID Number to this value.","type":"text"}]},{"type":"paragraph","content":[{"text":"callerid_name","type":"text","marks":[{"type":"strong"}]},{"text":". Set Caller ID Name to this value.","type":"text"}]},{"type":"paragraph","content":[{"text":"transfer_extension","type":"text","marks":[{"type":"strong"}]},{"text":". Transfer call to the extension of this value. If this XML is a response to the event On Outgoing Call, this can be an external number. Make sure to enter this number as you would dial it from your phone. For example, if you must dial 9 for an external number, an external number here must begin with a 9.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"WARNING","type":"text","marks":[{"type":"strong"}]},{"text":": It is possible to break Switchvox by creating routing loops with transfer_extension.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"display_url","type":"text","marks":[{"type":"strong"}]},{"text":". Display this URL in the Switchboard as a clickable icon. For example: the remote web application might lookup the caller’s phone number in your company’s user database, then return the URL of the caller’s user record.","type":"text"}]},{"type":"paragraph","content":[{"text":"continue_outgoing_reporting","type":"text","marks":[{"type":"strong"}]},{"text":". Continue reporting any subsequent outgoing calls for this JOB_ID. For example, if a call is made to a queue, the event will continue when a queue-member's extension is dialed. The value of this tag must be 1 or 0.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Affected Version(s)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"6.0","type":"text"}]}],"version":1}

Browser not supported