Class IncomingCallEvent
- java.lang.Object
-
- com.sinch.sdk.domains.voice.models.webhooks.WebhooksEvent
-
- com.sinch.sdk.domains.voice.models.webhooks.CallEvent
-
- com.sinch.sdk.domains.voice.models.webhooks.IncomingCallEvent
-
public class IncomingCallEvent extends CallEvent
This event, called the ICE event, can be triggered by either an incoming data call or an incoming PSTN call.It's a POST request to the specified calling callback URL. Look here for allowed
instructionsandactions.If there is no response to the callback within the timeout period, an error message is played, and the call is disconnected.
- See Also:
- ICE
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classIncomingCallEvent.Builder<B extends IncomingCallEvent.Builder<B>>
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IncomingCallEvent.Builder<?>builder()StringgetApplicationKey()The unique application keyCollection<Pair<String,String>>getCallHeaders()If the call is initiated by a Sinch SDK client, call headers are the headers specified by the caller client.StringgetCallResourceUrl()The path of the API resourceStringgetCli()The number that will be displayed to the recipient of the call.DomainTypegetDomain()The domain destination of the incoming callIntegergetDuration()The duration of the call in secondsDomainTypegetOriginationType()The origination domain of the incoming callStringgetRdnis()The redirected dialled number identification serviceDestinationgetTo()Information about the recipient of the callPricegetUserRate()Charged for the call established to the original destination.StringtoString()-
Methods inherited from class com.sinch.sdk.domains.voice.models.webhooks.CallEvent
getCustom, getTimestamp
-
Methods inherited from class com.sinch.sdk.domains.voice.models.webhooks.WebhooksEvent
getCallId, getVersion
-
-
-
-
Method Detail
-
getCallResourceUrl
public String getCallResourceUrl()
The path of the API resource- Returns:
- path value
-
getUserRate
public Price getUserRate()
Charged for the call established to the original destination. If the SVAML response specifies another destination, the same rate may not apply.- Returns:
- charged value
-
getCli
public String getCli()
The number that will be displayed to the recipient of the call.To set your own CLI, you may use your verified number or your Dashboard virtual number and add it to the
ActionConnectPstnSVAML response to the Incoming Call Event request.- Returns:
-
getTo
public Destination getTo()
Information about the recipient of the call- Returns:
- information value
-
getDomain
public DomainType getDomain()
The domain destination of the incoming call- Returns:
- Domain value
-
getApplicationKey
public String getApplicationKey()
The unique application key- Returns:
- Application key value
-
getOriginationType
public DomainType getOriginationType()
The origination domain of the incoming call- Returns:
- Origin type
-
getDuration
public Integer getDuration()
The duration of the call in seconds- Returns:
- Duration value
-
getRdnis
public String getRdnis()
The redirected dialled number identification service- Returns:
- RDNIS value
-
getCallHeaders
public Collection<Pair<String,String>> getCallHeaders()
If the call is initiated by a Sinch SDK client, call headers are the headers specified by the caller client. Read more about call headers here- Returns:
- Headers
-
builder
public static IncomingCallEvent.Builder<?> builder()
-
-