Application Mapping in Phonenumbers & Dialrules
Overview.
Rather than showing raw "responder" values from the database, the v2 API will show user-friendly name mappings of the most common values linked to the new field name destination-application. This is a list of valid application names and the descriptions.
More info on its uses can be found in these APIs.
Table Mapping and Description
API v2 "destination-application" | Database & v1 | Description |
---|---|---|
available-number | AvailableDID | Identifies this phone number as being unassigned to a specific destination. The Core Module will respond with a SIP 404 Not Found if this number is called. SIP response is configurable via this article. |
to-voicemail-residential | Residential VMail | The same as "to-voicemail" except that DTMF input is disabled during voicemail greeting playback and inbound calls are not prompted whether to be forwarded to an operator. |
to-callqueue | sip:start@call-queuing sip:start@call-queueing | Places a call into destination queue. Queue specific configurations can be found in this article. |
to-callqueue-announce-count-callers-ahead | sip:say-que-size@call-queuing | Announces a count of the number of callers ahead and then places a call into destination queue. |
to-callqueue-announce-expected-wait-time | sip:say-que-time@call-queuing | Announces the expected wait and then places a call into destination queue. |
to-connection | sip:start@to-connection | Sends a call directly to a connection matching the destination host parameter. |
to-connection-or-user-no-failover | sip:start@one-shot | Sends a call directly to a connection matching the destination host parameter or device matching the destination user and host parameters. Call disconnects upon no answer. |
to-single-device | sip:start@to-owned-device | Sends a call directly to a single device matching the destination user and host parameters. Does not check the device owner's Answer Rule configuration and does not send call to voicemail if unanswered. |
to-user | sip:start@to-user | Processes a call according to the destination user's Answering Rule configuration, including Call Forwarding and Simultaneous Ring. If the destination user has voicemail enabled and the call times out without being answered, calls will end up in the destination user's voicemail box. |
to-user-residential | sip:start@to-user-resi | The same as "to-user" except that DTMF input is disabled during voicemail greeting playback and inbound calls are not prompted whether to be forwarded to an operator. |
to-voicemail | sip:start@to-vmail | Sends a call directly to the destination user's voicemail box. |
spam-screening | SPAM-Screen | After a positive match from the spam check performed by the configured identity verification service, the system will announce the name of the party being called, prompt the caller to record their name and enter a DTMF digit, and then call the destination party and prompt whether or not to accept the call. |
to-connection-no-timeout | sip:no-rna@to-connection | The same as "to-connection" except the ring-no-answer timer is disabled (preventing any additional call processing if the call is unanswered) |
to-connection-block-caller-id | sip:privacy@to-connection | The same as "to-connection" except the "privacy" flag is set for this call, causing the caller's Caller ID to show as anonymous or unavailable. |
to-connection-add-header-force-cdr-by-fields | To-Conn-For-DNIS-Add-Header | The same as "to-connection" except CDRs (Call Detail Record) generated will have their "by" fields (typically indicating an intermediary step in a call flow) populated with data from the call's SIP From URI. |
to-connection-add-header-no-timeout | To-Conn-No-RNA-Add-Header | The same as "to-connection" except the ring-no-answer timer is disabled(preventing any additional call processing if the call is unanswered), and adds a custom SIP header, specified in the dial-rule-parameter, to the SIP INVITE sent out to the connection. |
to-connection-add-header | To-Connection-Add-Header | The same as "to-connection" except a custom SIP header, specified in the dial-rule-parameter, is added to the SIP INVITE sent out to the connection. |
to-single-device-add-header-allow-voicemail | To-Device-wVM-Add-Header | The same as "to-single-device" except that the system adds a custom SIP header, specified in the dial-rule-parameter, to the SIP INVITE sent to the destination device. If the user that owns the device has voicemail enabled and the call times out without being answered, calls will end up in the user's voicemail box. |
to-single-device-add-header-allow-voicemail-residential | To-DevResi-wVM-Add-Header | The same as "to-single-device" except that the system adds a custom SIP header, specified in the dial-rule-parameter, to the SIP INVITE sent to the destination device. If the user that owns the device has voicemail enabled and the call times out without being answered, calls will end up in the user's voicemail box. DTMF input is disabled during voicemail greeting playback and inbound calls are not prompted whether to be forwarded to an operator. |
to-single-device-add-header | To-Owned-Device-Add-Header | The same as "to-single-device" except that the system adds a custom SIP header, specified in the dial-rule-parameter, to the SIP INVITE sent to the destination device. |
to-user-add-header | To-User-Add-Header | Processes a call according to the destination user's Answering Rule configuration, including Call Forwarding and Simultaneous Ring and adds a custom SIP header, specified in the dial-rule-parameter, to the SIP INVITE(s) sent to the destination user's phones. If the destination user has voicemail enabled and the call times out without being answered, calls will end up in the destination user's voicemail box. |
to-user-residential-add-header | To-UserResi-Add-Header | The same as "to-user-add-header" except that DTMF input is disabled during voicemail greeting playback and inbound calls are not prompted whether to be forwarded to an operator. |
to-user-notify-of-recording | ToUserRecordingNotice | The same as "to-user" except that prior to ringing the destination user, the system will play the "call-may-be-recorded.wav" file and then continually play "shortringback.wav" while the destination user is rung. |
hangup | Hangup | Immediately disconnects the call. |
to-user-answer-and-fake-ringback | ToUserRingback | The same as "to-user" except that prior to ringing the destination user, the system will continually play the "shortringback.wav" file while the destination user is rung. |
Updated 2 months ago